20 #define GETTEXT_DOMAIN "wesnoth-lib"
32 #include <boost/filesystem.hpp>
33 #include <boost/filesystem/fstream.hpp>
34 #include <boost/iostreams/device/file_descriptor.hpp>
35 #include <boost/iostreams/stream.hpp>
36 #include <boost/process.hpp>
40 #include <boost/locale.hpp>
47 #ifndef VOLUME_NAME_NONE
48 #define VOLUME_NAME_NONE 0x4
54 #include <mach-o/dyld.h>
63 #if defined(__APPLE__) && defined(__MACH__) && defined(__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__)
65 #define WESNOTH_BOOST_OS_IOS (__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__*1000)
66 #include <SDL2/SDL_filesystem.h>
72 #define DBG_FS LOG_STREAM(debug, log_filesystem)
73 #define LOG_FS LOG_STREAM(info, log_filesystem)
74 #define WRN_FS LOG_STREAM(warn, log_filesystem)
75 #define ERR_FS LOG_STREAM(err, log_filesystem)
78 namespace bfs = boost::filesystem;
79 using boost::system::error_code;
87 std::string
path = WESNOTH_PATH;
92 #ifdef DEFAULT_PREFS_PATH
107 const std::string maincfg_filename =
"_main.cfg";
108 const std::string finalcfg_filename =
"_final.cfg";
109 const std::string initialcfg_filename =
"_initial.cfg";
112 class customcodecvt :
public std::codecvt<wchar_t , char , std::mbstate_t>
116 template<
typename char_t_to>
117 struct customcodecvt_do_conversion_writer
119 customcodecvt_do_conversion_writer(char_t_to*& _to_next, char_t_to* _to_end)
128 bool can_push(std::size_t count)
const
130 return static_cast<std::size_t
>(to_end - to_next) > count;
133 void push(char_t_to val)
135 assert(to_next != to_end);
140 template<
typename char_t_from,
typename char_t_to>
141 static void customcodecvt_do_conversion(std::mbstate_t& ,
142 const char_t_from* from,
143 const char_t_from* from_end,
144 const char_t_from*& from_next,
154 customcodecvt_do_conversion_writer<char_t_to> writer(to_next, to_end);
156 while(from_next != from_end) {
163 int do_encoding()
const noexcept
169 bool do_always_noconv()
const noexcept
174 int do_length(std::mbstate_t& ,
const char* ,
const char* , std::size_t )
const
177 throw "Not supported";
180 std::codecvt_base::result unshift(
181 std::mbstate_t& ,
char* ,
char* ,
char*& )
const
184 throw "Not supported";
188 std::codecvt_base::result do_in(std::mbstate_t& state,
190 const char* from_end,
191 const char*& from_next,
194 wchar_t*& to_next)
const
197 customcodecvt_do_conversion<char, wchar_t>(state, from, from_end, from_next, to, to_end, to_next);
200 return std::codecvt_base::error;
203 return std::codecvt_base::ok;
206 std::codecvt_base::result do_out(std::mbstate_t& state,
208 const wchar_t* from_end,
209 const wchar_t*& from_next,
212 char*& to_next)
const
215 customcodecvt_do_conversion<wchar_t, char>(state, from, from_end, from_next, to, to_end, to_next);
218 return std::codecvt_base::error;
221 return std::codecvt_base::ok;
235 utf8_loc = std::locale(utf8_loc,
new customcodecvt());
237 boost::filesystem::path::imbue(utf8_loc);
241 static static_runner static_bfs_path_imbuer;
243 bool is_filename_case_correct(
const std::string& fname,
const boost::iostreams::file_descriptor_source& fd)
245 wchar_t real_path[MAX_PATH];
246 GetFinalPathNameByHandleW(fd.handle(), real_path, MAX_PATH - 1, VOLUME_NAME_NONE);
253 bool is_filename_case_correct(
const std::string& ,
const boost::iostreams::file_descriptor_source& )
301 vec->push_back(file.generic_string());
303 vec->push_back(file.filename().generic_string());
310 return ec && ec != boost::system::errc::no_such_file_or_directory;
318 LOG_FS <<
"Failed to check if " << fpath.string() <<
" is a directory: " << ec.message();
329 ERR_FS <<
"Failed to check existence of file " << fpath.string() <<
": " << ec.message();
340 bfs::create_directory(dirpath, ec);
343 ERR_FS <<
"Failed to create directory " << dirpath.string() <<
": " << ec.message();
351 ERR_FS <<
"Could not open or create directory " << dirpath.string();
352 return std::string();
361 bfs::file_status
fs = bfs::status(dirpath, ec);
364 ERR_FS <<
"Failed to retrieve file status for " << dirpath.string() <<
": " << ec.message();
367 DBG_FS <<
"directory " << dirpath.string() <<
" exists, not creating";
370 ERR_FS <<
"cannot create directory " << dirpath.string() <<
"; file exists";
374 bool created = bfs::create_directory(dirpath, ec);
376 ERR_FS <<
"Failed to create directory " << dirpath.string() <<
": " << ec.message();
384 DBG_FS <<
"creating recursive directory: " << dirpath.string();
386 if(dirpath.empty()) {
391 bfs::file_status
fs = bfs::status(dirpath);
394 ERR_FS <<
"Failed to retrieve file status for " << dirpath.string() <<
": " << ec.message();
405 ERR_FS <<
"Could not create parents to " << dirpath.string();
411 std::vector<std::string>* files,
412 std::vector<std::string>* dirs,
423 get_files_in_dir(absolute_dir.string(), files, dirs, mode, filter, reorder, checksum);
431 LOG_FS <<
"searching for _main.cfg in directory " << dir;
432 const bfs::path maincfg = dirpath / maincfg_filename;
435 LOG_FS <<
"_main.cfg found : " << maincfg;
442 bfs::directory_iterator di(dirpath, ec);
443 bfs::directory_iterator end;
450 for(; di != end; ++di) {
452 bfs::file_status st = di->status(ec);
454 LOG_FS <<
"Failed to get file status of " << di->path().string() <<
": " << ec.message();
458 if(st.type() == bfs::regular_file) {
460 std::string basename = di->path().filename().string();
463 if(!basename.empty() && basename[0] ==
'.')
469 if(checksum !=
nullptr) {
470 std::time_t mtime = bfs::last_write_time(di->path(), ec);
472 LOG_FS <<
"Failed to read modification time of " << di->path().string() <<
": " << ec.message();
473 }
else if(mtime > checksum->
modified) {
479 LOG_FS <<
"Failed to read filesize of " << di->path().string() <<
": " << ec.message();
486 }
else if(st.type() == bfs::directory_file) {
487 std::string basename = di->path().filename().string();
489 if(!basename.empty() && basename[0] ==
'.') {
497 const bfs::path inner_main(di->path() / maincfg_filename);
498 bfs::file_status main_st = bfs::status(inner_main, ec);
501 LOG_FS <<
"Failed to get file status of " << inner_main.string() <<
": " << ec.message();
503 LOG_FS <<
"_main.cfg found : "
512 if(files !=
nullptr) {
513 std::sort(files->begin(), files->end());
516 if(dirs !=
nullptr) {
517 std::sort(dirs->begin(), dirs->end());
522 for(
unsigned int i = 0;
i < files->size();
i++) {
523 if(
ends_with((*files)[
i],
"/" + finalcfg_filename)) {
524 files->push_back((*files)[
i]);
525 files->erase(files->begin() +
i);
532 for(
unsigned int i = 0;
i < files->size();
i++)
533 if(
ends_with((*files)[
i],
"/" + initialcfg_filename)) {
538 std::string initialcfg = (*files)[foundit];
539 for(
unsigned int i = foundit;
i > 0;
i--)
540 (*files)[
i] = (*files)[
i - 1];
541 (*files)[0] = initialcfg;
553 std::string next_filename;
557 std::stringstream filename;
562 filename.setf(std::ios_base::right);
563 filename << counter << extension;
566 next_filename = filename.str();
567 }
while(
file_exists(next_filename) && counter < 1000);
569 return next_filename;
581 std::ostringstream
s;
588 static std::string suffix;
600 #if defined(__APPLE__) && !defined(__IPHONEOS__)
606 static void migrate_apple_config_directory_for_unsandboxed_builds()
608 const char* home_str = getenv(
"HOME");
609 bfs::path home = home_str ? home_str :
".";
614 boost::filesystem::path new_saves_dir = home /
"Library/Containers/org.wesnoth.Wesnoth/Data/Library/Application Support/Wesnoth_";
619 LOG_FS <<
"Apple developer's userdata migration: symlinking " << old_saves_dir.string() <<
" to " << new_saves_dir.string();
620 bfs::create_symlink(new_saves_dir, old_saves_dir);
621 }
else if(!bfs::is_symlink(old_saves_dir)) {
622 ERR_FS <<
"Apple developer's userdata migration: Problem! Old (non-containerized) directory " << old_saves_dir.string() <<
" is not a symlink. Your savegames are scattered around 2 locations.";
632 #if defined(__APPLE__) && !defined(__IPHONEOS__)
633 migrate_apple_config_directory_for_unsandboxed_builds();
667 static utils::optional<std::string> get_games_path()
669 PWSTR docs_path =
nullptr;
670 HRESULT res = SHGetKnownFolderPath(FOLDERID_Documents, KF_FLAG_CREATE,
nullptr, &docs_path);
671 utils::optional<std::string>
path = utils::nullopt;
675 path = games_path.string();
677 ERR_FS <<
"Could not determine path to user's Documents folder! (" << std::hex <<
"0x" << res << std::dec <<
") "
678 <<
"Please report this as a bug.";
681 CoTaskMemFree(docs_path);
688 #ifdef PREFERENCES_DIR
689 if(newprefdir.empty()) {
690 newprefdir = PREFERENCES_DIR;
691 DBG_FS <<
"Using PREFERENCES_DIR '" << PREFERENCES_DIR <<
"'";
697 if(newprefdir.empty()) {
700 #elif defined(__APPLE__)
702 #elif defined(WESNOTH_BOOST_OS_IOS)
703 char* sdl_pref_path = SDL_GetPrefPath(
"wesnoth.org",
"iWesnoth");
705 newprefdir = std::string(sdl_pref_path);
706 SDL_free(sdl_pref_path);
711 const char*
h = std::getenv(
"HOME");
712 std::string home =
h ?
h :
"";
713 h = std::getenv(
"XDG_DATA_HOME");
714 std::string xdg_data_home =
h ?
h :
"";
715 if (!xdg_data_home.empty()) {
717 }
else if (!home.empty()) {
726 if(newprefdir[0] ==
'~') {
728 utils::optional<std::string> games_path = get_games_path();
734 WRN_FS <<
"Using current directory instead: " << dir.string();
737 const char*
h = std::getenv(
"HOME");
738 std::string home =
h ?
h :
"";
743 ERR_FS <<
"Unable to determine path to user's HOME.";
744 WRN_FS <<
"Using current directory instead: " << dir.string();
747 dir /= newprefdir.substr(1);
762 bool rename_dir(
const std::string& old_dir,
const std::string& new_dir)
765 bfs::rename(old_dir, new_dir, ec);
768 ERR_FS <<
"Failed to rename directory '" << old_dir <<
"' to '" << new_dir <<
"'";
778 ERR_FS <<
"could not open or create cache directory at " <<
cache_dir.string() <<
'\n';
789 assert(!
user_data_dir.empty() &&
"Attempted to access userdata location before userdata initialization!");
806 #if defined(_X11) && !defined(PREFERENCES_DIR)
807 char const* xdg_cache = getenv(
"XDG_CACHE_HOME");
809 if(!xdg_cache || xdg_cache[0] ==
'\0') {
810 xdg_cache = getenv(
"HOME");
834 #if !defined(_WIN32) && !defined(_X11) && !defined(__APPLE__)
841 if(w_ver.major_version() != 1 || ms_ver.major_version() != 1) {
846 std::vector<other_version_dir> result;
849 for(
auto minor = w_ver.minor_version() + 4; minor >= ms_ver.minor_version(); --minor) {
850 if(minor == w_ver.minor_version())
855 version.set_minor_version(minor);
872 #elif defined(__APPLE__)
877 result.emplace_back(suffix,
path.string());
891 ERR_FS <<
"Failed to get current directory: " << ec.message();
895 return cwd.generic_string();
904 ERR_FS <<
"Failed to set current directory: " << ec.message();
907 LOG_FS <<
"Process working directory set to " << dir;
916 wchar_t process_path[MAX_PATH];
917 SetLastError(ERROR_SUCCESS);
919 GetModuleFileNameW(
nullptr, process_path, MAX_PATH);
921 if(GetLastError() != ERROR_SUCCESS) {
927 #elif defined(__APPLE__)
928 std::vector<char> buffer(PATH_MAX, 0);
929 uint32_t
size = PATH_MAX;
930 if(_NSGetExecutablePath(&buffer[0], &
size) == 0) {
931 buffer.resize(
size+1);
932 return std::string(buffer.begin(), buffer.end());
934 ERR_FS <<
"Path to wesnoth executable is too long";
935 return get_cwd() +
"/The Battle for Wesnoth";
942 bfs::path exe = bfs::read_symlink(self_exe, ec);
952 bfs::path search = bp::search_path(exe).string();
953 if(!search.string().empty()) {
954 return search.string();
959 search = bp::search_path(exe).string();
960 if(!search.string().empty()) {
961 return search.string();
972 return path.parent_path().string();
981 std::string
wesnothd = exe_dir +
"/wesnothd" + exe_name.substr(7);
991 bool created = bfs::create_directory(
bfs::path(dirname), ec);
993 ERR_FS <<
"Failed to create directory " << dirname <<
": " << ec.message();
1002 std::vector<std::string> files;
1003 std::vector<std::string> dirs;
1008 if(!files.empty()) {
1009 for(
const std::string&
f : files) {
1012 LOG_FS <<
"remove(" <<
f <<
"): " << ec.message();
1019 for(
const std::string&
d : dirs) {
1030 LOG_FS <<
"remove(" << dirname <<
"): " << ec.message();
1043 ERR_FS <<
"Could not delete file " << filename <<
": " << ec.message();
1051 std::ifstream file(fname, std::ios::binary);
1052 std::vector<uint8_t> file_contents;
1054 file_contents.reserve(
file_size(fname));
1055 file_contents.assign(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>());
1057 return file_contents;
1065 std::string img =
"";
1067 if(name.find(
".") != std::string::npos) {
1069 img =
"data:image/"+name.substr(name.find(
".")+1)+
";base64,"+
base64::encode(view);
1078 std::stringstream ss;
1085 LOG_FS <<
"Streaming " << fname <<
" for reading.";
1088 ERR_FS <<
"Trying to open file with empty name.";
1090 s->clear(std::ios_base::failbit);
1097 boost::iostreams::file_descriptor_source fd(
bfs::path(fname), std::ios_base::binary);
1100 if(!fd.is_open() && treat_failure_as_error) {
1101 ERR_FS <<
"Could not open '" << fname <<
"' for reading.";
1102 }
else if(!is_filename_case_correct(fname, fd)) {
1103 ERR_FS <<
"Not opening '" << fname <<
"' due to case mismatch.";
1105 s->clear(std::ios_base::failbit);
1109 return std::make_unique<boost::iostreams::stream<boost::iostreams::file_descriptor_source>>(fd, 4096, 0);
1110 }
catch(
const std::exception&) {
1111 if(treat_failure_as_error) {
1112 ERR_FS <<
"Could not open '" << fname <<
"' for reading.";
1116 s->clear(std::ios_base::failbit);
1123 LOG_FS <<
"streaming " << fname <<
" for writing.";
1125 boost::iostreams::file_descriptor_sink fd(
bfs::path(fname), mode);
1126 return std::make_unique<boost::iostreams::stream<boost::iostreams::file_descriptor_sink>>(fd, 4096, 0);
1127 }
catch(
const BOOST_IOSTREAMS_FAILURE&
e) {
1130 error_code ec_unused;
1131 if(create_directory && bfs::create_directories(
bfs::path(fname).parent_path(), ec_unused)) {
1140 void write_file(
const std::string& fname,
const std::string&
data, std::ios_base::openmode mode)
1143 os->exceptions(std::ios_base::goodbit);
1145 const std::size_t block_size = 4096;
1146 char buf[block_size];
1148 for(std::size_t
i = 0;
i <
data.size();
i += block_size) {
1149 const std::size_t bytes = std::min<std::size_t>(block_size,
data.size() -
i);
1150 std::copy(
data.begin() +
i,
data.begin() +
i + bytes, buf);
1152 os->write(buf, bytes);
1154 throw io_exception(
"Error writing to file: '" + fname +
"'");
1159 void copy_file(
const std::string& src,
const std::string& dest)
1187 std::time_t mtime = bfs::last_write_time(
bfs::path(fname), ec);
1189 LOG_FS <<
"Failed to read modification time of " << fname <<
": " << ec.message();
1212 return bfs::path(filename).extension() ==
".gz";
1217 return bfs::path(filename).extension() ==
".bz2";
1225 LOG_FS <<
"Failed to read filesize of " << fname <<
": " << ec.message();
1227 }
else if(
size > std::numeric_limits<int>::max()) {
1228 return std::numeric_limits<int>::max();
1237 uintmax_t size_sum = 0;
1239 for(bfs::recursive_directory_iterator
i(
p), end;
i != end && !ec; ++
i) {
1240 if(bfs::is_regular_file(
i->path())) {
1246 LOG_FS <<
"Failed to read directorysize of " << pname <<
": " << ec.message();
1248 }
else if(size_sum > std::numeric_limits<int>::max()) {
1249 return std::numeric_limits<int>::max();
1255 std::string
base_name(
const std::string& file,
const bool remove_extension)
1257 if(!remove_extension) {
1258 return bfs::path(file).filename().string();
1266 return bfs::path(file).parent_path().string();
1279 p =
p.parent_path();
1284 }
while(ec && !
is_root(
p.string()));
1286 return ec ?
"" :
p.string();
1292 const std::string
s = std::string(1,
c);
1298 return bfs::path::preferred_separator;
1306 return ec ? false : !
p.has_parent_path();
1329 const std::wstring& wpath =
bfs::path{
path}.make_preferred().wstring();
1330 return PathIsRootW(wpath.c_str()) == TRUE;
1344 std::string
normalize_path(
const std::string& fpath,
bool normalize_separators,
bool resolve_dot_entries)
1351 bfs::path p = resolve_dot_entries ? bfs::canonical(fpath, ec) : bfs::absolute(fpath);
1357 if(normalize_separators) {
1358 return p.make_preferred().string();
1366 std::string rel_path =
"";
1368 std::string addon_asset_dir;
1371 bool is_in_core_dir = (
path.find(core_asset_dir) != std::string::npos);
1372 bool is_in_addon_dir =
false;
1374 if (is_in_core_dir) {
1375 rel_path =
path.erase(0, core_asset_dir.size()+1);
1377 }
else if (!addon_id.empty()) {
1379 is_in_addon_dir = (
path.find(addon_asset_dir) != std::string::npos);
1380 if (is_in_addon_dir) {
1381 rel_path =
path.erase(0, addon_asset_dir.size()+1);
1387 std::string asset_path = addon_asset_dir +
"/" + filename;
1388 rel_path = filename;
1413 std::set<std::string> binary_paths;
1415 typedef std::map<std::string, std::vector<std::string>> paths_map;
1416 paths_map binary_paths_cache;
1422 if(binary_paths.empty()) {
1423 binary_paths.insert(
"");
1449 std::string
path = bp[
"path"].str();
1450 if(
path.find(
"..") != std::string::npos) {
1451 ERR_FS <<
"Invalid binary path '" <<
path <<
"'";
1455 if(!
path.empty() &&
path.back() !=
'/')
1457 if(binary_paths.count(
path) == 0) {
1458 binary_paths.insert(
path);
1466 binary_paths_cache.clear();
1468 for(
const std::string&
p :
paths_) {
1469 binary_paths.erase(
p);
1475 binary_paths_cache.clear();
1480 DBG_FS <<
"Looking for '" << filename_str <<
"'.";
1482 if(filename_str.empty()) {
1483 LOG_FS <<
" invalid filename";
1487 if(filename_str.find(
"..") != std::string::npos) {
1488 ERR_FS <<
"Illegal path '" << filename_str <<
"' (\"..\" not allowed).";
1492 if(filename_str.find(
'\\') != std::string::npos) {
1493 ERR_FS <<
"Illegal path '" << filename_str
1494 << R
"end(' ("\" not allowed, for compatibility with GNU/Linux and macOS).)end";
1501 ERR_FS <<
"Illegal path '" << filename_str <<
"' (blacklisted filename).";
1505 if(std::any_of(filepath.begin(), filepath.end(),
1506 [](
const bfs::path& dirname) { return default_blacklist.match_dir(dirname.string()); })) {
1507 ERR_FS <<
"Illegal path '" << filename_str <<
"' (blacklisted directory name).";
1520 const paths_map::const_iterator itor = binary_paths_cache.find(
type);
1521 if(itor != binary_paths_cache.end()) {
1522 return itor->second;
1525 if(
type.find(
"..") != std::string::npos) {
1527 ERR_FS <<
"Invalid WML type '" <<
type <<
"' for binary paths";
1528 static std::vector<std::string> dummy;
1532 std::vector<std::string>& res = binary_paths_cache[
type];
1536 for(
const std::string&
path : binary_paths) {
1563 std::string::size_type pos = filename.rfind(
"../");
1564 if(pos != std::string::npos) {
1570 return utils::nullopt;
1577 const std::set<std::string> bpaths(temp.begin(), temp.end());
1578 for(
const std::string& bp : bpaths) {
1582 DBG_FS <<
" checking '" << bp <<
"'";
1585 DBG_FS <<
" found at '" << bpath.string() <<
"'";
1586 if(result.empty()) {
1587 result = bpath.string();
1589 WRN_FS <<
"Conflicting files in binary_path: '" << result
1590 <<
"' and '" << bpath.string() <<
"'";
1595 if(result.empty()) {
1597 return utils::nullopt;
1606 return utils::nullopt;
1612 DBG_FS <<
" checking '" << bp <<
"'";
1614 DBG_FS <<
" found at '" << bpath.string() <<
"'";
1615 return bpath.string();
1620 return utils::nullopt;
1623 utils::optional<std::string>
get_wml_location(
const std::string& filename,
const std::string& current_dir)
1626 return utils::nullopt;
1634 if(filename[0] ==
'~') {
1636 DBG_FS <<
" trying '" << result.string() <<
"'";
1637 }
else if(*fpath.begin() ==
".") {
1638 if(!current_dir.empty()) {
1651 return utils::nullopt;
1653 DBG_FS <<
" found: '" << result.string() <<
"'";
1654 return result.string();
1660 bfs::path::iterator fi = full.begin(), fe = full.end(), pi = prefix.begin(), pe = prefix.end();
1661 while(fi != fe && pi != pe && *fi == *pi) {
1683 return "~" +
partial.generic_string();
1688 return partial.generic_string();
1698 return utils::nullopt;
1704 return partial.generic_string();
1709 return partial.generic_string();
1712 return full_path.generic_string();
1718 return program_name +
".exe";
1720 return program_name;
1727 const char* user_name = getenv(
"USERNAME");
1729 const char* user_name = getenv(
"USER");
1733 if(user_name !=
nullptr) {
1734 boost::replace_all(canonicalized, user_name,
"USER");
1737 return canonicalized;
1747 const std::size_t pos_ext = base.rfind(
".");
1749 std::string loc_base;
1750 if(pos_ext != std::string::npos) {
1751 loc_base = base.substr(0, pos_ext) + suff + base.substr(pos_ext);
1753 loc_base = base + suff;
1766 std::vector<std::string> langs =
utils::split(
_(
"language code for localized resources^en_US"));
1771 langs.push_back(
"en_US");
1772 for(
const std::string& lang : langs) {
1773 std::string loc_file = dir +
"/" +
"l10n" +
"/" + lang +
"/" + loc_base;
1779 return utils::nullopt;
1787 if(full_path.find(addons_path) == 0) {
1789 if(
path.size() > 0) {
1790 return path.begin()->string();
1794 return utils::nullopt;
A config object defines a single node in a WML file, with access to child nodes.
bool match_file(const std::string &name) const
A class grating read only view to a vector of config objects, viewed as one config with all children ...
config_array_view child_range(config_key_type key) const
Represents version numbers.
void set_major_version(unsigned int)
Sets the major version number.
unsigned int minor_version() const
Retrieves the minor version number (x2 in "x1.x2.x3").
unsigned int major_version() const
Retrieves the major version number (x1 in "x1.x2.x3").
static lg::log_domain log_filesystem("filesystem")
Declarations for File-IO.
static std::string _(const char *str)
Standard logging facilities (interface).
std::string encode(utils::byte_string_view bytes)
std::string get_legacy_editor_dir()
std::string get_cache_dir()
std::time_t file_modified_time(const std::string &fname)
Get the modification time of a file.
bool is_bzip2_file(const std::string &filename)
Returns true if the file ends with '.bz2'.
utils::optional< std::string > get_wml_location(const std::string &filename, const std::string ¤t_dir)
Returns a complete path to the actual WML file or directory, if either exists.
int dir_size(const std::string &pname)
Returns the sum of the sizes of the files contained in a directory.
bool is_relative(const std::string &path)
Returns whether the path seems to be relative.
static const bfs::path & get_user_data_path()
filesystem::scoped_istream istream_file(const std::string &fname, bool treat_failure_as_error)
bool is_root(const std::string &path)
Returns whether the path is the root of the file hierarchy.
void get_files_in_dir(const std::string &dir, std::vector< std::string > *files, std::vector< std::string > *dirs, name_mode mode, filter_mode filter, reorder_mode reorder, file_tree_checksum *checksum)
Get a list of all files and/or directories in a given directory.
const std::string wml_extension
bool is_cfg(const std::string &filename)
Returns true if the file ends with the wmlfile extension.
static bfs::path get_dir(const bfs::path &dirpath)
std::string get_user_data_dir()
std::string base_name(const std::string &file, const bool remove_extension)
Returns the base filename of a file, with directory name stripped.
std::string get_wml_persist_dir()
bool rename_dir(const std::string &old_dir, const std::string &new_dir)
static bool is_legal_file(const std::string &filename_str)
std::string get_exe_path()
void copy_file(const std::string &src, const std::string &dest)
Read a file and then writes it back out.
bool delete_file(const std::string &filename)
bool is_gzip_file(const std::string &filename)
Returns true if the file ends with '.gz'.
static bool file_exists(const bfs::path &fpath)
std::string get_exe_dir()
bool is_directory(const std::string &fname)
Returns true if the given file is a directory.
static bool is_directory_internal(const bfs::path &fpath)
bool delete_directory(const std::string &dirname, const bool keep_pbl)
std::string get_synced_prefs_file()
location of preferences file containing preferences that are synced between computers note that wesno...
std::string get_saves_dir()
std::string get_program_invocation(const std::string &program_name)
Returns the appropriate invocation for a Wesnoth-related binary, assuming that it is located in the s...
std::string read_file(const std::string &fname)
Basic disk I/O - read file.
std::string get_unsynced_prefs_file()
location of preferences file containing preferences that aren't synced between computers
bool ends_with(const std::string &str, const std::string &suffix)
const std::string map_extension
utils::optional< std::string > get_binary_file_location(const std::string &type, const std::string &filename)
Returns a complete path to the actual file of a given type, if it exists.
filesystem::scoped_ostream ostream_file(const std::string &fname, std::ios_base::openmode mode, bool create_directory)
static bool create_directory_if_missing_recursive(const bfs::path &dirpath)
int file_size(const std::string &fname)
Returns the size of a file, or -1 if the file doesn't exist.
bool is_mask(const std::string &filename)
Returns true if the file ends with the maskfile extension.
utils::optional< std::string > get_addon_id_from_path(const std::string &location)
Returns the add-on ID from a path.
std::string read_file_as_data_uri(const std::string &fname)
void set_cache_dir(const std::string &newcachedir)
const std::string mask_extension
std::unique_ptr< std::istream > scoped_istream
void clear_binary_paths_cache()
static bfs::path user_data_dir
void write_file(const std::string &fname, const std::string &data, std::ios_base::openmode mode)
Throws io_exception if an error occurs.
std::string get_short_wml_path(const std::string &filename)
Returns a short path to filename, skipping the (user) data directory.
std::string root_name(const std::string &path)
Returns the name of the root device if included in the given path.
std::string directory_name(const std::string &file)
Returns the directory name of a file, with filename stripped.
std::string get_logs_dir()
std::unique_ptr< std::ostream > scoped_ostream
static bool create_directory_if_missing(const bfs::path &dirpath)
utils::optional< std::string > get_binary_dir_location(const std::string &type, const std::string &filename)
Returns a complete path to the actual directory of a given type, if it exists.
bool is_userdata_initialized()
std::string nearest_extant_parent(const std::string &file)
Finds the nearest parent in existence for a file or directory.
char path_separator()
Returns the standard path separator for the current platform.
std::string get_sync_dir()
parent directory for everything that should be synced between systems.
bool looks_like_pbl(const std::string &file)
std::string get_addons_data_dir()
static void push_if_exists(std::vector< std::string > *vec, const bfs::path &file, bool full)
bool is_map(const std::string &filename)
Returns true if the file ends with the mapfile extension.
bool make_directory(const std::string &dirname)
utils::optional< std::string > get_independent_binary_file_path(const std::string &type, const std::string &filename)
Returns an asset path to filename for binary path-independent use in saved games.
std::string get_wesnothd_name()
static void setup_user_data_dir()
bool to_asset_path(std::string &path, std::string addon_id, std::string asset_type)
Helper function to convert absolute path to wesnoth relative path.
const blacklist_pattern_list default_blacklist
std::string get_addons_dir()
bool set_cwd(const std::string &dir)
utils::optional< std::string > get_localized_path(const std::string &file, const std::string &suff)
Returns the localized version of the given filename, if it exists.
std::vector< other_version_dir > find_other_version_saves_dirs()
Searches for directories containing saves created by other versions of Wesnoth.
std::string get_next_filename(const std::string &name, const std::string &extension)
Get the next free filename using "name + number (3 digits) + extension" maximum 1000 files then start...
static bfs::path subtract_path(const bfs::path &full, const bfs::path &prefix)
static void set_cache_path(bfs::path newcache)
std::vector< uint8_t > read_file_binary(const std::string &fname)
std::string sanitize_path(const std::string &path)
Sanitizes a path to remove references to the user's name.
std::string get_current_editor_dir(const std::string &addon_id)
const std::string get_version_path_suffix(const version_info &version)
static bool error_except_not_found(const error_code &ec)
bool is_path_sep(char c)
Returns whether c is a path separator.
static bfs::path cache_dir
std::string normalize_path(const std::string &fpath, bool normalize_separators, bool resolve_dot_entries)
Returns the absolute path of a file.
void set_user_data_dir(std::string newprefdir)
const std::vector< std::string > & get_binary_paths(const std::string &type)
Returns a vector with all possible paths to a given type of binary, e.g.
static void init_binary_paths()
Game configuration data as global variables.
const version_info min_savegame_version(MIN_SAVEGAME_VERSION)
std::string default_preferences_path
const version_info wesnoth_version(VERSION)
const std::string observer_team_name
observer team name used for observer team chat
int cache_compression_level
void remove()
Removes a tip.
bool exists(const image::locator &i_locator)
Returns true if the given image actually exists, without loading it.
void move_log_file()
Move the log file to another directory.
rng * generator
This generator is automatically synced during synced context.
std::size_t size(const std::string &str)
Length in characters of a UTF-8 string.
std::basic_string_view< uint8_t > byte_string_view
std::string get_unknown_exception_type()
Utility function for finding the type of thing caught with catch(...).
std::vector< std::string > split(const config_attribute_value &val)
std::string::const_iterator iterator
@ partial
There are still moves and/or attacks possible, but the unit doesn't fit in the "unmoved" status.
void read(config &cfg, std::istream &in, abstract_validator *validator)
void write(std::ostream &out, const configr_of &cfg, unsigned int level)
std::vector< std::string > paths_
void set_paths(const game_config_view &cfg)
An exception object used when an IO error occurs.
static map_location::DIRECTION s