aboutsummaryrefslogtreecommitdiff
path: root/libs/installer_bain/src/installerbain.cpp
blob: d39590e987392f85769397217c617c2e9e80b075 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
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/>.
*/

#include "installerbain.h"

#include <uibase/game_features/igamefeatures.h>
#include <uibase/game_features/moddatachecker.h>
#include <uibase/iinstallationmanager.h>
#include <uibase/iplugingame.h>
#include <uibase/log.h>

#include <QDir>
#include <QMessageBox>
#include <QtPlugin>

#include "baincomplexinstallerdialog.h"

using namespace MOBase;

InstallerBAIN::InstallerBAIN() : m_MOInfo(nullptr) {}

bool InstallerBAIN::init(IOrganizer* moInfo)
{
  m_MOInfo = moInfo;
  return true;
}

QString InstallerBAIN::name() const
{
  return "BAIN Installer";
}

QString InstallerBAIN::localizedName() const
{
  return tr("BAIN Installer");
}

QString InstallerBAIN::author() const
{
  return "Tannin";
}

QString InstallerBAIN::description() const
{
  return tr("Installer for BAIN archives (originally targeting Wrye Bash)");
}

VersionInfo InstallerBAIN::version() const
{
  return VersionInfo(1, 1, 0, VersionInfo::RELEASE_FINAL);
}

QList<PluginSetting> InstallerBAIN::settings() const
{
  return QList<PluginSetting>();
}

unsigned int InstallerBAIN::priority() const
{
  return 40;
}

bool InstallerBAIN::isManualInstaller() const
{
  return false;
}

void InstallerBAIN::onInstallationStart(QString const&, bool, IModInterface* currentMod)
{
  // We reset some field and fetch the previously installed options:
  m_InstallerUsed = false;
  m_PreviousOptions.clear();
  m_SelectedOptions.clear();

  if (currentMod) {
    auto settings = currentMod->pluginSettings(name());
    for (auto& [name, value] : settings) {
      if (name.startsWith("option")) {
        m_PreviousOptions.append(value.toString());
      }
    }
  }
}

void InstallerBAIN::onInstallationEnd(EInstallResult result, IModInterface* newMod)
{
  if (result == EInstallResult::RESULT_SUCCESS && m_InstallerUsed) {
    newMod->clearPluginSettings(name());
    for (auto i = 0; i < m_SelectedOptions.size(); ++i) {
      newMod->setPluginSetting(name(), QString("option%1").arg(i),
                               m_SelectedOptions[i]);
    }
  }
}

std::vector<std::shared_ptr<const MOBase::FileTreeEntry>>
InstallerBAIN::findSubpackages(std::shared_ptr<const MOBase::IFileTree> tree,
                               std::size_t* invalidFolders) const
{
  // Folders that can be present but do not impact the installation:
  static const std::set<QString, FileNameComparator> IGNORED_FOLDERS{
      "fomod", "omod conversion data", "images", "screenshots", "docs"};

  auto checker = m_MOInfo->gameFeatures()->gameFeature<ModDataChecker>();

  if (!checker) {
    return {};
  }

  // each directory would have to serve as a top-level directory
  std::vector<std::shared_ptr<const MOBase::FileTreeEntry>> subpackages;
  std::size_t ninvalids = 0;
  for (auto entry : *tree) {

    if (!entry->isDir()) {
      continue;
    }

    // ignore fomod in case of combined fomod/bain packages.
    // dirs starting with -- are supposed to be ignored
    if (IGNORED_FOLDERS.contains(entry->name()) || entry->name().startsWith("--")) {
      continue;
    }

    if (checker->dataLooksValid(entry->astree()) ==
        ModDataChecker::CheckReturn::VALID) {
      subpackages.push_back(entry);
    } else {
      ninvalids++;
    }
  }

  if (invalidFolders) {
    *invalidFolders = ninvalids;
  }

  return subpackages;
}

bool InstallerBAIN::isArchiveSupported(std::shared_ptr<const IFileTree> tree) const
{
  auto checker = m_MOInfo->gameFeatures()->gameFeature<ModDataChecker>();

  if (!checker) {
    return false;
  }

  std::size_t numInvalidDirs = 0;
  auto subpackages           = findSubpackages(tree, &numInvalidDirs);

  if (subpackages.size() < 2) {
    // a complex bain package contains at least 2 directories to choose from
    return false;
  } else if (numInvalidDirs == 0) {
    return true;
  } else {
    return QMessageBox::question(parentWidget(), tr("May be BAIN installer"),
                                 tr("This installer looks like it may contain a BAIN "
                                    "installer but I'm not sure. "
                                    "Install as BAIN installer?"),
                                 QMessageBox::Yes | QMessageBox::No) ==
           QMessageBox::Yes;
  }

  return true;
}

IPluginInstaller::EInstallResult
InstallerBAIN::install(GuessedValue<QString>& modName, std::shared_ptr<IFileTree>& tree,
                       QString&, int&)
{
  auto entry = tree->find("package.txt", FileTreeEntry::FILE);

  QString packageTXT;
  if (entry != nullptr) {
    packageTXT = manager()->extractFile(entry);
  }

  auto subpackages = findSubpackages(tree);

  BainComplexInstallerDialog dialog(subpackages, modName, m_PreviousOptions, packageTXT,
                                    parentWidget());

  int res = dialog.exec();

  if (res == QDialog::Accepted) {
    modName.update(dialog.getName(), GUESS_USER);

    // Update the tree:
    m_SelectedOptions = dialog.updateTree(tree);
    m_InstallerUsed   = true;

    return IPluginInstaller::RESULT_SUCCESS;
  } else {
    if (dialog.manualRequested()) {
      modName.update(dialog.getName(), GUESS_USER);
      return IPluginInstaller::RESULT_MANUALREQUESTED;
    } else {
      return IPluginInstaller::RESULT_CANCELED;
    }
  }
}

#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
Q_EXPORT_PLUGIN2(installerBAIN, InstallerBAIN)
#endif