diff options
Diffstat (limited to 'src/gui/windows/updaterwindow.h')
| -rw-r--r-- | src/gui/windows/updaterwindow.h | 258 |
1 files changed, 258 insertions, 0 deletions
diff --git a/src/gui/windows/updaterwindow.h b/src/gui/windows/updaterwindow.h new file mode 100644 index 000000000..e317e3f95 --- /dev/null +++ b/src/gui/windows/updaterwindow.h @@ -0,0 +1,258 @@ +/* + * The ManaPlus Client + * Copyright (C) 2004-2009 The Mana World Development Team + * Copyright (C) 2009-2010 The Mana Developers + * Copyright (C) 2011-2013 The ManaPlus Developers + * + * This file is part of The ManaPlus Client. + * + * 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, see <http://www.gnu.org/licenses/>. + */ + +#ifndef GUI_UPDATERWINDOW_H +#define GUI_UPDATERWINDOW_H + +#include "gui/widgets/linkhandler.h" +#include "gui/widgets/window.h" + +#include "net/download.h" + +#include "utils/mutex.h" + +#include <guichan/actionlistener.hpp> +#include <guichan/keylistener.hpp> + +#include <string> +#include <vector> + +class BrowserBox; +class Button; +class Label; +class ProgressBar; +class ResourceManager; +class ScrollArea; + +struct UpdateFile final +{ + public: + UpdateFile() : + name(), + hash(), + type(), + desc(), + required(false) + { + } + std::string name; + std::string hash; + std::string type; + std::string desc; + bool required; +}; + +/** + * Update progress window GUI + * + * \ingroup GUI + */ +class UpdaterWindow final : public Window, + public gcn::ActionListener, + public LinkHandler, + public gcn::KeyListener +{ + public: + /** + * Constructor. + * + * @param updateHost Host where to get the updated files. + * @param updatesDir Directory where to store updates (should be absolute + * and already created). + * @param applyUpdates If true, the update window will pass the updates to teh + * resource manager + */ + UpdaterWindow(const std::string &updateHost, + const std::string &updatesDir, + const bool applyUpdates, const int updateType); + + A_DELETE_COPY(UpdaterWindow) + + /** + * Destructor + */ + ~UpdaterWindow(); + + /** + * Set's progress bar status + */ + void setProgress(const float p); + + /** + * Set's label above progress + */ + void setLabel(const std::string &); + + /** + * Enables play button + */ + void enable(); + + /** + * Loads and display news. Assumes the news file contents have been loaded + * into the memory buffer. + */ + void loadNews(); + + void loadPatch(); + + void action(const gcn::ActionEvent &event) override; + + void keyPressed(gcn::KeyEvent &keyEvent) override; + + void logic() override; + + void handleLink(const std::string &link, + gcn::MouseEvent *event A_UNUSED) override; + + static void loadLocalUpdates(const std::string &dir); + + static void unloadUpdates(const std::string &dir); + + static void addUpdateFile(const ResourceManager *const resman, + const std::string &path, + const std::string &fixPath, + const std::string &file, + const bool append); + + static void removeUpdateFile(const ResourceManager *const resman, + const std::string &path, + const std::string &fixPath, + const std::string &file); + + static void loadManaPlusUpdates(const std::string &dir, + const ResourceManager *const resman); + + static void unloadManaPlusUpdates(const std::string &dir, + const ResourceManager *const resman); + + static unsigned long getFileHash(const std::string &filePath); + +private: + void download(); + + /** + * Loads the updates this window has gotten into the resource manager + */ + void loadUpdates(); + + + /** + * A download callback for progress updates. + */ + static int updateProgress(void *ptr, DownloadStatus status, + size_t dt, size_t dn); + + /** + * A libcurl callback for writing to memory. + */ + static size_t memoryWrite(void *ptr, size_t size, size_t nmemb, + void *stream); + + static bool validateFile(const std::string &filePath, + const unsigned long hash) A_WARN_UNUSED; + + enum UpdateDownloadStatus + { + UPDATE_ERROR = 0, + UPDATE_IDLE, + UPDATE_LIST, + UPDATE_COMPLETE, + UPDATE_NEWS, + UPDATE_RESOURCES, + UPDATE_PATCH, + UPDATE_LIST2, + UPDATE_RESOURCES2 + }; + + /** Status of the current download. */ + UpdateDownloadStatus mDownloadStatus; + + /** Host where we get the updated files. */ + std::string mUpdateHost; + + /** Place where the updates are stored (absolute path). */ + std::string mUpdatesDir; + + std::string mUpdatesDirReal; + + /** The file currently downloading. */ + std::string mCurrentFile; + + /** The new label caption to be set in the logic method. */ + std::string mNewLabelCaption; + + /** The new progress value to be set in the logic method. */ + float mDownloadProgress; + + // The mutex used to guard access to mNewLabelCaption + // and mDownloadProgress. + Mutex mDownloadMutex; + + /** The Adler32 checksum of the file currently downloading. */ + unsigned long mCurrentChecksum; + + /** A flag to indicate whether to use a memory buffer or a regular file. */ + bool mStoreInMemory; + + /** Flag that show if current download is complete. */ + bool mDownloadComplete; + + /** Flag that show if the user has canceled the update. */ + bool mUserCancel; + + /** Byte count currently downloaded in mMemoryBuffer. */ + int mDownloadedBytes; + + /** Buffer for files downloaded to memory. */ + char *mMemoryBuffer; + + /** Download handle. */ + Net::Download *mDownload; + + /** List of files to download. */ + std::vector<UpdateFile> mUpdateFiles; + + /** List of temp files to download. */ + std::vector<UpdateFile> mTempUpdateFiles; + + /** Index of the file to be downloaded. */ + unsigned int mUpdateIndex; + + /** Index offset for disaplay downloaded file. */ + unsigned int mUpdateIndexOffset; + + /** Tells ~UpdaterWindow() if it should load updates */ + bool mLoadUpdates; + + int mUpdateType; + + Label *mLabel; /**< Progress bar caption. */ + Button *mCancelButton; /**< Button to stop the update process. */ + Button *mPlayButton; /**< Button to start playing. */ + ProgressBar *mProgressBar; /**< Update progress bar. */ + BrowserBox *mBrowserBox; /**< Box to display news. */ + ScrollArea *mScrollArea; /**< Used to scroll news box. */ + std::string mUpdateServerPath; +}; + +#endif // GUI_UPDATERWINDOW_H |