The Battle for Wesnoth  1.19.0-dev
filesystem_common.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2017 - 2024
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 #include <fstream>
15 
16 #include "filesystem.hpp"
17 #include "wesconfig.h"
18 
19 #include "config.hpp"
20 #include "log.hpp"
23 
24 #include <boost/algorithm/string.hpp>
25 
26 static lg::log_domain log_filesystem("filesystem");
27 #define LOG_FS LOG_STREAM(info, log_filesystem)
28 #define ERR_FS LOG_STREAM(err, log_filesystem)
29 
30 namespace filesystem
31 {
32 
33 bool is_legal_user_file_name(const std::string& name, bool allow_whitespace)
34 {
35  //
36  // IMPORTANT NOTE:
37  //
38  // If you modify this function you must be aware that it is used by the
39  // add-on server validation routines both on the client and server sides.
40  // The addition or removal of any criteria here should be carefully
41  // evaluated with this in mind.
42  //
43 
44  if(name.empty() || name.back() == '.' || name.find("..") != std::string::npos || name.size() > 255) {
45  return false;
46  }
47 
48  // Reserved DOS device names on Windows.
49  static const std::set<std::string> dos_device_names = {
50  // Hardware devices
51  "NUL", "CON", "AUX", "PRN",
52  "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9",
53  "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9",
54  // Console API pseudo-devices
55  "CONIN$", "CONOUT$",
56  };
57 
58  // We can't use filesystem::base_name() here, because it returns the
59  // filename up to the *last* dot. "CON.foo.bar" is still redirected to
60  // "CON" on Windows, although "foo.CON.bar" and "foo.bar.CON" are not.
61  //
62  // Do also note that we're relying on the char-by-char check further below
63  // to flag the name as illegal if it contains a colon ':', the reason
64  // being that is valid to refer to DOS device names with a trailing colon
65  // (e.g. "CON:" is synonymous with "CON").
66 
67  const auto& first_name =
68  boost::algorithm::to_upper_copy(name.substr(0, name.find('.')), std::locale::classic());
69 
70  if(dos_device_names.count(first_name)) {
71  return false;
72  }
73 
74  const auto& name_ucs4 = unicode_cast<std::u32string>(name);
75  if(name != unicode_cast<std::string>(name_ucs4)){
76  return false; // name is an invalid UTF-8 sequence
77  }
78 
79  return name_ucs4.end() == std::find_if(name_ucs4.begin(), name_ucs4.end(), [=](char32_t c)
80  {
81  switch(c) {
82  case ' ':
83  return !allow_whitespace;
84  case '"':
85  case '*':
86  case '/':
87  case ':':
88  case '<':
89  case '>':
90  case '?':
91  case '\\':
92  case '|':
93  case '~':
94  case 0x7F: // DEL
95  return true;
96  default:
97  return c < 0x20 || // C0 control characters
98  (c >= 0x80 && c < 0xA0) || // C1 control characters
99  (c >= 0xD800 && c < 0xE000); // surrogate pairs
100  }
101  });
102 }
103 
104 void blacklist_pattern_list::remove_blacklisted_files_and_dirs(std::vector<std::string>& files, std::vector<std::string>& directories) const
105 {
106  files.erase(
107  std::remove_if(files.begin(), files.end(), [this](const std::string& name) { return match_file(name); }),
108  files.end());
109  directories.erase(
110  std::remove_if(directories.begin(), directories.end(), [this](const std::string& name) { return match_dir(name); }),
111  directories.end());
112 }
113 
114 bool blacklist_pattern_list::match_file(const std::string& name) const
115 {
116  return std::any_of(file_patterns_.begin(), file_patterns_.end(),
117  std::bind(&utils::wildcard_string_match, std::ref(name), std::placeholders::_1));
118 }
119 
120 bool blacklist_pattern_list::match_dir(const std::string& name) const
121 {
122  return std::any_of(directory_patterns_.begin(), directory_patterns_.end(),
123  std::bind(&utils::wildcard_string_match, std::ref(name), std::placeholders::_1));
124 }
125 
126 std::string get_prefs_file()
127 {
128  return get_user_config_dir() + "/preferences";
129 }
130 
131 std::string get_credentials_file()
132 {
133  return get_user_config_dir() + "/credentials-aes";
134 }
135 
137 {
138 #ifdef HAS_RELATIVE_DEFPREF
140 #else
142 #endif
143 }
144 
145 std::string get_save_index_file()
146 {
147  return get_user_data_dir() + "/save_index";
148 }
149 
150 std::string get_saves_dir()
151 {
152  const std::string dir_path = get_user_data_dir() + "/saves";
153  return get_dir(dir_path);
154 }
155 
156 std::string get_addons_data_dir()
157 {
158  const std::string dir_path = get_user_data_dir() + "/data";
159  return get_dir(dir_path);
160 }
161 
162 std::string get_addons_dir()
163 {
164  const std::string dir_path = get_addons_data_dir() + "/add-ons";
165  return get_dir(dir_path);
166 }
167 
168 std::string get_wml_persist_dir()
169 {
170  const std::string dir_path = get_user_data_dir() + "/persist";
171  return get_dir(dir_path);
172 }
173 
175 {
176  const std::string dir_path = get_user_data_dir() + "/editor";
177  return get_dir(dir_path);
178 }
179 
180 std::string get_current_editor_dir(const std::string& addon_id)
181 {
182  if(addon_id == "mainline") {
183  return get_dir(game_config::path) + "/data/multiplayer";
184  } else {
185  return get_addons_dir() + "/" + addon_id;
186  }
187 }
188 
189 std::string get_core_images_dir()
190 {
191  return get_dir(game_config::path + "/data/core/images");
192 }
193 
194 std::string get_intl_dir()
195 {
196 #ifdef _WIN32
197  return game_config::path + "/" LOCALEDIR;
198 #else
199 
200 #ifdef USE_INTERNAL_DATA
201  return get_cwd() + "/" LOCALEDIR;
202 #endif
203 
204 #if HAS_RELATIVE_LOCALEDIR
205  std::string res = game_config::path + "/" LOCALEDIR;
206 #else
207  std::string res = LOCALEDIR;
208 #endif
209 
210  return res;
211 #endif
212 }
213 
214 std::string get_screenshot_dir()
215 {
216  const std::string dir_path = get_user_data_dir() + "/screenshots";
217  return get_dir(dir_path);
218 }
219 
220 bool looks_like_pbl(const std::string& file)
221 {
222  return utils::wildcard_string_match(utf8::lowercase(file), "*.pbl");
223 }
224 
225 file_tree_checksum::file_tree_checksum()
226  : nfiles(0), sum_size(0), modified(0)
227 {}
228 
230  nfiles (cfg["nfiles"].to_size_t()),
231  sum_size(cfg["size"].to_size_t()),
232  modified(cfg["modified"].to_time_t())
233 {
234 }
235 
237 {
238  cfg["nfiles"] = nfiles;
239  cfg["size"] = sum_size;
240  cfg["modified"] = modified;
241 }
242 
244 {
245  return nfiles == rhs.nfiles && sum_size == rhs.sum_size &&
246  modified == rhs.modified;
247 }
248 
249 bool ends_with(const std::string& str, const std::string& suffix)
250 {
251  return str.size() >= suffix.size() && std::equal(suffix.begin(),suffix.end(),str.end()-suffix.size());
252 }
253 
254 std::string read_map(const std::string& name)
255 {
256  std::string res;
257  std::string map_location = get_wml_location(name);
258  if(map_location.empty()) {
259  // Consult [binary_path] for maps as well.
260  map_location = get_binary_file_location("maps", name);
261  }
262  if(!map_location.empty()) {
263  res = read_file(map_location);
264  }
265 
266  if(res.empty()) {
267  res = read_file(get_user_data_dir() + "/editor/maps/" + name);
268  }
269 
270  return res;
271 }
272 
273 std::string read_scenario(const std::string& name)
274 {
275  std::string res;
276  std::string file_location = get_wml_location(name);
277  if(file_location.empty()) {
278  // Consult [binary_path] for scenarios as well.
279  file_location = get_binary_file_location("scenarios", name);
280  }
281  if(!file_location.empty()) {
282  res = read_file(file_location);
283  }
284 
285  if(res.empty()) {
286  res = read_file(get_user_data_dir() + "/editor/scenarios/" + name);
287  }
288 
289  return res;
290 }
291 
292 static void get_file_tree_checksum_internal(const std::string& path, file_tree_checksum& res)
293 {
294 
295  std::vector<std::string> dirs;
297 
298  for(std::vector<std::string>::const_iterator j = dirs.begin(); j != dirs.end(); ++j) {
300  }
301 }
302 
304 {
305  static file_tree_checksum checksum;
306  if (reset)
307  checksum.reset();
308  if(checksum.nfiles == 0) {
309  get_file_tree_checksum_internal("data/",checksum);
310  get_file_tree_checksum_internal(get_user_data_dir() + "/data/",checksum);
311  LOG_FS << "calculated data tree checksum: "
312  << checksum.nfiles << " files; "
313  << checksum.sum_size << " bytes";
314  }
315 
316  return checksum;
317 }
318 
319 }
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
Declarations for File-IO.
static lg::log_domain log_filesystem("filesystem")
#define LOG_FS
Standard logging facilities (interface).
std::string get_legacy_editor_dir()
std::string get_user_config_dir()
Definition: filesystem.cpp:841
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.
Definition: filesystem.cpp:404
static bfs::path get_dir(const bfs::path &dirpath)
Definition: filesystem.cpp:329
std::string get_user_data_dir()
Definition: filesystem.cpp:870
std::string get_wml_persist_dir()
bool is_legal_user_file_name(const std::string &name, bool allow_whitespace=true)
Returns whether the given filename is a legal name for a user-created file.
std::string get_saves_dir()
std::string get_wml_location(const std::string &filename, const std::string &current_dir)
Returns a complete path to the actual WML file or directory or an empty string if the file isn't pres...
const file_tree_checksum & data_tree_checksum(bool reset=false)
Get the time at which the data/ tree was last modified at.
std::string read_file(const std::string &fname)
Basic disk I/O - read file.
bool ends_with(const std::string &str, const std::string &suffix)
std::string get_save_index_file()
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 or an empty string if the file isn't prese...
std::string get_prefs_file()
std::string read_scenario(const std::string &name)
std::string get_screenshot_dir()
std::string get_credentials_file()
bool looks_like_pbl(const std::string &file)
std::string get_addons_data_dir()
std::string get_default_prefs_file()
std::string get_addons_dir()
std::string get_intl_dir()
std::string get_core_images_dir()
static void get_file_tree_checksum_internal(const std::string &path, file_tree_checksum &res)
std::string get_current_editor_dir(const std::string &addon_id)
std::string read_map(const std::string &name)
std::string get_cwd()
Definition: filesystem.cpp:962
std::string path
Definition: filesystem.cpp:83
std::string default_preferences_path
Definition: filesystem.cpp:89
std::string lowercase(const std::string &s)
Returns a lowercased version of the string.
Definition: unicode.cpp:52
bool wildcard_string_match(const std::string &str, const std::string &match)
Match using '*' as any number of characters (including none), '+' as one or more characters,...
bool operator==(const file_tree_checksum &rhs) const
Encapsulates the map of the game.
Definition: location.hpp:38
mock_char c
Some defines: VERSION, PACKAGE, MIN_SAVEGAME_VERSION.
#define LOCALEDIR
Definition: wesconfig.h:19