diff options
author | Andrew <forkk@forkk.net> | 2013-05-08 12:56:43 -0500 |
---|---|---|
committer | Andrew <forkk@forkk.net> | 2013-05-08 12:56:43 -0500 |
commit | 5f781b3053c5ba8a25d354903acf2c31dc9a56c5 (patch) | |
tree | 94361d20568e55d63db7b18f3c7dded7d1e88e06 /libmultimc/include | |
parent | 2e62f6e8d8aded1036f96835ebebd4d656c0fcc2 (diff) | |
download | MultiMC-5f781b3053c5ba8a25d354903acf2c31dc9a56c5.tar MultiMC-5f781b3053c5ba8a25d354903acf2c31dc9a56c5.tar.gz MultiMC-5f781b3053c5ba8a25d354903acf2c31dc9a56c5.tar.lz MultiMC-5f781b3053c5ba8a25d354903acf2c31dc9a56c5.tar.xz MultiMC-5f781b3053c5ba8a25d354903acf2c31dc9a56c5.zip |
Implement basic game updater.
Resolves MMC-4: https://jira.forkk.net/browse/MMC-4
Diffstat (limited to 'libmultimc/include')
-rw-r--r-- | libmultimc/include/gameupdatetask.h | 144 | ||||
-rw-r--r-- | libmultimc/include/instance.h | 35 | ||||
-rw-r--r-- | libmultimc/include/logintask.h | 7 | ||||
-rw-r--r-- | libmultimc/include/minecraftprocess.h | 8 | ||||
-rw-r--r-- | libmultimc/include/minecraftversion.h | 10 |
5 files changed, 183 insertions, 21 deletions
diff --git a/libmultimc/include/gameupdatetask.h b/libmultimc/include/gameupdatetask.h index eabfbd1f..47f6c007 100644 --- a/libmultimc/include/gameupdatetask.h +++ b/libmultimc/include/gameupdatetask.h @@ -18,19 +18,105 @@ #include <QObject> +#include <QList> + +#include <QNetworkAccessManager> +#include <QUrl> + +#include "task.h" #include "loginresponse.h" +#include "instance.h" #include "libmmc_config.h" +class FileToDownload : public QObject +{ + Q_OBJECT + + /*! + * The URL to download the file from. + */ + Q_PROPERTY(QUrl url READ url WRITE setURL) + + /*! + * The path to download to. + * This path is relative to the instance's root directory. + */ + Q_PROPERTY(QString path READ path WRITE setPath) +public: + FileToDownload(const QUrl &url, const QString &path, QObject *parent = 0); + FileToDownload(const FileToDownload &other); + + virtual QUrl url() const { return m_dlURL; } + virtual void setURL(const QUrl &url) { m_dlURL = url; } + + virtual QString path() const { return m_dlPath; } + virtual void setPath(const QString &path) { m_dlPath = path; } + +private: + QUrl m_dlURL; + QString m_dlPath; +}; + /*! - * \brief The game update task is the task that handles downloading instances. - * Each instance type has its own class inheriting from this base game update task. + * The game update task is the task that handles downloading instances' files. */ -class LIBMULTIMC_EXPORT GameUpdateTask : public QObject +class LIBMULTIMC_EXPORT GameUpdateTask : public Task { Q_OBJECT + + /*! + * The task's state. + * A certain state message will be shown depending on what this is set to. + */ + Q_PROPERTY(int state READ state WRITE setState) + + /*! + * The substatus message. + * This will be next to the the state message in the task's status. + */ + Q_PROPERTY(QString subStatus READ subStatus WRITE setSubStatus) public: - explicit GameUpdateTask(const LoginResponse &response, QObject *parent = 0); + explicit GameUpdateTask(const LoginResponse &response, Instance *inst, QObject *parent = 0); + + + ///////////////////////// + // EXECUTION FUNCTIONS // + ///////////////////////// + + virtual void executeTask(); + + virtual bool downloadFile(const FileToDownload &file); + + + ////////////////////// + // STATE AND STATUS // + ////////////////////// + + virtual int state() const; + virtual void setState(int state, bool resetSubStatus = true); + + virtual QString subStatus() const; + virtual void setSubStatus(const QString &msg); + + /*! + * Gets the message that will be displated for the given state. + */ + virtual QString getStateMessage(int state); + +public slots: + + /*! + * Updates the status message based on the state and substatus message. + */ + virtual void updateStatus(); + + + virtual void error(const QString &msg); + + +private slots: + virtual void updateDownloadProgress(qint64 current, qint64 total); signals: /*! @@ -40,13 +126,59 @@ signals: void gameUpdateComplete(const LoginResponse &response); /*! - * \brief Signal emitted if the game update fails. + * \brief Signal emitted if an error occurrs during the update. * \param errorMsg An error message to be displayed to the user. */ - void gameUpdateFailed(const QString &errorMsg); + void gameUpdateError(const QString &errorMsg); private: + /////////// + // STUFF // + /////////// + + Instance *m_inst; + LoginResponse m_response; + + QNetworkAccessManager *netMgr; + + + + //////////////////////// + // FILE DOWNLOAD LIST // + //////////////////////// + + // List of URLs that the game updater will need to download. + QList<FileToDownload> m_downloadList; + int m_currentDownload; + + + + //////////////////////////// + // STATE AND STATUS STUFF // + //////////////////////////// + + int m_updateState; + QString m_subStatusMsg; + + enum UpdateState + { + // Initializing + StateInit = 0, + + // Determining files to download + StateDetermineURLs, + + // Downloading files + StateDownloadFiles, + + // Installing files + StateInstall, + + // Finished + StateFinished + }; }; + #endif // GAMEUPDATETASK_H diff --git a/libmultimc/include/instance.h b/libmultimc/include/instance.h index e72a0be3..717f8816 100644 --- a/libmultimc/include/instance.h +++ b/libmultimc/include/instance.h @@ -75,6 +75,21 @@ class LIBMULTIMC_EXPORT Instance : public QObject */ Q_PROPERTY(bool shouldRebuild READ shouldRebuild WRITE setShouldRebuild) + /*! + * Whether or not Minecraft should be downloaded when the instance is launched. + * This returns true if shouldForceUpdate game is true or if the intended and + * current versions don't match. + */ + Q_PROPERTY(bool shouldUpdateGame READ shouldUpdateGame STORED false) + + /*! + * Whether or not the game will be forced to update on the next launch. + * If this is set to true, shouldUpdateGame will be true, regardless of whether or not + * the current and intended versions match. + * It should be noted that this is set to false automatically when game updates are run. + */ + Q_PROPERTY(bool shouldForceUpdateGame READ shouldForceUpdateGame WRITE setShouldForceUpdateGame) + /*! * The instance's current version. @@ -182,7 +197,7 @@ public: //////// INSTANCE INFO //////// //// General Info //// - virtual QString name() { return settings().get("name").toString(); } + virtual QString name() const { return settings().get("name").toString(); } virtual void setName(QString val) { settings().set("name", val); @@ -212,27 +227,33 @@ public: //// Version Stuff //// - virtual QString currentVersion() { return settings().get("JarVersion").toString(); } + virtual QString currentVersion() const { return settings().get("JarVersion").toString(); } virtual void setCurrentVersion(QString val) { settings().set("JarVersion", val); } - virtual QString lwjglVersion() { return settings().get("LwjglVersion").toString(); } + virtual QString lwjglVersion() const { return settings().get("LwjglVersion").toString(); } virtual void setLWJGLVersion(QString val) { settings().set("LwjglVersion", val); } - virtual QString intendedVersion() { return settings().get("IntendedJarVersion").toString(); } + virtual QString intendedVersion() const { return settings().get("IntendedJarVersion").toString(); } virtual void setIntendedVersion(QString val) { settings().set("IntendedJarVersion", val); } + virtual bool shouldUpdateGame() const + { return shouldForceUpdateGame() || intendedVersion() != currentVersion(); } + + virtual bool shouldForceUpdateGame() const { return settings().get("ShouldForceUpdate").toBool(); } + virtual void setShouldForceUpdateGame(bool val) { settings().set("ShouldForceUpdate", val); } + //// Timestamps //// - virtual qint64 lastLaunch() { return settings().get("lastLaunchTime").value<qint64>(); } + virtual qint64 lastLaunch() const { return settings().get("lastLaunchTime").value<qint64>(); } virtual void setLastLaunch(qint64 val = QDateTime::currentMSecsSinceEpoch()) { settings().set("lastLaunchTime", val); emit propertiesChanged(this); } - virtual qint64 lastCurrentVersionUpdate() { return settings().get("lastVersionUpdate").value<qint64>(); } + virtual qint64 lastCurrentVersionUpdate() const { return settings().get("lastVersionUpdate").value<qint64>(); } virtual void setLastCurrentVersionUpdate(qint64 val) { settings().set("lastVersionUpdate", val); } @@ -274,7 +295,7 @@ public: * stored in the instance config file against the last modified time of Minecraft.jar. * \return True if updateCurrentVersion() should be called. */ - virtual bool shouldUpdateCurrentVersion(); + virtual bool shouldUpdateCurrentVersion() const; /*! * \brief Updates the current version. diff --git a/libmultimc/include/logintask.h b/libmultimc/include/logintask.h index e00609ec..15d715bd 100644 --- a/libmultimc/include/logintask.h +++ b/libmultimc/include/logintask.h @@ -30,20 +30,19 @@ class LIBMULTIMC_EXPORT LoginTask : public Task { Q_OBJECT public: - explicit LoginTask(const UserInfo& uInfo, QString inst, QObject *parent = 0); + explicit LoginTask(const UserInfo& uInfo, QObject *parent = 0); public slots: void processNetReply(QNetworkReply* reply); signals: - void loginComplete(QString inst, LoginResponse loginResponse); - void loginFailed(QString inst, const QString& errorMsg); + void loginComplete(LoginResponse loginResponse); + void loginFailed(const QString& errorMsg); protected: void executeTask(); QNetworkReply* netReply; - QString inst; UserInfo uInfo; }; diff --git a/libmultimc/include/minecraftprocess.h b/libmultimc/include/minecraftprocess.h index ac4d6be2..eb861236 100644 --- a/libmultimc/include/minecraftprocess.h +++ b/libmultimc/include/minecraftprocess.h @@ -54,7 +54,7 @@ public: * @param session the minecraft session id * @param console the instance console window */ - MinecraftProcess(InstancePtr inst, QString user, QString session); + MinecraftProcess(Instance *inst, QString user, QString session); /** * @brief launch minecraft @@ -66,7 +66,7 @@ public: * @param inst the instance * @param destination the destination path */ - static inline void extractIcon(InstancePtr inst, QString destination); + static inline void extractIcon(Instance *inst, QString destination); /** * @brief extract the MultiMC launcher.jar @@ -78,7 +78,7 @@ public: * @brief prepare the launch by extracting icon and launcher * @param inst the instance */ - static void prepare(InstancePtr inst); + static void prepare(Instance *inst); /** * @brief split a string into argv items like a shell would do @@ -101,7 +101,7 @@ signals: void log(QString text, MessageLevel::Enum level=MessageLevel::MultiMC); protected: - InstancePtr m_instance; + Instance *m_instance; QString m_user; QString m_session; QString m_err_leftover; diff --git a/libmultimc/include/minecraftversion.h b/libmultimc/include/minecraftversion.h index e30582ac..fd11b316 100644 --- a/libmultimc/include/minecraftversion.h +++ b/libmultimc/include/minecraftversion.h @@ -39,6 +39,11 @@ class LIBMULTIMC_EXPORT MinecraftVersion : public InstVersion */ Q_PROPERTY(QString etag READ etag) + /*! + * True if this is a version from the new Minecraft launcher's version list. + */ + Q_PROPERTY(bool isForNewLauncher READ isForNewLauncher WRITE setIsForNewLauncher) + public: explicit MinecraftVersion(QString descriptor, QString name, @@ -75,6 +80,9 @@ public: virtual QString typeName() const; virtual qint64 timestamp() const; + virtual bool isForNewLauncher() const; + virtual void setIsForNewLauncher(bool val); + virtual VersionType versionType() const; virtual void setVersionType(VersionType typeName); @@ -90,6 +98,8 @@ private: QString m_dlUrl; QString m_etag; VersionType m_type; + + bool m_isNewLauncherVersion; }; #endif // MINECRAFTVERSION_H |