updaterwindow.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  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_WINDOWS_UPDATERWINDOW_H
#define GUI_WINDOWS_UPDATERWINDOW_H
 
#include "enums/gui/updatedownloadstatus.h"
 
#include "enums/net/downloadstatus.h"
#include "enums/net/updatetype.h"
 
#include "enums/simpletypes/append.h"
 
#include "gui/widgets/window.h"
 
#include "resources/updatefile.h"
 
#include "utils/mutex.h"
 
#include "listeners/actionlistener.h"
#include "listeners/keylistener.h"
 
class Button;
class ItemLinkHandler;
class Label;
class ProgressBar;
class ScrollArea;
class StaticBrowserBox;
 
namespace Net
{
    class Download;
}  // namespace Net
 
class UpdaterWindow final : public Window,
                            public ActionListener,
                            public KeyListener
{
    public:
        UpdaterWindow(const std::string &restrict updateHost,
                      const std::string &restrict updatesDir,
                      const bool applyUpdates,
                      const UpdateTypeT updateType);
 
        A_DELETE_COPY(UpdaterWindow)
 
        
        ~UpdaterWindow() override final;
 
        void postInit() override final;
 
        void setProgress(const float p);
 
        void setLabel(const std::string &);
 
        void enable();
 
        void loadNews();
 
        void loadPatch();
 
        void action(const ActionEvent &event) override final;
 
        void keyPressed(KeyEvent &event) override final;
 
        void logic() override final;
 
        void loadFile(std::string file);
 
        void deleteSelf();
 
        static void loadLocalUpdates(const std::string &dir);
 
        static void unloadUpdates(const std::string &dir);
 
        static void addUpdateFile(const std::string &restrict path,
                                  const std::string &restrict fixPath,
                                  const std::string &restrict file,
                                  const Append append);
 
        static void removeUpdateFile(const std::string &restrict path,
                                     const std::string &restrict fixPath,
                                     const std::string &filerestrict);
 
        static void loadManaPlusUpdates(const std::string &dir);
 
        static void unloadManaPlusUpdates(const std::string &dir);
 
        static unsigned long getFileHash(const std::string &filePath);
 
        static void loadMods(const std::string &dir,
                             const STD_VECTOR<UpdateFile> &updateFiles);
 
        static void loadDirMods(const std::string &dir);
 
        static void unloadMods(const std::string &dir);
 
    private:
        void download();
 
        void loadUpdates();
 
        static int updateProgress(void *ptr,
                                  const DownloadStatusT status,
                                  size_t dt,
                                  const size_t dn);
 
        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;
 
        float mDownloadProgress;
 
        std::string mUpdateHost;
 
        std::string mUpdatesDir;
 
        std::string mUpdatesDirReal;
 
        std::string mCurrentFile;
 
        std::string mNewLabelCaption;
 
        // The mutex used to guard access to mNewLabelCaption
        // and mDownloadProgress.
        Mutex mDownloadMutex;
 
        unsigned long mCurrentChecksum;
 
        char *mMemoryBuffer;
 
        Net::Download *mDownload;
 
        STD_VECTOR<UpdateFile> mUpdateFiles;
 
        STD_VECTOR<UpdateFile> mTempUpdateFiles;
 
        std::string mUpdateServerPath;
 
        ItemLinkHandler *mItemLinkHandler A_NONNULLPOINTER;
        Label *mLabel A_NONNULLPOINTER;
        Button *mCancelButton A_NONNULLPOINTER;
        Button *mPlayButton A_NONNULLPOINTER;
        ProgressBar *mProgressBar A_NONNULLPOINTER;
        StaticBrowserBox *mBrowserBox A_NONNULLPOINTER;
        ScrollArea *mScrollArea A_NONNULLPOINTER;
 
        UpdateDownloadStatusT mDownloadStatus;
 
        int mDownloadedBytes;
 
        unsigned int mUpdateIndex;
 
        unsigned int mUpdateIndexOffset;
 
        UpdateTypeT mUpdateType;
 
        bool mStoreInMemory;
 
        bool mDownloadComplete;
 
        bool mUserCancel;
 
        bool mLoadUpdates;
 
        bool mValidateXml;
 
        bool mSkipPatches;
};
 
extern UpdaterWindow *updaterWindow;
 
#endif  // GUI_WINDOWS_UPDATERWINDOW_H