Merge pull request #15 from ModOrganizer2/update-cmake-common-qt6

Update following cmake_common changes.

CMakeLists.txt

@@ -1,12 +1,11 @@
 cmake_minimum_required(VERSION 3.16)
 
 project(installer_bundle)
-set(project_type plugin)
-set(enable_warnings OFF)
 
 if(DEFINED DEPENDENCIES_DIR)
-	include(${DEPENDENCIES_DIR}/modorganizer_super/cmake_common/project.cmake)
+	include(${DEPENDENCIES_DIR}/modorganizer_super/cmake_common/mo2.cmake)
 else()
-	include(../cmake_common/project.cmake)
+	include(${CMAKE_CURRENT_LIST_DIR}/../cmake_common/mo2.cmake)
 endif()
+
 add_subdirectory(src)

appveyor.yml

@@ -5,20 +5,28 @@ environment:
   WEBHOOK_URL:
     secure: gOKbXaZM9ImtMD5XrYITvdyZUW/az082G9OIN1EC1Vbg57wBaeLhi49uGjxPw5GVujHku6kxN6ab89zhbS5GVeluR76GM83IbKV4Sh7udXzoYZZdg6YudtYHzdhCgUeiedpswbuczTq9ceIkkfSEWZuh/lMAAVVwvcGsJAnoPFw=
 build_script:
-- cmd: >-
-    git clone --depth=1 --branch=%APPVEYOR_REPO_BRANCH% https://github.com/ModOrganizer2/modorganizer-umbrella.git c:\projects\modorganizer-umbrella 2> $null
+- pwsh: >-
+    $ErrorActionPreference = 'Stop'
 
-    mkdir c:\projects\modorganizer-build -type directory
+    git clone --depth=1 --no-single-branch https://github.com/ModOrganizer2/modorganizer-umbrella.git c:\projects\modorganizer-umbrella
+
+    New-Item -ItemType Directory -Path c:\projects\modorganizer-build
 
     cd c:\projects\modorganizer-umbrella
+    
+    ($env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH -eq $null) ? ($branch = $env:APPVEYOR_REPO_BRANCH) : ($branch = $env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH)
 
-    C:\Python37-x64\python.exe unimake.py -d c:\projects\modorganizer-build -s Appveyor_Build=True %APPVEYOR_PROJECT_NAME%
+    git checkout $(git show-ref --verify --quiet refs/remotes/origin/${branch} || echo '-b') ${branch}
+
+    C:\Python37-x64\python.exe unimake.py -d c:\projects\modorganizer-build -s Appveyor_Build=True ${env:APPVEYOR_PROJECT_NAME}
+    
+    if($LastExitCode -ne 0) { $host.SetShouldExit($LastExitCode )  }
 artifacts:
-- path: build\src\installer_bundle.dll
+- path: vsbuild\src\RelWithDebInfo\installer_bundle.dll
   name: installer_bundle_dll
-- path: build\src\installer_bundle.pdb
+- path: vsbuild\src\RelWithDebInfo\installer_bundle.pdb
   name: installer_bundle_pdb
-- path: build\src\installer_bundle.lib
+- path: vsbuild\src\RelWithDebInfo\installer_bundle.lib
   name: installer_bundle_lib
 on_success:
   - ps: Set-Location -Path $env:APPVEYOR_BUILD_FOLDER

src/CMakeLists.txt

@@ -1,6 +1,5 @@
 cmake_minimum_required(VERSION 3.16)
-if(DEFINED DEPENDENCIES_DIR)
-	include(${DEPENDENCIES_DIR}/modorganizer_super/cmake_common/src.cmake)
-else()
-	include(../../cmake_common/src.cmake)
-endif()
+
+add_library(installer_bundle SHARED)
+mo2_configure_plugin(installer_bundle WARNINGS OFF)
+mo2_install_target(installer_bundle)

src/installer_bundle_en.ts

@@ -4,9 +4,43 @@
 <context>
     <name>InstallerBundle</name>
     <message>
-        <location filename="installerbundle.cpp" line="50"/>
+        <location filename="installerbundle.cpp" line="48"/>
+        <source>Bundle Installer</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="installerbundle.cpp" line="58"/>
         <source>Proxy-Installer to handle bundles containing the actual mod archive</source>
         <translation type="unfinished"></translation>
     </message>
 </context>
+<context>
+    <name>MultiArchiveDialog</name>
+    <message>
+        <location filename="multiarchivedialog.ui" line="14"/>
+        <source>Bundled archives</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="multiarchivedialog.ui" line="20"/>
+        <source>This archive contains multiple archives that can be installed separately. Please select the archive you want to extract and install.</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="multiarchivedialog.ui" line="35"/>
+        <location filename="multiarchivedialog.ui" line="38"/>
+        <source>Opens a Dialog that allows custom modifications.</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="multiarchivedialog.ui" line="41"/>
+        <source>Manual</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="multiarchivedialog.ui" line="64"/>
+        <source>Cancel</source>
+        <translation type="unfinished"></translation>
+    </message>
+</context>
 </TS>

src/installerbundle.cpp

@@ -22,6 +22,8 @@ along with Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
 
 #include <QtPlugin>
 
+#include "multiarchivedialog.h"
+
 using namespace MOBase;
 
 
@@ -30,8 +32,9 @@ InstallerBundle::InstallerBundle()
 }
 
 
-bool InstallerBundle::init(IOrganizer*)
+bool InstallerBundle::init(IOrganizer *organizer)
 {
+  m_Organizer = organizer;
   return true;
 }
 
@@ -40,6 +43,11 @@ QString InstallerBundle::name() const
   return "Bundle Installer";
 }
 
+QString InstallerBundle::localizedName() const
+{
+  return tr("Bundle Installer");
+}
+
 QString InstallerBundle::author() const
 {
   return "Tannin";
@@ -55,14 +63,11 @@ VersionInfo InstallerBundle::version() const
   return VersionInfo(1, 1, 0, VersionInfo::RELEASE_FINAL);
 }
 
-bool InstallerBundle::isActive() const
-{
-  return true;
-}
-
 QList<PluginSetting> InstallerBundle::settings() const
 {
-  return QList<PluginSetting>();
+  return {
+    PluginSetting("auto_reinstall", "when reinstalling from an archive containing multiple mods, automatically select the previously installed", true)
+  };
 }
 
 unsigned int InstallerBundle::priority() const
@@ -75,8 +80,31 @@ bool InstallerBundle::isManualInstaller() const
   return false;
 }
 
-std::shared_ptr<const FileTreeEntry> InstallerBundle::findObject(std::shared_ptr<const IFileTree> tree) const
+void InstallerBundle::onInstallationStart(QString const& archive, bool reinstallation, IModInterface* currentMod)
 {
+  // We reset some field and fetch the previously installed file:
+  m_InstallationFile = archive;
+  m_InstallerUsed = false;
+  m_SelectedFile = "";
+  m_PreviousFile = "";
+
+  if (reinstallation && m_Organizer->pluginSetting(name(), "auto_reinstall").toBool()) {
+    m_PreviousFile = currentMod->pluginSetting(name(), "archive", QString()).toString();
+  }
+}
+void InstallerBundle::onInstallationEnd(EInstallResult result, IModInterface* newMod)
+{
+  if (result == EInstallResult::RESULT_SUCCESS && m_InstallerUsed) {
+    newMod->setInstallationFile(m_InstallationFile);
+    if (!m_SelectedFile.isEmpty()) {
+      newMod->setPluginSetting(name(), "archive", m_SelectedFile);
+    }
+  }
+}
+
+std::vector<std::shared_ptr<const MOBase::FileTreeEntry>> InstallerBundle::findObjects(std::shared_ptr<const IFileTree> tree) const
+{
+  std::vector<std::shared_ptr<const MOBase::FileTreeEntry>> entries;
   // Check if we have an archive:
   auto managerExtensions = manager()->getSupportedExtensions();
 
@@ -85,7 +113,7 @@ std::shared_ptr<const FileTreeEntry> InstallerBundle::findObject(std::shared_ptr
   for (auto entry : *tree) {
     if (entry->isFile()) {
       if (managerExtensions.contains(entry->suffix(), FileNameComparator::CaseSensitivity)) {
-        return entry;
+        entries.push_back(entry);
       }
     }
     else {
@@ -93,30 +121,66 @@ std::shared_ptr<const FileTreeEntry> InstallerBundle::findObject(std::shared_ptr
     }
   }
 
+  if (!entries.empty()) {
+    return entries;
+  }
+
   // Arguably this should also check the name of the directory we're looking at
   // is the same as the module name:
   if (nDirs != 1) {
-    return nullptr;
+    return {};
   }
 
   // Retrieve the first folder which is the first item:
-  return findObject(tree->at(0)->astree());
+  return findObjects(tree->at(0)->astree());
 }
 
 bool InstallerBundle::isArchiveSupported(std::shared_ptr<const IFileTree> tree) const
 {
-  return findObject(tree) != nullptr;
+  return !findObjects(tree).empty();
 }
 
 IPluginInstaller::EInstallResult InstallerBundle::install(
   GuessedValue<QString>& modName, std::shared_ptr<IFileTree>& tree, QString&, int &modId)
 {
   // Find a valid "object":
-  auto entry = findObject(tree);
-  if (entry == nullptr) {
+  auto entries = findObjects(tree);
+  if (entries.empty()) {
     return IPluginInstaller::RESULT_NOTATTEMPTED;
   }
 
+  std::shared_ptr<const FileTreeEntry> entry = nullptr;
+  if (entries.size() == 1) {
+    entry = entries[0];
+  }
+  else {
+    if (!m_PreviousFile.isEmpty()) {
+      entry = tree->find(m_PreviousFile);
+    }
+
+    if (entry == nullptr) {
+      MultiArchiveDialog dialog(entries, parentWidget());
+      if (dialog.exec() == QDialog::Accepted) {
+        entry = dialog.selectedEntry();
+        m_SelectedFile = entry->pathFrom(tree);
+      }
+      else {
+        if (dialog.manualRequested()) {
+          return IPluginInstaller::RESULT_MANUALREQUESTED;
+        }
+        else {
+          return IPluginInstaller::RESULT_CANCELED;
+        }
+      }
+    }
+  }
+
+  if (entry == nullptr) {
+    return IPluginInstaller::RESULT_CANCELED;
+  }
+
+  m_InstallerUsed = true;
+
   // Extract it:
   QString tempFile = manager()->extractFile(entry);
   IPluginInstaller::EInstallResult res = manager()->installArchive(modName, tempFile, modId);

src/installerbundle.h

@@ -36,16 +36,19 @@ public:
 
   InstallerBundle();
 
-  virtual bool init(MOBase::IOrganizer *moInfo);
-  virtual QString name() const;
-  virtual QString author() const;
-  virtual QString description() const;
-  virtual MOBase::VersionInfo version() const;
-  virtual bool isActive() const;
-  virtual QList<MOBase::PluginSetting> settings() const;
+  virtual bool init(MOBase::IOrganizer* moInfo) override;
+  virtual QString name() const override;
+  virtual QString localizedName() const override;
+  virtual QString author() const override;
+  virtual QString description() const override;
+  virtual MOBase::VersionInfo version() const override;
+  virtual QList<MOBase::PluginSetting> settings() const override;
 
   virtual unsigned int priority() const override;
-  virtual bool isManualInstaller() const;
+  virtual bool isManualInstaller() const override;
+
+  virtual void onInstallationStart(QString const& archive, bool reinstallation, MOBase::IModInterface* currentMod) override;
+  virtual void onInstallationEnd(EInstallResult result, MOBase::IModInterface* newMod) override;
 
   virtual bool isArchiveSupported(std::shared_ptr<const MOBase::IFileTree> tree) const override;
   virtual EInstallResult install(MOBase::GuessedValue<QString> &modName,
@@ -55,13 +58,31 @@ public:
 private:
 
   /**
-   * @brief Find the first entry that can be extracted from this archive.
+   * @brief Find the entries that can be extracted from this archive.
    *
    * @param tree The tree to look the entry in.
    *
    * @return the entry, if one was found, or a null pointer.
    */
-  std::shared_ptr<const MOBase::FileTreeEntry> findObject(std::shared_ptr<const MOBase::IFileTree> tree) const;
+  std::vector<std::shared_ptr<const MOBase::FileTreeEntry>> findObjects(std::shared_ptr<const MOBase::IFileTree> tree) const;
+
+private:
+
+  MOBase::IOrganizer* m_Organizer;
+
+  // The archive being installed:
+  QString m_InstallationFile;
+
+  // Indicates if this installer was used during the installation process:
+  bool m_InstallerUsed;
+
+  // Contains the file installed (when multiple archives are present), or an
+  // empty string:
+  QString m_SelectedFile;
+
+  // Contains the file previously installed (when multiple archives are present), or an
+  // empty string:
+  QString m_PreviousFile;
 };
 
 

src/multiarchivedialog.cpp

@@ -0,0 +1,44 @@
+#include "multiarchivedialog.h"
+#include "ui_multiarchivedialog.h"
+
+
+using namespace MOBase;
+
+
+MultiArchiveDialog::MultiArchiveDialog(
+  std::vector<std::shared_ptr<const MOBase::FileTreeEntry>> entries, QWidget* parent)
+  : QDialog(parent), ui(new Ui::MultiArchiveDialog), m_Manual(false), m_SelectedEntry(nullptr)
+{
+  ui->setupUi(this);
+
+  auto layout = ui->middleLayout;
+  for (auto& entry : entries) {
+    QPushButton* button = new QPushButton(entry->name(), this);
+    button->setStyleSheet("text-align: left; padding: 10px; font-weight: bold;");
+    layout->addWidget(button);
+
+    connect(button, &QPushButton::clicked, [this, entry]() {
+      m_SelectedEntry = entry;
+      this->accept();
+    });
+  }
+}
+
+
+MultiArchiveDialog::~MultiArchiveDialog()
+{
+  delete ui;
+}
+
+
+void MultiArchiveDialog::on_cancelBtn_clicked()
+{
+  this->reject();
+}
+
+
+void MultiArchiveDialog::on_manualBtn_clicked()
+{
+  m_Manual = true;
+  this->reject();
+}

src/multiarchivedialog.h

@@ -0,0 +1,77 @@
+/*
+Copyright (C) 2012 Sebastian Herbord. All rights reserved.
+
+This file is part of Mod Organizer.
+
+Mod Organizer 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 3 of the License, or
+(at your option) any later version.
+
+Mod Organizer 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 Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef BAINCOMPLEXINSTALLERDIALOG_H
+#define BAINCOMPLEXINSTALLERDIALOG_H
+
+#include <vector>
+
+#include <QDialog>
+
+#include "ifiletree.h"
+
+namespace Ui {
+  class MultiArchiveDialog;
+}
+
+
+
+/**
+ *
+ **/
+class MultiArchiveDialog: public QDialog
+{
+  Q_OBJECT
+  
+public:
+ /**
+  * @brief Constructor
+  *
+  * @param tree the directory tree of the archive. The caller is resonsible to verify this actually qualifies as a bain installer
+  * @param modName proposed name for the mod. The dialog allows the user to change this
+  * @param packageTXT path to the extracted package.txt file or an empty string if there is none
+  * @param parent parent widget
+  **/
+ explicit MultiArchiveDialog(std::vector<std::shared_ptr<const MOBase::FileTreeEntry>> entries,  QWidget *parent);
+  ~MultiArchiveDialog();
+
+  /**
+   * @return bool true if the user requested the manual dialog
+   **/
+  bool manualRequested() const { return m_Manual; }
+
+  /**
+   * @return QString the (user-modified) name to be used for the mod
+   **/
+  auto selectedEntry() const { return m_SelectedEntry; }
+
+private slots:
+
+  void on_manualBtn_clicked();
+  void on_cancelBtn_clicked();
+
+private:
+
+  Ui::MultiArchiveDialog *ui;
+  bool m_Manual;
+  std::shared_ptr<const MOBase::FileTreeEntry> m_SelectedEntry;
+
+};
+
+#endif // BAINCOMPLEXINSTALLERDIALOG_H

src/multiarchivedialog.ui

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MultiArchiveDialog</class>
+ <widget class="QDialog" name="MultiArchiveDialog">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>424</width>
+    <height>146</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Bundled archives</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <widget class="QLabel" name="label_2">
+     <property name="text">
+      <string>This archive contains multiple archives that can be installed separately. Please select the archive you want to extract and install.</string>
+     </property>
+     <property name="wordWrap">
+      <bool>true</bool>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <layout class="QVBoxLayout" name="middleLayout"/>
+   </item>
+   <item>
+    <layout class="QHBoxLayout" name="horizontalLayout">
+     <item>
+      <widget class="QPushButton" name="manualBtn">
+       <property name="toolTip">
+        <string>Opens a Dialog that allows custom modifications.</string>
+       </property>
+       <property name="whatsThis">
+        <string>Opens a Dialog that allows custom modifications.</string>
+       </property>
+       <property name="text">
+        <string>Manual</string>
+       </property>
+       <property name="autoDefault">
+        <bool>false</bool>
+       </property>
+      </widget>
+     </item>
+     <item>
+      <spacer name="horizontalSpacer">
+       <property name="orientation">
+        <enum>Qt::Horizontal</enum>
+       </property>
+       <property name="sizeHint" stdset="0">
+        <size>
+         <width>40</width>
+         <height>20</height>
+        </size>
+       </property>
+      </spacer>
+     </item>
+     <item>
+      <widget class="QPushButton" name="cancelBtn">
+       <property name="text">
+        <string>Cancel</string>
+       </property>
+       <property name="autoDefault">
+        <bool>false</bool>
+       </property>
+      </widget>
+     </item>
+    </layout>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>