CModHandler.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848
  1. #include "StdInc.h"
  2. #include "CModHandler.h"
  3. #include "CDefObjInfoHandler.h"
  4. #include "JsonNode.h"
  5. #include "filesystem/Filesystem.h"
  6. #include "filesystem/AdapterLoaders.h"
  7. #include "filesystem/CFilesystemLoader.h"
  8. #include "CCreatureHandler.h"
  9. #include "CArtHandler.h"
  10. #include "CTownHandler.h"
  11. #include "CHeroHandler.h"
  12. #include "CObjectHandler.h"
  13. #include "StringConstants.h"
  14. #include "CStopWatch.h"
  15. #include "IHandlerBase.h"
  16. #include "CSpellHandler.h"
  17. /*
  18. * CModHandler.cpp, part of VCMI engine
  19. *
  20. * Authors: listed in file AUTHORS in main folder
  21. *
  22. * License: GNU General Public License v2.0 or later
  23. * Full text of license available in license.txt file, in main folder
  24. *
  25. */
  26. void CIdentifierStorage::checkIdentifier(std::string & ID)
  27. {
  28. if (boost::algorithm::ends_with(ID, "."))
  29. logGlobal->warnStream() << "BIG WARNING: identifier " << ID << " seems to be broken!";
  30. else
  31. {
  32. size_t pos = 0;
  33. do
  34. {
  35. if (std::tolower(ID[pos]) != ID[pos] ) //Not in camelCase
  36. {
  37. logGlobal->warnStream() << "Warning: identifier " << ID << " is not in camelCase!";
  38. ID[pos] = std::tolower(ID[pos]);// Try to fix the ID
  39. }
  40. pos = ID.find('.', pos);
  41. }
  42. while(pos++ != std::string::npos);
  43. }
  44. }
  45. CIdentifierStorage::ObjectCallback::ObjectCallback(std::string localScope, std::string remoteScope, std::string type,
  46. std::string name, const std::function<void(si32)> & callback, bool optional):
  47. localScope(localScope),
  48. remoteScope(remoteScope),
  49. type(type),
  50. name(name),
  51. callback(callback),
  52. optional(optional)
  53. {}
  54. static std::pair<std::string, std::string> splitString(std::string input, char separator)
  55. {
  56. std::pair<std::string, std::string> ret;
  57. size_t splitPos = input.find(separator);
  58. if (splitPos == std::string::npos)
  59. {
  60. ret.first.clear();
  61. ret.second = input;
  62. }
  63. else
  64. {
  65. ret.first = input.substr(0, splitPos);
  66. ret.second = input.substr(splitPos + 1);
  67. }
  68. return ret;
  69. }
  70. void CIdentifierStorage::requestIdentifier(ObjectCallback callback)
  71. {
  72. checkIdentifier(callback.type);
  73. checkIdentifier(callback.name);
  74. assert(!callback.localScope.empty());
  75. scheduledRequests.push_back(callback);
  76. }
  77. void CIdentifierStorage::requestIdentifier(std::string scope, std::string type, std::string name, const std::function<void(si32)> & callback)
  78. {
  79. auto pair = splitString(name, ':'); // remoteScope:name
  80. requestIdentifier(ObjectCallback(scope, pair.first, type, pair.second, callback, false));
  81. }
  82. void CIdentifierStorage::requestIdentifier(std::string type, const JsonNode & name, const std::function<void(si32)> & callback)
  83. {
  84. auto pair = splitString(name.String(), ':'); // remoteScope:name
  85. requestIdentifier(ObjectCallback(name.meta, pair.first, type, pair.second, callback, false));
  86. }
  87. void CIdentifierStorage::requestIdentifier(const JsonNode & name, const std::function<void(si32)> & callback)
  88. {
  89. auto pair = splitString(name.String(), ':'); // remoteScope:<type.name>
  90. auto pair2 = splitString(pair.second, '.'); // type.name
  91. requestIdentifier(ObjectCallback(name.meta, pair.first, pair2.first, pair2.second, callback, false));
  92. }
  93. void CIdentifierStorage::tryRequestIdentifier(std::string scope, std::string type, std::string name, const std::function<void(si32)> & callback)
  94. {
  95. auto pair = splitString(name, ':'); // remoteScope:name
  96. requestIdentifier(ObjectCallback(scope, pair.first, type, pair.second, callback, true));
  97. }
  98. void CIdentifierStorage::tryRequestIdentifier(std::string type, const JsonNode & name, const std::function<void(si32)> & callback)
  99. {
  100. auto pair = splitString(name.String(), ':'); // remoteScope:name
  101. requestIdentifier(ObjectCallback(name.meta, pair.first, type, pair.second, callback, true));
  102. }
  103. boost::optional<si32> CIdentifierStorage::getIdentifier(std::string type, const JsonNode & name, bool silent)
  104. {
  105. auto pair = splitString(name.String(), ':'); // remoteScope:name
  106. auto idList = getPossibleIdentifiers(ObjectCallback(name.meta, pair.first, type, pair.second, std::function<void(si32)>(), silent));
  107. if (idList.size() == 1)
  108. return idList.front().id;
  109. if (!silent)
  110. logGlobal->errorStream() << "Failed to resolve identifier " << name.String() << " from mod " << type;
  111. return boost::optional<si32>();
  112. }
  113. boost::optional<si32> CIdentifierStorage::getIdentifier(const JsonNode & name, bool silent)
  114. {
  115. auto pair = splitString(name.String(), ':'); // remoteScope:<type.name>
  116. auto pair2 = splitString(pair.second, '.'); // type.name
  117. auto idList = getPossibleIdentifiers(ObjectCallback(name.meta, pair.first, pair2.first, pair2.second, std::function<void(si32)>(), silent));
  118. if (idList.size() == 1)
  119. return idList.front().id;
  120. if (!silent)
  121. logGlobal->errorStream() << "Failed to resolve identifier " << name.String() << " from mod " << name.meta;
  122. return boost::optional<si32>();
  123. }
  124. void CIdentifierStorage::registerObject(std::string scope, std::string type, std::string name, si32 identifier)
  125. {
  126. ObjectData data;
  127. data.scope = scope;
  128. data.id = identifier;
  129. std::string fullID = type + '.' + name;
  130. checkIdentifier(fullID);
  131. registeredObjects.insert(std::make_pair(fullID, data));
  132. }
  133. std::vector<CIdentifierStorage::ObjectData> CIdentifierStorage::getPossibleIdentifiers(const ObjectCallback & request)
  134. {
  135. std::set<std::string> allowedScopes;
  136. if (request.remoteScope.empty())
  137. {
  138. // normally ID's from all required mods, own mod and virtual "core" mod are allowed
  139. if (request.localScope != "core" && request.localScope != "")
  140. allowedScopes = VLC->modh->getModData(request.localScope).dependencies;
  141. allowedScopes.insert(request.localScope);
  142. allowedScopes.insert("core");
  143. }
  144. else
  145. {
  146. //...unless destination mod was specified explicitly
  147. auto myDeps = VLC->modh->getModData(request.localScope).dependencies;
  148. if (request.remoteScope == "core" || // allow only available to all core mod
  149. myDeps.count(request.remoteScope)) // or dependencies
  150. allowedScopes.insert(request.remoteScope);
  151. }
  152. std::string fullID = request.type + '.' + request.name;
  153. auto entries = registeredObjects.equal_range(fullID);
  154. if (entries.first != entries.second)
  155. {
  156. std::vector<ObjectData> locatedIDs;
  157. for (auto it = entries.first; it != entries.second; it++)
  158. {
  159. if (vstd::contains(allowedScopes, it->second.scope))
  160. {
  161. locatedIDs.push_back(it->second);
  162. }
  163. }
  164. return locatedIDs;
  165. }
  166. return std::vector<ObjectData>();
  167. }
  168. bool CIdentifierStorage::resolveIdentifier(const ObjectCallback & request)
  169. {
  170. auto identifiers = getPossibleIdentifiers(request);
  171. if (identifiers.size() == 1) // normally resolved ID
  172. {
  173. request.callback(identifiers.front().id);
  174. return true;
  175. }
  176. if (request.optional && identifiers.empty()) // failed to resolve optinal ID
  177. return true;
  178. // error found. Try to generate some debug info
  179. if (identifiers.size() == 0)
  180. logGlobal->errorStream() << "Unknown identifier!";
  181. else
  182. logGlobal->errorStream() << "Ambiguous identifier request!";
  183. logGlobal->errorStream() << "Request for " << request.type << "." << request.name << " from mod " << request.localScope;
  184. for (auto id : identifiers)
  185. {
  186. logGlobal->errorStream() << "\tID is available in mod " << id.scope;
  187. }
  188. return false;
  189. }
  190. void CIdentifierStorage::finalize()
  191. {
  192. bool errorsFound = false;
  193. for(const ObjectCallback & request : scheduledRequests)
  194. {
  195. errorsFound |= !resolveIdentifier(request);
  196. }
  197. if (errorsFound)
  198. {
  199. for(auto object : registeredObjects)
  200. {
  201. logGlobal->traceStream() << object.first << " -> " << object.second.id;
  202. }
  203. logGlobal->errorStream() << "All known identifiers were dumped into log file";
  204. }
  205. assert(errorsFound == false);
  206. }
  207. CContentHandler::ContentTypeHandler::ContentTypeHandler(IHandlerBase * handler, std::string objectName):
  208. handler(handler),
  209. objectName(objectName),
  210. originalData(handler->loadLegacyData(VLC->modh->settings.data["textData"][objectName].Float()))
  211. {
  212. for(auto & node : originalData)
  213. {
  214. node.setMeta("core");
  215. }
  216. }
  217. bool CContentHandler::ContentTypeHandler::preloadModData(std::string modName, std::vector<std::string> fileList, bool validate)
  218. {
  219. bool result;
  220. JsonNode data = JsonUtils::assembleFromFiles(fileList, result);
  221. data.setMeta(modName);
  222. ModInfo & modInfo = modData[modName];
  223. for(auto entry : data.Struct())
  224. {
  225. size_t colon = entry.first.find(':');
  226. if (colon == std::string::npos)
  227. {
  228. // normal object, local to this mod
  229. modInfo.modData[entry.first].swap(entry.second);
  230. }
  231. else
  232. {
  233. std::string remoteName = entry.first.substr(0, colon);
  234. std::string objectName = entry.first.substr(colon + 1);
  235. // patching this mod? Send warning and continue - this situation can be handled normally
  236. if (remoteName == modName)
  237. logGlobal->warnStream() << "Redundant namespace definition for " << objectName;
  238. JsonNode & remoteConf = modData[remoteName].patches[objectName];
  239. JsonUtils::merge(remoteConf, entry.second);
  240. }
  241. }
  242. return result;
  243. }
  244. bool CContentHandler::ContentTypeHandler::loadMod(std::string modName, bool validate)
  245. {
  246. ModInfo & modInfo = modData[modName];
  247. bool result = true;
  248. auto performValidate = [&,this](JsonNode & data, const std::string & name){
  249. handler->beforeValidate(data);
  250. if (validate)
  251. result &= JsonUtils::validate(data, "vcmi:" + objectName, name);
  252. };
  253. // apply patches
  254. if (!modInfo.patches.isNull())
  255. JsonUtils::merge(modInfo.modData, modInfo.patches);
  256. for(auto & entry : modInfo.modData.Struct())
  257. {
  258. const std::string & name = entry.first;
  259. JsonNode & data = entry.second;
  260. if (vstd::contains(data.Struct(), "index") && !data["index"].isNull())
  261. {
  262. // try to add H3 object data
  263. size_t index = data["index"].Float();
  264. if (originalData.size() > index)
  265. {
  266. JsonUtils::merge(originalData[index], data);
  267. performValidate(originalData[index],name);
  268. handler->loadObject(modName, name, originalData[index], index);
  269. originalData[index].clear(); // do not use same data twice (same ID)
  270. continue;
  271. }
  272. }
  273. // normal new object or one with index bigger that data size
  274. performValidate(data,name);
  275. handler->loadObject(modName, name, data);
  276. }
  277. return result;
  278. }
  279. void CContentHandler::ContentTypeHandler::afterLoadFinalization()
  280. {
  281. handler->afterLoadFinalization();
  282. }
  283. CContentHandler::CContentHandler()
  284. {
  285. handlers.insert(std::make_pair("heroClasses", ContentTypeHandler(&VLC->heroh->classes, "heroClass")));
  286. handlers.insert(std::make_pair("artifacts", ContentTypeHandler(VLC->arth, "artifact")));
  287. handlers.insert(std::make_pair("creatures", ContentTypeHandler(VLC->creh, "creature")));
  288. handlers.insert(std::make_pair("factions", ContentTypeHandler(VLC->townh, "faction")));
  289. handlers.insert(std::make_pair("heroes", ContentTypeHandler(VLC->heroh, "hero")));
  290. handlers.insert(std::make_pair("spells", ContentTypeHandler(VLC->spellh, "spell")));
  291. //TODO: bonuses, something else?
  292. }
  293. bool CContentHandler::preloadModData(std::string modName, JsonNode modConfig, bool validate)
  294. {
  295. bool result = true;
  296. for(auto & handler : handlers)
  297. {
  298. result &= handler.second.preloadModData(modName, modConfig[handler.first].convertTo<std::vector<std::string> >(), validate);
  299. }
  300. return result;
  301. }
  302. bool CContentHandler::loadMod(std::string modName, bool validate)
  303. {
  304. bool result = true;
  305. for(auto & handler : handlers)
  306. {
  307. result &= handler.second.loadMod(modName, validate);
  308. }
  309. return result;
  310. }
  311. void CContentHandler::afterLoadFinalization()
  312. {
  313. for(auto & handler : handlers)
  314. {
  315. handler.second.afterLoadFinalization();
  316. }
  317. }
  318. void CContentHandler::preloadData(CModInfo & mod)
  319. {
  320. bool validate = (mod.validation != CModInfo::PASSED);
  321. // print message in format [<8-symbols checksum>] <modname>
  322. logGlobal->infoStream() << "\t\t[" << std::noshowbase << std::hex << std::setw(8) << std::setfill('0')
  323. << mod.checksum << "] " << mod.name;
  324. if (validate && mod.identifier != "core")
  325. {
  326. if (!JsonUtils::validate(mod.config, "vcmi:mod", mod.identifier))
  327. mod.validation = CModInfo::FAILED;
  328. }
  329. if (!preloadModData(mod.identifier, mod.config, validate))
  330. mod.validation = CModInfo::FAILED;
  331. }
  332. void CContentHandler::load(CModInfo & mod)
  333. {
  334. bool validate = (mod.validation != CModInfo::PASSED);
  335. if (!loadMod(mod.identifier, validate))
  336. mod.validation = CModInfo::FAILED;
  337. if (validate)
  338. {
  339. if (mod.validation != CModInfo::FAILED)
  340. logGlobal->infoStream() << "\t\t[DONE] " << mod.name;
  341. else
  342. logGlobal->errorStream() << "\t\t[FAIL] " << mod.name;
  343. }
  344. else
  345. logGlobal->infoStream() << "\t\t[SKIP] " << mod.name;
  346. }
  347. static JsonNode loadModSettings(std::string path)
  348. {
  349. if (CResourceHandler::get("local")->existsResource(ResourceID(path)))
  350. {
  351. return JsonNode(ResourceID(path, EResType::TEXT));
  352. }
  353. // Probably new install. Create initial configuration
  354. CResourceHandler::get("local")->createResource(path);
  355. return JsonNode();
  356. }
  357. JsonNode addMeta(JsonNode config, std::string meta)
  358. {
  359. config.setMeta(meta);
  360. return std::move(config);
  361. }
  362. CModInfo::CModInfo(std::string identifier,const JsonNode & local, const JsonNode & config):
  363. identifier(identifier),
  364. name(config["name"].String()),
  365. description(config["description"].String()),
  366. dependencies(config["depends"].convertTo<std::set<std::string> >()),
  367. conflicts(config["conflicts"].convertTo<std::set<std::string> >()),
  368. validation(PENDING),
  369. config(addMeta(config, identifier))
  370. {
  371. loadLocalData(local);
  372. }
  373. JsonNode CModInfo::saveLocalData() const
  374. {
  375. std::ostringstream stream;
  376. stream << std::noshowbase << std::hex << std::setw(8) << std::setfill('0') << checksum;
  377. JsonNode conf;
  378. conf["active"].Bool() = enabled;
  379. conf["validated"].Bool() = validation != FAILED;
  380. conf["checksum"].String() = stream.str();
  381. return conf;
  382. }
  383. std::string CModInfo::getModDir(std::string name)
  384. {
  385. return "MODS/" + boost::algorithm::replace_all_copy(name, ".", "/MODS/");
  386. }
  387. std::string CModInfo::getModFile(std::string name)
  388. {
  389. return getModDir(name) + "/mod.json";
  390. }
  391. void CModInfo::updateChecksum(ui32 newChecksum)
  392. {
  393. // comment-out next line to force validation of all mods ignoring checksum
  394. if (newChecksum != checksum)
  395. {
  396. checksum = newChecksum;
  397. validation = PENDING;
  398. }
  399. }
  400. void CModInfo::loadLocalData(const JsonNode & data)
  401. {
  402. bool validated = false;
  403. enabled = true;
  404. checksum = 0;
  405. if (data.getType() == JsonNode::DATA_BOOL)
  406. {
  407. enabled = data.Bool();
  408. }
  409. if (data.getType() == JsonNode::DATA_STRUCT)
  410. {
  411. enabled = data["active"].Bool();
  412. validated = data["validated"].Bool();
  413. checksum = strtol(data["checksum"].String().c_str(), nullptr, 16);
  414. }
  415. if (enabled)
  416. validation = validated ? PASSED : PENDING;
  417. else
  418. validation = validated ? PASSED : FAILED;
  419. }
  420. CModHandler::CModHandler()
  421. {
  422. for (int i = 0; i < GameConstants::RESOURCE_QUANTITY; ++i)
  423. {
  424. identifiers.registerObject("core", "resource", GameConstants::RESOURCE_NAMES[i], i);
  425. }
  426. for(int i=0; i<GameConstants::PRIMARY_SKILLS; ++i)
  427. identifiers.registerObject("core", "primSkill", PrimarySkill::names[i], i);
  428. }
  429. void CModHandler::loadConfigFromFile (std::string name)
  430. {
  431. settings.data = JsonUtils::assembleFromFiles("config/" + name);
  432. const JsonNode & hardcodedFeatures = settings.data["hardcodedFeatures"];
  433. settings.MAX_HEROES_AVAILABLE_PER_PLAYER = hardcodedFeatures["MAX_HEROES_AVAILABLE_PER_PLAYER"].Float();
  434. settings.MAX_HEROES_ON_MAP_PER_PLAYER = hardcodedFeatures["MAX_HEROES_ON_MAP_PER_PLAYER"].Float();
  435. settings.CREEP_SIZE = hardcodedFeatures["CREEP_SIZE"].Float();
  436. settings.WEEKLY_GROWTH = hardcodedFeatures["WEEKLY_GROWTH_PERCENT"].Float();
  437. settings.NEUTRAL_STACK_EXP = hardcodedFeatures["NEUTRAL_STACK_EXP_DAILY"].Float();
  438. settings.MAX_BUILDING_PER_TURN = hardcodedFeatures["MAX_BUILDING_PER_TURN"].Float();
  439. settings.DWELLINGS_ACCUMULATE_CREATURES = hardcodedFeatures["DWELLINGS_ACCUMULATE_CREATURES"].Bool();
  440. settings.ALL_CREATURES_GET_DOUBLE_MONTHS = hardcodedFeatures["ALL_CREATURES_GET_DOUBLE_MONTHS"].Bool();
  441. const JsonNode & gameModules = settings.data["modules"];
  442. modules.STACK_EXP = gameModules["STACK_EXPERIENCE"].Bool();
  443. modules.STACK_ARTIFACT = gameModules["STACK_ARTIFACTS"].Bool();
  444. modules.COMMANDERS = gameModules["COMMANDERS"].Bool();
  445. modules.MITHRIL = gameModules["MITHRIL"].Bool();
  446. }
  447. // currentList is passed by value to get current list of depending mods
  448. bool CModHandler::hasCircularDependency(TModID modID, std::set <TModID> currentList) const
  449. {
  450. const CModInfo & mod = allMods.at(modID);
  451. // Mod already present? We found a loop
  452. if (vstd::contains(currentList, modID))
  453. {
  454. logGlobal->errorStream() << "Error: Circular dependency detected! Printing dependency list:";
  455. logGlobal->errorStream() << "\t" << mod.name << " -> ";
  456. return true;
  457. }
  458. currentList.insert(modID);
  459. // recursively check every dependency of this mod
  460. for(const TModID & dependency : mod.dependencies)
  461. {
  462. if (hasCircularDependency(dependency, currentList))
  463. {
  464. logGlobal->errorStream() << "\t" << mod.name << " ->\n"; // conflict detected, print dependency list
  465. return true;
  466. }
  467. }
  468. return false;
  469. }
  470. bool CModHandler::checkDependencies(const std::vector <TModID> & input) const
  471. {
  472. for(const TModID & id : input)
  473. {
  474. const CModInfo & mod = allMods.at(id);
  475. for(const TModID & dep : mod.dependencies)
  476. {
  477. if (!vstd::contains(input, dep))
  478. {
  479. logGlobal->errorStream() << "Error: Mod " << mod.name << " requires missing " << dep << "!";
  480. return false;
  481. }
  482. }
  483. for(const TModID & conflicting : mod.conflicts)
  484. {
  485. if (vstd::contains(input, conflicting))
  486. {
  487. logGlobal->errorStream() << "Error: Mod " << mod.name << " conflicts with " << allMods.at(conflicting).name << "!";
  488. return false;
  489. }
  490. }
  491. if (hasCircularDependency(id))
  492. return false;
  493. }
  494. return true;
  495. }
  496. std::vector <TModID> CModHandler::resolveDependencies(std::vector <TModID> input) const
  497. {
  498. // Topological sort algorithm
  499. // May not be the fastest one but VCMI does not needs any speed here
  500. // Unless user have dozens of mods with complex dependencies this code should be fine
  501. // first - sort input to have input strictly based on name (and not on hashmap or anything else)
  502. boost::range::sort(input);
  503. std::vector <TModID> output;
  504. output.reserve(input.size());
  505. std::set <TModID> resolvedMods;
  506. // Check if all mod dependencies are resolved (moved to resolvedMods)
  507. auto isResolved = [&](const CModInfo mod) -> bool
  508. {
  509. for(const TModID & dependency : mod.dependencies)
  510. {
  511. if (!vstd::contains(resolvedMods, dependency))
  512. return false;
  513. }
  514. return true;
  515. };
  516. while (!input.empty())
  517. {
  518. std::set <TModID> toResolve; // list of mods resolved on this iteration
  519. for (auto it = input.begin(); it != input.end();)
  520. {
  521. if (isResolved(allMods.at(*it)))
  522. {
  523. toResolve.insert(*it);
  524. output.push_back(*it);
  525. it = input.erase(it);
  526. continue;
  527. }
  528. it++;
  529. }
  530. resolvedMods.insert(toResolve.begin(), toResolve.end());
  531. }
  532. return output;
  533. }
  534. std::vector<std::string> CModHandler::getModList(std::string path)
  535. {
  536. std::string modDir = boost::to_upper_copy(path + "MODS/");
  537. size_t depth = boost::range::count(modDir, '/');
  538. auto list = CResourceHandler::get("initial")->getFilteredFiles([&](const ResourceID & id) -> bool
  539. {
  540. if (id.getType() != EResType::DIRECTORY)
  541. return false;
  542. if (!boost::algorithm::starts_with(id.getName(), modDir))
  543. return false;
  544. if (boost::range::count(id.getName(), '/') != depth )
  545. return false;
  546. return true;
  547. });
  548. //storage for found mods
  549. std::vector<std::string> foundMods;
  550. for (auto & entry : list)
  551. {
  552. std::string name = entry.getName();
  553. name.erase(0, modDir.size()); //Remove path prefix
  554. // check if wog is actually present. Hack-ish but better than crash
  555. // TODO: remove soon (hopefully - before 0.96)
  556. if (name == "WOG")
  557. {
  558. if (!CResourceHandler::get("initial")->existsResource(ResourceID("DATA/ZVS", EResType::DIRECTORY)) &&
  559. !CResourceHandler::get("initial")->existsResource(ResourceID("MODS/WOG/DATA/ZVS", EResType::DIRECTORY)))
  560. {
  561. continue;
  562. }
  563. }
  564. if (!name.empty())
  565. foundMods.push_back(name);
  566. }
  567. return foundMods;
  568. }
  569. void CModHandler::loadMods(std::string path, std::string parent, const JsonNode & modSettings, bool enableMods)
  570. {
  571. for (std::string modName : getModList(path))
  572. {
  573. boost::to_lower(modName);
  574. std::string modFullName = parent.empty() ? modName : parent + '.' + modName;
  575. if (CResourceHandler::get("initial")->existsResource(ResourceID(CModInfo::getModFile(modFullName))))
  576. {
  577. CModInfo mod(modFullName, modSettings[modName], JsonNode(ResourceID(CModInfo::getModFile(modFullName))));
  578. if (!parent.empty()) // this is submod, add parent to dependecies
  579. mod.dependencies.insert(parent);
  580. allMods[modFullName] = mod;
  581. if (mod.enabled && enableMods)
  582. activeMods.push_back(modFullName);
  583. loadMods(CModInfo::getModDir(modFullName) + '/', modFullName, modSettings[modName]["mods"], enableMods && mod.enabled);
  584. }
  585. }
  586. }
  587. void CModHandler::loadMods()
  588. {
  589. const JsonNode modConfig = loadModSettings("config/modSettings.json");
  590. loadMods("", "", modConfig["activeMods"], true);
  591. coreMod = CModInfo("core", modConfig["core"], JsonNode(ResourceID("config/gameConfig.json")));
  592. coreMod.name = "Original game files";
  593. }
  594. std::vector<std::string> CModHandler::getAllMods()
  595. {
  596. std::vector<std::string> modlist;
  597. for (auto & entry : allMods)
  598. modlist.push_back(entry.first);
  599. return modlist;
  600. }
  601. std::vector<std::string> CModHandler::getActiveMods()
  602. {
  603. return activeMods;
  604. }
  605. static JsonNode genDefaultFS()
  606. {
  607. // default FS config for mods: directory "Content" that acts as H3 root directory
  608. JsonNode defaultFS;
  609. defaultFS[""].Vector().resize(2);
  610. defaultFS[""].Vector()[0]["type"].String() = "zip";
  611. defaultFS[""].Vector()[0]["path"].String() = "/Content.zip";
  612. defaultFS[""].Vector()[1]["type"].String() = "dir";
  613. defaultFS[""].Vector()[1]["path"].String() = "/Content";
  614. return defaultFS;
  615. }
  616. static ISimpleResourceLoader * genModFilesystem(const std::string & modName, const JsonNode & conf)
  617. {
  618. static const JsonNode defaultFS = genDefaultFS();
  619. if (!conf["filesystem"].isNull())
  620. return CResourceHandler::createFileSystem(CModInfo::getModDir(modName), conf["filesystem"]);
  621. else
  622. return CResourceHandler::createFileSystem(CModInfo::getModDir(modName), defaultFS);
  623. }
  624. static ui32 calculateModChecksum(const std::string modName, ISimpleResourceLoader * filesystem)
  625. {
  626. boost::crc_32_type modChecksum;
  627. // first - add current VCMI version into checksum to force re-validation on VCMI updates
  628. modChecksum.process_bytes(reinterpret_cast<const void*>(GameConstants::VCMI_VERSION.data()), GameConstants::VCMI_VERSION.size());
  629. // second - add mod.json into checksum because filesystem does not contains this file
  630. // FIXME: remove workaround for core mod
  631. if (modName != "core")
  632. {
  633. ResourceID modConfFile(CModInfo::getModFile(modName), EResType::TEXT);
  634. ui32 configChecksum = CResourceHandler::get("initial")->load(modConfFile)->calculateCRC32();
  635. modChecksum.process_bytes(reinterpret_cast<const void *>(&configChecksum), sizeof(configChecksum));
  636. }
  637. // third - add all detected text files from this mod into checksum
  638. auto files = filesystem->getFilteredFiles([](const ResourceID & resID)
  639. {
  640. return resID.getType() == EResType::TEXT &&
  641. ( boost::starts_with(resID.getName(), "DATA") ||
  642. boost::starts_with(resID.getName(), "CONFIG"));
  643. });
  644. for (const ResourceID & file : files)
  645. {
  646. ui32 fileChecksum = filesystem->load(file)->calculateCRC32();
  647. modChecksum.process_bytes(reinterpret_cast<const void *>(&fileChecksum), sizeof(fileChecksum));
  648. }
  649. return modChecksum.checksum();
  650. }
  651. void CModHandler::loadModFilesystems()
  652. {
  653. activeMods = resolveDependencies(activeMods);
  654. coreMod.updateChecksum(calculateModChecksum("core", CResourceHandler::get("core")));
  655. for(std::string & modName : activeMods)
  656. {
  657. CModInfo & mod = allMods[modName];
  658. CResourceHandler::addFilesystem("data", modName, genModFilesystem(modName, mod.config));
  659. }
  660. }
  661. CModInfo & CModHandler::getModData(TModID modId)
  662. {
  663. CModInfo & mod = allMods.at(modId);
  664. assert(vstd::contains(activeMods, modId)); // not really necessary but won't hurt
  665. return mod;
  666. }
  667. void CModHandler::initializeConfig()
  668. {
  669. loadConfigFromFile("defaultMods.json");
  670. }
  671. void CModHandler::load()
  672. {
  673. CStopWatch totalTime, timer;
  674. CContentHandler content;
  675. logGlobal->infoStream() << "\tInitializing content handler: " << timer.getDiff() << " ms";
  676. for(const TModID & modName : activeMods)
  677. {
  678. logGlobal->traceStream() << "Generating checksum for " << modName;
  679. allMods[modName].updateChecksum(calculateModChecksum(modName, CResourceHandler::get(modName)));
  680. }
  681. // first - load virtual "core" mod that contains all data
  682. // TODO? move all data into real mods? RoE, AB, SoD, WoG
  683. content.preloadData(coreMod);
  684. for(const TModID & modName : activeMods)
  685. content.preloadData(allMods[modName]);
  686. logGlobal->infoStream() << "\tParsing mod data: " << timer.getDiff() << " ms";
  687. content.load(coreMod);
  688. for(const TModID & modName : activeMods)
  689. content.load(allMods[modName]);
  690. logGlobal->infoStream() << "\tLoading mod data: " << timer.getDiff() << "ms";
  691. VLC->creh->loadCrExpBon();
  692. VLC->creh->buildBonusTreeForTiers(); //do that after all new creatures are loaded
  693. identifiers.finalize();
  694. logGlobal->infoStream() << "\tResolving identifiers: " << timer.getDiff() << " ms";
  695. content.afterLoadFinalization();
  696. logGlobal->infoStream() << "\tHandlers post-load finalization: " << timer.getDiff() << " ms";
  697. logGlobal->infoStream() << "\tAll game content loaded in " << totalTime.getDiff() << " ms";
  698. }
  699. void CModHandler::afterLoad()
  700. {
  701. JsonNode modSettings;
  702. for (auto & modEntry : allMods)
  703. {
  704. std::string pointer = "/" + boost::algorithm::replace_all_copy(modEntry.first, ".", "/mods/");
  705. modSettings["activeMods"].resolvePointer(pointer) = modEntry.second.saveLocalData();
  706. }
  707. modSettings["core"] = coreMod.saveLocalData();
  708. std::ofstream file(*CResourceHandler::get()->getResourceName(ResourceID("config/modSettings.json")), std::ofstream::trunc);
  709. file << modSettings;
  710. }