VCMIDirs.cpp 22 KB

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