blame: source/code/sago/platform_folders.cpp

/*

Its is under the MIT license, to encourage reuse by cut-and-paste.

The original files are hosted here: https://github.com/sago007/PlatformFolders

Copyright (c) 2015-2016 Poul Sander

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation files

(the "Software"), to deal in the Software without restriction,

including without limitation the rights to use, copy, modify, merge,

publish, distribute, sublicense, and/or sell copies of the Software,

and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

*/

#include "platform_folders.h"

#include <iostream>

#include <stdexcept>

#include <string.h>

#include <cstdio>

#include <cstdlib>

#if defined(_WIN32)

#include <windows.h>

#include <shlobj.h>

static std::string win32_utf16_to_utf8(const wchar_t* wstr) {

	std::string res;

	// If the 6th parameter is 0 then WideCharToMultiByte returns the number of bytes needed to store the result.

	int actualSize = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, NULL, 0, NULL, NULL);

	if (actualSize > 0) {

		//If the converted UTF-8 string could not be in the initial buffer. Allocate one that can hold it.

		std::vector<char> buffer(actualSize);

		actualSize = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, &buffer[0], buffer.size(), NULL, NULL);

		res = buffer.data();

	}

	if (actualSize == 0) {

		// WideCharToMultiByte return 0 for errors.

		const std::string errorMsg = "UTF16 to UTF8 failed with error code: " + GetLastError();

		throw std::runtime_error(errorMsg.c_str());

	}

	return res;

}

static std::string GetWindowsFolder(int folderId, const char* errorMsg) {

	wchar_t szPath[MAX_PATH];

	szPath[0] = 0;

	if ( !SUCCEEDED( SHGetFolderPathW( NULL, folderId, NULL, 0, szPath ) ) ) {

		throw std::runtime_error(errorMsg);

	}

	return win32_utf16_to_utf8(szPath);

}

static std::string GetAppData() {

	return GetWindowsFolder(CSIDL_APPDATA, "RoamingAppData could not be found");

}

static std::string GetAppDataCommon() {

	return GetWindowsFolder(CSIDL_COMMON_APPDATA, "Common appdata could not be found");

}

static std::string GetAppDataLocal() {

	return GetWindowsFolder(CSIDL_LOCAL_APPDATA, "LocalAppData could not be found");

}

#elif defined(__APPLE__)

#include <CoreServices/CoreServices.h>

static std::string GetMacFolder(OSType folderType, const char* errorMsg) {

	std::string ret;

	FSRef ref;

	char path[PATH_MAX];

	OSStatus err = FSFindFolder( kUserDomain, folderType, kCreateFolder, &ref );

	if (err != noErr) {

		throw std::runtime_error(errorMsg);

	}

	FSRefMakePath( &ref, (UInt8*)&path, PATH_MAX );

	ret = path;

	return ret;

}

#else

#include <map>

#include <fstream>

#include <pwd.h>

#include <unistd.h>

#include <sys/types.h>

// For strlen and strtok

#include <cstring>

//Typically Linux. For easy reading the comments will just say Linux but should work with most *nixes

static void throwOnRelative(const char* envName, const char* envValue) {

	if (envValue[0] != '/') {

		char buffer[200];

		std::snprintf(buffer, sizeof(buffer), "Environment \"%s\" does not start with an '/'. XDG specifies that the value must be absolute. The current value is: \"%s\"", envName, envValue);

		throw std::runtime_error(buffer);

	}

}

/**

 * Retrives the effective user's home dir.

 * If the user is running as root we ignore the HOME environment. It works badly with sudo.

 * Writing to $HOME as root implies security concerns that a multiplatform program cannot be assumed to handle.

 * @return The home directory. HOME environment is respected for non-root users if it exists.

 */

static std::string getHome() {

	std::string res;

	int uid = getuid();

	const char* homeEnv = std::getenv("HOME");

	if ( uid != 0 && homeEnv) {

		//We only acknowlegde HOME if not root.

		res = homeEnv;

		return res;

	}

	struct passwd* pw = getpwuid(uid);

	if (!pw) {

		throw std::runtime_error("Unable to get passwd struct.");

	}

	const char* tempRes = pw->pw_dir;

	if (!tempRes) {

		throw std::runtime_error("User has no home directory");

	}

	res = tempRes;

	return res;

}

static std::string getLinuxFolderDefault(const char* envName, const char* defaultRelativePath) {

	std::string res;

	const char* tempRes = std::getenv(envName);

	if (tempRes) {

		throwOnRelative(envName, tempRes);

		res = tempRes;

		return res;

	}

	res = getHome() + "/" + defaultRelativePath;

	return res;

}

static void appendExtraFoldersTokenizer(const char* envName, const char* envValue, std::vector<std::string>& folders) {

	std::vector<char> buffer(envValue, envValue + std::strlen(envValue) + 1);

	char* p = std::strtok ( &buffer[0], ":");

	while (p != NULL) {

		if (p[0] == '/') {

			folders.push_back(p);

		}

		else {

			//Unless the system is wrongly configured this should never happen... But of course some systems will be incorectly configured.

			//The XDG documentation indicates that the folder should be ignored but that the program should continue.

			std::cerr << "Skipping path \"" << p << "\" in \"" << envName << "\" because it does not start with a \"/\"\n";

		}

		p = std::strtok (NULL, ":");

	}

}

static void appendExtraFolders(const char* envName, const char* defaultValue, std::vector<std::string>& folders) {

	const char* envValue = std::getenv(envName);

	if (!envValue) {

		envValue = defaultValue;

	}

	appendExtraFoldersTokenizer(envName, envValue, folders);

}

#endif

namespace sago {

std::string getDataHome() {

#if defined(_WIN32)

	return GetAppData();

#elif defined(__APPLE__)

	return GetMacFolder(kApplicationSupportFolderType, "Failed to find the Application Support Folder");

#else

	return getLinuxFolderDefault("XDG_DATA_HOME", ".local/share");

#endif

}

std::string getConfigHome() {

#if defined(_WIN32)

	return GetAppData();

#elif defined(__APPLE__)

	return GetMacFolder(kApplicationSupportFolderType, "Failed to find the Application Support Folder");

#else

	return getLinuxFolderDefault("XDG_CONFIG_HOME", ".config");

#endif

}

std::string getCacheDir() {

#if defined(_WIN32)

	return GetAppDataLocal();

#elif defined(__APPLE__)

	return GetMacFolder(kCachedDataFolderType, "Failed to find the Application Support Folder");

#else

	return getLinuxFolderDefault("XDG_CACHE_HOME", ".cache");

#endif

}

void appendAdditionalDataDirectories(std::vector<std::string>& homes) {

#if defined(_WIN32)

	homes.push_back(GetAppDataCommon());

#elif defined(__APPLE__)

#else

	appendExtraFolders("XDG_DATA_DIRS", "/usr/local/share/:/usr/share/", homes);

#endif

}

void appendAdditionalConfigDirectories(std::vector<std::string>& homes) {

#if defined(_WIN32)

	homes.push_back(GetAppDataCommon());

#elif defined(__APPLE__)

#else

	appendExtraFolders("XDG_CONFIG_DIRS", "/etc/xdg", homes);

#endif

}

#if defined(_WIN32)

#elif defined(__APPLE__)

#else

struct PlatformFolders::PlatformFoldersData {

	std::map<std::string, std::string> folders;

};

static void PlatformFoldersAddFromFile(const std::string& filename, std::map<std::string, std::string>& folders) {

	std::ifstream infile(filename.c_str());

	std::string line;

	while (std::getline(infile, line)) {

		if (line.length() == 0 || line.at(0) == '#' || line.substr(0, 4) != "XDG_" || line.find("_DIR") == std::string::npos) {

			continue;

		}

		try {

			std::size_t splitPos = line.find('=');

			std::string key = line.substr(0, splitPos);

			std::size_t valueStart = line.find('"', splitPos);

			std::size_t valueEnd = line.find('"', valueStart+1);

			std::string value = line.substr(valueStart+1, valueEnd - valueStart - 1);

			folders[key] = value;

		} catch (std::exception&  e) {

			std::cerr << "WARNING: Failed to process \"" << line << "\" from \"" << filename << "\". Error: "<< e.what() << "\n";

			continue;

		}

	}

}

static void PlatformFoldersFillData(std::map<std::string, std::string>& folders) {

	folders["XDG_DOCUMENTS_DIR"] = "$HOME/Documents";

	folders["XDG_DESKTOP_DIR"] = "$HOME/Desktop";

	folders["XDG_DOWNLOAD_DIR"] = "$HOME/Downloads";

	folders["XDG_MUSIC_DIR"] = "$HOME/Music";

	folders["XDG_PICTURES_DIR"] = "$HOME/Pictures";

	folders["XDG_PUBLICSHARE_DIR"] = "$HOME/Public";

	folders["XDG_TEMPLATES_DIR"] = "$HOME/.Templates";

	folders["XDG_VIDEOS_DIR"] = "$HOME/Videos";

	PlatformFoldersAddFromFile( getConfigHome()+"/user-dirs.dirs", folders);

	for (std::map<std::string, std::string>::iterator itr = folders.begin() ; itr != folders.end() ; ++itr ) {

		std::string& value = itr->second;

		if (value.compare(0, 5, "$HOME") == 0) {

			value = getHome() + value.substr(5, std::string::npos);

		}

	}

}

#endif

PlatformFolders::PlatformFolders() {

#if defined(_WIN32)

#elif defined(__APPLE__)

#else

	this->data = new PlatformFolders::PlatformFoldersData();

	try {

		PlatformFoldersFillData(data->folders);

	}

	catch (...) {

		delete this->data;

		throw;

	}

#endif

}

PlatformFolders::~PlatformFolders() {

#if defined(_WIN32)

#elif defined(__APPLE__)

#else

	delete this->data;

#endif

}

std::string PlatformFolders::getDocumentsFolder() const {

#if defined(_WIN32)

	return GetWindowsFolder(CSIDL_PERSONAL, "Failed to find My Documents folder");

#elif defined(__APPLE__)

	return GetMacFolder(kDocumentsFolderType, "Failed to find Documents Folder");

#else

	return data->folders["XDG_DOCUMENTS_DIR"];

#endif

}

std::string PlatformFolders::getDesktopFolder() const {

#if defined(_WIN32)

	return GetWindowsFolder(CSIDL_DESKTOP, "Failed to find Desktop folder");

#elif defined(__APPLE__)

	return GetMacFolder(kDesktopFolderType, "Failed to find Desktop folder");

#else

	return data->folders["XDG_DESKTOP_DIR"];

#endif

}

std::string PlatformFolders::getPicturesFolder() const {

#if defined(_WIN32)

	return GetWindowsFolder(CSIDL_MYPICTURES, "Failed to find My Pictures folder");

#elif defined(__APPLE__)

	return GetMacFolder(kPictureDocumentsFolderType, "Failed to find Picture folder");

#else

	return data->folders["XDG_PICTURES_DIR"];

#endif

}

std::string PlatformFolders::getDownloadFolder1() const {

#if defined(_WIN32)

	//Pre Vista. Files was downloaded to the desktop

	return GetWindowsFolder(CSIDL_DESKTOP, "Failed to find My Downloads (Desktop) folder");

#elif defined(__APPLE__)

	return GetMacFolder(kDownloadsFolderType, "Failed to find Download folder");

#else

	return data->folders["XDG_DOWNLOAD_DIR"];

#endif

}

std::string PlatformFolders::getMusicFolder() const {

#if defined(_WIN32)

	return GetWindowsFolder(CSIDL_MYMUSIC, "Failed to find My Music folder");

#elif defined(__APPLE__)

	return GetMacFolder(kMusicDocumentsFolderType, "Failed to find Music folder");

#else

	return data->folders["XDG_MUSIC_DIR"];

#endif

}

std::string PlatformFolders::getVideoFolder() const {

#if defined(_WIN32)

	return GetWindowsFolder(CSIDL_MYVIDEO, "Failed to find My Video folder");

#elif defined(__APPLE__)

	return GetMacFolder(kMovieDocumentsFolderType, "Failed to find Movie folder");

#else

	return data->folders["XDG_VIDEOS_DIR"];

#endif

}

std::string PlatformFolders::getSaveGamesFolder1() const {

#if defined(_WIN32)

	//A dedicated Save Games folder was not introduced until Vista. For XP and older save games are most often saved in a normal folder named "My Games".

	//Data that should not be user accessible should be placed under GetDataHome() instead

	return GetWindowsFolder(CSIDL_PERSONAL, "Failed to find My Documents folder")+"\\My Games";

#elif defined(__APPLE__)

	return GetMacFolder(kApplicationSupportFolderType, "Failed to find Application Support Folder");

#else

	return getDataHome();

#endif

}

std::string getDesktopFolder() {

	return PlatformFolders().getDesktopFolder();

}

std::string getDocumentsFolder() {

	return PlatformFolders().getDocumentsFolder();

}

std::string getDownloadFolder1() {

	return PlatformFolders().getDownloadFolder1();

}

std::string getPicturesFolder() {

	return PlatformFolders().getPicturesFolder();

}

std::string getMusicFolder() {

	return PlatformFolders().getMusicFolder();

}

std::string getVideoFolder() {

	return PlatformFolders().getVideoFolder();

}

std::string getSaveGamesFolder1() {

	return PlatformFolders().getSaveGamesFolder1();

}

}  //namespace sago