- moved shared and uibase libraries to namespaces

- bugfix: the "fix mods" function was accessing the save game data incorrectly, causing a crash

1 files changed, 308 insertions, 308 deletions

diff --git a/src/nexusinterface.h b/src/nexusinterface.h
index 0e6c0eeb..cca84e06 100644
--- a/src/nexusinterface.h
+++ b/src/nexusinterface.h
@@ -17,311 +17,311 @@ You should have received a copy of the GNU General Public License
 along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#ifndef NEXUSINTERFACE_H

-#define NEXUSINTERFACE_H

-

-

-#include "nxmaccessmanager.h"

-

-#include "utility.h"

-#include <gameinfo.h>

-#include <versioninfo.h>

-#include <QNetworkReply>

-#include <QNetworkDiskCache>

-#include <QQueue>

-#include <QVariant>

-#include <QTimer>

-#include <list>

-#include <set>

-

-

-class NexusInterface;

-

-

-/**

- * @brief convenience class to make nxm requests easier

- * usually, all objects that started a nxm request will be signaled if one finished.

- * Therefore, the objects need to store the id of the requests they started and then filter

- * the result.

- * NexusBridge does this automatically. Users connect to the signals of NexusBridge they intend

- * to handle and only receive the signals the caused

- **/

-class NexusBridge : public QObject

-{

-

-  Q_OBJECT

-

-public:

-

-  NexusBridge();

-

-  /**

-   * @brief request description for a mod

-   *

-   * @param modID id of the mod caller is interested in

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   **/

-  void requestDescription(int modID, QVariant userData,

-                          const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief request a list of the files belonging to a mod

-   *

-   * @param modID id of the mod caller is interested in

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   **/

-  void requestFiles(int modID, QVariant userData,

-                    const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief request info about a single file of a mod

-   *

-   * @param modID id of the mod caller is interested in

-   * @param fileID id of the file the caller is interested in

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   **/

-  void requestFileInfo(int modID, int fileID, QVariant userData,

-                       const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief request the download url of a file

-   *

-   * @param modID id of the mod caller is interested in

-   * @param fileID id of the file the caller is interested in

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   **/

-  void requestDownloadURL(int modID, int fileID, QVariant userData,

-                          const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief requestToggleEndorsement

-   * @param modID

-   * @param userData

-   * @param url

-   */

-  void requestToggleEndorsement(int modID, bool endorse, QVariant userData,

-                                const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-signals:

-

-  void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData);

-  void nxmFilesAvailable(int modID, QVariant userData, QVariant resultData);

-  void nxmFileInfoAvailable(int modID, int fileID, QVariant userData, QVariant resultData);

-  void nxmDownloadURLsAvailable(int modID, int fileID, QVariant userData, QVariant resultData);

-  void nxmEndorsementToggled(int modID, QVariant userData, QVariant resultData);

-  void nxmRequestFailed(int modID, QVariant userData, const QString &errorMessage);

-

-public slots:

-

-  void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData, int requestID);

-  void nxmFilesAvailable(int modID, QVariant userData, QVariant resultData, int requestID);

-  void nxmFileInfoAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);

-  void nxmDownloadURLsAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);

-  void nxmEndorsementToggled(int modID, QVariant userData, QVariant resultData, int requestID);

-  void nxmRequestFailed(int modID, QVariant userData, int requestID, const QString &errorMessage);

-

-private:

-

-  NexusInterface *m_Interface;

-  std::set<int> m_RequestIDs;

-

-};

-

-

-/**

- * @brief Makes asynchronous requests to the nexus API

- *

- * This class can be used to make asynchronous requests to the Nexus API.

- * Currently, responses are sent to all receivers that have sent a request of the relevant type, so the

- * recipient has to filter the response by the id returned when making the request

- **/

-class NexusInterface : public QObject

-{

-  Q_OBJECT

-

-public:

-

-  static NexusInterface *instance();

-

-  /**

-   * @return the access manager object used to connect to nexus

-   **/

-  NXMAccessManager *getAccessManager();

-

-  /**

-   * @brief request description for a mod

-   *

-   * @param modID id of the mod caller is interested in

-   * @param receiver the object to receive the result asynchronously via a signal (nxmDescriptionAvailable)

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   * @return int an id to identify the request

-   **/

-  int requestDescription(int modID, QObject *receiver, QVariant userData,

-                         const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief request nexus descriptions for multiple mods at once

-   * @param modIDs a list of ids of mods the caller is interested in

-   * @param receiver the object to receive the result asynchronously via a signal (nxmDescriptionAvailable)

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   * @return int an id to identify the request

-   */

-  int requestUpdates(const std::vector<int> &modIDs, QObject *receiver, QVariant userData,

-                     const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief request a list of the files belonging to a mod

-   *

-   * @param modID id of the mod caller is interested in

-   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   * @return int an id to identify the request

-   **/

-  int requestFiles(int modID, QObject *receiver, QVariant userData,

-                   const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief request info about a single file of a mod

-   *

-   * @param modID id of the mod caller is interested in

-   * @param fileID id of the file the caller is interested in

-   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   * @return int an id to identify the request

-   **/

-  int requestFileInfo(int modID, int fileID, QObject *receiver, QVariant userData,

-                      const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief request the download url of a file

-   *

-   * @param modID id of the mod caller is interested in

-   * @param fileID id of the file the caller is interested in

-   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   * @return int an id to identify the request

-   **/

-  int requestDownloadURL(int modID, int fileID, QObject *receiver, QVariant userData,

-                         const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @brief toggle endorsement state of the mod

-   * @param modID id of the mod

-   * @param endorse true if the mod should be endorsed, false for un-endorse

-   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)

-   * @param userData user data to be returned with the result

-   * @param url the url to request from

-   * @return int an id to identify the request

-   */

-  int requestToggleEndorsement(int modID, bool endorse, QObject *receiver, QVariant userData,

-                               const QString &url = ToQString(GameInfo::instance().getNexusInfoUrl()));

-

-  /**

-   * @param directory the directory to store cache files

-   **/

-  void setCacheDirectory(const QString &directory);

-

-  /**

-   * MO has to send a "Nexus Client Vx.y.z" as part of the user agent to be allowed to use the API

-   * @param nmmVersion the version of nmm to impersonate

-   **/

-  void setNMMVersion(const QString &nmmVersion);

-

-public:

-

-  /**

-   * @brief guess the mod id from a filename as delivered by Nexus

-   * @param fileName name of the file

-   * @return the guessed mod id

-   * @note this currently doesn't fit well with the remaining interface but this is the best place for the function

-   */

-  static void interpretNexusFileName(const QString &fileName, QString &modName, int &modID, bool query);

-

-signals:

-

-  void requestNXMDownload(const QString &url);

-

-  void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData, int requestID);

-  void nxmUpdatesAvailable(const std::vector<int> &modIDs, QVariant userData, QVariant resultData, int requestID);

-  void nxmFilesAvailable(int modID, QVariant userData, QVariant resultData, int requestID);

-  void nxmFileInfoAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);

-  void nxmDownloadURLsAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);

-  void nxmEndorsementToggled(int modID, QVariant userData, QVariant resultData, int requestID);

-  void nxmRequestFailed(int modID, QVariant userData, int requestID, const QString &errorString);

-

-private slots:

-

-  void requestFinished();

-  void requestError(QNetworkReply::NetworkError error);

-  void requestTimeout();

-

-  void downloadRequestedNXM(const QString &url);

-

-private:

-

-  struct NXMRequestInfo {

-    int m_ModID;

-    std::vector<int> m_ModIDList;

-    int m_FileID;

-    QNetworkReply *m_Reply;

-    enum Type {

-      TYPE_DESCRIPTION,

-      TYPE_FILES,

-      TYPE_FILEINFO,

-      TYPE_DOWNLOADURL,

-      TYPE_TOGGLEENDORSEMENT,

-      TYPE_GETUPDATES

-    } m_Type;

-    QVariant m_UserData;

-    QTimer *m_Timeout;

-    QString m_URL;

-    int m_ID;

-    int m_Endorse;

-

-    NXMRequestInfo(int modID, Type type, QVariant userData, const QString &url)

-      : m_ModID(modID), m_FileID(0), m_Reply(NULL), m_Type(type), m_UserData(userData),

-        m_Timeout(NULL), m_ID(s_NextID.fetchAndAddAcquire(1)), m_URL(url) {}

-    NXMRequestInfo(std::vector<int> modIDList, Type type, QVariant userData, const QString &url)

-      : m_ModID(-1), m_ModIDList(modIDList), m_FileID(0), m_Reply(NULL), m_Type(type), m_UserData(userData),

-        m_Timeout(NULL), m_ID(s_NextID.fetchAndAddAcquire(1)), m_URL(url) {}

-    NXMRequestInfo(int modID, int fileID, Type type, QVariant userData, const QString &url)

-      : m_ModID(modID), m_FileID(fileID), m_Reply(NULL), m_Type(type), m_UserData(userData),

-        m_Timeout(NULL), m_ID(s_NextID.fetchAndAddAcquire(1)), m_URL(url) {}

-

-  private:

-    static QAtomicInt s_NextID;

-  };

-

-  static const int MAX_ACTIVE_DOWNLOADS = 2;

-

-private:

-

-  NexusInterface();

-  void nextRequest();

-  void requestFinished(std::list<NXMRequestInfo>::iterator iter);

-

-private:

-

-  static NexusInterface *s_Instance;

-

-  QNetworkDiskCache *m_DiskCache;

-

-  NXMAccessManager *m_AccessManager;

-

-  std::list<NXMRequestInfo> m_ActiveRequest;

-  QQueue<NXMRequestInfo> m_RequestQueue;

-

-  QString m_NMMVersion;

-

-};

-

-#endif // NEXUSINTERFACE_H

+#ifndef NEXUSINTERFACE_H
+#define NEXUSINTERFACE_H
+
+
+#include "nxmaccessmanager.h"
+
+#include "utility.h"
+#include <gameinfo.h>
+#include <versioninfo.h>
+#include <QNetworkReply>
+#include <QNetworkDiskCache>
+#include <QQueue>
+#include <QVariant>
+#include <QTimer>
+#include <list>
+#include <set>
+
+
+class NexusInterface;
+
+
+/**
+ * @brief convenience class to make nxm requests easier
+ * usually, all objects that started a nxm request will be signaled if one finished.
+ * Therefore, the objects need to store the id of the requests they started and then filter
+ * the result.
+ * NexusBridge does this automatically. Users connect to the signals of NexusBridge they intend
+ * to handle and only receive the signals the caused
+ **/
+class NexusBridge : public QObject
+{
+
+  Q_OBJECT
+
+public:
+
+  NexusBridge();
+
+  /**
+   * @brief request description for a mod
+   *
+   * @param modID id of the mod caller is interested in
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   **/
+  void requestDescription(int modID, QVariant userData,
+                          const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief request a list of the files belonging to a mod
+   *
+   * @param modID id of the mod caller is interested in
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   **/
+  void requestFiles(int modID, QVariant userData,
+                    const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief request info about a single file of a mod
+   *
+   * @param modID id of the mod caller is interested in
+   * @param fileID id of the file the caller is interested in
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   **/
+  void requestFileInfo(int modID, int fileID, QVariant userData,
+                       const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief request the download url of a file
+   *
+   * @param modID id of the mod caller is interested in
+   * @param fileID id of the file the caller is interested in
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   **/
+  void requestDownloadURL(int modID, int fileID, QVariant userData,
+                          const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief requestToggleEndorsement
+   * @param modID
+   * @param userData
+   * @param url
+   */
+  void requestToggleEndorsement(int modID, bool endorse, QVariant userData,
+                                const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+signals:
+
+  void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData);
+  void nxmFilesAvailable(int modID, QVariant userData, QVariant resultData);
+  void nxmFileInfoAvailable(int modID, int fileID, QVariant userData, QVariant resultData);
+  void nxmDownloadURLsAvailable(int modID, int fileID, QVariant userData, QVariant resultData);
+  void nxmEndorsementToggled(int modID, QVariant userData, QVariant resultData);
+  void nxmRequestFailed(int modID, QVariant userData, const QString &errorMessage);
+
+public slots:
+
+  void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData, int requestID);
+  void nxmFilesAvailable(int modID, QVariant userData, QVariant resultData, int requestID);
+  void nxmFileInfoAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);
+  void nxmDownloadURLsAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);
+  void nxmEndorsementToggled(int modID, QVariant userData, QVariant resultData, int requestID);
+  void nxmRequestFailed(int modID, QVariant userData, int requestID, const QString &errorMessage);
+
+private:
+
+  NexusInterface *m_Interface;
+  std::set<int> m_RequestIDs;
+
+};
+
+
+/**
+ * @brief Makes asynchronous requests to the nexus API
+ *
+ * This class can be used to make asynchronous requests to the Nexus API.
+ * Currently, responses are sent to all receivers that have sent a request of the relevant type, so the
+ * recipient has to filter the response by the id returned when making the request
+ **/
+class NexusInterface : public QObject
+{
+  Q_OBJECT
+
+public:
+
+  static NexusInterface *instance();
+
+  /**
+   * @return the access manager object used to connect to nexus
+   **/
+  NXMAccessManager *getAccessManager();
+
+  /**
+   * @brief request description for a mod
+   *
+   * @param modID id of the mod caller is interested in
+   * @param receiver the object to receive the result asynchronously via a signal (nxmDescriptionAvailable)
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   * @return int an id to identify the request
+   **/
+  int requestDescription(int modID, QObject *receiver, QVariant userData,
+                         const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief request nexus descriptions for multiple mods at once
+   * @param modIDs a list of ids of mods the caller is interested in
+   * @param receiver the object to receive the result asynchronously via a signal (nxmDescriptionAvailable)
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   * @return int an id to identify the request
+   */
+  int requestUpdates(const std::vector<int> &modIDs, QObject *receiver, QVariant userData,
+                     const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief request a list of the files belonging to a mod
+   *
+   * @param modID id of the mod caller is interested in
+   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   * @return int an id to identify the request
+   **/
+  int requestFiles(int modID, QObject *receiver, QVariant userData,
+                   const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief request info about a single file of a mod
+   *
+   * @param modID id of the mod caller is interested in
+   * @param fileID id of the file the caller is interested in
+   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   * @return int an id to identify the request
+   **/
+  int requestFileInfo(int modID, int fileID, QObject *receiver, QVariant userData,
+                      const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief request the download url of a file
+   *
+   * @param modID id of the mod caller is interested in
+   * @param fileID id of the file the caller is interested in
+   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   * @return int an id to identify the request
+   **/
+  int requestDownloadURL(int modID, int fileID, QObject *receiver, QVariant userData,
+                         const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @brief toggle endorsement state of the mod
+   * @param modID id of the mod
+   * @param endorse true if the mod should be endorsed, false for un-endorse
+   * @param receiver the object to receive the result asynchronously via a signal (nxmFilesAvailable)
+   * @param userData user data to be returned with the result
+   * @param url the url to request from
+   * @return int an id to identify the request
+   */
+  int requestToggleEndorsement(int modID, bool endorse, QObject *receiver, QVariant userData,
+                               const QString &url = MOBase::ToQString(MOShared::GameInfo::instance().getNexusInfoUrl()));
+
+  /**
+   * @param directory the directory to store cache files
+   **/
+  void setCacheDirectory(const QString &directory);
+
+  /**
+   * MO has to send a "Nexus Client Vx.y.z" as part of the user agent to be allowed to use the API
+   * @param nmmVersion the version of nmm to impersonate
+   **/
+  void setNMMVersion(const QString &nmmVersion);
+
+public:
+
+  /**
+   * @brief guess the mod id from a filename as delivered by Nexus
+   * @param fileName name of the file
+   * @return the guessed mod id
+   * @note this currently doesn't fit well with the remaining interface but this is the best place for the function
+   */
+  static void interpretNexusFileName(const QString &fileName, QString &modName, int &modID, bool query);
+
+signals:
+
+  void requestNXMDownload(const QString &url);
+
+  void nxmDescriptionAvailable(int modID, QVariant userData, QVariant resultData, int requestID);
+  void nxmUpdatesAvailable(const std::vector<int> &modIDs, QVariant userData, QVariant resultData, int requestID);
+  void nxmFilesAvailable(int modID, QVariant userData, QVariant resultData, int requestID);
+  void nxmFileInfoAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);
+  void nxmDownloadURLsAvailable(int modID, int fileID, QVariant userData, QVariant resultData, int requestID);
+  void nxmEndorsementToggled(int modID, QVariant userData, QVariant resultData, int requestID);
+  void nxmRequestFailed(int modID, QVariant userData, int requestID, const QString &errorString);
+
+private slots:
+
+  void requestFinished();
+  void requestError(QNetworkReply::NetworkError error);
+  void requestTimeout();
+
+  void downloadRequestedNXM(const QString &url);
+
+private:
+
+  struct NXMRequestInfo {
+    int m_ModID;
+    std::vector<int> m_ModIDList;
+    int m_FileID;
+    QNetworkReply *m_Reply;
+    enum Type {
+      TYPE_DESCRIPTION,
+      TYPE_FILES,
+      TYPE_FILEINFO,
+      TYPE_DOWNLOADURL,
+      TYPE_TOGGLEENDORSEMENT,
+      TYPE_GETUPDATES
+    } m_Type;
+    QVariant m_UserData;
+    QTimer *m_Timeout;
+    QString m_URL;
+    int m_ID;
+    int m_Endorse;
+
+    NXMRequestInfo(int modID, Type type, QVariant userData, const QString &url)
+      : m_ModID(modID), m_FileID(0), m_Reply(NULL), m_Type(type), m_UserData(userData),
+        m_Timeout(NULL), m_ID(s_NextID.fetchAndAddAcquire(1)), m_URL(url) {}
+    NXMRequestInfo(std::vector<int> modIDList, Type type, QVariant userData, const QString &url)
+      : m_ModID(-1), m_ModIDList(modIDList), m_FileID(0), m_Reply(NULL), m_Type(type), m_UserData(userData),
+        m_Timeout(NULL), m_ID(s_NextID.fetchAndAddAcquire(1)), m_URL(url) {}
+    NXMRequestInfo(int modID, int fileID, Type type, QVariant userData, const QString &url)
+      : m_ModID(modID), m_FileID(fileID), m_Reply(NULL), m_Type(type), m_UserData(userData),
+        m_Timeout(NULL), m_ID(s_NextID.fetchAndAddAcquire(1)), m_URL(url) {}
+
+  private:
+    static QAtomicInt s_NextID;
+  };
+
+  static const int MAX_ACTIVE_DOWNLOADS = 2;
+
+private:
+
+  NexusInterface();
+  void nextRequest();
+  void requestFinished(std::list<NXMRequestInfo>::iterator iter);
+
+private:
+
+  static NexusInterface *s_Instance;
+
+  QNetworkDiskCache *m_DiskCache;
+
+  NXMAccessManager *m_AccessManager;
+
+  std::list<NXMRequestInfo> m_ActiveRequest;
+  QQueue<NXMRequestInfo> m_RequestQueue;
+
+  QString m_NMMVersion;
+
+};
+
+#endif // NEXUSINTERFACE_H