cmodlistview_moc.cpp 34 KB

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