VCMIDirs.cpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711
  1. /*
  2. * VCMIDirs.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 "VCMIDirs.h"
  12. #ifdef VCMI_IOS
  13. #include "iOS_utils.h"
  14. #endif
  15. VCMI_LIB_NAMESPACE_BEGIN
  16. namespace bfs = boost::filesystem;
  17. bfs::path IVCMIDirs::userLogsPath() const { return userCachePath(); }
  18. bfs::path IVCMIDirs::userSavePath() const { return userDataPath() / "Saves"; }
  19. bfs::path IVCMIDirs::fullLibraryPath(const std::string &desiredFolder, const std::string &baseLibName) const
  20. {
  21. return libraryPath() / desiredFolder / libraryName(baseLibName);
  22. }
  23. std::string IVCMIDirs::genHelpString() const
  24. {
  25. std::vector<std::string> tempVec;
  26. for (const bfs::path & path : dataPaths())
  27. tempVec.push_back(path.string());
  28. const auto gdStringA = boost::algorithm::join(tempVec, ":");
  29. return
  30. " game data: " + gdStringA + "\n"
  31. " libraries: " + libraryPath().string() + "\n"
  32. " server: " + serverPath().string() + "\n"
  33. "\n"
  34. " user data: " + userDataPath().string() + "\n"
  35. " user cache: " + userCachePath().string() + "\n"
  36. " user config: " + userConfigPath().string() + "\n"
  37. " user logs: " + userLogsPath().string() + "\n"
  38. " user saves: " + userSavePath().string() + "\n"; // Should end without new-line?
  39. }
  40. void IVCMIDirs::init()
  41. {
  42. // TODO: Log errors
  43. bfs::create_directories(userDataPath());
  44. bfs::create_directories(userCachePath());
  45. bfs::create_directories(userConfigPath());
  46. bfs::create_directories(userLogsPath());
  47. bfs::create_directories(userSavePath());
  48. }
  49. #ifdef VCMI_ANDROID
  50. #include "CAndroidVMHelper.h"
  51. #endif
  52. #ifdef VCMI_WINDOWS
  53. #ifdef __MINGW32__
  54. #define _WIN32_IE 0x0500
  55. #ifndef CSIDL_MYDOCUMENTS
  56. #define CSIDL_MYDOCUMENTS CSIDL_PERSONAL
  57. #endif
  58. #endif // __MINGW32__
  59. #include <windows.h>
  60. #include <shlobj.h>
  61. #include <shellapi.h>
  62. // Generates script file named _temp.bat in 'to' directory and runs it
  63. // Script will:
  64. // - Wait util 'exeName' ends.
  65. // - Copy all files from 'from' to 'to'
  66. // - Ask user to replace files existed in 'to'.
  67. // - Run 'exeName'
  68. // - Delete itself.
  69. bool StartBatchCopyDataProgram(
  70. const bfs::path& from, const bfs::path& to, const bfs::path& exeName,
  71. const bfs::path& currentPath = bfs::current_path())
  72. {
  73. static const char base[] =
  74. "@echo off" "\n"
  75. "echo Preparing to move VCMI data system." "\n"
  76. ":CLIENT_RUNNING_LOOP" "\n"
  77. "TASKLIST | FIND /I %1% > nul" "\n"
  78. "IF ERRORLEVEL 1 (" "\n"
  79. "GOTO CLIENT_NOT_RUNNING" "\n"
  80. ") ELSE (" "\n"
  81. "echo %1% is still running..." "\n"
  82. "echo Waiting until process ends..." "\n"
  83. "ping 1.1.1.1 -n 1 -w 3000 > nul" "\n" // Sleep ~3 seconds. I love Windows :)
  84. "goto :CLIENT_RUNNING_LOOP" "\n"
  85. ")" "\n"
  86. ":CLIENT_NOT_RUNNING" "\n"
  87. "echo %1% turned off..." "\n"
  88. "echo Attempt to move datas." "\n"
  89. "echo From: %2%" "\n"
  90. "echo To: %4%" "\n"
  91. "echo Please resolve any conflicts..." "\n"
  92. "move /-Y %3% %4%" "\n" // Move all files from %3% to %4%.
  93. // /-Y ask what to do when file exists in %4%
  94. ":REMOVE_OLD_DIR" "\n"
  95. "rd %2% || rem" "\n" // Remove empty directory. Sets error flag if fail.
  96. "IF ERRORLEVEL 145 (" "\n" // Directory not empty
  97. "echo Directory %2% is not empty." "\n"
  98. "echo Please move rest of files manually now." "\n"
  99. "pause" "\n" // Press any key to continue...
  100. "goto REMOVE_OLD_DIR" "\n"
  101. ")" "\n"
  102. "echo Game data updated succefully." "\n"
  103. "echo Please update your shortcuts." "\n"
  104. "echo Press any key to start a game . . ." "\n"
  105. "pause > nul" "\n"
  106. "%5%" "\n"
  107. "del \"%%~f0\"&exit" "\n" // Script deletes itself
  108. ;
  109. const auto startGameString =
  110. bfs::equivalent(currentPath, from) ?
  111. (boost::format("start \"\" %1%") % (to / exeName)) : // Start game in new path.
  112. (boost::format("start \"\" /D %1% %2%") % currentPath % (to / exeName)); // Start game in 'currentPath"
  113. const bfs::path bathFilename = to / "_temp.bat";
  114. bfs::ofstream bathFile(bathFilename, bfs::ofstream::trunc | bfs::ofstream::out);
  115. if (!bathFile.is_open())
  116. return false;
  117. bathFile << (boost::format(base) % exeName % from % (from / "*.*") % to % startGameString.str()).str();
  118. bathFile.close();
  119. std::system(("start \"Updating VCMI datas\" /D \"" + to.string() + "\" \"" + bathFilename.string() + '\"').c_str());
  120. // start won't block std::system
  121. // /D start bat in other directory insteand of current directory.
  122. return true;
  123. }
  124. class VCMIDirsWIN32 final : public IVCMIDirs
  125. {
  126. public:
  127. boost::filesystem::path userDataPath() const override;
  128. boost::filesystem::path userCachePath() const override;
  129. boost::filesystem::path userConfigPath() const override;
  130. std::vector<boost::filesystem::path> dataPaths() const override;
  131. boost::filesystem::path clientPath() const override;
  132. boost::filesystem::path serverPath() const override;
  133. boost::filesystem::path libraryPath() const override;
  134. boost::filesystem::path binaryPath() const override;
  135. std::string libraryName(const std::string& basename) const override;
  136. void init() override;
  137. protected:
  138. boost::filesystem::path oldUserDataPath() const;
  139. boost::filesystem::path oldUserSavePath() const;
  140. };
  141. void VCMIDirsWIN32::init()
  142. {
  143. std::locale::global(boost::locale::generator().generate("en_US.UTF-8"));
  144. boost::filesystem::path::imbue(std::locale());
  145. // Call base (init dirs)
  146. IVCMIDirs::init();
  147. // Moves one directory (from) contents to another directory (to)
  148. // Shows user the "moving file dialog" and ask to resolve conflits.
  149. // If necessary updates current directory.
  150. auto moveDirIfExists = [](const bfs::path& from, const bfs::path& to) -> bool
  151. {
  152. if (!bfs::is_directory(from))
  153. return true; // Nothing to do here. Flies away.
  154. if (bfs::is_empty(from))
  155. {
  156. if (bfs::current_path() == from)
  157. bfs::current_path(to);
  158. bfs::remove(from);
  159. return true; // Nothing to do here. Flies away.
  160. }
  161. if (!bfs::is_directory(to))
  162. {
  163. // IVCMIDirs::init() should create all destination directories.
  164. // TODO: Log fact, that we shouldn't be here.
  165. bfs::create_directories(to);
  166. }
  167. // Why the hell path strings should be end with double null :/
  168. auto makeDoubleNulled = [](const bfs::path& path) -> std::unique_ptr<wchar_t[]>
  169. {
  170. const std::wstring& pathStr = path.native();
  171. std::unique_ptr<wchar_t[]> result(new wchar_t[pathStr.length() + 2]);
  172. size_t i = 0;
  173. for (const wchar_t ch : pathStr)
  174. result[i++] = ch;
  175. result[i++] = L'\0';
  176. result[i++] = L'\0';
  177. return result;
  178. };
  179. auto fromDNulled = makeDoubleNulled(from / L"*.*");
  180. auto toDNulled = makeDoubleNulled(to);
  181. SHFILEOPSTRUCTW fileOp;
  182. fileOp.hwnd = GetConsoleWindow();
  183. fileOp.wFunc = FO_MOVE;
  184. fileOp.pFrom = fromDNulled.get();
  185. fileOp.pTo = toDNulled.get();
  186. fileOp.fFlags = 0;
  187. fileOp.hNameMappings = nullptr;
  188. fileOp.lpszProgressTitle = nullptr;
  189. const int errorCode = SHFileOperationW(&fileOp);
  190. if (errorCode != 0) // TODO: Log error. User should try to move files.
  191. return false;
  192. else if (fileOp.fAnyOperationsAborted) // TODO: Log warn. User aborted operation. User should move files.
  193. return false;
  194. else if (!bfs::is_empty(from)) // TODO: Log warn. Some files not moved. User should try to move files.
  195. return false;
  196. if (bfs::current_path() == from)
  197. bfs::current_path(to);
  198. // TODO: Log fact that we moved files succefully.
  199. bfs::remove(from);
  200. return true;
  201. };
  202. // Retrieves the fully qualified path for the file that contains the specified module.
  203. // The module must have been loaded by the current process.
  204. // If this parameter is nullptr, retrieves the path of the executable file of the current process.
  205. auto getModulePath = [](HMODULE hModule) -> bfs::path
  206. {
  207. wchar_t exePathW[MAX_PATH];
  208. DWORD nSize = GetModuleFileNameW(hModule, exePathW, MAX_PATH);
  209. DWORD error = GetLastError();
  210. // WARN: Windows XP don't set ERROR_INSUFFICIENT_BUFFER error.
  211. if (nSize != 0 && error != ERROR_INSUFFICIENT_BUFFER)
  212. return bfs::path(std::wstring(exePathW, nSize));
  213. // TODO: Error handling
  214. return bfs::path();
  215. };
  216. // Moves one directory contents to another directory
  217. // Shows user the "moving file dialog" and ask to resolve conflicts.
  218. // It takes into account that 'from' path can contain current executable.
  219. // If necessary closes program and starts update script.
  220. auto advancedMoveDirIfExists = [getModulePath, moveDirIfExists](const bfs::path& from, const bfs::path& to) -> bool
  221. {
  222. const bfs::path executablePath = getModulePath(nullptr);
  223. // VCMI cann't determine executable path.
  224. // Use standard way to move directory and exit function.
  225. if (executablePath.empty())
  226. return moveDirIfExists(from, to);
  227. const bfs::path executableName = executablePath.filename();
  228. // Current executabl isn't in 'from' path.
  229. // Use standard way to move directory and exit function.
  230. if (!bfs::equivalent(executablePath, from / executableName))
  231. return moveDirIfExists(from, to);
  232. // Try standard way to move directory.
  233. // I don't know how other systems, but Windows 8.1 allow to move running executable.
  234. if (moveDirIfExists(from, to))
  235. return true;
  236. // Start copying script and exit program.
  237. if (StartBatchCopyDataProgram(from, to, executableName))
  238. exit(ERROR_SUCCESS);
  239. // Everything failed :C
  240. return false;
  241. };
  242. moveDirIfExists(oldUserSavePath(), userSavePath());
  243. advancedMoveDirIfExists(oldUserDataPath(), userDataPath());
  244. }
  245. bfs::path VCMIDirsWIN32::userDataPath() const
  246. {
  247. wchar_t profileDir[MAX_PATH];
  248. if (SHGetSpecialFolderPathW(nullptr, profileDir, CSIDL_MYDOCUMENTS, FALSE) != FALSE)
  249. return bfs::path(profileDir) / "My Games" / "vcmi";
  250. return ".";
  251. }
  252. bfs::path VCMIDirsWIN32::oldUserDataPath() const
  253. {
  254. wchar_t profileDir[MAX_PATH];
  255. if (SHGetSpecialFolderPathW(nullptr, profileDir, CSIDL_PROFILE, FALSE) == FALSE) // WinAPI way failed
  256. {
  257. #if defined(_MSC_VER) && _MSC_VER >= 1700
  258. wchar_t* buffer;
  259. size_t bufferSize;
  260. errno_t result = _wdupenv_s(&buffer, &bufferSize, L"userprofile");
  261. if (result == 0)
  262. {
  263. bfs::path result(std::wstring(buffer, bufferSize));
  264. free(buffer);
  265. return result;
  266. }
  267. #else
  268. const char* profileDirA;
  269. if ((profileDirA = std::getenv("userprofile"))) // STL way succeed
  270. return bfs::path(profileDirA) / "vcmi";
  271. #endif
  272. else
  273. return "."; // Every thing failed, return current directory.
  274. }
  275. else
  276. return bfs::path(profileDir) / "vcmi";
  277. //return dataPaths()[0] ???;
  278. }
  279. bfs::path VCMIDirsWIN32::oldUserSavePath() const { return userDataPath() / "Games"; }
  280. bfs::path VCMIDirsWIN32::userCachePath() const { return userDataPath(); }
  281. bfs::path VCMIDirsWIN32::userConfigPath() const { return userDataPath() / "config"; }
  282. std::vector<bfs::path> VCMIDirsWIN32::dataPaths() const
  283. {
  284. return std::vector<bfs::path>(1, bfs::path("."));
  285. }
  286. bfs::path VCMIDirsWIN32::clientPath() const { return binaryPath() / "VCMI_client.exe"; }
  287. bfs::path VCMIDirsWIN32::serverPath() const { return binaryPath() / "VCMI_server.exe"; }
  288. bfs::path VCMIDirsWIN32::libraryPath() const { return "."; }
  289. bfs::path VCMIDirsWIN32::binaryPath() const { return "."; }
  290. std::string VCMIDirsWIN32::libraryName(const std::string& basename) const { return basename + ".dll"; }
  291. #elif defined(VCMI_UNIX)
  292. class IVCMIDirsUNIX : public IVCMIDirs
  293. {
  294. public:
  295. boost::filesystem::path clientPath() const override;
  296. boost::filesystem::path serverPath() const override;
  297. virtual bool developmentMode() const;
  298. };
  299. bool IVCMIDirsUNIX::developmentMode() const
  300. {
  301. // We want to be able to run VCMI from single directory. E.g to run from build output directory
  302. return bfs::exists("AI") && bfs::exists("config") && bfs::exists("Mods") && bfs::exists("vcmiserver") && bfs::exists("vcmiclient");
  303. }
  304. bfs::path IVCMIDirsUNIX::clientPath() const { return binaryPath() / "vcmiclient"; }
  305. bfs::path IVCMIDirsUNIX::serverPath() const { return binaryPath() / "vcmiserver"; }
  306. #ifdef VCMI_APPLE
  307. class VCMIDirsApple : public IVCMIDirsUNIX
  308. {
  309. public:
  310. bfs::path userConfigPath() const override;
  311. std::string libraryName(const std::string& basename) const override;
  312. };
  313. bfs::path VCMIDirsApple::userConfigPath() const { return userDataPath() / "config"; }
  314. std::string VCMIDirsApple::libraryName(const std::string& basename) const { return "lib" + basename + ".dylib"; }
  315. #ifdef VCMI_IOS
  316. class VCMIDirsIOS final : public VCMIDirsApple
  317. {
  318. public:
  319. bfs::path userDataPath() const override;
  320. bfs::path userCachePath() const override;
  321. bfs::path userLogsPath() const override;
  322. std::vector<bfs::path> dataPaths() const override;
  323. bfs::path libraryPath() const override;
  324. bfs::path fullLibraryPath(const std::string & desiredFolder, const std::string & baseLibName) const override;
  325. bfs::path binaryPath() const override;
  326. };
  327. bfs::path VCMIDirsIOS::userDataPath() const { return {iOS_utils::documentsPath()}; }
  328. bfs::path VCMIDirsIOS::userCachePath() const { return {iOS_utils::cachesPath()}; }
  329. bfs::path VCMIDirsIOS::userLogsPath() const { return {iOS_utils::documentsPath()}; }
  330. std::vector<bfs::path> VCMIDirsIOS::dataPaths() const
  331. {
  332. std::vector<bfs::path> paths;
  333. paths.reserve(4);
  334. #ifdef VCMI_IOS_SIM
  335. paths.emplace_back(iOS_utils::hostApplicationSupportPath());
  336. #endif
  337. paths.emplace_back(userDataPath());
  338. paths.emplace_back(iOS_utils::documentsPath());
  339. paths.emplace_back(binaryPath());
  340. return paths;
  341. }
  342. bfs::path VCMIDirsIOS::fullLibraryPath(const std::string & desiredFolder, const std::string & baseLibName) const
  343. {
  344. // iOS has flat libs directory structure
  345. return libraryPath() / libraryName(baseLibName);
  346. }
  347. bfs::path VCMIDirsIOS::libraryPath() const { return {iOS_utils::frameworksPath()}; }
  348. bfs::path VCMIDirsIOS::binaryPath() const { return {iOS_utils::bundlePath()}; }
  349. #elif defined(VCMI_MAC)
  350. class VCMIDirsOSX final : public VCMIDirsApple
  351. {
  352. public:
  353. boost::filesystem::path userDataPath() const override;
  354. boost::filesystem::path userCachePath() const override;
  355. boost::filesystem::path userLogsPath() const override;
  356. std::vector<boost::filesystem::path> dataPaths() const override;
  357. boost::filesystem::path libraryPath() const override;
  358. boost::filesystem::path binaryPath() const override;
  359. void init() override;
  360. };
  361. void VCMIDirsOSX::init()
  362. {
  363. // Call base (init dirs)
  364. IVCMIDirsUNIX::init();
  365. auto moveDirIfExists = [](const bfs::path& from, const bfs::path& to)
  366. {
  367. if (!bfs::is_directory(from))
  368. return; // Nothing to do here. Flies away.
  369. if (bfs::is_empty(from))
  370. {
  371. bfs::remove(from);
  372. return; // Nothing to do here. Flies away.
  373. }
  374. if (!bfs::is_directory(to))
  375. {
  376. // IVCMIDirs::init() should create all destination directories.
  377. // TODO: Log fact, that we shouldn't be here.
  378. bfs::create_directories(to);
  379. }
  380. for (bfs::directory_iterator file(from); file != bfs::directory_iterator(); ++file)
  381. {
  382. const boost::filesystem::path& srcFilePath = file->path();
  383. const boost::filesystem::path dstFilePath = to / srcFilePath.filename();
  384. // TODO: Aplication should ask user what to do when file exists:
  385. // replace/ignore/stop process/replace all/ignore all
  386. if (!boost::filesystem::exists(dstFilePath))
  387. bfs::rename(srcFilePath, dstFilePath);
  388. }
  389. if (!bfs::is_empty(from)); // TODO: Log warn. Some files not moved. User should try to move files.
  390. else
  391. bfs::remove(from);
  392. };
  393. moveDirIfExists(userDataPath() / "Games", userSavePath());
  394. }
  395. bfs::path VCMIDirsOSX::userDataPath() const
  396. {
  397. // This is Cocoa code that should be normally used to get path to Application Support folder but can't use it here for now...
  398. // NSArray* urls = [[NSFileManager defaultManager] URLsForDirectory:NSApplicationSupportDirectory inDomains:NSUserDomainMask];
  399. // UserPath = path([urls[0] path] + "/vcmi").string();
  400. // ...so here goes a bit of hardcode instead
  401. const char* homeDir = getenv("HOME"); // Should be std::getenv?
  402. if (homeDir == nullptr)
  403. homeDir = ".";
  404. return bfs::path(homeDir) / "Library" / "Application Support" / "vcmi";
  405. }
  406. bfs::path VCMIDirsOSX::userCachePath() const { return userDataPath(); }
  407. bfs::path VCMIDirsOSX::userLogsPath() const
  408. {
  409. // TODO: use proper objc code from Foundation framework
  410. if(const auto homeDir = std::getenv("HOME"))
  411. return bfs::path{homeDir} / "Library" / "Logs" / "vcmi";
  412. return IVCMIDirsUNIX::userLogsPath();
  413. }
  414. std::vector<bfs::path> VCMIDirsOSX::dataPaths() const
  415. {
  416. std::vector<bfs::path> ret;
  417. //FIXME: need some proper codepath for detecting running from build output directory
  418. if(developmentMode())
  419. {
  420. ret.push_back(".");
  421. }
  422. else
  423. {
  424. ret.push_back("../Resources/Data");
  425. }
  426. return ret;
  427. }
  428. bfs::path VCMIDirsOSX::libraryPath() const { return "."; }
  429. bfs::path VCMIDirsOSX::binaryPath() const { return "."; }
  430. #endif // VCMI_IOS, VCMI_MAC
  431. #elif defined(VCMI_XDG)
  432. class VCMIDirsXDG : public IVCMIDirsUNIX
  433. {
  434. public:
  435. boost::filesystem::path userDataPath() const override;
  436. boost::filesystem::path userCachePath() const override;
  437. boost::filesystem::path userConfigPath() const override;
  438. std::vector<boost::filesystem::path> dataPaths() const override;
  439. boost::filesystem::path libraryPath() const override;
  440. boost::filesystem::path binaryPath() const override;
  441. std::string libraryName(const std::string& basename) const override;
  442. };
  443. bfs::path VCMIDirsXDG::userDataPath() const
  444. {
  445. // $XDG_DATA_HOME, default: $HOME/.local/share
  446. const char* homeDir;
  447. if((homeDir = getenv("XDG_DATA_HOME")))
  448. return bfs::path(homeDir) / "vcmi";
  449. else if((homeDir = getenv("HOME")))
  450. return bfs::path(homeDir) / ".local" / "share" / "vcmi";
  451. else
  452. return ".";
  453. }
  454. bfs::path VCMIDirsXDG::userCachePath() const
  455. {
  456. // $XDG_CACHE_HOME, default: $HOME/.cache
  457. const char * tempResult;
  458. if ((tempResult = getenv("XDG_CACHE_HOME")))
  459. return bfs::path(tempResult) / "vcmi";
  460. else if ((tempResult = getenv("HOME")))
  461. return bfs::path(tempResult) / ".cache" / "vcmi";
  462. else
  463. return ".";
  464. }
  465. bfs::path VCMIDirsXDG::userConfigPath() const
  466. {
  467. // $XDG_CONFIG_HOME, default: $HOME/.config
  468. const char * tempResult;
  469. if ((tempResult = getenv("XDG_CONFIG_HOME")))
  470. return bfs::path(tempResult) / "vcmi";
  471. else if ((tempResult = getenv("HOME")))
  472. return bfs::path(tempResult) / ".config" / "vcmi";
  473. else
  474. return ".";
  475. }
  476. std::vector<bfs::path> VCMIDirsXDG::dataPaths() const
  477. {
  478. // $XDG_DATA_DIRS, default: /usr/local/share/:/usr/share/
  479. // construct list in reverse.
  480. // in specification first directory has highest priority
  481. // in vcmi fs last directory has highest priority
  482. std::vector<bfs::path> ret;
  483. if(developmentMode())
  484. {
  485. //For now we'll disable usage of system directories when VCMI running from bin directory
  486. ret.push_back(".");
  487. }
  488. else
  489. {
  490. ret.push_back(M_DATA_DIR);
  491. const char * tempResult;
  492. if((tempResult = getenv("XDG_DATA_DIRS")) != nullptr)
  493. {
  494. std::string dataDirsEnv = tempResult;
  495. std::vector<std::string> dataDirs;
  496. boost::split(dataDirs, dataDirsEnv, boost::is_any_of(":"));
  497. for (auto & entry : boost::adaptors::reverse(dataDirs))
  498. ret.push_back(bfs::path(entry) / "vcmi");
  499. }
  500. else
  501. {
  502. ret.push_back(bfs::path("/usr/share") / "vcmi");
  503. ret.push_back(bfs::path("/usr/local/share") / "vcmi");
  504. }
  505. // Debian and other distributions might want to use it while it's not part of XDG
  506. ret.push_back(bfs::path("/usr/share/games") / "vcmi");
  507. }
  508. return ret;
  509. }
  510. bfs::path VCMIDirsXDG::libraryPath() const
  511. {
  512. if(developmentMode())
  513. return ".";
  514. else
  515. return M_LIB_DIR;
  516. }
  517. bfs::path VCMIDirsXDG::binaryPath() const
  518. {
  519. if(developmentMode())
  520. return ".";
  521. else
  522. return M_BIN_DIR;
  523. }
  524. std::string VCMIDirsXDG::libraryName(const std::string& basename) const { return "lib" + basename + ".so"; }
  525. #ifdef VCMI_ANDROID
  526. class VCMIDirsAndroid : public VCMIDirsXDG
  527. {
  528. std::string basePath;
  529. std::string internalPath;
  530. std::string nativePath;
  531. public:
  532. bfs::path fullLibraryPath(const std::string & desiredFolder, const std::string & baseLibName) const override;
  533. bfs::path libraryPath() const override;
  534. bfs::path userDataPath() const override;
  535. bfs::path userCachePath() const override;
  536. bfs::path userConfigPath() const override;
  537. std::vector<bfs::path> dataPaths() const override;
  538. void init() override;
  539. };
  540. bfs::path VCMIDirsAndroid::libraryPath() const { return nativePath; }
  541. bfs::path VCMIDirsAndroid::userDataPath() const { return basePath; }
  542. bfs::path VCMIDirsAndroid::userCachePath() const { return userDataPath() / "cache"; }
  543. bfs::path VCMIDirsAndroid::userConfigPath() const { return userDataPath() / "config"; }
  544. bfs::path VCMIDirsAndroid::fullLibraryPath(const std::string & desiredFolder, const std::string & baseLibName) const
  545. {
  546. // ignore passed folder (all libraries in android are dumped into a single folder)
  547. return libraryPath() / libraryName(baseLibName);
  548. }
  549. std::vector<bfs::path> VCMIDirsAndroid::dataPaths() const
  550. {
  551. std::vector<bfs::path> paths(2);
  552. paths.push_back(internalPath);
  553. paths.push_back(userDataPath());
  554. return paths;
  555. }
  556. void VCMIDirsAndroid::init()
  557. {
  558. // asks java code to retrieve needed paths from environment
  559. CAndroidVMHelper envHelper;
  560. basePath = envHelper.callStaticStringMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "dataRoot");
  561. internalPath = envHelper.callStaticStringMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "internalDataRoot");
  562. nativePath = envHelper.callStaticStringMethod(CAndroidVMHelper::NATIVE_METHODS_DEFAULT_CLASS, "nativePath");
  563. IVCMIDirs::init();
  564. }
  565. #endif // VCMI_ANDROID
  566. #endif // VCMI_APPLE, VCMI_XDG
  567. #endif // VCMI_WINDOWS, VCMI_UNIX
  568. // Getters for interfaces are separated for clarity.
  569. namespace VCMIDirs
  570. {
  571. const IVCMIDirs& get()
  572. {
  573. #ifdef VCMI_WINDOWS
  574. static VCMIDirsWIN32 singleton;
  575. #elif defined(VCMI_ANDROID)
  576. static VCMIDirsAndroid singleton;
  577. #elif defined(VCMI_XDG)
  578. static VCMIDirsXDG singleton;
  579. #elif defined(VCMI_MAC)
  580. static VCMIDirsOSX singleton;
  581. #elif defined(VCMI_IOS)
  582. static VCMIDirsIOS singleton;
  583. #endif
  584. static bool initialized = false;
  585. if (!initialized)
  586. {
  587. singleton.init();
  588. initialized = true;
  589. }
  590. return singleton;
  591. }
  592. }
  593. VCMI_LIB_NAMESPACE_END