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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
#include "gamebryogameplugins.h"
#include <imodinterface.h>
#include <iplugingame.h>
#include <ipluginlist.h>
#include <report.h>
#include <safewritefile.h>
#include <scopeguard.h>
#include <utility.h>
#include <QDateTime>
#include <QDir>
#include <QHash>
#include <QString>
#include <QStringEncoder>
#include <QStringList>
using MOBase::IOrganizer;
using MOBase::IPluginList;
using MOBase::reportError;
using MOBase::SafeWriteFile;
GamebryoGamePlugins::GamebryoGamePlugins(IOrganizer* organizer) : m_Organizer(organizer)
{}
void GamebryoGamePlugins::writePluginLists(const IPluginList* pluginList)
{
if (!m_LastRead.isValid()) {
// attempt to write uninitialized plugin lists
return;
}
writePluginList(pluginList, m_Organizer->profile()->absolutePath() + "/plugins.txt");
writeLoadOrderList(pluginList,
m_Organizer->profile()->absolutePath() + "/loadorder.txt");
m_LastRead = QDateTime::currentDateTime();
}
void GamebryoGamePlugins::readPluginLists(MOBase::IPluginList* pluginList)
{
QString loadOrderPath = organizer()->profile()->absolutePath() + "/loadorder.txt";
QString pluginsPath = organizer()->profile()->absolutePath() + "/plugins.txt";
bool loadOrderIsNew = !m_LastRead.isValid() || !QFileInfo(loadOrderPath).exists() ||
QFileInfo(loadOrderPath).lastModified() > m_LastRead;
bool pluginsIsNew =
!m_LastRead.isValid() || QFileInfo(pluginsPath).lastModified() > m_LastRead;
if (loadOrderIsNew || !pluginsIsNew) {
// read both files if they are both new or both older than the last read
QStringList loadOrder = readLoadOrderList(pluginList, loadOrderPath);
pluginList->setLoadOrder(loadOrder);
readPluginList(pluginList);
} else {
// If the plugins is new but not loadorder, we must reparse the load order from the
// plugin files
QStringList loadOrder = readPluginList(pluginList);
pluginList->setLoadOrder(loadOrder);
}
m_LastRead = QDateTime::currentDateTime();
}
QStringList GamebryoGamePlugins::getLoadOrder()
{
QString loadOrderPath = organizer()->profile()->absolutePath() + "/loadorder.txt";
QString pluginsPath = organizer()->profile()->absolutePath() + "/plugins.txt";
bool loadOrderIsNew = !m_LastRead.isValid() || !QFileInfo(loadOrderPath).exists() ||
QFileInfo(loadOrderPath).lastModified() > m_LastRead;
bool pluginsIsNew =
!m_LastRead.isValid() || QFileInfo(pluginsPath).lastModified() > m_LastRead;
if (loadOrderIsNew || !pluginsIsNew) {
return readLoadOrderList(m_Organizer->pluginList(), loadOrderPath);
} else {
return readPluginList(m_Organizer->pluginList());
}
}
void GamebryoGamePlugins::writePluginList(const MOBase::IPluginList* pluginList,
const QString& filePath)
{
return writeList(pluginList, filePath, false);
}
void GamebryoGamePlugins::writeLoadOrderList(const MOBase::IPluginList* pluginList,
const QString& filePath)
{
return writeList(pluginList, filePath, true);
}
void GamebryoGamePlugins::writeList(const IPluginList* pluginList,
const QString& filePath, bool loadOrder)
{
SafeWriteFile file(filePath);
QStringEncoder encoder = loadOrder
? QStringEncoder(QStringConverter::Encoding::Utf8)
: QStringEncoder(QStringConverter::Encoding::System);
file->resize(0);
file->write(
encoder.encode("# This file was automatically generated by Mod Organizer.\r\n"));
bool invalidFileNames = false;
int writtenCount = 0;
QStringList plugins = pluginList->pluginNames();
std::sort(plugins.begin(), plugins.end(),
[pluginList](const QString& lhs, const QString& rhs) {
return pluginList->priority(lhs) < pluginList->priority(rhs);
});
for (const QString& pluginName : plugins) {
if (loadOrder || (pluginList->state(pluginName) == IPluginList::STATE_ACTIVE)) {
auto result = encoder.encode(pluginName);
if (encoder.hasError()) {
invalidFileNames = true;
qCritical("invalid plugin name %s", qUtf8Printable(pluginName));
} else {
file->write(result);
}
file->write("\r\n");
++writtenCount;
}
}
if (invalidFileNames) {
reportError(QObject::tr("Some of your plugins have invalid names! These "
"plugins can not be loaded by the game. Please see "
"mo_interface.log for a list of affected plugins "
"and rename them."));
}
if (writtenCount == 0) {
qWarning("plugin list would be empty, this is almost certainly wrong. Not "
"saving.");
} else {
file->commit();
}
}
QStringList GamebryoGamePlugins::readLoadOrderList(MOBase::IPluginList* pluginList,
const QString& filePath)
{
QStringList pluginNames = organizer()->managedGame()->primaryPlugins();
std::set<QString> pluginLookup;
for (auto&& name : pluginNames) {
pluginLookup.insert(name.toLower());
}
const auto b = MOBase::forEachLineInFile(filePath, [&](QString s) {
if (!pluginLookup.contains(s.toLower())) {
pluginLookup.insert(s);
pluginNames.push_back(std::move(s));
}
});
if (!b) {
return readPluginList(pluginList);
}
return pluginNames;
}
QStringList GamebryoGamePlugins::readPluginList(MOBase::IPluginList* pluginList)
{
QStringList primary = organizer()->managedGame()->primaryPlugins();
for (const QString& pluginName : primary) {
if (pluginList->state(pluginName) != IPluginList::STATE_MISSING) {
pluginList->setState(pluginName, IPluginList::STATE_ACTIVE);
}
}
QStringList plugins = pluginList->pluginNames();
QStringList pluginsClone(plugins);
// Do not sort the primary plugins. Their load order should be locked as defined in
// "primaryPlugins".
for (const auto& plugin : pluginsClone) {
if (primary.contains(plugin, Qt::CaseInsensitive))
plugins.removeAll(plugin);
}
// Always use filetime loadorder to get the actual load order
QHash<QString, QDateTime> modificationTimes;
modificationTimes.reserve(plugins.size());
for (const auto& pluginName : plugins) {
MOBase::IModInterface* mod =
organizer()->modList()->getMod(pluginList->origin(pluginName));
QDir dir = mod ? mod->absolutePath() : organizer()->managedGame()->dataDirectory();
QString absPath = dir.absoluteFilePath(pluginName);
modificationTimes.insert(pluginName, QFileInfo(absPath).lastModified());
}
std::ranges::sort(
plugins, [&modificationTimes](const QString& lhs, const QString& rhs) {
return modificationTimes.value(lhs) < modificationTimes.value(rhs);
});
// Determine plugin active state by the plugins.txt file.
bool pluginsTxtExists = true;
QString filePath = organizer()->profile()->absolutePath() + "/plugins.txt";
QFile file(filePath);
if (!file.open(QIODevice::ReadOnly)) {
pluginsTxtExists = false;
}
ON_BLOCK_EXIT([&]() {
file.close();
});
if (file.size() == 0) {
// MO stores at least a header in the file. if it's completely empty the
// file is broken
pluginsTxtExists = false;
}
QStringList activePlugins;
if (pluginsTxtExists) {
while (!file.atEnd()) {
QByteArray line = file.readLine();
QString pluginName;
if ((line.size() > 0) && (line.at(0) != '#')) {
QStringEncoder encoder(QStringConverter::Encoding::System);
pluginName = encoder.encode(line.trimmed().constData());
}
if (pluginName.size() > 0) {
pluginList->setState(pluginName, IPluginList::STATE_ACTIVE);
activePlugins.push_back(pluginName);
}
}
for (const auto& pluginName : plugins) {
if (!activePlugins.contains(pluginName, Qt::CaseInsensitive)) {
pluginList->setState(pluginName, IPluginList::STATE_INACTIVE);
}
}
} else {
for (const QString& pluginName : plugins) {
pluginList->setState(pluginName, IPluginList::STATE_INACTIVE);
}
}
return primary + plugins;
}
|
