Forgot the actual download class

2 files changed, 403 insertions, 0 deletions

diff --git a/src/net/download.cpp b/src/net/download.cpp
new file mode 100644
index 00000000..a2368d85
--- /dev/null
+++ b/src/net/download.cpp
@@ -0,0 +1,295 @@
+/*
+ *  The Mana World
+ *  Copyright (C) 2009  The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include "net/download.h"
+
+#include "log.h"
+#include "main.h"
+
+#include <SDL.h>
+#include <SDL_thread.h>
+
+#include <curl/curl.h>
+#include <zlib.h>
+
+const char *DOWNLOAD_ERROR_MESSAGE_THREAD = "Could not create download thread!";
+
+/**
+ * Calculates the Alder-32 checksum for the given file.
+ */
+static unsigned long fadler32(FILE *file)
+{
+    // Obtain file size
+    fseek(file, 0, SEEK_END);
+    long fileSize = ftell(file);
+    rewind(file);
+
+    // Calculate Adler-32 checksum
+    char *buffer = (char*) malloc(fileSize);
+    const size_t read = fread(buffer, 1, fileSize, file);
+    unsigned long adler = adler32(0L, Z_NULL, 0);
+    adler = adler32(adler, (Bytef*) buffer, read);
+    free(buffer);
+
+    return adler;
+}
+
+enum {
+    OPTIONS_NONE = 0,
+    OPTIONS_MEMORY = 1
+};
+
+namespace Net{
+Download::Download(void *ptr, const std::string &url,
+                   DownloadUpdate updateFunction):
+        mPtr(ptr),
+        mUrl(url),
+        mFileName(""),
+        mWriteFunction(NULL),
+        mUpdateFunction(updateFunction),
+        mThread(NULL),
+        mCurl(NULL),
+        mHeaders(NULL)
+
+{
+    mError = (char*) malloc(CURL_ERROR_SIZE);
+    mError[0] = 0;
+
+    mOptions.cancel = false;
+}
+
+Download::~Download()
+{
+    delete mError;
+
+    if (mHeaders)
+        curl_slist_free_all(mHeaders);
+}
+
+void Download::addHeader(const std::string &header)
+{
+    mHeaders = curl_slist_append(mHeaders, header.c_str());
+}
+
+void Download::noCache()
+{
+    addHeader("pragma: no-cache");
+    addHeader("Cache-Control: no-cache");
+}
+
+void Download::setFile(const std::string &filename, Sint64 adler32)
+{
+    mOptions.memoryWrite = false;
+    mFileName = filename;
+
+    if (adler32 > -1)
+    {
+        mAdler = (unsigned long) adler32;
+        mOptions.checkAdler = true;
+    }
+    else
+        mOptions.checkAdler =  false;
+}
+
+void Download::setWriteFunction(WriteFunction write)
+{
+    mOptions.memoryWrite = true;
+    mWriteFunction = write;
+}
+
+bool Download::start()
+{
+    logger->log("Starting download: %s\n", mUrl.c_str());
+
+    mThread = SDL_CreateThread(downloadThread, this);
+
+    if (!mThread)
+    {
+        logger->log(DOWNLOAD_ERROR_MESSAGE_THREAD);
+        strcpy(mError, DOWNLOAD_ERROR_MESSAGE_THREAD);
+        mUpdateFunction(mPtr, DOWNLOAD_STATUS_THREAD_ERROR, 0, 0);
+
+        return false;
+    }
+
+    return true;
+}
+
+void Download::cancel()
+{
+    logger->log("Canceling download: %s\n", mUrl.c_str());
+    mOptions.cancel = true;
+}
+
+char *Download::getError()
+{
+    return mError;
+}
+
+int Download::downloadProgress(void *clientp, double dltotal, double dlnow,
+                     double ultotal, double ulnow)
+{
+    Download *d = reinterpret_cast<Download*>(clientp);
+
+    if (d->mOptions.cancel)
+    {
+        return d->mUpdateFunction(d->mPtr, DOWNLOAD_STATUS_CANCELLED, dltotal,
+                                  dlnow);
+        return -5;
+    }
+
+    return d->mUpdateFunction(d->mPtr, DOWNLOAD_STATUS_IDLE, dltotal, dlnow);
+}
+
+int Download::downloadThread(void *ptr)
+{
+    int attempts = 0;
+    bool complete = false;
+    Download *d = reinterpret_cast<Download*>(ptr);
+    CURLcode res;
+    std::string outFilename;
+
+    if (!d->mOptions.memoryWrite)
+    {
+        outFilename = d->mFileName + ".part";
+    }
+
+    while (attempts < 3 && !complete)
+    {
+        FILE *file = NULL;
+
+        d->mUpdateFunction(d->mPtr, DOWNLOAD_STATUS_STARTING, 0, 0);
+
+        d->mCurl = curl_easy_init();
+
+        if (d->mCurl)
+        {
+            logger->log("Downloading: %s", d->mUrl.c_str());
+
+            curl_easy_setopt(d->mCurl, CURLOPT_HTTPHEADER, d->mHeaders);
+
+            if (d->mOptions.memoryWrite)
+            {
+                curl_easy_setopt(d->mCurl, CURLOPT_FAILONERROR, 1);
+                curl_easy_setopt(d->mCurl, CURLOPT_WRITEFUNCTION, d->mWriteFunction);
+                curl_easy_setopt(d->mCurl, CURLOPT_WRITEDATA, d->mPtr);
+            }
+            else
+            {
+                file = fopen(outFilename.c_str(), "w+b");
+                curl_easy_setopt(d->mCurl, CURLOPT_WRITEDATA, file);
+            }
+
+#ifdef PACKAGE_VERSION
+            curl_easy_setopt(d->mCurl, CURLOPT_USERAGENT, "TMW/" PACKAGE_VERSION);
+#else
+            curl_easy_setopt(d->mCurl, CURLOPT_USERAGENT, "TMW");
+#endif
+            curl_easy_setopt(d->mCurl, CURLOPT_ERRORBUFFER, d->mError);
+            curl_easy_setopt(d->mCurl, CURLOPT_URL, d->mUrl.c_str());
+            curl_easy_setopt(d->mCurl, CURLOPT_NOPROGRESS, 0);
+            curl_easy_setopt(d->mCurl, CURLOPT_PROGRESSFUNCTION, downloadProgress);
+            curl_easy_setopt(d->mCurl, CURLOPT_PROGRESSDATA, ptr);
+            curl_easy_setopt(d->mCurl, CURLOPT_NOSIGNAL, 1);
+            curl_easy_setopt(d->mCurl, CURLOPT_CONNECTTIMEOUT, 15);
+
+            if ((res = curl_easy_perform(d->mCurl)) != 0)
+            {
+                switch (res)
+                {
+                case CURLE_COULDNT_CONNECT:
+                default:
+                    logger->log("curl error %d: %s host: %s",
+                                res, d->mError, d->mUrl.c_str());
+                    break;
+                }
+
+                d->mUpdateFunction(d->mPtr, DOWNLOAD_STATUS_ERROR, 0, 0);
+
+                if (!d->mOptions.memoryWrite)
+                {
+                    fclose(file);
+                    ::remove(outFilename.c_str());
+                }
+                attempts++;
+                continue;
+            }
+
+            curl_easy_cleanup(d->mCurl);
+
+            if (!d->mOptions.memoryWrite)
+            {
+                // Don't check resources2.txt checksum
+                if (d->mOptions.checkAdler)
+                {
+                    unsigned long adler = fadler32(file);
+
+                    if (d->mAdler != adler)
+                    {
+                        fclose(file);
+
+                        // Remove the corrupted file
+                        ::remove(d->mFileName.c_str());
+                        logger->log("Checksum for file %s failed: (%lx/%lx)",
+                            d->mFileName.c_str(),
+                            adler, d->mAdler);
+                        attempts++;
+                        continue; // Bail out here to avoid the renaming
+                    }
+                }
+                fclose(file);
+
+                // Any existing file with this name is deleted first, otherwise
+                // the rename will fail on Windows.
+                ::remove(d->mFileName.c_str());
+                ::rename(outFilename.c_str(), d->mFileName.c_str());
+
+                // Check if we can open it and no errors were encountered
+                // during renaming
+                file = fopen(d->mFileName.c_str(), "rb");
+                if (file)
+                {
+                    fclose(file);
+                    complete = true;
+                }
+            }
+            else
+            {
+                // It's stored in memory, we're done
+                complete = true;
+            }
+        }
+        attempts++;
+    }
+
+    if (!complete) {
+        d->mUpdateFunction(d->mPtr, DOWNLOAD_STATUS_ERROR, 0, 0);
+    }
+    else
+    {
+        d->mUpdateFunction(d->mPtr, DOWNLOAD_STATUS_COMPLETE, 0, 0);
+    }
+
+    return 0;
+}
+
+
+} // namespace Net
diff --git a/src/net/download.h b/src/net/download.h
new file mode 100644
index 00000000..1e1f806f
--- /dev/null
+++ b/src/net/download.h
@@ -0,0 +1,108 @@
+/*
+ *  The Mana World
+ *  Copyright (C) 2009  The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include <SDL_types.h>
+#include <stdio.h>
+#include <string>
+
+#ifndef NET_DOWNLOAD_H
+#define NET_DOWNLOAD_H
+
+enum DownloadStatus
+{
+    DOWNLOAD_STATUS_CANCELLED = -3,
+    DOWNLOAD_STATUS_THREAD_ERROR = -2,
+    DOWNLOAD_STATUS_ERROR = -1,
+    DOWNLOAD_STATUS_STARTING = 0,
+    DOWNLOAD_STATUS_IDLE,
+    DOWNLOAD_STATUS_COMPLETE
+};
+
+typedef int (*DownloadUpdate)(void *ptr, DownloadStatus status,
+                              size_t total, size_t remaining);
+
+// Matches what CURL expects
+typedef size_t (*WriteFunction)( void *ptr, size_t size, size_t nmemb,
+                                 void *stream);
+
+struct SDL_Thread;
+typedef void CURL;
+struct curl_slist;
+
+namespace Net {
+class Download
+{
+    public:
+        Download(void *ptr, const std::string &url, DownloadUpdate updateFunction);
+
+        ~Download();
+
+        void addHeader(const std::string &header);
+
+        /**
+         * Convience method for adding no-cache headers.
+         */
+        void noCache();
+
+        void setFile(const std::string &filename, Sint64 adler32 = -1);
+
+        void setWriteFunction(WriteFunction write);
+
+        /**
+         * Starts the download thread.
+         * @returns true  if thread was created
+         *          false if the thread could not be made or download wasn't
+         *                properly setup
+         */
+        bool start();
+
+        /**
+         * Cancels the download. Returns immediately, the cancelled status will
+         * be noted in the next avialable update call.
+         */
+        void cancel();
+
+        char *getError();
+
+    private:
+        static int downloadThread(void *ptr);
+        static int downloadProgress(void *clientp, double dltotal, double dlnow,
+                                        double ultotal, double ulnow);
+        void *mPtr;
+        std::string mUrl;
+        struct {
+            unsigned cancel : 1;
+            unsigned memoryWrite: 1;
+            unsigned checkAdler: 1;
+        } mOptions;
+        std::string mFileName;
+        WriteFunction mWriteFunction;
+        unsigned long mAdler;
+        DownloadUpdate mUpdateFunction;
+        SDL_Thread *mThread;
+        CURL *mCurl;
+        curl_slist *mHeaders;
+        char *mError;
+};
+
+} // namespace Net
+
+#endif // NET_DOWNLOAD_H