cmodlistview_moc.cpp 32 KB

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