The Battle for Wesnoth  1.19.14+dev
preferences.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2024 - 2025
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 /**
16  * @file
17  * Get and set user-preferences.
18  */
19 
20 #define GETTEXT_DOMAIN "wesnoth-lib"
21 
23 
24 #include "cursor.hpp"
25 #include "game_board.hpp"
26 #include "game_display.hpp"
27 #include "formula/string_utils.hpp"
28 #include "game_config.hpp"
29 #include "game_data.hpp"
30 #include "gettext.hpp"
34 #include "hotkey/hotkey_item.hpp"
35 #include "log.hpp"
36 #include "map_settings.hpp"
37 #include "map/map.hpp"
38 #include "resources.hpp"
39 #include "serialization/chrono.hpp"
40 #include "serialization/parser.hpp"
41 #include "sound.hpp"
42 #include "units/unit.hpp"
43 #include "video.hpp"
44 
45 #include <sys/stat.h> // for setting the permissions of the preferences file
46 #include <boost/algorithm/string.hpp>
47 
48 #ifdef _WIN32
50 #include <windows.h>
51 #endif
52 
53 #ifndef __APPLE__
54 #include <openssl/evp.h>
55 #include <openssl/err.h>
56 #else
57 #include <CommonCrypto/CommonCryptor.h>
58 #endif
59 
60 static lg::log_domain log_config("config");
61 #define ERR_CFG LOG_STREAM(err , log_config)
62 #define DBG_CFG LOG_STREAM(debug , log_config)
63 
64 static lg::log_domain log_filesystem("filesystem");
65 #define ERR_FS LOG_STREAM(err, log_filesystem)
66 
67 static lg::log_domain advanced_preferences("advanced_preferences");
68 #define ERR_ADV LOG_STREAM(err, advanced_preferences)
69 
70 using namespace std::chrono_literals;
71 
73  : preferences_()
74  , fps_(false)
75  , completed_campaigns_()
76  , encountered_units_set_()
77  , encountered_terrains_set_()
78  , history_map_()
79  , acquaintances_()
80  , option_values_()
81  , options_initialized_(false)
82  , mp_modifications_()
83  , mp_modifications_initialized_(false)
84  , sp_modifications_()
85  , sp_modifications_initialized_(false)
86  , message_private_on_(false)
87  , credentials_()
88  , advanced_prefs_()
89 {
92 
93  // make sure this has a default set
94  if(!preferences_.has_attribute("scroll_threshold")) {
95  preferences_[prefs_list::scroll_threshold] = 10;
96  }
97 
98  for(const config& acfg : preferences_.child_range(prefs_list::acquaintance)) {
100  acquaintances_[ac.get_nick()] = ac;
101  }
102 }
103 
105 {
106  config campaigns;
107  for(const auto& elem : completed_campaigns_) {
108  config cmp;
109  cmp["name"] = elem.first;
110  cmp["difficulty_levels"] = utils::join(elem.second);
111  campaigns.add_child("campaign", cmp);
112  }
113 
114  set_child(prefs_list::completed_campaigns, campaigns);
115 
116  preferences_[prefs_list::encountered_units] = utils::join(encountered_units_set_);
118  preferences_[prefs_list::encountered_terrain_list] = t_translation::write_list(terrain);
119 
120  /* Structure of the history
121  [history]
122  [history_id]
123  [line]
124  message = foobar
125  [/line]
126  */
127  config history;
128  for(const auto& history_id : history_map_) {
129  config history_id_cfg; // [history_id]
130  for(const std::string& line : history_id.second) {
131  config cfg; // [line]
132 
133  cfg["message"] = line;
134  history_id_cfg.add_child("line", std::move(cfg));
135  }
136 
137  history.add_child(history_id.first, history_id_cfg);
138  }
139  set_child(prefs_list::history, history);
140 
141  preferences_.clear_children(prefs_list::acquaintance);
142 
143  for(auto& a : acquaintances_) {
144  config& item = preferences_.add_child(prefs_list::acquaintance);
145  a.second.save(item);
146  }
147 
148  history_map_.clear();
149  encountered_units_set_.clear();
151 
152  try {
153  if(!no_preferences_save) {
155  }
156  } catch (...) {
157  ERR_FS << "Failed to write preferences due to exception: " << utils::get_unknown_exception_type();
158  }
159 }
160 
162 {
163  advanced_prefs_.clear();
164 
165  for(const config& pref : gc.child_range("advanced_preference")) {
166  try {
167  advanced_prefs_.emplace_back(pref);
168  } catch(const std::invalid_argument& e) {
169  ERR_ADV << e.what();
170  continue;
171  }
172  }
173 
174  // show_deprecation has a different default on the dev branch
175  if(game_config::wesnoth_version.is_dev_version()) {
177  if(op.field == prefs_list::show_deprecation) {
178  op.cfg["default"] = true;
179  }
180  }
181  }
182 
183  std::sort(advanced_prefs_.begin(), advanced_prefs_.end(), [](const auto& lhs, const auto& rhs) { return translation::icompare(lhs.name, rhs.name) < 0; });
184 }
185 
186 void prefs::migrate_preferences(const std::string& migrate_prefs_file)
187 {
188  if(migrate_prefs_file != filesystem::get_synced_prefs_file() && filesystem::file_exists(migrate_prefs_file)) {
189  // if the file doesn't exist, just copy the file over
190  // else need to merge the preferences file
193  } else {
194  auto current_stream = filesystem::istream_file(filesystem::get_synced_prefs_file(), false);
195  config current_cfg = io::read(*current_stream);
196 
197  auto old_stream = filesystem::istream_file(migrate_prefs_file, false);
198  config old_cfg = io::read(*old_stream);
199 
200  // when both files have the same attribute, use the one from whichever was most recently modified
201  bool current_prefs_are_older = filesystem::file_modified_time(filesystem::get_synced_prefs_file()) < filesystem::file_modified_time(migrate_prefs_file);
202  for(const auto& [key, value] : old_cfg.attribute_range()) {
203  if(current_prefs_are_older || !current_cfg.has_attribute(key)) {
204  preferences_[key] = value;
205  }
206  }
207 
208  // don't touch child tags
209 
211  }
212  }
213 }
215 {
219 }
220 
221 std::set<std::string> prefs::all_attributes()
222 {
223  std::set<std::string> attrs;
224 
225  // attributes that exist in the preferences file
226  for(const auto& attr : preferences_.attribute_range()) {
227  attrs.emplace(attr.first);
228  }
229  // all mainline preference attributes, whether they're set or not
230  for(const auto attr : prefs_list::values) {
231  attrs.emplace(attr);
232  }
233 
234  return attrs;
235 }
236 
238 {
240  try{
241  config default_prefs;
242  config unsynced_prefs;
243  config synced_prefs;
244 #ifdef DEFAULT_PREFS_PATH
245  // NOTE: the system preferences file is only ever relevant for the first time wesnoth starts
246  // any default values will subsequently be written to the normal preferences files, which takes precedence over any values in the system preferences file
247  {
249  default_prefs = io::read(*stream);
250  }
251 #endif
252  {
254  unsynced_prefs = io::read(*stream);
255  }
256 
257  {
259  synced_prefs = io::read(*stream);
260  }
261 
262  preferences_.merge_with(default_prefs);
263  preferences_.merge_with(unsynced_prefs);
264  preferences_.merge_with(synced_prefs);
265 
266  // check for any unknown preferences
267  for(const auto& [key, _] : synced_prefs.attribute_range()) {
269  unknown_synced_attributes_.insert(key);
270  }
271  }
272  for(const auto& [key, _] : unsynced_prefs.attribute_range()) {
274  unknown_unsynced_attributes_.insert(key);
275  }
276  }
277 
278  for(const auto [key, _] : synced_prefs.all_children_view()) {
279  if(!utils::contains(synced_children_, key)) {
280  unknown_synced_children_.insert(key);
281  }
282  }
283  for(const auto [key, _] : unsynced_prefs.all_children_view()) {
285  unknown_unsynced_children_.insert(key);
286  }
287  }
288  } catch(const config::error& e) {
289  ERR_CFG << "Error loading preference, message: " << e.what();
290  }
291 
294 
295  /*
296  completed_campaigns = "A,B,C"
297  [completed_campaigns]
298  [campaign]
299  name = "A"
300  difficulty_levels = "EASY,MEDIUM"
301  [/campaign]
302  [/completed_campaigns]
303  */
304  // presumably for backwards compatibility?
305  // nothing actually sets the attribute, only the child tags
306  for(const std::string& c : utils::split(preferences_[prefs_list::completed_campaigns])) {
307  completed_campaigns_[c]; // create the elements
308  }
309 
310  if(auto ccc = get_child(prefs_list::completed_campaigns)) {
311  for(const config& cc : ccc->child_range("campaign")) {
312  std::set<std::string>& d = completed_campaigns_[cc["name"]];
313  std::vector<std::string> nd = utils::split(cc["difficulty_levels"]);
314  std::copy(nd.begin(), nd.end(), std::inserter(d, d.begin()));
315  }
316  }
317 
318  encountered_units_set_ = utils::split_set(preferences_[prefs_list::encountered_units].str());
319 
320  const t_translation::ter_list terrain(t_translation::read_list(preferences_[prefs_list::encountered_terrain_list].str()));
321  encountered_terrains_set_.insert(terrain.begin(), terrain.end());
322 
323  if(auto history = get_child(prefs_list::history)) {
324  /* Structure of the history
325  [history]
326  [history_id]
327  [line]
328  message = foobar
329  [/line]
330  */
331  for(const auto [key, cfg] : history->all_children_view()) {
332  for(const config& l : cfg.child_range("line")) {
333  history_map_[key].push_back(l["message"]);
334  }
335  }
336  }
337 }
338 
340 {
341 #ifndef _WIN32
342  bool synced_prefs_file_existed = filesystem::file_exists(filesystem::get_synced_prefs_file());
343  bool unsynced_prefs_file_existed = filesystem::file_exists(filesystem::get_unsynced_prefs_file());
344 #endif
345 
346  config synced;
347  config unsynced;
348 
349  for(const char* attr : synced_attributes_) {
350  if(preferences_.has_attribute(attr)) {
351  synced[attr] = preferences_[attr];
352  }
353  }
354  for(const char* attr : synced_children_) {
355  for(const auto& child : preferences_.child_range(attr)) {
356  synced.add_child(attr, child);
357  }
358  }
359 
360  for(const char* attr : unsynced_attributes_) {
361  if(preferences_.has_attribute(attr)) {
362  unsynced[attr] = preferences_[attr];
363  }
364  }
365  for(const char* attr : unsynced_children_) {
366  for(const auto& child : preferences_.child_range(attr)) {
367  unsynced.add_child(attr, child);
368  }
369  }
370 
371  // write any unknown preferences back out
372  for(const std::string& attr : unknown_synced_attributes_) {
373  synced[attr] = preferences_[attr];
374  }
375  for(const std::string& attr : unknown_synced_children_) {
376  for(const auto& child : preferences_.child_range(attr)) {
377  synced.add_child(attr, child);
378  }
379  }
380 
381  for(const std::string& attr : unknown_unsynced_attributes_) {
382  unsynced[attr] = preferences_[attr];
383  }
384  for(const std::string& attr : unknown_unsynced_children_) {
385  for(const auto& child : preferences_.child_range(attr)) {
386  unsynced.add_child(attr, child);
387  }
388  }
389 
390  try {
392  } catch(const filesystem::io_exception&) {
393  ERR_FS << "error writing to synced preferences file '" << filesystem::get_synced_prefs_file() << "'";
394  }
395 
396  try {
398  } catch(const filesystem::io_exception&) {
399  ERR_FS << "error writing to unsynced preferences file '" << filesystem::get_unsynced_prefs_file() << "'";
400  }
401 
403 
404 #ifndef _WIN32
405  if(!synced_prefs_file_existed) {
406  if(chmod(filesystem::get_synced_prefs_file().c_str(), 0600) == -1) {
407  ERR_FS << "error setting permissions of preferences file '" << filesystem::get_synced_prefs_file() << "'";
408  }
409  }
410  if(!unsynced_prefs_file_existed) {
411  if(chmod(filesystem::get_unsynced_prefs_file().c_str(), 0600) == -1) {
412  ERR_FS << "error setting permissions of unsynced preferences file '" << filesystem::get_unsynced_prefs_file() << "'";
413  }
414  }
415 #endif
416 }
417 
419 {
420  // Zero them before clearing.
421  // Probably overly paranoid, but doesn't hurt?
422  for(auto& cred : credentials_) {
423  std::fill(cred.username.begin(), cred.username.end(), '\0');
424  std::fill(cred.server.begin(), cred.server.end(), '\0');
425  }
426  credentials_.clear();
427 }
428 
430 {
431  if(!remember_password()) {
432  return;
433  }
435  std::string cred_file = filesystem::get_credentials_file();
436  if(!filesystem::file_exists(cred_file)) {
437  return;
438  }
439  filesystem::scoped_istream stream = filesystem::istream_file(cred_file, false);
440  // Credentials file is a binary blob, so use streambuf iterator
441  preferences::secure_buffer data((std::istreambuf_iterator<char>(*stream)), (std::istreambuf_iterator<char>()));
443  if(data.empty() || data[0] != pref_constants::CREDENTIAL_SEPARATOR) {
444  ERR_CFG << "Invalid data in credentials file";
445  return;
446  }
447  for(const std::string& elem : utils::split(std::string(data.begin(), data.end()), pref_constants::CREDENTIAL_SEPARATOR, utils::REMOVE_EMPTY)) {
448  std::size_t at = elem.find_last_of('@');
449  std::size_t eq = elem.find_first_of('=', at + 1);
450  if(at != std::string::npos && eq != std::string::npos) {
451  preferences::secure_buffer key(elem.begin() + eq + 1, elem.end());
452  credentials_.emplace_back(elem.substr(0, at), elem.substr(at + 1, eq - at - 1), unescape(key));
453  }
454  }
455 }
456 
458 {
459  if(!remember_password()) {
461  return;
462  }
463 
464 #ifndef _WIN32
465  bool creds_file_existed = filesystem::file_exists(filesystem::get_credentials_file());
466 #endif
467 
468  preferences::secure_buffer credentials_data;
469  for(const auto& cred : credentials_) {
470  credentials_data.push_back(pref_constants::CREDENTIAL_SEPARATOR);
471  credentials_data.insert(credentials_data.end(), cred.username.begin(), cred.username.end());
472  credentials_data.push_back('@');
473  credentials_data.insert(credentials_data.end(), cred.server.begin(), cred.server.end());
474  credentials_data.push_back('=');
475  preferences::secure_buffer key_escaped = escape(cred.key);
476  credentials_data.insert(credentials_data.end(), key_escaped.begin(), key_escaped.end());
477  }
478  try {
480  preferences::secure_buffer encrypted = aes_encrypt(credentials_data, build_key("global", get_system_username()));
481  credentials_file->write(reinterpret_cast<const char*>(encrypted.data()), encrypted.size());
482  } catch(const filesystem::io_exception&) {
483  ERR_CFG << "error writing to credentials file '" << filesystem::get_credentials_file() << "'";
484  }
485 
486 #ifndef _WIN32
487  if(!creds_file_existed) {
488  if(chmod(filesystem::get_credentials_file().c_str(), 0600) == -1) {
489  ERR_FS << "error setting permissions of credentials file '" << filesystem::get_credentials_file() << "'";
490  }
491  }
492 #endif
493 }
494 
495 //
496 // helpers
497 //
498 void prefs::set_child(const std::string& key, const config& val) {
500  preferences_.add_child(key, val);
501 }
502 
504 {
505  return preferences_.optional_child(key);
506 }
507 
508 std::string prefs::get(const std::string& key, const std::string& def) {
509  return preferences_[key].empty() ? def : preferences_[key];
510 }
511 
513 {
514  return preferences_[key];
515 }
516 
517 //
518 // accessors
519 //
520 static std::string fix_orb_color_name(const std::string& color) {
521  if (color.substr(0,4) == "orb_") {
522  if(color[4] >= '0' && color[4] <= '9') {
523  return color.substr(5);
524  } else {
525  return color.substr(4);
526  }
527  }
528  return color;
529 }
530 
531 std::string prefs::allied_color() {
532  std::string ally_color = preferences_[prefs_list::ally_orb_color].str();
533  if (ally_color.empty())
535  return fix_orb_color_name(ally_color);
536 }
537 void prefs::set_allied_color(const std::string& color_id) {
539 }
540 
541 std::string prefs::enemy_color() {
543  if (enemy_color.empty())
546 }
547 void prefs::set_enemy_color(const std::string& color_id) {
549 }
550 
551 std::string prefs::moved_color() {
553  if (moved_color.empty())
556 }
557 void prefs::set_moved_color(const std::string& color_id) {
559 }
560 
561 std::string prefs::unmoved_color() {
563  if (unmoved_color.empty())
566 }
567 void prefs::set_unmoved_color(const std::string& color_id) {
569 }
570 
571 std::string prefs::partial_color() {
572  std::string partmoved_color = preferences_[prefs_list::partial_orb_color].str();
573  if (partmoved_color.empty())
575  return fix_orb_color_name(partmoved_color);
576 }
577 void prefs::set_partial_color(const std::string& color_id) {
579 }
580 std::string prefs::reach_map_color() {
581  std::string reachmap_color = preferences_[prefs_list::reach_map_color].str();
582  if (reachmap_color.empty())
584  return fix_orb_color_name(reachmap_color);
585 }
586 void prefs::set_reach_map_color(const std::string& color_id) {
588 }
589 
591  std::string reachmap_enemy_color = preferences_[prefs_list::reach_map_enemy_color].str();
592  if (reachmap_enemy_color.empty())
594  return fix_orb_color_name(reachmap_enemy_color);
595 }
596 void prefs::set_reach_map_enemy_color(const std::string& color_id) {
598 }
599 
601 {
603 }
604 
605 void prefs::set_reach_map_border_opacity(const int new_opacity)
606 {
608 }
609 
611 {
613 }
614 
615 void prefs::set_reach_map_tint_opacity(const int new_opacity)
616 {
618 }
619 
621 {
622  const unsigned x_res = preferences_[prefs_list::xresolution].to_unsigned();
623  const unsigned y_res = preferences_[prefs_list::yresolution].to_unsigned();
624 
625  // Either resolution was unspecified, return default.
626  if(x_res == 0 || y_res == 0) {
628  }
629 
630  return point(
631  std::max<unsigned>(x_res, pref_constants::min_window_width),
632  std::max<unsigned>(y_res, pref_constants::min_window_height)
633  );
634 }
635 
636 void prefs::set_resolution(const point& res)
637 {
638  preferences_[prefs_list::xresolution] = std::to_string(res.x);
639  preferences_[prefs_list::yresolution] = std::to_string(res.y);
640 }
641 
643 {
644  // For now this has a minimum value of 1 and a maximum of 4.
645  return std::max<int>(std::min<int>(preferences_[prefs_list::pixel_scale].to_int(1), pref_constants::max_pixel_scale), pref_constants::min_pixel_scale);
646 }
647 
649 {
651 }
652 
654 {
655  if(video::headless()) {
656  return true;
657  }
658 
659  return preferences_[prefs_list::turbo].to_bool();
660 }
661 
662 void prefs::set_turbo(bool ison)
663 {
664  preferences_[prefs_list::turbo] = ison;
665 }
666 
668 {
669  // Clip at 80 because if it's too low it'll cause crashes
670  return std::max<int>(std::min<int>(preferences_[prefs_list::font_scale].to_int(100), pref_constants::max_font_scaling), pref_constants::min_font_scaling);
671 }
672 
674 {
676 }
677 
679 {
680  return (size * font_scaling()) / 100;
681 }
682 
684 {
685  return preferences_[prefs_list::keepalive_timeout].to_int(20);
686 }
687 
688 void prefs::keepalive_timeout(int seconds)
689 {
690  preferences_[prefs_list::keepalive_timeout] = std::abs(seconds);
691 }
692 
694 {
695  // Sounds don't sound good on Windows unless the buffer size is 4k,
696  // but this seems to cause crashes on other systems...
697  #ifdef _WIN32
698  const std::size_t buf_size = 4096;
699  #else
700  const std::size_t buf_size = 1024;
701  #endif
702 
703  return preferences_[prefs_list::sound_buffer_size].to_int(buf_size);
704 }
705 
706 void prefs::save_sound_buffer_size(const std::size_t size)
707 {
708  const std::string new_size = std::to_string(size);
709  if (preferences_[prefs_list::sound_buffer_size] == new_size)
710  return;
711 
712  preferences_[prefs_list::sound_buffer_size] = new_size;
713 
715 }
716 
718 {
719  return preferences_[prefs_list::music_volume].to_int(100);
720 }
721 
723 {
724  if(music_volume() == vol) {
725  return;
726  }
727 
730 }
731 
733 {
734  return preferences_[prefs_list::sound_volume].to_int(100);
735 }
736 
738 {
739  if(sound_volume() == vol) {
740  return;
741  }
742 
745 }
746 
748 {
749  return preferences_[prefs_list::bell_volume].to_int(100);
750 }
751 
753 {
754  if(bell_volume() == vol) {
755  return;
756  }
757 
760 }
761 
762 // old pref name had uppercase UI
764 {
766  return preferences_[prefs_list::ui_volume].to_int(100);
767  } else {
768  return preferences_["UI_volume"].to_int(100);
769  }
770 }
771 
772 void prefs::set_ui_volume(int vol)
773 {
774  if(ui_volume() == vol) {
775  return;
776  }
777 
780 }
781 
783 {
784  return preferences_[prefs_list::turn_bell].to_bool(true);
785 }
786 
787 bool prefs::set_turn_bell(bool ison)
788 {
789  if(!turn_bell() && ison) {
791  if(!music_on() && !sound() && !ui_sound_on()) {
792  if(!sound::init_sound()) {
794  return false;
795  }
796  }
797  } else if(turn_bell() && !ison) {
800  if(!music_on() && !sound() && !ui_sound_on())
802  }
803  return true;
804 }
805 
806 // old pref name had uppercase UI
808 {
809  if(preferences_.has_attribute(prefs_list::ui_sound)) {
810  return preferences_[prefs_list::ui_sound].to_bool(true);
811  } else {
812  return preferences_["UI_sound"].to_bool(true);
813  }
814 }
815 
816 bool prefs::set_ui_sound(bool ison)
817 {
818  if(!ui_sound_on() && ison) {
819  preferences_[prefs_list::ui_sound] = true;
820  if(!music_on() && !sound() && !turn_bell()) {
821  if(!sound::init_sound()) {
822  preferences_[prefs_list::ui_sound] = false;
823  return false;
824  }
825  }
826  } else if(ui_sound_on() && !ison) {
827  preferences_[prefs_list::ui_sound] = false;
829  if(!music_on() && !sound() && !turn_bell())
831  }
832  return true;
833 }
834 
836 {
837  return preferences_[prefs_list::message_bell].to_bool(true);
838 }
839 
841 {
842  return preferences_[prefs_list::sound].to_bool(true);
843 }
844 
845 bool prefs::set_sound(bool ison) {
846  if(!sound() && ison) {
848  if(!music_on() && !turn_bell() && !ui_sound_on()) {
849  if(!sound::init_sound()) {
851  return false;
852  }
853  }
854  } else if(sound() && !ison) {
857  if(!music_on() && !turn_bell() && !ui_sound_on())
859  }
860  return true;
861 }
862 
864 {
865  return preferences_[prefs_list::music].to_bool(true);
866 }
867 
868 bool prefs::set_music(bool ison) {
869  if(!music_on() && ison) {
870  preferences_[prefs_list::music] = true;
871  if(!sound() && !turn_bell() && !ui_sound_on()) {
872  if(!sound::init_sound()) {
873  preferences_[prefs_list::music] = false;
874  return false;
875  }
876  }
877  else
879  } else if(music_on() && !ison) {
880  preferences_[prefs_list::music] = false;
881  if(!sound() && !turn_bell() && !ui_sound_on())
883  else
885  }
886  return true;
887 }
888 
890 {
891  return std::clamp<int>(preferences_[prefs_list::scroll].to_int(50), 1, 100);
892 }
893 
894 void prefs::set_scroll_speed(const int new_speed)
895 {
896  preferences_[prefs_list::scroll] = new_speed;
897 }
898 
900 {
901  return preferences_[prefs_list::middle_click_scrolls].to_bool(true);
902 }
903 
905 {
906  return preferences_[prefs_list::scroll_threshold].to_int(10);
907 }
908 
910 {
911  return fps_;
912 }
913 
914 void prefs::set_show_fps(bool value)
915 {
916  fps_ = value;
917 }
918 
920 {
922 }
923 
925 {
927 }
928 
930 {
932  preferences_.clear_children("hotkey");
933 }
934 
935 void prefs::add_alias(const std::string &alias, const std::string &command)
936 {
937  config &alias_list = preferences_.child_or_add("alias");
938  alias_list[alias] = command;
939 }
940 
941 
943 {
944  return get_child(prefs_list::alias);
945 }
946 
947 unsigned int prefs::sample_rate()
948 {
949  return preferences_[prefs_list::sample_rate].to_int(44100);
950 }
951 
952 void prefs::save_sample_rate(const unsigned int rate)
953 {
954  if (sample_rate() == rate)
955  return;
956 
957  preferences_[prefs_list::sample_rate] = rate;
958 
959  // If audio is open, we have to re set sample rate
961 }
962 
964 {
965  return preferences_[prefs_list::confirm_load_save_from_different_version].to_bool(true);
966 }
967 
969 {
970  return preferences_[prefs_list::use_twelve_hour_clock_format].to_bool();
971 }
972 
974 {
975  return sort_order::get_enum(preferences_[prefs_list::addon_manager_saved_order_direction].to_int()).value_or(sort_order::type::none);
976 }
977 
979 {
980  preferences_[prefs_list::addon_manager_saved_order_direction] = sort_order::get_string(value);
981 }
982 
983 bool prefs::achievement(const std::string& content_for, const std::string& id)
984 {
985  for(config& ach : preferences_.child_range(prefs_list::achievements))
986  {
987  if(ach["content_for"].str() == content_for)
988  {
989  return utils::contains(utils::split(ach["ids"]), id);
990  }
991  }
992  return false;
993 }
994 
995 void prefs::set_achievement(const std::string& content_for, const std::string& id)
996 {
997  for(config& ach : preferences_.child_range(prefs_list::achievements))
998  {
999  // if achievements already exist for this content and the achievement has not already been set, add it
1000  if(ach["content_for"].str() == content_for)
1001  {
1002  std::vector<std::string> ids = utils::split(ach["ids"]);
1003 
1004  if(ids.empty())
1005  {
1006  ach["ids"] = id;
1007  }
1008  else if(!utils::contains(ids, id))
1009  {
1010  ach["ids"] = ach["ids"].str() + "," + id;
1011  }
1012  ach.remove_children("in_progress", [&id](config cfg){return cfg["id"].str() == id;});
1013  return;
1014  }
1015  }
1016 
1017  // else no achievements have been set for this content yet
1018  config ach;
1019  ach["content_for"] = content_for;
1020  ach["ids"] = id;
1021  preferences_.add_child(prefs_list::achievements, ach);
1022 }
1023 
1024 int prefs::progress_achievement(const std::string& content_for, const std::string& id, int limit, int max_progress, int amount)
1025 {
1026  if(achievement(content_for, id))
1027  {
1028  return -1;
1029  }
1030 
1031  for(config& ach : preferences_.child_range(prefs_list::achievements))
1032  {
1033  // if achievements already exist for this content and the achievement has not already been set, add it
1034  if(ach["content_for"].str() == content_for)
1035  {
1036  // check if this achievement has progressed before - if so then increment it
1037  for(config& in_progress : ach.child_range("in_progress"))
1038  {
1039  if(in_progress["id"].str() == id)
1040  {
1041  // don't let using 'limit' decrease the achievement's current progress
1042  int starting_progress = in_progress["progress_at"].to_int();
1043  if(starting_progress >= limit) {
1044  return starting_progress;
1045  }
1046 
1047  in_progress["progress_at"] = std::clamp(starting_progress + amount, 0, std::min(limit, max_progress));
1048  return in_progress["progress_at"].to_int();
1049  }
1050  }
1051 
1052  // else this is the first time this achievement is progressing
1053  if(amount != 0)
1054  {
1055  config set_progress;
1056  set_progress["id"] = id;
1057  set_progress["progress_at"] = std::clamp(amount, 0, std::min(limit, max_progress));
1058 
1059  config& child = ach.add_child("in_progress", set_progress);
1060  return child["progress_at"].to_int();
1061  }
1062  return 0;
1063  }
1064  }
1065 
1066  // else not only has this achievement not progressed before, this is the first achievement for this achievement group to be added
1067  if(amount != 0)
1068  {
1069  config ach;
1070  config set_progress;
1071 
1072  set_progress["id"] = id;
1073  set_progress["progress_at"] = std::clamp(amount, 0, std::min(limit, max_progress));
1074 
1075  ach["content_for"] = content_for;
1076  ach["ids"] = "";
1077 
1078  config& child = ach.add_child("in_progress", set_progress);
1079  preferences_.add_child(prefs_list::achievements, ach);
1080  return child["progress_at"].to_int();
1081  }
1082  return 0;
1083 }
1084 
1085 bool prefs::sub_achievement(const std::string& content_for, const std::string& id, const std::string& sub_id)
1086 {
1087  // this achievement is already completed
1088  if(achievement(content_for, id))
1089  {
1090  return true;
1091  }
1092 
1093  for(config& ach : preferences_.child_range(prefs_list::achievements))
1094  {
1095  if(ach["content_for"].str() == content_for)
1096  {
1097  // check if the specific sub-achievement has been completed but the overall achievement is not completed
1098  for(const auto& in_progress : ach.child_range("in_progress"))
1099  {
1100  if(in_progress["id"] == id)
1101  {
1102  return utils::contains(utils::split(in_progress["sub_ids"]), sub_id);
1103  }
1104  }
1105  }
1106  }
1107  return false;
1108 }
1109 
1110 void prefs::set_sub_achievement(const std::string& content_for, const std::string& id, const std::string& sub_id)
1111 {
1112  // this achievement is already completed
1113  if(achievement(content_for, id))
1114  {
1115  return;
1116  }
1117 
1118  for(config& ach : preferences_.child_range(prefs_list::achievements))
1119  {
1120  // if achievements already exist for this content and the achievement has not already been set, add it
1121  if(ach["content_for"].str() == content_for)
1122  {
1123  // check if this achievement has had sub-achievements set before
1124  for(config& in_progress : ach.child_range("in_progress"))
1125  {
1126  if(in_progress["id"].str() == id)
1127  {
1128  std::vector<std::string> sub_ids = utils::split(in_progress["sub_ids"]);
1129 
1130  if(!utils::contains(sub_ids, sub_id))
1131  {
1132  in_progress["sub_ids"] = in_progress["sub_ids"].str() + "," + sub_id;
1133  }
1134 
1135  in_progress["progress_at"] = sub_ids.size()+1;
1136  return;
1137  }
1138  }
1139 
1140  // else if this is the first sub-achievement being set
1141  config set_progress;
1142  set_progress["id"] = id;
1143  set_progress["sub_ids"] = sub_id;
1144  set_progress["progress_at"] = 1;
1145  ach.add_child("in_progress", set_progress);
1146  return;
1147  }
1148  }
1149 
1150  // else not only has this achievement not had a sub-achievement completed before, this is the first achievement for this achievement group to be added
1151  config ach;
1152  config set_progress;
1153 
1154  set_progress["id"] = id;
1155  set_progress["sub_ids"] = sub_id;
1156  set_progress["progress_at"] = 1;
1157 
1158  ach["content_for"] = content_for;
1159  ach["ids"] = "";
1160 
1161  ach.add_child("in_progress", set_progress);
1162  preferences_.add_child(prefs_list::achievements, ach);
1163 }
1164 
1166 {
1167  return preferences_[prefs_list::show_deprecation].to_bool(def);
1168 }
1169 
1171 {
1172  return preferences_[prefs_list::scroll_when_mouse_outside].to_bool(def);
1173 }
1174 
1176 {
1177  set_child(prefs_list::dir_bookmarks, cfg);
1178 }
1180 {
1181  return get_child(prefs_list::dir_bookmarks);
1182 }
1183 
1185 {
1186  return preferences_[prefs_list::lobby_auto_open_whisper_windows].to_bool(true);
1187 }
1188 
1190 {
1191  return std::max(std::size_t(1), preferences_[prefs_list::editor_max_recent_files].to_size_t(10));
1192 }
1193 
1194 //
1195 // NOTE: The MRU read/save functions enforce the entry count limit in
1196 // order to ensure the list on disk doesn't grow forever. Otherwise,
1197 // normally this would be the UI's responsibility instead.
1198 //
1199 
1200 std::vector<std::string> prefs::do_read_editor_mru()
1201 {
1202  auto cfg = get_child(prefs_list::editor_recent_files);
1203 
1204  std::vector<std::string> mru;
1205  if(!cfg) {
1206  return mru;
1207  }
1208 
1209  for(const config& child : cfg->child_range("entry"))
1210  {
1211  const std::string& entry = child["path"].str();
1212  if(!entry.empty()) {
1213  mru.push_back(entry);
1214  }
1215  }
1216 
1217  mru.resize(std::min(editor_mru_limit(), mru.size()));
1218 
1219  return mru;
1220 }
1221 
1222 void prefs::do_commit_editor_mru(const std::vector<std::string>& mru)
1223 {
1224  config cfg;
1225  unsigned n = 0;
1226 
1227  for(const std::string& entry : mru)
1228  {
1229  if(entry.empty()) {
1230  continue;
1231  }
1232 
1233  config& child = cfg.add_child("entry");
1234  child["path"] = entry;
1235 
1236  if(++n >= editor_mru_limit()) {
1237  break;
1238  }
1239  }
1240 
1241  set_child(prefs_list::editor_recent_files, cfg);
1242 }
1243 
1244 std::vector<std::string> prefs::recent_files()
1245 {
1246  return do_read_editor_mru();
1247 }
1248 
1249 void prefs::add_recent_files_entry(const std::string& path)
1250 {
1251  if(path.empty()) {
1252  return;
1253  }
1254 
1255  std::vector<std::string> mru = do_read_editor_mru();
1256 
1257  // Enforce uniqueness. Normally shouldn't do a thing unless somebody
1258  // has been tampering with the preferences file.
1259  utils::erase(mru, path);
1260 
1261  mru.insert(mru.begin(), path);
1262  mru.resize(std::min(editor_mru_limit(), mru.size()));
1263 
1264  do_commit_editor_mru(mru);
1265 }
1266 
1268 {
1269  return preferences_[prefs_list::color_cursors].to_bool(true);
1270 }
1271 
1273 {
1274  preferences_[prefs_list::color_cursors] = value;
1275 
1276  cursor::set();
1277 }
1278 
1280 {
1281  return preferences_[prefs_list::unit_standing_animations].to_bool(true);
1282 }
1283 
1285 {
1286  preferences_[prefs_list::unit_standing_animations] = value;
1287 
1288  if(display* d = display::get_singleton()) {
1289  d->reset_standing_animations();
1290  }
1291 }
1292 
1294 {
1295  std::vector<theme_info> themes = theme::get_basic_theme_info();
1296 
1297  if (themes.empty()) {
1299  _("No known themes. Try changing from within an existing game."));
1300 
1301  return false;
1302  }
1303 
1304  gui2::dialogs::theme_list dlg(themes);
1305 
1306  for (std::size_t k = 0; k < themes.size(); ++k) {
1307  if(themes[k].id == theme()) {
1308  dlg.set_selected_index(static_cast<int>(k));
1309  }
1310  }
1311 
1312  dlg.show();
1313  const int action = dlg.selected_index();
1314 
1315  if (action >= 0) {
1316  set_theme(themes[action].id);
1317  if(display::get_singleton() && resources::gamedata && resources::gamedata->get_theme().empty()) {
1318  display::get_singleton()->set_theme(themes[action].id);
1319  }
1320 
1321  return true;
1322  }
1323 
1324  return false;
1325 }
1326 
1328 {
1329  const std::string filename = filesystem::get_wesnothd_name();
1330 
1331  const std::string& old_path = filesystem::directory_name(get_mp_server_program_name());
1332  std::string path =
1333  !old_path.empty() && filesystem::is_directory(old_path)
1334  ? old_path : filesystem::get_exe_dir();
1335 
1336  const std::string msg = VGETTEXT("The <b>$filename</b> server application provides multiplayer server functionality and is required for hosting local network games. It will normally be found in the same folder as the game executable.", {{"filename", filename}});
1337 
1339 
1340  dlg.set_title(_("Find Server Application"))
1341  .set_message(msg)
1342  .set_ok_label(_("Select"))
1343  .set_read_only(true)
1345  .set_path(path);
1346 
1347  if(dlg.show()) {
1348  path = dlg.path();
1350  }
1351 }
1352 
1353 std::string prefs::theme()
1354 {
1355  if(video::headless()) {
1356  static const std::string null_theme = "null";
1357  return null_theme;
1358  }
1359 
1360  std::string res = preferences_[prefs_list::theme];
1361  if(res.empty()) {
1362  return "Default";
1363  }
1364 
1365  return res;
1366 }
1367 
1368 void prefs::set_theme(const std::string& theme)
1369 {
1370  if(theme != "null") {
1371  preferences_[prefs_list::theme] = theme;
1372  }
1373 }
1374 
1375 void prefs::set_mp_server_program_name(const std::string& path)
1376 {
1377  if(path.empty()) {
1378  preferences_.remove_attribute(prefs_list::mp_server_program_name);
1379  } else {
1380  preferences_[prefs_list::mp_server_program_name] = path;
1381  }
1382 }
1383 
1385 {
1386  return preferences_[prefs_list::mp_server_program_name].str();
1387 }
1388 
1389 const std::map<std::string, preferences::acquaintance>& prefs::get_acquaintances()
1390 {
1391  return acquaintances_;
1392 }
1393 
1394 const std::string prefs::get_ignored_delim()
1395 {
1396  std::vector<std::string> ignored;
1397 
1398  for(const auto& person : acquaintances_) {
1399  if(person.second.get_status() == "ignore") {
1400  ignored.push_back(person.second.get_nick());
1401  }
1402  }
1403 
1404  return utils::join(ignored);
1405 }
1406 
1407 // returns acquaintances in the form nick => notes where the status = filter
1408 std::map<std::string, std::string> prefs::get_acquaintances_nice(const std::string& filter)
1409 {
1410  std::map<std::string, std::string> ac_nice;
1411 
1412  for(const auto& a : acquaintances_) {
1413  if(a.second.get_status() == filter) {
1414  ac_nice[a.second.get_nick()] = a.second.get_notes();
1415  }
1416  }
1417 
1418  return ac_nice;
1419 }
1420 
1421 std::pair<preferences::acquaintance*, bool> prefs::add_acquaintance(const std::string& nick, const std::string& mode, const std::string& notes)
1422 {
1423  if(!utils::isvalid_wildcard(nick)) {
1424  return std::pair(nullptr, false);
1425  }
1426 
1427  preferences::acquaintance new_entry(nick, mode, notes);
1428  auto [iter, added_new] = acquaintances_.insert_or_assign(nick, new_entry);
1429 
1430  return std::pair(&iter->second, added_new);
1431 }
1432 
1433 bool prefs::remove_acquaintance(const std::string& nick)
1434 {
1436 
1437  // nick might include the notes, depending on how we're removing
1438  if(i == acquaintances_.end()) {
1439  std::size_t pos = nick.find_first_of(' ');
1440 
1441  if(pos != std::string::npos) {
1442  i = acquaintances_.find(nick.substr(0, pos));
1443  }
1444  }
1445 
1446  if(i == acquaintances_.end()) {
1447  return false;
1448  }
1449 
1450  acquaintances_.erase(i);
1451 
1452  return true;
1453 }
1454 
1455 bool prefs::is_friend(const std::string& nick)
1456 {
1457  const auto it = acquaintances_.find(nick);
1458 
1459  if(it == acquaintances_.end()) {
1460  return false;
1461  } else {
1462  return it->second.get_status() == "friend";
1463  }
1464 }
1465 
1466 bool prefs::is_ignored(const std::string& nick)
1467 {
1468  const auto it = acquaintances_.find(nick);
1469 
1470  if(it == acquaintances_.end()) {
1471  return false;
1472  } else {
1473  return it->second.get_status() == "ignore";
1474  }
1475 }
1476 
1477 void prefs::add_completed_campaign(const std::string& campaign_id, const std::string& difficulty_level)
1478 {
1479  completed_campaigns_[campaign_id].insert(difficulty_level);
1480 }
1481 
1482 bool prefs::is_campaign_completed(const std::string& campaign_id)
1483 {
1484  return completed_campaigns_.count(campaign_id) != 0;
1485 }
1486 
1487 bool prefs::is_campaign_completed(const std::string& campaign_id, const std::string& difficulty_level)
1488 {
1489  const auto it = completed_campaigns_.find(campaign_id);
1490  return it == completed_campaigns_.end() ? false : it->second.count(difficulty_level) != 0;
1491 }
1492 
1493 bool prefs::parse_should_show_lobby_join(const std::string& sender, const std::string& message)
1494 {
1495  // If it's actually not a lobby join or leave message return true (show it).
1496  if(sender != "server") {
1497  return true;
1498  }
1499 
1500  std::string::size_type pos = message.find(" has logged into the lobby");
1501  if(pos == std::string::npos) {
1502  pos = message.find(" has disconnected");
1503  if(pos == std::string::npos) {
1504  return true;
1505  }
1506  }
1507 
1510  return false;
1511  }
1512 
1514  return true;
1515  }
1516 
1517  return is_friend(message.substr(0, pos));
1518 }
1519 
1521 {
1522  std::string pref = preferences_[prefs_list::lobby_joins];
1523  if(pref == "friends") {
1525  } else if(pref == "all") {
1527  } else if(pref == "none") {
1529  } else {
1531  }
1532 }
1533 
1535 {
1542  }
1543 }
1544 
1545 const std::vector<game_config::server_info>& prefs::builtin_servers_list()
1546 {
1547  static std::vector<game_config::server_info> pref_servers = game_config::server_list;
1548  return pref_servers;
1549 }
1550 
1551 void prefs::add_game_preset(config&& preset_data)
1552 {
1553  config preset{ prefs_list::game_preset, std::move(preset_data) };
1554 
1555  int min = 0;
1556  for(const auto& c : preferences_.child_range(prefs_list::game_preset)) {
1557  min = std::min(min, c["id"].to_int());
1558  }
1559  preset.mandatory_child(prefs_list::game_preset)["id"] = min-1;
1560  preferences_.append(preset);
1561 }
1562 
1564 {
1565  preferences_.remove_children(prefs_list::game_preset, [&id](const config& preset) {return preset["id"] == id;});
1566 }
1567 
1569 {
1570  return preferences_.child_range(prefs_list::game_preset);
1571 }
1572 
1574 {
1575  return preferences_.find_child(prefs_list::game_preset, "id", std::to_string(id));
1576 }
1577 
1578 std::vector<game_config::server_info> prefs::user_servers_list()
1579 {
1580  std::vector<game_config::server_info> pref_servers;
1581 
1582  for(const config& server : preferences_.child_range(prefs_list::server)) {
1583  pref_servers.emplace_back();
1584  pref_servers.back().name = server["name"].str();
1585  pref_servers.back().address = server["address"].str();
1586  }
1587 
1588  return pref_servers;
1589 }
1590 
1591 void prefs::set_user_servers_list(const std::vector<game_config::server_info>& value)
1592 {
1593  preferences_.clear_children(prefs_list::server);
1594 
1595  for(const auto& svinfo : value) {
1596  config& sv_cfg = preferences_.add_child(prefs_list::server);
1597  sv_cfg["name"] = svinfo.name;
1598  sv_cfg["address"] = svinfo.address;
1599  }
1600 }
1601 
1602 std::string prefs::network_host()
1603 {
1604  std::string res = preferences_[prefs_list::host];
1605  if(res.empty()) {
1606  return builtin_servers_list().front().address;
1607  } else {
1608  return res;
1609  }
1610 }
1611 
1612 void prefs::set_network_host(const std::string& host)
1613 {
1614  preferences_[prefs_list::host] = host;
1615 }
1616 
1618 {
1619  if(!preferences_[prefs_list::campaign_server].empty()) {
1620  return preferences_[prefs_list::campaign_server].str();
1621  } else {
1623  }
1624 }
1625 
1626 void prefs::set_campaign_server(const std::string& host)
1627 {
1628  preferences_[prefs_list::campaign_server] = host;
1629 }
1630 
1632 {
1633  return preferences_[prefs_list::show_combat].to_bool(true);
1634 }
1635 
1637 {
1638  if(options_initialized_) {
1639  return option_values_;
1640  }
1641 
1642  if(!get_child(prefs_list::options)) {
1643  // It may be an invalid config, which would cause problems in
1644  // multiplayer_create, so let's replace it with an empty but valid
1645  // config
1647  } else {
1648  option_values_ = *get_child(prefs_list::options);
1649  }
1650 
1651  options_initialized_ = true;
1652 
1653  return option_values_;
1654 }
1655 
1657 {
1658  set_child(prefs_list::options, values);
1659  options_initialized_ = false;
1660 }
1661 
1662 std::chrono::seconds prefs::countdown_init_time()
1663 {
1664  return chrono::parse_duration(preferences_[prefs_list::mp_countdown_init_time], 240s);
1665 }
1666 
1667 void prefs::set_countdown_init_time(const std::chrono::seconds& value)
1668 {
1669  preferences_[prefs_list::mp_countdown_init_time] = std::clamp(value, 0s, 1500s);
1670 }
1671 
1673 {
1674  preferences_.remove_attribute(prefs_list::mp_countdown_init_time);
1675 }
1676 
1677 std::chrono::seconds prefs::countdown_reservoir_time()
1678 {
1679  return chrono::parse_duration(preferences_[prefs_list::mp_countdown_reservoir_time], 360s);
1680 }
1681 
1682 void prefs::set_countdown_reservoir_time(const std::chrono::seconds& value)
1683 {
1684  preferences_[prefs_list::mp_countdown_reservoir_time] = std::clamp(value, 30s, 1500s);
1685 }
1686 
1688 {
1689  preferences_.remove_attribute(prefs_list::mp_countdown_reservoir_time);
1690 }
1691 
1692 std::chrono::seconds prefs::countdown_turn_bonus()
1693 {
1694  return chrono::parse_duration(preferences_[prefs_list::mp_countdown_turn_bonus], 240s);
1695 }
1696 
1697 void prefs::set_countdown_turn_bonus(const std::chrono::seconds& value)
1698 {
1699  preferences_[prefs_list::mp_countdown_turn_bonus] = std::clamp(value, 0s, 300s);
1700 }
1701 
1703 {
1704  preferences_.remove_attribute(prefs_list::mp_countdown_turn_bonus);
1705 }
1706 
1707 std::chrono::seconds prefs::countdown_action_bonus()
1708 {
1709  return chrono::parse_duration(preferences_[prefs_list::mp_countdown_action_bonus], 0s);
1710 }
1711 
1712 void prefs::set_countdown_action_bonus(const std::chrono::seconds& value)
1713 {
1714  preferences_[prefs_list::mp_countdown_action_bonus] = std::clamp(value, 0s, 30s);
1715 }
1716 
1718 {
1719  preferences_.remove_attribute(prefs_list::mp_countdown_action_bonus);
1720 }
1721 
1722 std::chrono::minutes prefs::chat_message_aging()
1723 {
1724  return chrono::parse_duration(preferences_[prefs_list::chat_message_aging], 20min);
1725 }
1726 
1727 void prefs::set_chat_message_aging(const std::chrono::minutes& value)
1728 {
1729  preferences_[prefs_list::chat_message_aging] = value;
1730 }
1731 
1733 {
1734  return settings::get_village_gold(preferences_[prefs_list::mp_village_gold]);
1735 }
1736 
1738 {
1739  preferences_[prefs_list::mp_village_gold] = value;
1740 }
1741 
1743 {
1744  return settings::get_village_support(preferences_[prefs_list::mp_village_support]);
1745 }
1746 
1748 {
1749  preferences_[prefs_list::mp_village_support] = std::to_string(value);
1750 }
1751 
1753 {
1754  return settings::get_xp_modifier(preferences_[prefs_list::mp_xp_modifier]);
1755 }
1756 
1757 void prefs::set_xp_modifier(int value)
1758 {
1759  preferences_[prefs_list::mp_xp_modifier] = value;
1760 }
1761 
1762 const std::vector<std::string>& prefs::modifications(bool mp)
1763 {
1765  if(mp) {
1766  mp_modifications_ = utils::split(preferences_[prefs_list::mp_modifications].str(), ',');
1768  } else {
1769  sp_modifications_ = utils::split(preferences_[prefs_list::sp_modifications].str(), ',');
1771  }
1772  }
1773 
1775 }
1776 
1777 void prefs::set_modifications(const std::vector<std::string>& value, bool mp)
1778 {
1779  if(mp) {
1780  preferences_[prefs_list::mp_modifications] = utils::join(value, ",");
1782  } else {
1783  preferences_[prefs_list::sp_modifications] = utils::join(value, ",");
1785  }
1786 }
1787 
1789 {
1790  return message_private_on_;
1791 }
1792 
1794 {
1795  message_private_on_ = value;
1796 }
1797 
1799 {
1800  const std::string& choice = preferences_[prefs_list::compress_saves];
1801 
1802  // "yes" was used in 1.11.7 and earlier; the compress_saves
1803  // option used to be a toggle for gzip in those versions.
1804  if(choice.empty() || choice == "gzip" || choice == "yes") {
1806  } else if(choice == "bzip2") {
1808  } else if(choice == "none" || choice == "no") { // see above
1810  } /*else*/
1811 
1812  // In case the preferences file was created by a later version
1813  // supporting some algorithm we don't; although why would anyone
1814  // playing a game need more algorithms, really...
1816 }
1817 
1818 std::string prefs::get_chat_timestamp(const std::chrono::system_clock::time_point& t)
1819 {
1820  if(chat_timestamp()) {
1821  if(use_twelve_hour_clock_format() == false) {
1822  return chrono::format_local_timestamp(t, _("[%H:%M]")) + " ";
1823  } else {
1824  return chrono::format_local_timestamp(t, _("[%I:%M %p]")) + " ";
1825  }
1826  }
1827 
1828  return "";
1829 }
1830 
1831 std::set<std::string>& prefs::encountered_units()
1832 {
1833  return encountered_units_set_;
1834 }
1835 
1836 std::set<t_translation::terrain_code>& prefs::encountered_terrains()
1837 {
1839 }
1840 
1841 /**
1842  * Returns a pointer to the history vector associated with given id
1843  * making a new one if it doesn't exist.
1844  *
1845  * @todo FIXME only used for gui2. Could be used for the above histories.
1846  */
1847 std::vector<std::string>* prefs::get_history(const std::string& id)
1848 {
1849  return &history_map_[id];
1850 }
1851 
1853 {
1854  const std::string confirmation = preferences_[prefs_list::confirm_end_turn];
1855  return confirmation == "green" || confirmation == "yes";
1856 }
1857 
1859 {
1860  return preferences_[prefs_list::confirm_end_turn] == "yellow";
1861 }
1862 
1864 {
1865  // This is very non-intrusive so it is on by default
1866  const std::string confirmation = preferences_[prefs_list::confirm_end_turn];
1867  return confirmation == "no_moves" || confirmation.empty();
1868 }
1869 
1870 void prefs::encounter_recruitable_units(const std::vector<team>& teams)
1871 {
1872  for(const team& help_team : teams) {
1873  help_team.log_recruitable();
1874  encountered_units_set_.insert(help_team.recruits().begin(), help_team.recruits().end());
1875  }
1876 }
1877 
1879 {
1880  for(const auto& help_unit : units) {
1881  encountered_units_set_.insert(help_unit.type_id());
1882  }
1883 }
1884 
1885 void prefs::encounter_recallable_units(const std::vector<team>& teams)
1886 {
1887  for(const team& t : teams) {
1888  for(const unit_const_ptr u : t.recall_list()) {
1889  encountered_units_set_.insert(u->type_id());
1890  }
1891  }
1892 }
1893 
1895 {
1896  map.for_each_loc([&](const map_location& loc) {
1897  const t_translation::terrain_code terrain = map.get_terrain(loc);
1898  encountered_terrains().insert(terrain);
1900  encountered_terrains().insert(t);
1901  }
1902  });
1903 }
1904 
1906 {
1907  encounter_recruitable_units(gameboard_.teams());
1908  encounter_start_units(gameboard_.units());
1909  encounter_recallable_units(gameboard_.teams());
1910  encounter_map_terrain(gameboard_.map());
1911 }
1912 
1914 {
1915  preferences_.remove_attribute(prefs_list::player_joins_sound);
1916  preferences_.remove_attribute(prefs_list::player_joins_notif);
1917  preferences_.remove_attribute(prefs_list::player_joins_lobby);
1918  preferences_.remove_attribute(prefs_list::player_leaves_sound);
1919  preferences_.remove_attribute(prefs_list::player_leaves_notif);
1920  preferences_.remove_attribute(prefs_list::player_leaves_lobby);
1921  preferences_.remove_attribute(prefs_list::private_message_sound);
1922  preferences_.remove_attribute(prefs_list::private_message_notif);
1923  preferences_.remove_attribute(prefs_list::private_message_lobby);
1924  preferences_.remove_attribute(prefs_list::friend_message_sound);
1925  preferences_.remove_attribute(prefs_list::friend_message_notif);
1926  preferences_.remove_attribute(prefs_list::friend_message_lobby);
1927  preferences_.remove_attribute(prefs_list::public_message_sound);
1928  preferences_.remove_attribute(prefs_list::public_message_notif);
1929  preferences_.remove_attribute(prefs_list::public_message_lobby);
1930  preferences_.remove_attribute(prefs_list::server_message_sound);
1931  preferences_.remove_attribute(prefs_list::server_message_notif);
1932  preferences_.remove_attribute(prefs_list::server_message_lobby);
1933  preferences_.remove_attribute(prefs_list::ready_for_start_sound);
1934  preferences_.remove_attribute(prefs_list::ready_for_start_notif);
1935  preferences_.remove_attribute(prefs_list::ready_for_start_lobby);
1936  preferences_.remove_attribute(prefs_list::game_has_begun_sound);
1937  preferences_.remove_attribute(prefs_list::game_has_begun_notif);
1938  preferences_.remove_attribute(prefs_list::game_has_begun_lobby);
1939  preferences_.remove_attribute(prefs_list::turn_changed_sound);
1940  preferences_.remove_attribute(prefs_list::turn_changed_notif);
1941  preferences_.remove_attribute(prefs_list::turn_changed_lobby);
1942  preferences_.remove_attribute(prefs_list::game_created_sound);
1943  preferences_.remove_attribute(prefs_list::game_created_notif);
1944  preferences_.remove_attribute(prefs_list::game_created_lobby);
1945 }
1946 
1948 {
1949 #ifdef _WIN32
1950  wchar_t buffer[300];
1951  DWORD size = 300;
1952  if(GetUserNameW(buffer, &size)) {
1953  //size includes a terminating null character.
1954  assert(size > 0);
1955  return unicode_cast<std::string>(std::wstring_view{buffer});
1956  }
1957 #else
1958  if(char* const login = getenv("USER")) {
1959  return login;
1960  }
1961 #endif
1962  return {};
1963 }
1964 
1965 preferences::secure_buffer prefs::build_key(const std::string& server, const std::string& login)
1966 {
1967  std::string sysname = get_system_username();
1968  preferences::secure_buffer result(std::max<std::size_t>(server.size() + login.size() + sysname.size(), 32));
1969  unsigned char i = 0;
1970  std::generate(result.begin(), result.end(), [&i]() {return 'x' ^ i++;});
1971  std::copy(login.begin(), login.end(), result.begin());
1972  std::copy(sysname.begin(), sysname.end(), result.begin() + login.size());
1973  std::copy(server.begin(), server.end(), result.begin() + login.size() + sysname.size());
1974  return result;
1975 }
1976 
1978 {
1979 #ifndef __APPLE__
1980  int update_length;
1981  int extra_length;
1982  int total_length;
1983  // AES IV is generally 128 bits
1984  const unsigned char iv[] = {1,2,3,4,5,6,7,8,1,2,3,4,5,6,7,8};
1985  unsigned char encrypted_buffer[1024];
1986 
1987  if(plaintext.size() > 1008)
1988  {
1989  ERR_CFG << "Cannot encrypt data larger than 1008 bytes.";
1990  return preferences::secure_buffer();
1991  }
1992  DBG_CFG << "Encrypting data with length: " << plaintext.size();
1993 
1994  EVP_CIPHER_CTX *ctx = EVP_CIPHER_CTX_new();
1995  if(!ctx)
1996  {
1997  ERR_CFG << "AES EVP_CIPHER_CTX_new failed with error:";
1998  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
1999  return preferences::secure_buffer();
2000  }
2001 
2002  // TODO: use EVP_EncryptInit_ex2 once openssl 3.0 is more widespread
2003  if(EVP_EncryptInit_ex(ctx, EVP_aes_256_cbc(), nullptr, key.data(), iv) != 1)
2004  {
2005  ERR_CFG << "AES EVP_EncryptInit_ex failed with error:";
2006  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
2007  EVP_CIPHER_CTX_free(ctx);
2008  return preferences::secure_buffer();
2009  }
2010 
2011  if(EVP_EncryptUpdate(ctx, encrypted_buffer, &update_length, plaintext.data(), plaintext.size()) != 1)
2012  {
2013  ERR_CFG << "AES EVP_EncryptUpdate failed with error:";
2014  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
2015  EVP_CIPHER_CTX_free(ctx);
2016  return preferences::secure_buffer();
2017  }
2018  DBG_CFG << "Update length: " << update_length;
2019 
2020  if(EVP_EncryptFinal_ex(ctx, encrypted_buffer + update_length, &extra_length) != 1)
2021  {
2022  ERR_CFG << "AES EVP_EncryptFinal failed with error:";
2023  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
2024  EVP_CIPHER_CTX_free(ctx);
2025  return preferences::secure_buffer();
2026  }
2027  DBG_CFG << "Extra length: " << extra_length;
2028 
2029  EVP_CIPHER_CTX_free(ctx);
2030 
2031  total_length = update_length+extra_length;
2033  for(int i = 0; i < total_length; i++)
2034  {
2035  result.push_back(encrypted_buffer[i]);
2036  }
2037 
2038  DBG_CFG << "Successfully encrypted plaintext value of '" << utils::join(plaintext, "") << "' having length " << plaintext.size();
2039  DBG_CFG << "For a total encrypted length of: " << total_length;
2040 
2041  return result;
2042 #else
2043  std::size_t outWritten = 0;
2044  preferences::secure_buffer result(plaintext.size(), '\0');
2045 
2046  CCCryptorStatus ccStatus = CCCrypt(kCCDecrypt,
2047  kCCAlgorithmRC4,
2048  kCCOptionPKCS7Padding,
2049  key.data(),
2050  key.size(),
2051  nullptr,
2052  plaintext.data(),
2053  plaintext.size(),
2054  result.data(),
2055  result.size(),
2056  &outWritten);
2057 
2058  assert(ccStatus == kCCSuccess);
2059  assert(outWritten == plaintext.size());
2060 
2061  return result;
2062 #endif
2063 }
2064 
2066 {
2067 #ifndef __APPLE__
2068  int update_length;
2069  int extra_length;
2070  int total_length;
2071  // AES IV is generally 128 bits
2072  const unsigned char iv[] = {1,2,3,4,5,6,7,8,1,2,3,4,5,6,7,8};
2073  unsigned char plaintext_buffer[1024];
2074 
2075  if(encrypted.size() > 1024)
2076  {
2077  ERR_CFG << "Cannot decrypt data larger than 1024 bytes.";
2078  return preferences::secure_buffer();
2079  }
2080  DBG_CFG << "Decrypting data with length: " << encrypted.size();
2081 
2082  EVP_CIPHER_CTX *ctx = EVP_CIPHER_CTX_new();
2083  if(!ctx)
2084  {
2085  ERR_CFG << "AES EVP_CIPHER_CTX_new failed with error:";
2086  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
2087  return preferences::secure_buffer();
2088  }
2089 
2090  // TODO: use EVP_DecryptInit_ex2 once openssl 3.0 is more widespread
2091  if(EVP_DecryptInit_ex(ctx, EVP_aes_256_cbc(), nullptr, key.data(), iv) != 1)
2092  {
2093  ERR_CFG << "AES EVP_DecryptInit_ex failed with error:";
2094  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
2095  EVP_CIPHER_CTX_free(ctx);
2096  return preferences::secure_buffer();
2097  }
2098 
2099  if(EVP_DecryptUpdate(ctx, plaintext_buffer, &update_length, encrypted.data(), encrypted.size()) != 1)
2100  {
2101  ERR_CFG << "AES EVP_DecryptUpdate failed with error:";
2102  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
2103  EVP_CIPHER_CTX_free(ctx);
2104  return preferences::secure_buffer();
2105  }
2106  DBG_CFG << "Update length: " << update_length;
2107 
2108  if(EVP_DecryptFinal_ex(ctx, plaintext_buffer + update_length, &extra_length) != 1)
2109  {
2110  ERR_CFG << "AES EVP_DecryptFinal failed with error:";
2111  ERR_CFG << ERR_error_string(ERR_get_error(), nullptr);
2112  EVP_CIPHER_CTX_free(ctx);
2113  return preferences::secure_buffer();
2114  }
2115  DBG_CFG << "Extra length: " << extra_length;
2116 
2117  EVP_CIPHER_CTX_free(ctx);
2118 
2119  total_length = update_length+extra_length;
2121  for(int i = 0; i < total_length; i++)
2122  {
2123  result.push_back(plaintext_buffer[i]);
2124  }
2125 
2126  DBG_CFG << "Successfully decrypted data to the value: " << utils::join(result, "");
2127  DBG_CFG << "For a total decrypted length of: " << total_length;
2128 
2129  return result;
2130 #else
2131  std::size_t outWritten = 0;
2132  preferences::secure_buffer result(encrypted.size(), '\0');
2133 
2134  CCCryptorStatus ccStatus = CCCrypt(kCCDecrypt,
2135  kCCAlgorithmRC4,
2136  kCCOptionPKCS7Padding,
2137  key.data(),
2138  key.size(),
2139  nullptr,
2140  encrypted.data(),
2141  encrypted.size(),
2142  result.data(),
2143  result.size(),
2144  &outWritten);
2145 
2146  assert(ccStatus == kCCSuccess);
2147  assert(outWritten == encrypted.size());
2148 
2149  // the decrypted result is likely shorter than the encrypted data, so the extra padding needs to be removed.
2150  while(!result.empty() && result.back() == 0) {
2151  result.pop_back();
2152  }
2153 
2154  return result;
2155 #endif
2156 }
2157 
2159 {
2160  preferences::secure_buffer unescaped;
2161  unescaped.reserve(text.size());
2162  bool escaping = false;
2163  for(char c : text) {
2164  if(escaping) {
2165  if(c == '\xa') {
2166  unescaped.push_back('\xc');
2167  } else if(c == '.') {
2168  unescaped.push_back('@');
2169  } else {
2170  unescaped.push_back(c);
2171  }
2172  escaping = false;
2173  } else if(c == '\x1') {
2174  escaping = true;
2175  } else {
2176  unescaped.push_back(c);
2177  }
2178  }
2179  assert(!escaping);
2180  return unescaped;
2181 }
2182 
2184 {
2186  escaped.reserve(text.size());
2187  for(char c : text) {
2188  if(c == '\x1') {
2189  escaped.push_back('\x1');
2190  escaped.push_back('\x1');
2191  } else if(c == '\xc') {
2192  escaped.push_back('\x1');
2193  escaped.push_back('\xa');
2194  } else if(c == '@') {
2195  escaped.push_back('\x1');
2196  escaped.push_back('.');
2197  } else {
2198  escaped.push_back(c);
2199  }
2200  }
2201  return escaped;
2202 }
2203 
2205 {
2206  return preferences_[prefs_list::remember_password].to_bool();
2207 }
2208 
2209 void prefs::set_remember_password(bool remember)
2210 {
2211  preferences_[prefs_list::remember_password] = remember;
2212 
2213  if(remember) {
2214  load_credentials();
2215  } else {
2217  }
2218 }
2219 
2220 std::string prefs::login()
2221 {
2222  std::string name = get("login", pref_constants::EMPTY_LOGIN);
2223  if(name == pref_constants::EMPTY_LOGIN) {
2224  name = get_system_username();
2225  } else if(name.size() > 2 && name.front() == '@' && name.back() == '@') {
2226  name = name.substr(1, name.size() - 2);
2227  } else {
2228  ERR_CFG << "malformed user credentials (did you manually edit the preferences file?)";
2229  }
2230  if(name.empty()) {
2231  return "player";
2232  }
2233  return name;
2234 }
2235 
2236 void prefs::set_login(const std::string& login)
2237 {
2238  auto login_clean = login;
2239  boost::trim(login_clean);
2240 
2241  preferences_[prefs_list::login] = '@' + login_clean + '@';
2242 }
2243 
2244 std::string prefs::password(const std::string& server, const std::string& login)
2245 {
2246  DBG_CFG << "Retrieving password for server: '" << server << "', login: '" << login << "'";
2247  auto login_clean = login;
2248  boost::trim(login_clean);
2249 
2250  if(!remember_password()) {
2251  if(!credentials_.empty() && credentials_[0].username == login_clean && credentials_[0].server == server) {
2252  auto temp = aes_decrypt(credentials_[0].key, build_key(server, login_clean));
2253  return std::string(temp.begin(), temp.end());
2254  } else {
2255  return "";
2256  }
2257  }
2258  auto cred = std::find_if(credentials_.begin(), credentials_.end(), [&](const preferences::login_info& cred) {
2259  return cred.server == server && cred.username == login_clean;
2260  });
2261  if(cred == credentials_.end()) {
2262  return "";
2263  }
2264  auto temp = aes_decrypt(cred->key, build_key(server, login_clean));
2265  return std::string(temp.begin(), temp.end());
2266 }
2267 
2268 void prefs::set_password(const std::string& server, const std::string& login, const std::string& key)
2269 {
2270  DBG_CFG << "Setting password for server: '" << server << "', login: '" << login << "'";
2271  auto login_clean = login;
2272  boost::trim(login_clean);
2273 
2274  preferences::secure_buffer temp(key.begin(), key.end());
2275  if(!remember_password()) {
2277  credentials_.emplace_back(login_clean, server, aes_encrypt(temp, build_key(server, login_clean)));
2278  return;
2279  }
2280  auto cred = std::find_if(credentials_.begin(), credentials_.end(), [&](const preferences::login_info& cred) {
2281  return cred.server == server && cred.username == login_clean;
2282  });
2283  if(cred == credentials_.end()) {
2284  // This is equivalent to emplace_back, but also returns the iterator to the new element
2285  cred = credentials_.emplace(credentials_.end(), login_clean, server);
2286  }
2287  cred->key = aes_encrypt(temp, build_key(server, login_clean));
2288 }
map_location loc
Definition: move.cpp:172
double t
Definition: astarsearch.cpp:63
Variant for storing WML attributes.
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:158
void append(const config &cfg)
Append data from another config object to this one.
Definition: config.cpp:188
const_attr_itors attribute_range() const
Definition: config.cpp:756
auto all_children_view() const
In-order iteration over all children.
Definition: config.hpp:796
boost::iterator_range< child_iterator > child_itors
Definition: config.hpp:281
optional_config_impl< config > find_child(config_key_type key, const std::string &name, const std::string &value)
Returns the first child of tag key with a name attribute containing value.
Definition: config.cpp:780
void clear_children(T... keys)
Definition: config.hpp:602
bool has_attribute(config_key_type key) const
Definition: config.cpp:157
void merge_with(const config &c)
Merge config 'c' into this config, overwriting this config's values.
Definition: config.cpp:1113
void remove_children(config_key_type key, const std::function< bool(const config &)> &p={})
Removes all children with tag key for which p returns true.
Definition: config.cpp:650
child_itors child_range(config_key_type key)
Definition: config.cpp:268
config & child_or_add(config_key_type key)
Returns a reference to the first child with the given key.
Definition: config.cpp:401
void remove_attribute(config_key_type key)
Definition: config.cpp:162
bool empty() const
Definition: config.cpp:839
void clear()
Definition: config.cpp:818
optional_config_impl< config > optional_child(config_key_type key, int n=0)
Equivalent to mandatory_child, but returns an empty optional if the nth child was not found.
Definition: config.cpp:380
config & add_child(config_key_type key)
Definition: config.cpp:436
Sort-of-Singleton that many classes, both GUI and non-GUI, use to access the game data.
Definition: display.hpp:88
void set_theme(const std::string &new_theme)
Definition: display.cpp:241
static display * get_singleton()
Returns the display object if a display object exists.
Definition: display.hpp:102
Game board class.
Definition: game_board.hpp:47
virtual const std::vector< team > & teams() const override
Definition: game_board.hpp:80
virtual const unit_map & units() const override
Definition: game_board.hpp:107
virtual const gamemap & map() const override
Definition: game_board.hpp:97
A class grating read only view to a vector of config objects, viewed as one config with all children ...
static game_config_view wrap(const config &cfg)
config_array_view child_range(config_key_type key) const
terrain_code get_terrain(const map_location &loc) const
Looks up terrain at a particular location.
Definition: map.cpp:301
void for_each_loc(const F &f) const
Definition: map.hpp:136
Encapsulates the map of the game.
Definition: map.hpp:172
const t_translation::ter_list & underlying_union_terrain(const map_location &loc) const
Definition: map.cpp:59
file_dialog & set_ok_label(const std::string &value)
Sets the OK button label.
file_dialog & set_path(const std::string &value)
Sets the initial file selection.
file_dialog & set_title(const std::string &value)
Sets the current dialog title text.
Definition: file_dialog.hpp:59
file_dialog & set_read_only(bool value)
Whether to provide user interface elements for manipulating existing objects.
file_dialog & set_filename(const std::string &value)
Sets the initial file name input but not the path.
file_dialog & set_message(const std::string &value)
Sets the current dialog instructions/message text.
Definition: file_dialog.hpp:78
bool show(const unsigned auto_close_time=0)
Shows the window.
int selected_index() const
Returns the selected item index after displaying.
Definition: theme_list.hpp:35
void set_selected_index(int index)
Sets the initially selected item index (-1 by default).
Definition: theme_list.hpp:41
const std::string & get_nick() const
Definition: preferences.hpp:91
void set_lobby_joins(pref_constants::lobby_joins show)
std::string enemy_color()
config::attribute_value get_as_attribute(const std::string &key)
void set_reach_map_enemy_color(const std::string &color_id)
void set_network_host(const std::string &host)
std::set< t_translation::terrain_code > & encountered_terrains()
const config & options()
bool set_music(bool ison)
void set_sound_volume(int vol)
void set_remember_password(bool remember)
const std::map< std::string, preferences::acquaintance > & get_acquaintances()
optional_const_config get_alias()
bool show_theme_dialog()
void set_turbo(bool ison)
std::string get_system_username()
bool mp_modifications_initialized_
std::map< std::string, std::vector< std::string > > history_map_
void save_hotkeys()
int village_support()
void set_addon_manager_saved_order_direction(sort_order::type value)
std::chrono::seconds countdown_turn_bonus()
bool middle_click_scrolls()
bool turn_bell()
void set_countdown_reservoir_time(const std::chrono::seconds &value)
void remove_game_preset(int id)
std::set< std::string > & encountered_units()
void add_alias(const std::string &alias, const std::string &command)
void write_preferences()
void clear_preferences()
std::vector< std::string > sp_modifications_
void clear_mp_alert_prefs()
The most recently selected add-on id from the editor.
void set_village_gold(int value)
bool confirm_load_save_from_different_version()
std::string network_host()
void clear_countdown_init_time()
std::set< std::string > unknown_unsynced_attributes_
bool set_ui_sound(bool ison)
void set_reach_map_border_opacity(const int new_opacity)
std::chrono::minutes chat_message_aging()
void set_login(const std::string &login)
static prefs & get()
const std::string get_ignored_delim()
std::map< std::string, preferences::acquaintance > acquaintances_
static constexpr std::array unsynced_children_
bool fps_
config::child_itors get_game_presets()
int scroll_speed()
bool message_private()
void encounter_recallable_units(const std::vector< team > &teams)
std::map< std::string, std::set< std::string > > completed_campaigns_
bool show_combat()
std::string theme()
optional_const_config dir_bookmarks()
void set_theme(const std::string &theme)
void set_xp_modifier(int value)
void set_user_servers_list(const std::vector< game_config::server_info > &value)
preferences::secure_buffer build_key(const std::string &server, const std::string &login)
Fills a secure_buffer with 32 bytes of deterministically generated bytes, then overwrites it with the...
bool sound()
bool is_campaign_completed(const std::string &campaign_id)
void set_allied_color(const std::string &color_id)
bool get_scroll_when_mouse_outside(bool def)
void show_wesnothd_server_search()
bool green_confirm()
int bell_volume()
int mouse_scroll_threshold()
Gets the threshold for when to scroll.
std::string get_chat_timestamp(const std::chrono::system_clock::time_point &t)
bool is_ignored(const std::string &nick)
std::vector< std::string > mp_modifications_
bool achievement(const std::string &content_for, const std::string &id)
std::set< std::string > unknown_synced_attributes_
void set_enemy_color(const std::string &color_id)
void save_credentials()
std::chrono::seconds countdown_init_time()
void set_password(const std::string &server, const std::string &login, const std::string &key)
bool sub_achievement(const std::string &content_for, const std::string &id, const std::string &sub_id)
void clear_credentials()
std::vector< preferences::login_info > credentials_
std::vector< std::string > do_read_editor_mru()
void encounter_recruitable_units(const std::vector< team > &teams)
bool parse_should_show_lobby_join(const std::string &sender, const std::string &message)
int progress_achievement(const std::string &content_for, const std::string &id, int limit=999999, int max_progress=999999, int amount=0)
Increments the achievement's current progress by amount if it hasn't already been completed.
sort_order::type addon_manager_saved_order_direction()
bool set_turn_bell(bool ison)
static constexpr std::array synced_attributes_
unsigned int sample_rate()
void set_reach_map_tint_opacity(const int new_opacity)
void set_countdown_turn_bonus(const std::chrono::seconds &value)
static constexpr std::array synced_children_
void set_options(const config &values)
int reach_map_tint_opacity()
void set_message_private(bool value)
std::vector< game_config::server_info > user_servers_list()
optional_const_config get_child(const std::string &key)
void load_credentials()
std::string unmoved_color()
void set_music_volume(int vol)
void load_advanced_prefs(const game_config_view &gc)
std::string allied_color()
void set_show_standing_animations(bool value)
void set_show_fps(bool value)
void set_pixel_scale(const int scale)
std::size_t editor_mru_limit()
void set_color_cursors(bool value)
std::vector< preferences::option > advanced_prefs_
void encounter_start_units(const unit_map &units)
pref_constants::lobby_joins get_lobby_joins()
bool show_fps()
void load_hotkeys()
void set_chat_message_aging(const std::chrono::minutes &value)
optional_const_config get_game_preset(int id)
void encounter_map_terrain(const gamemap &map)
int font_scaling()
void set_village_support(int value)
preferences::secure_buffer escape(const preferences::secure_buffer &text)
std::chrono::seconds countdown_action_bonus()
std::string moved_color()
bool confirm_no_moves()
void set_font_scaling(int scale)
std::size_t sound_buffer_size()
bool use_color_cursors()
bool yellow_confirm()
config option_values_
void migrate_preferences(const std::string &prefs_dir)
bool message_bell()
void set_dir_bookmarks(const config &cfg)
bool message_private_on_
std::set< t_translation::terrain_code > encountered_terrains_set_
bool set_sound(bool ison)
bool is_friend(const std::string &nick)
void set_achievement(const std::string &content_for, const std::string &id)
Marks the specified achievement as completed.
preferences::secure_buffer aes_decrypt(const preferences::secure_buffer &text, const preferences::secure_buffer &key)
Same as aes_encrypt(), except of course it takes encrypted data as an argument and returns decrypted ...
int village_gold()
config preferences_
void clear_countdown_turn_bonus()
std::string login()
bool music_on()
int font_scaled(int size)
void set_scroll_speed(const int scroll)
std::pair< preferences::acquaintance *, bool > add_acquaintance(const std::string &nick, const std::string &mode, const std::string &notes)
bool ui_sound_on()
bool options_initialized_
int music_volume()
int pixel_scale()
std::string partial_color()
preferences::secure_buffer unescape(const preferences::secure_buffer &text)
void set_resolution(const point &res)
void set_campaign_server(const std::string &host)
void set_unmoved_color(const std::string &color_id)
bool remove_acquaintance(const std::string &nick)
void clear_countdown_reservoir_time()
void set_ui_volume(int vol)
bool turbo()
const std::vector< std::string > & modifications(bool mp=true)
void do_commit_editor_mru(const std::vector< std::string > &mru)
std::chrono::seconds countdown_reservoir_time()
std::string reach_map_color()
compression::format save_compression_format()
std::vector< std::string > recent_files()
Retrieves the list of recently opened files.
std::set< std::string > encountered_units_set_
void set_bell_volume(int vol)
std::string get_mp_server_program_name()
std::string reach_map_enemy_color()
void add_game_preset(config &&preset_data)
void set_partial_color(const std::string &color_id)
void set_child(const std::string &key, const config &val)
static constexpr std::array unsynced_attributes_
std::set< std::string > all_attributes()
int keepalive_timeout()
void set_mp_server_program_name(const std::string &)
bool remember_password()
int ui_volume()
void add_recent_files_entry(const std::string &path)
Adds an entry to the recent files list.
void set_moved_color(const std::string &color_id)
point resolution()
void save_sample_rate(const unsigned int rate)
bool use_twelve_hour_clock_format()
static bool no_preferences_save
int reach_map_border_opacity()
int sound_volume()
void set_modifications(const std::vector< std::string > &value, bool mp=true)
void set_countdown_init_time(const std::chrono::seconds &value)
void set_sub_achievement(const std::string &content_for, const std::string &id, const std::string &sub_id)
Marks the specified sub-achievement as completed.
std::set< std::string > unknown_unsynced_children_
const std::vector< game_config::server_info > & builtin_servers_list()
void set_reach_map_color(const std::string &color_id)
void reload_preferences()
std::string campaign_server()
std::set< std::string > unknown_synced_children_
void add_completed_campaign(const std::string &campaign_id, const std::string &difficulty_level)
void clear_hotkeys()
void save_sound_buffer_size(const std::size_t size)
int xp_modifier()
void encounter_all_content(const game_board &gb)
std::string password(const std::string &server, const std::string &login)
bool sp_modifications_initialized_
std::vector< std::string > * get_history(const std::string &id)
Returns a pointer to the history vector associated with given id making a new one if it doesn't exist...
preferences::secure_buffer aes_encrypt(const preferences::secure_buffer &text, const preferences::secure_buffer &key)
Encrypts the value of text using key and a hard coded IV using AES.
void set_countdown_action_bonus(const std::chrono::seconds &value)
bool auto_open_whisper_windows()
void load_preferences()
std::map< std::string, std::string > get_acquaintances_nice(const std::string &filter)
bool get_show_deprecation(bool def)
bool show_standing_animations()
void clear_countdown_action_bonus()
This class stores all the data for a single 'side' (in game nomenclature).
Definition: team.hpp:74
Definition: theme.hpp:43
static std::vector< theme_info > get_basic_theme_info(bool include_hidden=false)
Returns minimal info about saved themes, optionally including hidden ones.
Definition: theme.cpp:985
Container associating units to locations.
Definition: map.hpp:98
const config * cfg
#define VGETTEXT(msgid,...)
Handy wrappers around interpolate_variables_into_string and gettext.
std::size_t i
Definition: function.cpp:1032
static std::string _(const char *str)
Definition: gettext.hpp:97
std::string id
Text to match against addon_info.tags()
Definition: manager.cpp:199
Standard logging facilities (interface).
General settings and defaults for scenarios.
auto parse_duration(const config_attribute_value &val, const Duration &def=Duration{0})
Definition: chrono.hpp:71
auto format_local_timestamp(const std::chrono::system_clock::time_point &time, std::string_view format="%F %T")
Definition: chrono.hpp:62
void set(CURSOR_TYPE type)
Use the default parameter to reset cursors.
Definition: cursor.cpp:178
void point(int x, int y)
Draw a single point.
Definition: draw.cpp:214
void fill(const ::rect &rect, uint8_t r, uint8_t g, uint8_t b, uint8_t a)
Fill an area with the given colour.
Definition: draw.cpp:52
void line(int from_x, int from_y, int to_x, int to_y)
Draw a line.
Definition: draw.cpp:189
filesystem::scoped_istream istream_file(const std::string &fname, bool treat_failure_as_error)
std::chrono::system_clock::time_point file_modified_time(const bfs::path &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)
static bool file_exists(const bfs::path &fpath)
Definition: filesystem.cpp:341
std::string get_exe_dir()
bool is_directory(const std::string &fname)
Returns true if the given file is a directory.
std::string get_synced_prefs_file()
location of preferences file containing preferences that are synced between computers note that wesno...
std::string get_unsynced_prefs_file()
location of preferences file containing preferences that aren't synced between computers
filesystem::scoped_ostream ostream_file(const std::string &fname, std::ios_base::openmode mode, bool create_directory)
std::unique_ptr< std::istream > scoped_istream
Definition: filesystem.hpp:53
std::string get_credentials_file()
std::string directory_name(const std::string &file)
Returns the directory name of a file, with filename stripped.
std::unique_ptr< std::ostream > scoped_ostream
Definition: filesystem.hpp:54
std::string get_wesnothd_name()
std::string get_default_prefs_file()
std::string partial_orb_color
std::string reach_map_enemy_color
std::string moved_orb_color
std::string unmoved_orb_color
std::string ally_orb_color
std::string enemy_orb_color
std::string reach_map_color
std::string turn_bell
std::string path
Definition: filesystem.cpp:106
const version_info wesnoth_version(VERSION)
int reach_map_border_opacity
std::vector< server_info > server_list
Definition: game_config.cpp:76
int reach_map_tint_opacity
void show(const gui2::tracked_drawable &target)
Displays the fps report popup for the given tracked_drawable.
Definition: fps_report.cpp:131
static int bell_volume()
static int music_volume()
static bool sound()
static int ui_volume()
static int sound_volume()
void show_transient_message(const std::string &title, const std::string &message, const std::string &image, const bool message_use_markup, const bool title_use_markup)
Shows a transient message to the user.
void save_hotkeys(config &cfg)
Save the non-default hotkeys to the config.
void reset_default_hotkeys()
Reset all hotkeys to the defaults.
void load_custom_hotkeys(const game_config_view &cfg)
Registers all hotkeys present in this config, overwriting any matching default hotkeys.
config read(std::istream &in, abstract_validator *validator)
Definition: parser.cpp:600
void write(std::ostream &out, const configr_of &cfg, unsigned int level)
Definition: parser.cpp:737
Main entry points of multiplayer mode.
Definition: lobby_data.cpp:49
const int min_window_height
Definition: preferences.hpp:37
const int max_pixel_scale
Definition: preferences.hpp:49
const std::string EMPTY_LOGIN
Definition: preferences.hpp:57
const int min_pixel_scale
Definition: preferences.hpp:48
const std::string default_addons_server
Definition: preferences.hpp:61
const int def_window_width
Definition: preferences.hpp:39
const int min_font_scaling
Definition: preferences.hpp:45
const int min_window_width
Definition: preferences.hpp:36
const int max_font_scaling
Definition: preferences.hpp:46
const int def_window_height
Definition: preferences.hpp:40
const unsigned char CREDENTIAL_SEPARATOR
Definition: preferences.hpp:56
game_data * gamedata
Definition: resources.cpp:22
static std::string at(const std::string &file, int line)
int get_village_support(const std::string &value)
Gets the village unit level support.
int get_xp_modifier(const std::string &value)
Gets the xp modifier.
int get_village_gold(const std::string &value, const game_classification *classification)
Gets the village gold.
void set_bell_volume(int vol)
Definition: sound.cpp:1107
void reset_sound()
Definition: sound.cpp:523
bool init_sound()
Definition: sound.cpp:440
void close_sound()
Definition: sound.cpp:492
void play_music()
Definition: sound.cpp:616
void stop_music()
Definition: sound.cpp:554
void stop_UI_sound()
Definition: sound.cpp:589
void stop_bell()
Definition: sound.cpp:577
void set_music_volume(int vol)
Definition: sound.cpp:1067
void stop_sound()
Definition: sound.cpp:562
void set_UI_volume(int vol)
Definition: sound.cpp:1119
void set_sound_volume(int vol)
Definition: sound.cpp:1087
std::vector< terrain_code > ter_list
Definition: translation.hpp:77
ter_list read_list(std::string_view str, const ter_layer filler)
Reads a list of terrains from a string, when reading the.
std::string write_list(const ter_list &list)
Writes a list of terrains to a string, only writes the new format.
std::size_t size(std::string_view str)
Length in characters of a UTF-8 string.
Definition: unicode.cpp:85
constexpr auto values
Definition: ranges.hpp:42
constexpr auto filter
Definition: ranges.hpp:38
@ REMOVE_EMPTY
void trim(std::string_view &s)
bool isvalid_wildcard(const std::string &username)
Check if the username pattern contains only valid characters.
std::size_t erase(Container &container, const Value &value)
Convenience wrapper for using std::remove on a container.
Definition: general.hpp:118
std::set< std::string > split_set(std::string_view s, char sep, const int flags)
bool contains(const Container &container, const Value &value)
Returns true iff value is found in container.
Definition: general.hpp:87
std::string get_unknown_exception_type()
Utility function for finding the type of thing caught with catch(...).
Definition: general.cpp:23
std::string join(const T &v, const std::string &s=",")
Generates a new string joining container items in a list.
std::vector< std::string > split(const config_attribute_value &val)
bool headless()
The game is running headless.
Definition: video.cpp:147
std::string::const_iterator iterator
Definition: tokenizer.hpp:25
static void msg(const char *act, debug_info &i, const char *to="", const char *result="")
Definition: debugger.cpp:109
void scale(size_t factor, const uint32_t *src, uint32_t *trg, int srcWidth, int srcHeight, ColorFormat colFmt, const ScalerCfg &cfg=ScalerCfg(), int yFirst=0, int yLast=std::numeric_limits< int >::max())
Definition: xbrz.cpp:1175
std::string_view data
Definition: picture.cpp:188
static lg::log_domain log_filesystem("filesystem")
#define ERR_CFG
Definition: preferences.cpp:61
#define DBG_CFG
Definition: preferences.cpp:62
#define ERR_ADV
Definition: preferences.cpp:68
static lg::log_domain advanced_preferences("advanced_preferences")
static std::string fix_orb_color_name(const std::string &color)
#define ERR_FS
Definition: preferences.cpp:65
static lg::log_domain log_config("config")
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
std::string filename
Filename.
An exception object used when an IO error occurs.
Definition: filesystem.hpp:67
Encapsulates the map of the game.
Definition: location.hpp:46
Holds a 2D point.
Definition: point.hpp:25
static std::string get_string(enum_type key)
Converts a enum to its string equivalent.
Definition: enum_base.hpp:46
static constexpr utils::optional< enum_type > get_enum(const std::string_view value)
Converts a string into its enum equivalent.
Definition: enum_base.hpp:57
A terrain string which is converted to a terrain is a string with 1 or 2 layers the layers are separa...
Definition: translation.hpp:49
mock_char c
static map_location::direction n
static map_location::direction s
#define d
#define e