cmodlistview_moc.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128
  1. /*
  2. * cmodlistview_moc.cpp, part of VCMI engine
  3. *
  4. * Authors: listed in file AUTHORS in main folder
  5. *
  6. * License: GNU General Public License v2.0 or later
  7. * Full text of license available in license.txt file, in main folder
  8. *
  9. */
  10. #include "StdInc.h"
  11. #include "cmodlistview_moc.h"
  12. #include "ui_cmodlistview_moc.h"
  13. #include "imageviewer_moc.h"
  14. #include "../mainwindow_moc.h"
  15. #include <QJsonArray>
  16. #include <QCryptographicHash>
  17. #include <QRegularExpression>
  18. #include "modstatemodel.h"
  19. #include "modstateitemmodel_moc.h"
  20. #include "modstatecontroller.h"
  21. #include "cdownloadmanager_moc.h"
  22. #include "chroniclesextractor.h"
  23. #include "../settingsView/csettingsview_moc.h"
  24. #include "../vcmiqt/launcherdirs.h"
  25. #include "../vcmiqt/jsonutils.h"
  26. #include "../helper.h"
  27. #include "../../lib/VCMIDirs.h"
  28. #include "../../lib/CConfigHandler.h"
  29. #include "../../lib/texts/Languages.h"
  30. #include "../../lib/modding/CModVersion.h"
  31. #include "../../lib/filesystem/Filesystem.h"
  32. #include <future>
  33. void CModListView::setupModModel()
  34. {
  35. modStateModel = std::make_shared<ModStateModel>();
  36. modModel = new ModStateItemModel(this);
  37. manager = std::make_unique<ModStateController>(modStateModel);
  38. }
  39. void CModListView::changeEvent(QEvent *event)
  40. {
  41. if(event->type() == QEvent::LanguageChange)
  42. {
  43. ui->retranslateUi(this);
  44. modModel->reloadRepositories();
  45. }
  46. QWidget::changeEvent(event);
  47. }
  48. void CModListView::dragEnterEvent(QDragEnterEvent* event)
  49. {
  50. if(event->mimeData()->hasUrls())
  51. for(const auto & url : event->mimeData()->urls())
  52. for(const auto & ending : QStringList({".zip", ".h3m", ".h3c", ".vmap", ".vcmp", ".json", ".exe"}))
  53. if(url.fileName().endsWith(ending, Qt::CaseInsensitive))
  54. {
  55. event->acceptProposedAction();
  56. return;
  57. }
  58. }
  59. void CModListView::dropEvent(QDropEvent* event)
  60. {
  61. const QMimeData* mimeData = event->mimeData();
  62. if(mimeData->hasUrls())
  63. {
  64. const QList<QUrl> urlList = mimeData->urls();
  65. for (const auto & url : urlList)
  66. manualInstallFile(url.toLocalFile());
  67. }
  68. }
  69. void CModListView::setupFilterModel()
  70. {
  71. filterModel = new CModFilterModel(modModel, this);
  72. filterModel->setFilterKeyColumn(-1); // filter across all columns
  73. filterModel->setSortCaseSensitivity(Qt::CaseInsensitive); // to make it more user-friendly
  74. filterModel->setDynamicSortFilter(true);
  75. }
  76. void CModListView::setupModsView()
  77. {
  78. ui->allModsView->setModel(filterModel);
  79. // input data is not sorted - sort it before display
  80. ui->allModsView->sortByColumn(ModFields::TYPE, Qt::AscendingOrder);
  81. ui->allModsView->header()->setSectionResizeMode(ModFields::STATUS_ENABLED, QHeaderView::Fixed);
  82. ui->allModsView->header()->setSectionResizeMode(ModFields::STATUS_UPDATE, QHeaderView::Fixed);
  83. QSettings s(Ui::teamName, Ui::appName);
  84. auto state = s.value("AllModsView/State").toByteArray();
  85. if(!state.isNull()) //read last saved settings
  86. {
  87. ui->allModsView->header()->restoreState(state);
  88. }
  89. else //default //TODO: default high-DPI scaling
  90. {
  91. ui->allModsView->setColumnWidth(ModFields::NAME, 220);
  92. ui->allModsView->setColumnWidth(ModFields::TYPE, 75);
  93. }
  94. ui->allModsView->resizeColumnToContents(ModFields::STATUS_ENABLED);
  95. ui->allModsView->resizeColumnToContents(ModFields::STATUS_UPDATE);
  96. ui->allModsView->setUniformRowHeights(true);
  97. connect(ui->allModsView->selectionModel(), SIGNAL(currentRowChanged(const QModelIndex&,const QModelIndex&)),
  98. this, SLOT(modSelected(const QModelIndex&,const QModelIndex&)));
  99. connect(filterModel, SIGNAL(modelReset()),
  100. this, SLOT(modelReset()));
  101. connect(modModel, SIGNAL(dataChanged(QModelIndex,QModelIndex)),
  102. this, SLOT(dataChanged(QModelIndex,QModelIndex)));
  103. }
  104. CModListView::CModListView(QWidget * parent)
  105. : QWidget(parent)
  106. , ui(new Ui::CModListView)
  107. {
  108. ui->setupUi(this);
  109. setAcceptDrops(true);
  110. ui->uninstallButton->setIcon(QIcon{":/icons/mod-delete.png"});
  111. ui->enableButton->setIcon(QIcon{":/icons/mod-enabled.png"});
  112. ui->disableButton->setIcon(QIcon{":/icons/mod-disabled.png"});
  113. ui->updateButton->setIcon(QIcon{":/icons/mod-update.png"});
  114. ui->installButton->setIcon(QIcon{":/icons/mod-download.png"});
  115. ui->splitter->setStyleSheet("QSplitter::handle {background: palette('window');}");
  116. setupModModel();
  117. setupFilterModel();
  118. setupModsView();
  119. ui->progressWidget->setVisible(false);
  120. dlManager = nullptr;
  121. if(settings["launcher"]["autoCheckRepositories"].Bool())
  122. loadRepositories();
  123. #ifdef VCMI_MOBILE
  124. for(auto * scrollWidget : {
  125. (QAbstractItemView*)ui->allModsView,
  126. (QAbstractItemView*)ui->screenshotsList})
  127. {
  128. Helper::enableScrollBySwiping(scrollWidget);
  129. scrollWidget->setVerticalScrollMode(QAbstractItemView::ScrollPerPixel);
  130. scrollWidget->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
  131. }
  132. #endif
  133. }
  134. void CModListView::loadRepositories()
  135. {
  136. QStringList repositories;
  137. if (settings["launcher"]["defaultRepositoryEnabled"].Bool())
  138. repositories.push_back(QString::fromStdString(settings["launcher"]["defaultRepositoryURL"].String()));
  139. if (settings["launcher"]["extraRepositoryEnabled"].Bool())
  140. repositories.push_back(QString::fromStdString(settings["launcher"]["extraRepositoryURL"].String()));
  141. for(auto entry : repositories)
  142. {
  143. if (entry.isEmpty())
  144. continue;
  145. // URL must be encoded to something else to get rid of symbols illegal in file names
  146. auto hashed = QCryptographicHash::hash(entry.toUtf8(), QCryptographicHash::Md5);
  147. auto hashedStr = QString::fromUtf8(hashed.toHex());
  148. downloadFile(hashedStr + ".json", entry, tr("mods repository index"));
  149. }
  150. }
  151. CModListView::~CModListView()
  152. {
  153. QSettings s(Ui::teamName, Ui::appName);
  154. s.setValue("AllModsView/State", ui->allModsView->header()->saveState());
  155. delete ui;
  156. }
  157. static QString replaceIfNotEmpty(QVariant value, QString pattern)
  158. {
  159. if(value.canConvert<QStringList>())
  160. return pattern.arg(value.toStringList().join(", "));
  161. if(value.canConvert<QString>())
  162. return pattern.arg(value.toString());
  163. // all valid types of data should have been filtered by code above
  164. assert(!value.isValid());
  165. return "";
  166. }
  167. static QString replaceIfNotEmpty(QStringList value, QString pattern)
  168. {
  169. if(!value.empty())
  170. return pattern.arg(value.join(", "));
  171. return "";
  172. }
  173. QString CModListView::genChangelogText(ModState & mod)
  174. {
  175. QString headerTemplate = "<p><span style=\" font-weight:600;\">%1: </span></p>";
  176. QString entryBegin = "<p align=\"justify\"><ul>";
  177. QString entryEnd = "</ul></p>";
  178. QString entryLine = "<li>%1</li>";
  179. //QString versionSeparator = "<hr/>";
  180. QString result;
  181. QMap<QString, QStringList> changelog = mod.getChangelog();
  182. QList<QString> versions = changelog.keys();
  183. std::sort(versions.begin(), versions.end(), [](QString lesser, QString greater)
  184. {
  185. return CModVersion::fromString(lesser.toStdString()) < CModVersion::fromString(greater.toStdString());
  186. });
  187. std::reverse(versions.begin(), versions.end());
  188. for(auto & version : versions)
  189. {
  190. result += headerTemplate.arg(version);
  191. result += entryBegin;
  192. for(auto & line : changelog.value(version))
  193. result += entryLine.arg(line);
  194. result += entryEnd;
  195. }
  196. return result;
  197. }
  198. QStringList CModListView::getModNames(QStringList input)
  199. {
  200. QStringList result;
  201. for(const auto & modID : input)
  202. {
  203. auto mod = modStateModel->getMod(modID);
  204. QString displayName = mod.getName();
  205. if (displayName.isEmpty())
  206. displayName = modID.toLower();
  207. if (mod.isSubmod())
  208. {
  209. auto parentModID = mod.getTopParentID();
  210. auto parentMod = modStateModel->getMod(parentModID);
  211. QString parentDisplayName = parentMod.getName();
  212. if (parentDisplayName.isEmpty())
  213. parentDisplayName = parentModID.toLower();
  214. if (modStateModel->isModInstalled(modID))
  215. displayName = QString("%1 (%2)").arg(displayName, parentDisplayName);
  216. else
  217. displayName = parentDisplayName;
  218. }
  219. result += displayName;
  220. }
  221. return result;
  222. }
  223. QString CModListView::genModInfoText(ModState & mod)
  224. {
  225. QString prefix = "<p><span style=\" font-weight:600;\">%1: </span>"; // shared prefix
  226. QString redPrefix = "<p><span style=\" font-weight:600; color:red\">%1: </span>"; // shared prefix
  227. QString lineTemplate = prefix + "%2</p>";
  228. QString urlTemplate = prefix + "<a href=\"%2\">%3</a></p>";
  229. QString textTemplate = prefix + "</p><p align=\"justify\">%2</p>";
  230. QString listTemplate = "<p align=\"justify\">%1: %2</p>";
  231. QString noteTemplate = "<p align=\"justify\">%1</p>";
  232. QString incompatibleString = redPrefix + tr("Mod is incompatible") + "</p>";
  233. QString supportedVersions = redPrefix + "%2 %3 %4</p>";
  234. QString result;
  235. result += replaceIfNotEmpty(mod.getName(), lineTemplate.arg(tr("Mod name")));
  236. result += replaceIfNotEmpty(mod.getInstalledVersion(), lineTemplate.arg(tr("Installed version")));
  237. result += replaceIfNotEmpty(mod.getRepositoryVersion(), lineTemplate.arg(tr("Latest version")));
  238. if(!mod.getLocalSizeFormatted().isEmpty())
  239. result += replaceIfNotEmpty(mod.getLocalSizeFormatted(), lineTemplate.arg(tr("Size")));
  240. if((!mod.isInstalled() || mod.isUpdateAvailable()) && !mod.getDownloadSizeFormatted().isEmpty())
  241. result += replaceIfNotEmpty(mod.getDownloadSizeFormatted(), lineTemplate.arg(tr("Download size")));
  242. result += replaceIfNotEmpty(mod.getAuthors(), lineTemplate.arg(tr("Authors")));
  243. if(mod.getLicenseName().isEmpty())
  244. result += urlTemplate.arg(tr("License")).arg(mod.getLicenseUrl()).arg(mod.getLicenseName());
  245. if(mod.getContact().isEmpty())
  246. result += urlTemplate.arg(tr("Contact")).arg(mod.getContact()).arg(mod.getContact());
  247. //compatibility info
  248. if(!mod.isCompatible())
  249. {
  250. auto compatibilityInfo = mod.getCompatibleVersionRange();
  251. auto minStr = compatibilityInfo.first;
  252. auto maxStr = compatibilityInfo.second;
  253. result += incompatibleString.arg(tr("Compatibility"));
  254. if(minStr == maxStr)
  255. result += supportedVersions.arg(tr("Required VCMI version"), minStr, "", "");
  256. else
  257. {
  258. if(minStr.isEmpty() || maxStr.isEmpty())
  259. {
  260. if(minStr.isEmpty())
  261. result += supportedVersions.arg(tr("Supported VCMI version"), maxStr, ", ", tr("please upgrade mod"));
  262. else
  263. result += supportedVersions.arg(tr("Required VCMI version"), minStr, " ", tr("or newer"));
  264. }
  265. else
  266. result += supportedVersions.arg(tr("Supported VCMI versions"), minStr, " - ", maxStr);
  267. }
  268. }
  269. QVariant baseLanguageVariant = mod.getBaseLanguage();
  270. QString baseLanguageID = baseLanguageVariant.isValid() ? baseLanguageVariant.toString() : "english";
  271. QStringList supportedLanguages = mod.getSupportedLanguages();
  272. if(supportedLanguages.size() > 1)
  273. {
  274. QStringList supportedLanguagesTranslated;
  275. for (const auto & languageID : supportedLanguages)
  276. supportedLanguagesTranslated += QApplication::translate("Language", Languages::getLanguageOptions(languageID.toStdString()).nameEnglish.c_str());
  277. result += replaceIfNotEmpty(supportedLanguagesTranslated, lineTemplate.arg(tr("Languages")));
  278. }
  279. result += replaceIfNotEmpty(getModNames(mod.getDependencies()), lineTemplate.arg(tr("Required mods")));
  280. result += replaceIfNotEmpty(getModNames(mod.getConflicts()), lineTemplate.arg(tr("Conflicting mods")));
  281. result += replaceIfNotEmpty(mod.getDescription(), textTemplate.arg(tr("Description")));
  282. result += "<p></p>"; // to get some empty space
  283. QString unknownDeps = tr("This mod can not be installed or enabled because the following dependencies are not present");
  284. QString blockingMods = tr("This mod can not be enabled because the following mods are incompatible with it");
  285. QString hasActiveDependentMods = tr("This mod cannot be disabled because it is required by the following mods");
  286. QString hasDependentMods = tr("This mod cannot be uninstalled or updated because it is required by the following mods");
  287. QString thisIsSubmod = tr("This is a submod and it cannot be installed or uninstalled separately from its parent mod");
  288. QString notes;
  289. notes += replaceIfNotEmpty(getModNames(findInvalidDependencies(mod.getName())), listTemplate.arg(unknownDeps));
  290. notes += replaceIfNotEmpty(getModNames(findBlockingMods(mod.getName())), listTemplate.arg(blockingMods));
  291. if(mod.isEnabled())
  292. notes += replaceIfNotEmpty(getModNames(findDependentMods(mod.getName(), true)), listTemplate.arg(hasActiveDependentMods));
  293. if(mod.isInstalled())
  294. notes += replaceIfNotEmpty(getModNames(findDependentMods(mod.getName(), false)), listTemplate.arg(hasDependentMods));
  295. if(mod.isSubmod())
  296. notes += noteTemplate.arg(thisIsSubmod);
  297. if(notes.size())
  298. result += textTemplate.arg(tr("Notes")).arg(notes);
  299. return result;
  300. }
  301. void CModListView::disableModInfo()
  302. {
  303. ui->disableButton->setVisible(false);
  304. ui->enableButton->setVisible(false);
  305. ui->installButton->setVisible(false);
  306. ui->uninstallButton->setVisible(false);
  307. ui->updateButton->setVisible(false);
  308. }
  309. void CModListView::dataChanged(const QModelIndex & topleft, const QModelIndex & bottomRight)
  310. {
  311. selectMod(ui->allModsView->currentIndex());
  312. }
  313. void CModListView::selectMod(const QModelIndex & index)
  314. {
  315. if(!index.isValid())
  316. {
  317. disableModInfo();
  318. }
  319. else
  320. {
  321. const auto modName = index.data(ModRoles::ModNameRole).toString();
  322. auto mod = modStateModel->getMod(modName);
  323. ui->modInfoBrowser->setHtml(genModInfoText(mod));
  324. ui->changelogBrowser->setHtml(genChangelogText(mod));
  325. Helper::enableScrollBySwiping(ui->modInfoBrowser);
  326. Helper::enableScrollBySwiping(ui->changelogBrowser);
  327. bool hasInvalidDeps = !findInvalidDependencies(modName).empty();
  328. bool hasBlockingMods = !findBlockingMods(modName).empty();
  329. bool hasDependentMods = !findDependentMods(modName, true).empty();
  330. ui->disableButton->setVisible(mod.isEnabled());
  331. ui->enableButton->setVisible(mod.isDisabled());
  332. ui->installButton->setVisible(mod.isAvailable() && !mod.isSubmod());
  333. ui->uninstallButton->setVisible(mod.isInstalled() && !mod.isSubmod());
  334. ui->updateButton->setVisible(mod.isUpdateAvailable());
  335. // Block buttons if action is not allowed at this time
  336. // TODO: automate handling of some of these cases instead of forcing player
  337. // to resolve all conflicts manually.
  338. ui->disableButton->setEnabled(!hasDependentMods && !mod.isHidden());
  339. ui->enableButton->setEnabled(!hasBlockingMods && !hasInvalidDeps);
  340. ui->installButton->setEnabled(!hasInvalidDeps);
  341. ui->uninstallButton->setEnabled(!hasDependentMods && !mod.isHidden());
  342. ui->updateButton->setEnabled(!hasInvalidDeps && !hasDependentMods);
  343. loadScreenshots();
  344. }
  345. }
  346. void CModListView::modSelected(const QModelIndex & current, const QModelIndex &)
  347. {
  348. selectMod(current);
  349. }
  350. void CModListView::on_allModsView_activated(const QModelIndex & index)
  351. {
  352. selectMod(index);
  353. loadScreenshots();
  354. }
  355. void CModListView::on_lineEdit_textChanged(const QString & arg1)
  356. {
  357. #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
  358. auto baseStr = QRegularExpression::wildcardToRegularExpression(arg1, QRegularExpression::UnanchoredWildcardConversion);
  359. #else
  360. auto baseStr = QRegularExpression::wildcardToRegularExpression(arg1);
  361. //Hack due to lack QRegularExpression::UnanchoredWildcardConversion in Qt5
  362. baseStr.chop(3);
  363. baseStr.remove(0,5);
  364. #endif
  365. QRegularExpression regExp{baseStr, QRegularExpression::CaseInsensitiveOption};
  366. filterModel->setFilterRegularExpression(regExp);
  367. }
  368. void CModListView::on_comboBox_currentIndexChanged(int index)
  369. {
  370. auto enumIndex = static_cast<ModFilterMask>(index);
  371. filterModel->setTypeFilter(enumIndex);
  372. }
  373. QStringList CModListView::findInvalidDependencies(QString mod)
  374. {
  375. QStringList ret;
  376. for(QString requirement : modStateModel->getMod(mod).getDependencies())
  377. {
  378. if(!modStateModel->isModExists(requirement) && !modStateModel->isModExists(modStateModel->getMod(requirement).getTopParentID()))
  379. ret += requirement;
  380. }
  381. return ret;
  382. }
  383. QStringList CModListView::findBlockingMods(QString modUnderTest)
  384. {
  385. QStringList ret;
  386. auto required = modStateModel->getMod(modUnderTest).getDependencies();
  387. for(QString name : modStateModel->getAllMods())
  388. {
  389. auto mod = modStateModel->getMod(name);
  390. if(mod.isEnabled())
  391. {
  392. // one of enabled mods have requirement (or this mod) marked as conflict
  393. for(auto conflict : mod.getConflicts())
  394. {
  395. if(required.contains(conflict))
  396. ret.push_back(name);
  397. }
  398. }
  399. }
  400. return ret;
  401. }
  402. QStringList CModListView::findDependentMods(QString mod, bool excludeDisabled)
  403. {
  404. QStringList ret;
  405. for(QString modName : modStateModel->getAllMods())
  406. {
  407. auto current = modStateModel->getMod(modName);
  408. if(!current.isInstalled() || !current.isVisible())
  409. continue;
  410. if(current.getDependencies().contains(mod, Qt::CaseInsensitive))
  411. {
  412. if(!(current.isDisabled() && excludeDisabled))
  413. ret += modName;
  414. }
  415. }
  416. return ret;
  417. }
  418. void CModListView::on_enableButton_clicked()
  419. {
  420. QString modName = ui->allModsView->currentIndex().data(ModRoles::ModNameRole).toString();
  421. enableModByName(modName);
  422. checkManagerErrors();
  423. }
  424. void CModListView::enableModByName(QString modName)
  425. {
  426. assert(findBlockingMods(modName).empty());
  427. assert(findInvalidDependencies(modName).empty());
  428. auto mod = modStateModel->getMod(modName);
  429. for(auto & name : mod.getDependencies())
  430. {
  431. if(modStateModel->getMod(name).isDisabled())
  432. manager->enableMod(name);
  433. }
  434. emit modsChanged();
  435. }
  436. void CModListView::on_disableButton_clicked()
  437. {
  438. QString modName = ui->allModsView->currentIndex().data(ModRoles::ModNameRole).toString();
  439. disableModByName(modName);
  440. checkManagerErrors();
  441. }
  442. void CModListView::disableModByName(QString modName)
  443. {
  444. if(modStateModel->isModExists(modName) && modStateModel->getMod(modName).isEnabled())
  445. manager->disableMod(modName);
  446. emit modsChanged();
  447. }
  448. void CModListView::on_updateButton_clicked()
  449. {
  450. QString modName = ui->allModsView->currentIndex().data(ModRoles::ModNameRole).toString();
  451. assert(findInvalidDependencies(modName).empty());
  452. for(auto & name : modStateModel->getMod(modName).getDependencies())
  453. {
  454. auto mod = modStateModel->getMod(name);
  455. // update required mod, install missing (can be new dependency)
  456. if(mod.isUpdateAvailable() || !mod.isInstalled())
  457. downloadFile(name + ".zip", mod.getDownloadUrl(), name, mod.getDownloadSizeMegabytes());
  458. }
  459. }
  460. void CModListView::on_uninstallButton_clicked()
  461. {
  462. QString modName = ui->allModsView->currentIndex().data(ModRoles::ModNameRole).toString();
  463. // NOTE: perhaps add "manually installed" flag and uninstall those dependencies that don't have it?
  464. if(modStateModel->isModExists(modName) && modStateModel->getMod(modName).isInstalled())
  465. {
  466. if(modStateModel->getMod(modName).isEnabled())
  467. manager->disableMod(modName);
  468. manager->uninstallMod(modName);
  469. }
  470. emit modsChanged();
  471. checkManagerErrors();
  472. }
  473. void CModListView::on_installButton_clicked()
  474. {
  475. QString modName = ui->allModsView->currentIndex().data(ModRoles::ModNameRole).toString();
  476. assert(findInvalidDependencies(modName).empty());
  477. for(auto & name : modStateModel->getMod(modName).getDependencies())
  478. {
  479. auto mod = modStateModel->getMod(name);
  480. if(mod.isAvailable())
  481. downloadFile(name + ".zip", mod.getDownloadUrl(), name, mod.getDownloadSizeMegabytes());
  482. else if(!mod.isEnabled())
  483. enableModByName(name);
  484. }
  485. for(auto & name : modStateModel->getMod(modName).getConflicts())
  486. {
  487. auto mod = modStateModel->getMod(name);
  488. if(mod.isEnabled())
  489. {
  490. //TODO: consider reverse dependencies disabling
  491. //TODO: consider if it may be possible for subdependencies to block disabling conflicting mod?
  492. //TODO: consider if it may be possible to get subconflicts that will block disabling conflicting mod?
  493. disableModByName(name);
  494. }
  495. }
  496. }
  497. void CModListView::on_installFromFileButton_clicked()
  498. {
  499. // iOS can't display modal dialogs when called directly on button press
  500. // https://bugreports.qt.io/browse/QTBUG-98651
  501. QTimer::singleShot(0, this, [this]
  502. {
  503. QString filter = tr("All supported files") + " (*.h3m *.vmap *.h3c *.vcmp *.zip *.json *.exe);;" +
  504. tr("Maps") + " (*.h3m *.vmap);;" +
  505. tr("Campaigns") + " (*.h3c *.vcmp);;" +
  506. tr("Configs") + " (*.json);;" +
  507. tr("Mods") + " (*.zip);;" +
  508. tr("Gog files") + " (*.exe)";
  509. #if defined(VCMI_MOBILE)
  510. filter = tr("All files (*.*)"); //Workaround for sometimes incorrect mime for some extensions (e.g. for exe)
  511. #endif
  512. QStringList files = QFileDialog::getOpenFileNames(this, tr("Select files (configs, mods, maps, campaigns, gog files) to install..."), QDir::homePath(), filter);
  513. for(const auto & file : files)
  514. {
  515. manualInstallFile(file);
  516. }
  517. });
  518. }
  519. void CModListView::manualInstallFile(QString filePath)
  520. {
  521. QString fileName = QFileInfo{filePath}.fileName();
  522. if(filePath.endsWith(".zip", Qt::CaseInsensitive))
  523. downloadFile(fileName.toLower()
  524. // mod name currently comes from zip file -> remove suffixes from github zip download
  525. .replace(QRegularExpression("-[0-9a-f]{40}"), "")
  526. .replace(QRegularExpression("-vcmi-.+\\.zip"), ".zip")
  527. .replace("-main.zip", ".zip")
  528. , QUrl::fromLocalFile(filePath), "mods");
  529. else if(filePath.endsWith(".json", Qt::CaseInsensitive))
  530. {
  531. QDir configDir(QString::fromStdString(VCMIDirs::get().userConfigPath().string()));
  532. QStringList configFile = configDir.entryList({fileName}, QDir::Filter::Files); // case insensitive check
  533. if(!configFile.empty())
  534. {
  535. auto dialogResult = QMessageBox::warning(this, tr("Replace config file?"), tr("Do you want to replace %1?").arg(configFile[0]), QMessageBox::Yes | QMessageBox::No, QMessageBox::No);
  536. if(dialogResult == QMessageBox::Yes)
  537. {
  538. const auto configFilePath = configDir.filePath(configFile[0]);
  539. QFile::remove(configFilePath);
  540. QFile::copy(filePath, configFilePath);
  541. // reload settings
  542. Helper::loadSettings();
  543. for(auto widget : qApp->allWidgets())
  544. if(auto settingsView = qobject_cast<CSettingsView *>(widget))
  545. settingsView->loadSettings();
  546. // manager->loadMods();
  547. // manager->loadModSettings();
  548. }
  549. }
  550. }
  551. else
  552. downloadFile(fileName, QUrl::fromLocalFile(filePath), fileName);
  553. }
  554. void CModListView::downloadFile(QString file, QString url, QString description, qint64 size)
  555. {
  556. downloadFile(file, QUrl{url}, description, size);
  557. }
  558. void CModListView::downloadFile(QString file, QUrl url, QString description, qint64 size)
  559. {
  560. if(!dlManager)
  561. {
  562. dlManager = new CDownloadManager();
  563. ui->progressWidget->setVisible(true);
  564. connect(dlManager, SIGNAL(downloadProgress(qint64,qint64)),
  565. this, SLOT(downloadProgress(qint64,qint64)));
  566. connect(dlManager, SIGNAL(finished(QStringList,QStringList,QStringList)),
  567. this, SLOT(downloadFinished(QStringList,QStringList,QStringList)));
  568. connect(manager.get(), SIGNAL(extractionProgress(qint64,qint64)),
  569. this, SLOT(extractionProgress(qint64,qint64)));
  570. connect(modModel, &ModStateItemModel::dataChanged, filterModel, &QAbstractItemModel::dataChanged);
  571. const auto progressBarFormat = tr("Downloading %1. %p% (%v MB out of %m MB) finished").arg(description);
  572. ui->progressBar->setFormat(progressBarFormat);
  573. }
  574. dlManager->downloadFile(url, file, size);
  575. }
  576. void CModListView::downloadProgress(qint64 current, qint64 max)
  577. {
  578. // display progress, in megabytes
  579. ui->progressBar->setVisible(true);
  580. ui->progressBar->setMaximum(max / (1024 * 1024));
  581. ui->progressBar->setValue(current / (1024 * 1024));
  582. }
  583. void CModListView::extractionProgress(qint64 current, qint64 max)
  584. {
  585. // display progress, in extracted files
  586. ui->progressBar->setVisible(true);
  587. ui->progressBar->setMaximum(max);
  588. ui->progressBar->setValue(current);
  589. }
  590. void CModListView::downloadFinished(QStringList savedFiles, QStringList failedFiles, QStringList errors)
  591. {
  592. QString title = tr("Download failed");
  593. QString firstLine = tr("Unable to download all files.\n\nEncountered errors:\n\n");
  594. QString lastLine = tr("\n\nInstall successfully downloaded?");
  595. bool doInstallFiles = false;
  596. // if all files were d/loaded there should be no errors. And on failure there must be an error
  597. assert(failedFiles.empty() == errors.empty());
  598. if(savedFiles.empty())
  599. {
  600. // no successfully downloaded mods
  601. QMessageBox::warning(this, title, firstLine + errors.join("\n"), QMessageBox::Ok, QMessageBox::Ok);
  602. }
  603. else if(!failedFiles.empty())
  604. {
  605. // some mods were not downloaded
  606. int result = QMessageBox::warning (this, title, firstLine + errors.join("\n") + lastLine,
  607. QMessageBox::Yes | QMessageBox::No, QMessageBox::No );
  608. if(result == QMessageBox::Yes)
  609. doInstallFiles = true;
  610. }
  611. else
  612. {
  613. // everything OK
  614. doInstallFiles = true;
  615. }
  616. dlManager->deleteLater();
  617. dlManager = nullptr;
  618. ui->progressBar->setMaximum(0);
  619. ui->progressBar->setValue(0);
  620. if(doInstallFiles)
  621. installFiles(savedFiles);
  622. hideProgressBar();
  623. emit modsChanged();
  624. }
  625. void CModListView::hideProgressBar()
  626. {
  627. if(dlManager == nullptr) // it was not recreated meanwhile
  628. {
  629. ui->progressWidget->setVisible(false);
  630. ui->progressBar->setMaximum(0);
  631. ui->progressBar->setValue(0);
  632. }
  633. }
  634. void CModListView::installFiles(QStringList files)
  635. {
  636. QStringList mods;
  637. QStringList maps;
  638. QStringList images;
  639. QStringList exe;
  640. QVector<QVariantMap> repositories;
  641. // TODO: some better way to separate zip's with mods and downloaded repository files
  642. for(QString filename : files)
  643. {
  644. if(filename.endsWith(".zip", Qt::CaseInsensitive))
  645. mods.push_back(filename);
  646. else if(filename.endsWith(".h3m", Qt::CaseInsensitive) || filename.endsWith(".h3c", Qt::CaseInsensitive) || filename.endsWith(".vmap", Qt::CaseInsensitive) || filename.endsWith(".vcmp", Qt::CaseInsensitive))
  647. maps.push_back(filename);
  648. if(filename.endsWith(".exe", Qt::CaseInsensitive))
  649. exe.push_back(filename);
  650. else if(filename.endsWith(".json", Qt::CaseInsensitive))
  651. {
  652. //download and merge additional files
  653. auto repoData = JsonUtils::JsonFromFile(filename).toMap();
  654. if(repoData.value("name").isNull())
  655. {
  656. for(const auto & key : repoData.keys())
  657. {
  658. auto modjson = repoData[key].toMap().value("mod");
  659. if(!modjson.isNull())
  660. {
  661. downloadFile(key + ".json", modjson.toString(), tr("mods repository index"));
  662. }
  663. }
  664. }
  665. else
  666. {
  667. auto modn = QFileInfo(filename).baseName();
  668. QVariantMap temp;
  669. temp[modn] = repoData;
  670. repoData = temp;
  671. }
  672. repositories.push_back(repoData);
  673. }
  674. else if(filename.endsWith(".png", Qt::CaseInsensitive))
  675. images.push_back(filename);
  676. }
  677. // if (!repositories.empty())
  678. // manager->loadRepositories(repositories);
  679. if(!mods.empty())
  680. installMods(mods);
  681. if(!maps.empty())
  682. installMaps(maps);
  683. if(!exe.empty())
  684. {
  685. ui->progressBar->setFormat(tr("Installing chronicles"));
  686. float prog = 0.0;
  687. auto futureExtract = std::async(std::launch::async, [this, exe, &prog]()
  688. {
  689. ChroniclesExtractor ce(this, [&prog](float progress) { prog = progress; });
  690. ce.installChronicles(exe);
  691. return true;
  692. });
  693. while(futureExtract.wait_for(std::chrono::milliseconds(10)) != std::future_status::ready)
  694. {
  695. emit extractionProgress(static_cast<int>(prog * 1000.f), 1000);
  696. qApp->processEvents();
  697. }
  698. if(futureExtract.get())
  699. {
  700. //update
  701. CResourceHandler::get("initial")->updateFilteredFiles([](const std::string &){ return true; });
  702. // manager->loadMods();
  703. // modModel->reloadRepositories();
  704. emit modsChanged();
  705. }
  706. }
  707. if(!images.empty())
  708. loadScreenshots();
  709. }
  710. void CModListView::installMods(QStringList archives)
  711. {
  712. QStringList modNames;
  713. for(QString archive : archives)
  714. {
  715. // get basename out of full file name
  716. // remove path remove extension
  717. QString modName = archive.section('/', -1, -1).section('.', 0, 0);
  718. modNames.push_back(modName);
  719. }
  720. QStringList modsToEnable;
  721. // disable mod(s), to properly recalculate dependencies, if changed
  722. for(QString mod : boost::adaptors::reverse(modNames))
  723. {
  724. ModState entry = modStateModel->getMod(mod);
  725. if(entry.isInstalled())
  726. {
  727. // enable mod if installed and enabled
  728. if(entry.isEnabled())
  729. modsToEnable.push_back(mod);
  730. }
  731. else
  732. {
  733. // enable mod if m
  734. if(settings["launcher"]["enableInstalledMods"].Bool())
  735. modsToEnable.push_back(mod);
  736. }
  737. }
  738. // uninstall old version of mod, if installed
  739. for(QString mod : boost::adaptors::reverse(modNames))
  740. {
  741. if(modStateModel->getMod(mod).isInstalled())
  742. manager->uninstallMod(mod);
  743. }
  744. for(int i = 0; i < modNames.size(); i++)
  745. {
  746. ui->progressBar->setFormat(tr("Installing mod %1").arg(modNames[i]));
  747. manager->installMod(modNames[i], archives[i]);
  748. }
  749. std::function<void(QString)> enableMod;
  750. enableMod = [&](QString modName)
  751. {
  752. auto mod = modStateModel->getMod(modName);
  753. if(mod.isInstalled() && !mod.isKeptDisabled())
  754. {
  755. for (auto const & dependencyName : mod.getDependencies())
  756. {
  757. auto dependency = modStateModel->getMod(dependencyName);
  758. if(dependency.isDisabled())
  759. manager->enableMod(dependencyName);
  760. }
  761. if(mod.isDisabled() && manager->enableMod(modName))
  762. {
  763. for(QString child : modStateModel->getSubmods(modName))
  764. enableMod(child);
  765. }
  766. }
  767. };
  768. for(QString mod : modsToEnable)
  769. {
  770. enableMod(mod);
  771. }
  772. checkManagerErrors();
  773. for(QString archive : archives)
  774. QFile::remove(archive);
  775. }
  776. void CModListView::installMaps(QStringList maps)
  777. {
  778. const auto destDir = CLauncherDirs::mapsPath() + QChar{'/'};
  779. for(QString map : maps)
  780. {
  781. QFile(map).rename(destDir + map.section('/', -1, -1));
  782. }
  783. }
  784. void CModListView::on_refreshButton_clicked()
  785. {
  786. loadRepositories();
  787. }
  788. void CModListView::on_pushButton_clicked()
  789. {
  790. delete dlManager;
  791. dlManager = nullptr;
  792. hideProgressBar();
  793. }
  794. void CModListView::modelReset()
  795. {
  796. selectMod(filterModel->rowCount() > 0 ? filterModel->index(0, 0) : QModelIndex());
  797. }
  798. void CModListView::checkManagerErrors()
  799. {
  800. QString errors = manager->getErrors().join('\n');
  801. if(errors.size() != 0)
  802. {
  803. QString title = tr("Operation failed");
  804. QString description = tr("Encountered errors:\n") + errors;
  805. QMessageBox::warning(this, title, description, QMessageBox::Ok, QMessageBox::Ok);
  806. }
  807. }
  808. void CModListView::on_tabWidget_currentChanged(int index)
  809. {
  810. loadScreenshots();
  811. }
  812. void CModListView::loadScreenshots()
  813. {
  814. if(ui->tabWidget->currentIndex() == 2)
  815. {
  816. if(!ui->allModsView->currentIndex().isValid())
  817. {
  818. // select the first mod, so we can access its data
  819. ui->allModsView->setCurrentIndex(filterModel->index(0, 0));
  820. }
  821. ui->screenshotsList->clear();
  822. QString modName = ui->allModsView->currentIndex().data(ModRoles::ModNameRole).toString();
  823. assert(modStateModel->isModExists(modName)); //should be filtered out by check above
  824. for(QString url : modStateModel->getMod(modName).getScreenshots())
  825. {
  826. // URL must be encoded to something else to get rid of symbols illegal in file names
  827. const auto hashed = QCryptographicHash::hash(url.toUtf8(), QCryptographicHash::Md5);
  828. const auto fileName = QString{QLatin1String{"%1.png"}}.arg(QLatin1String{hashed.toHex()});
  829. const auto fullPath = QString{QLatin1String{"%1/%2"}}.arg(CLauncherDirs::downloadsPath(), fileName);
  830. QPixmap pixmap(fullPath);
  831. if(pixmap.isNull())
  832. {
  833. // image file not exists or corrupted - try to redownload
  834. downloadFile(fileName, url, tr("screenshots"));
  835. }
  836. else
  837. {
  838. // managed to load cached image
  839. QIcon icon(pixmap);
  840. auto * item = new QListWidgetItem(icon, QString(tr("Screenshot %1")).arg(ui->screenshotsList->count() + 1));
  841. ui->screenshotsList->addItem(item);
  842. }
  843. }
  844. }
  845. }
  846. void CModListView::on_screenshotsList_clicked(const QModelIndex & index)
  847. {
  848. if(index.isValid())
  849. {
  850. QIcon icon = ui->screenshotsList->item(index.row())->icon();
  851. auto pixmap = icon.pixmap(icon.availableSizes()[0]);
  852. ImageViewer::showPixmap(pixmap, this);
  853. }
  854. }
  855. //const CModList & CModListView::getModList() const
  856. //{
  857. // assert(modModel);
  858. // return *modModel;
  859. //}
  860. void CModListView::doInstallMod(const QString & modName)
  861. {
  862. assert(findInvalidDependencies(modName).empty());
  863. for(auto & name : modStateModel->getMod(modName).getDependencies())
  864. {
  865. auto mod = modStateModel->getMod(name);
  866. if(!mod.isInstalled())
  867. downloadFile(name + ".zip", mod.getDownloadUrl(), name, mod.getDownloadSizeMegabytes());
  868. }
  869. }
  870. bool CModListView::isModAvailable(const QString & modName)
  871. {
  872. return !modStateModel->isModInstalled(modName);
  873. }
  874. bool CModListView::isModEnabled(const QString & modName)
  875. {
  876. auto mod = modStateModel->getMod(modName);
  877. return mod.isEnabled();
  878. }
  879. bool CModListView::isModInstalled(const QString & modName)
  880. {
  881. auto mod = modStateModel->getMod(modName);
  882. return mod.isInstalled();
  883. }
  884. QString CModListView::getTranslationModName(const QString & language)
  885. {
  886. for(const auto & modName : modStateModel->getAllMods())
  887. {
  888. auto mod = modStateModel->getMod(modName);
  889. if (!mod.isTranslation())
  890. continue;
  891. if (mod.getBaseLanguage() != language)
  892. continue;
  893. return modName;
  894. }
  895. return QString();
  896. }
  897. void CModListView::on_allModsView_doubleClicked(const QModelIndex &index)
  898. {
  899. if(!index.isValid())
  900. return;
  901. auto modName = index.data(ModRoles::ModNameRole).toString();
  902. auto mod = modStateModel->getMod(modName);
  903. bool hasInvalidDeps = !findInvalidDependencies(modName).empty();
  904. bool hasBlockingMods = !findBlockingMods(modName).empty();
  905. bool hasDependentMods = !findDependentMods(modName, true).empty();
  906. if(!hasInvalidDeps && mod.isAvailable() && !mod.isSubmod())
  907. {
  908. on_installButton_clicked();
  909. return;
  910. }
  911. if(!hasInvalidDeps && !hasDependentMods && mod.isUpdateAvailable() && index.column() == ModFields::STATUS_UPDATE)
  912. {
  913. on_updateButton_clicked();
  914. return;
  915. }
  916. if(index.column() == ModFields::NAME)
  917. {
  918. if(ui->allModsView->isExpanded(index))
  919. ui->allModsView->collapse(index);
  920. else
  921. ui->allModsView->expand(index);
  922. return;
  923. }
  924. if(!hasBlockingMods && !hasInvalidDeps && mod.isDisabled())
  925. {
  926. on_enableButton_clicked();
  927. return;
  928. }
  929. if(!hasDependentMods && !mod.isVisible() && mod.isEnabled())
  930. {
  931. on_disableButton_clicked();
  932. return;
  933. }
  934. }