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