0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

address feedback.

Browse source
This commit is contained in:
pentarctagon 2024-06-23 20:01:05 -05:00 • committed by Pentarctagon
parent 171423bb8a
commit b77b983319
6 changed files with 82 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/SConscript
View file

@ -42,9 +42,9 @@ for environ in [test_env, client_env, env]:
environ.Append(CPPDEFINES = "LOCALEDIR='\"$localedirname\"'")
if not os.path.isabs(env['localedirname']):
environ.Append(CPPDEFINES = "HAS_RELATIVE_LOCALEDIR")
if env['version_suffix'] and not env['prefsdir']:
environ['prefsdir'] = "~/.wesnoth$version_suffix"
if environ['prefsdir']:
if env['version_suffix']:
environ['prefsdir'] += env['version_suffix']
environ.Append(CPPDEFINES = "PREFERENCES_DIR=\\\"$prefsdir\\\"")
else:
environ["fifodir"] = ""

6
src/commandline_options.cpp
View file

@ -170,7 +170,7 @@ commandline_options::commandline_options(const std::vector<std::string>& args)
general_opts.add_options()
("all-translations", "Show all translations, even incomplete ones.")
("clock", "Adds the option to show a clock for testing the drawing timer.")
("config-dir", po::value<std::string>(), "sets the path of the userdata directory to $HOME/<arg> or My Documents\\My Games\\<arg> for Windows. You can specify also an absolute path outside the $HOME or My Documents\\My Games directory. DEPRECATED: use userdata-dir instead.")
("config-dir", po::value<std::string>(), "sets the path of the userdata directory. DEPRECATED: use userdata-dir instead.")
("config-path", "prints the path of the userdata directory and exits. DEPRECATED: use userdata-path instead." IMPLY_TERMINAL)
("core", po::value<std::string>(), "overrides the loaded core with the one whose id is specified.")
("data-dir", po::value<std::string>(), "overrides the data directory with the one specified.")
@ -205,9 +205,9 @@ commandline_options::commandline_options(const std::vector<std::string>& args)
("unsafe-scripts", "makes the \'package\' package available to Lua scripts, so that they can load arbitrary packages. Do not do this with untrusted scripts! This action gives ua the same permissions as the Wesnoth executable.")
("usercache-dir", po::value<std::string>(), "sets the path of the cache directory to $HOME/<arg> or My Documents\\My Games\\<arg> for Windows. You can specify also an absolute path outside the $HOME or My Documents\\My Games directory. Defaults to $HOME/.cache/wesnoth on X11 and to the userdata-dir on other systems.")
("usercache-path", "prints the path of the cache directory and exits.")
("userconfig-dir", po::value<std::string>(), "sets the path of the user config directory. You must specify an absolute path outside the $HOME or My Documents\\My Games directory. Defaults to the userdata-dir.")
("userconfig-dir", po::value<std::string>(), "sets the path of the user config directory. Defaults to the userdata-dir.")
("userconfig-path", "prints the path of the user config directory and exits.")
("userdata-dir", po::value<std::string>(), "sets the path of the userdata directory. You must specify an absolute path outside the $HOME or My Documents\\My Games directory.")
("userdata-dir", po::value<std::string>(), "sets the path of the userdata directory. You can use ~ to denote $HOME or My Documents\\My Games on Windows.")
("userdata-path", "prints the path of the userdata directory and exits." IMPLY_TERMINAL)
("username", po::value<std::string>(), "uses <username> when connecting to a server, ignoring other preferences.")
("validcache", "assumes that the cache is valid. (dangerous)")

91
src/filesystem.cpp
View file

@ -655,9 +655,11 @@ static void setup_user_data_dir()
}
#ifdef _WIN32
// A convenience for portable installs on Windows.
// relative paths with . or .. as the first component are considered relative to the current workdir instead of Documents/My Games.
// Only provided for Windows since portable installs on other systems are not particularly relevant or supported.
/**
* A convenience for portable installs on Windows.
* relative paths with . or .. as the first component are considered relative to the current workdir instead of Documents/My Games.
* Only provided for Windows since portable installs on other systems are not particularly relevant or supported.
*/
static bool is_path_relative_to_cwd(const std::string& str)
{
const bfs::path p(str);
@ -669,6 +671,28 @@ static bool is_path_relative_to_cwd(const std::string& str)
return *p.begin() == "." || *p.begin() == "..";
}
/**
* @return the path to the My Games directory on success or an empty string on failure
*/
static std::optional<std::string> get_games_path()
{
PWSTR docs_path = nullptr;
HRESULT res = SHGetKnownFolderPath(FOLDERID_Documents, KF_FLAG_CREATE, nullptr, &docs_path);
std::optional<std::string> path = std::nullopt;
if(res == S_OK) {
bfs::path games_path = bfs::path(docs_path) / "My Games";
path = games_path.string();
} else {
ERR_FS << "Could not determine path to user's Documents folder! (" << std::hex << "0x" << res << std::dec << ") "
<< "User config/data directories may be unavailable for "
<< "this session. Please report this as a bug.";
}
CoTaskMemFree(docs_path);
return path;
}
static bfs::path windows_userdata(const std::string& newprefdir)
{
bfs::path dir;
@ -683,6 +707,7 @@ static bfs::path windows_userdata(const std::string& newprefdir)
// if a custom userdata directory is provided as an absolute path, just use that
// else if it's relative to the current working directory, just use that
// else if the first characters is a tilde, then replace that with the path to the "My Games" folder
// else if no custom userdata directory was provided, default to the "My Games" folder if present or fallback to the current working directory if not
// else a relative path was provided that isn't relative to the current working directory, so ignore it and use the default
if(temp.size() > 2 && temp[1] == ':') {
@ -693,35 +718,39 @@ static bfs::path windows_userdata(const std::string& newprefdir)
// Custom directory relative to workdir (for portable installs, etc.)
dir = get_cwd() + "/" + temp;
DBG_FS << "userdata relative to current working directory";
} else if(!temp.empty() && temp[0] == '~') {
std::optional<std::string> games_path = get_games_path();
if(games_path) {
dir = *games_path;
} else {
dir = get_cwd();
}
dir / temp.substr(1);
} else {
if(temp.empty()) {
temp = "Wesnoth" + get_version_path_suffix();
DBG_FS << "using default userdata folder name";
} else {
temp = "Wesnoth" + get_version_path_suffix();
DBG_FS << "relative path for userdata that doesn't start with '.' or '..' is not allowed, using default userdata folder name";
} else {
ERR_FS << "relative path for userdata whose first path component is neither '.' or '..' is not allowed: " << temp
<< ", using default location under My Games";
temp = "Wesnoth" + get_version_path_suffix();
}
PWSTR docs_path = nullptr;
HRESULT res = SHGetKnownFolderPath(FOLDERID_Documents, KF_FLAG_CREATE, nullptr, &docs_path);
if(res != S_OK) {
std::optional<std::string> games_path = get_games_path();
if(games_path) {
create_directory_if_missing(*games_path);
dir = *games_path;
dir / temp;
DBG_FS << "userdata is under My Games at " << dir.string();
} else {
//
// Crummy fallback path full of pain and suffering.
//
ERR_FS << "Could not determine path to user's Documents folder! (" << std::hex << "0x" << res << std::dec << ") "
<< "User config/data directories may be unavailable for "
<< "this session. Please report this as a bug.";
dir = bfs::path(get_cwd()) / temp;
} else {
bfs::path games_path = bfs::path(docs_path) / "My Games";
create_directory_if_missing(games_path);
dir = games_path / temp;
DBG_FS << "userdata is under My Games";
dir = get_cwd();
dir / temp;
DBG_FS << "userdata is at " << dir.string();
}
CoTaskMemFree(docs_path);
}
return dir;
@ -731,6 +760,7 @@ static bfs::path apple_userdata(const std::string& newprefdir)
{
bfs::path dir;
std::string temp = newprefdir;
const char* home_str = getenv("HOME");
// if a custom userdata was not specified
// use the PREFERENCES_DIR if defined
@ -738,7 +768,6 @@ static bfs::path apple_userdata(const std::string& newprefdir)
// else use a default - this is currently the "unsandboxed" location from migrate_apple_config_directory_for_unsandboxed_builds() above
if(temp.empty()) {
#ifdef PREFERENCES_DIR
const char* home_str = getenv("HOME");
temp = PREFERENCES_DIR;
DBG_FS << "userdata using PREFERENCES_DIR '" << PREFERENCES_DIR << "'";
if(home_str && temp[0] == '~') {
@ -754,7 +783,7 @@ static bfs::path apple_userdata(const std::string& newprefdir)
DBG_FS << "userdata using SDL pref path";
#else
temp = "Library/Application Support/Wesnoth_"+get_version_path_suffix();
DBG_FS << "userdata using default path relative to HOME";
DBG_FS << "Using default relative path for userdata";
#endif
}
@ -762,11 +791,11 @@ static bfs::path apple_userdata(const std::string& newprefdir)
// else make it relative to HOME if HOME is populated, otherwise make it relative to the current working directory
if(temp[0] == '/') {
dir = temp;
DBG_FS << "userdata using absolute path";
DBG_FS << "userdata using absolute path: " << temp;
} else {
dir = ".";
dir / temp;
DBG_FS << "unable to determine location to use for userdata, defaulting to current working directory";
bfs::path home = home_str ? home_str : get_cwd();
dir = home / temp;
DBG_FS << "userdata is relative to the current working directory: " << dir.string();
}
return dir;
@ -821,10 +850,10 @@ static bfs::path linux_userdata(const std::string& newprefdir)
}
// unable to determine another userdata directory, so just use the current working directory for the userdata
dir = ".";
DBG_FS << "unable to determine location to use for userdata, defaulting to current working directory";
dir = get_cwd();
dir /= temp;
ERR_FS << "unable to determine location to use for userdata, defaulting to current working directory: " << dir.string();
return dir;
}
#endif

2
src/preferences/preferences.cpp
View file

@ -148,7 +148,7 @@ prefs::~prefs()
encountered_terrains_set_.clear();
try {
if(!no_preferences_save_) {
if(!no_preferences_save) {
write_preferences();
}
} catch (...) {

6
src/preferences/preferences.hpp
View file

@ -742,11 +742,11 @@ class prefs
std::vector<preferences::option>& get_advanced_preferences() {return advanced_prefs_;}
static void disable_preferences_save() {
no_preferences_save_ = true;
no_preferences_save = true;
}
static bool preferences_save() {
return no_preferences_save_;
return no_preferences_save;
}
private:
@ -757,7 +757,7 @@ class prefs
prefs(const prefs&& p) = delete;
prefs& operator=(const prefs&& p) = delete;
inline static bool no_preferences_save_ = false;
inline static bool no_preferences_save = false;
config preferences_;
bool fps_;

25
src/wesnoth.cpp
View file

@ -286,33 +286,34 @@ static int process_command_args(const commandline_options& cmdline_opts)
filesystem::set_cache_dir(*cmdline_opts.usercache_dir);
}
if(cmdline_opts.userconfig_dir) {
filesystem::set_user_config_dir(*cmdline_opts.userconfig_dir);
}
if(cmdline_opts.userdata_dir) {
filesystem::set_user_data_dir(*cmdline_opts.userdata_dir);
}
// earliest possible point to ensure the userdata directory is known
if(!filesystem::is_userdata_initialized()) {
filesystem::set_user_data_dir(std::string());
}
if(cmdline_opts.usercache_path) {
std::cout << filesystem::get_cache_dir();
return 0;
}
if(cmdline_opts.userconfig_dir) {
filesystem::set_user_config_dir(*cmdline_opts.userconfig_dir);
}
if(cmdline_opts.userconfig_path) {
std::cout << filesystem::get_user_config_dir();
return 0;
}
if(cmdline_opts.userdata_dir) {
filesystem::set_user_data_dir(*cmdline_opts.userdata_dir);
}
if(cmdline_opts.userdata_path) {
std::cout << filesystem::get_user_data_dir();
return 0;
}
// earliest possible point to ensure the userdata directory is known
// if you're hitting the assertion in the preferences about the userdata not being initialized, it means you're trying to use the preferences before wesnoth knows where the preferences are
filesystem::get_user_data_dir();
if(cmdline_opts.data_dir) {
const std::string datadir = *cmdline_opts.data_dir;
PLAIN_LOG << "Starting with directory: '" << datadir << "'";