preferences.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2024 - 2024
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#pragma once
 
#include "config.hpp"
#include "desktop/notifications.hpp"
#include "filesystem.hpp"
#include "game_config.hpp"
#include "gui/sort_order.hpp"
#include "preferences/preferences_list.hpp"
#include "serialization/compression.hpp"
#include "team.hpp"
#include "terrain/translation.hpp"
#include "lua/wrapper_lua.h" // for lua_State arguments to friend functions
#include "log.hpp"
#include <set>
 
struct point;
class unit_map;
class game_board;
 
namespace pref_constants
{
const int min_window_width  = 800;
const int min_window_height = 540;
 
const int def_window_width  = 1280;
const int def_window_height = 720;
 
const int max_window_width = 1920;
const int max_window_height = 1080;
 
const int min_font_scaling  = 80;
const int max_font_scaling  = 150;
 
const int min_pixel_scale = 1;
const int max_pixel_scale = 4;
 
const int TRANSITION_UPDATE_OFF = 0;
const int TRANSITION_UPDATE_ON = 1;
const int TRANSITION_UPDATE_PARTIAL = 2;
const int TRANSITION_UPDATE_COUNT = 3;
 
const unsigned char CREDENTIAL_SEPARATOR = '\f';
const std::string EMPTY_LOGIN = "@@";
 
const int INFINITE_AUTO_SAVES = 61;
 
const std::string default_addons_server = "add-ons.wesnoth.org";
 
enum class lobby_joins { show_none, show_friends, show_all };
 
enum PREFERENCE_VIEW { VIEW_DEFAULT, VIEW_FRIENDS };
};
 
namespace preferences
{
class acquaintance
{
public:
    acquaintance()
    {
    }
 
    explicit acquaintance(const config& cfg)
    {
        nick_ = cfg["nick"].str();
        status_ = cfg["status"].str();
        notes_ = cfg["notes"].str();
    }
 
    acquaintance(const std::string& nick, const std::string& status, const std::string& notes)
        : nick_(nick)
        , status_(status)
        , notes_(notes)
    {
    }
 
    const std::string& get_nick() const { return nick_; }
    const std::string& get_status() const { return status_; }
    const std::string& get_notes() const { return notes_; }
 
    void save(config& item)
    {
        item["nick"] = nick_;
        item["status"] = status_;
        item["notes"] = notes_;
    }
 
private:
    /** acquaintance's MP nick */
    std::string nick_;
 
    /**status (e.g., "friend", "ignore") */
    std::string status_;
 
    /** notes on the acquaintance */
    std::string notes_;
};
 
class secure_buffer : public std::vector<unsigned char>
{
public:
    template<typename... T> secure_buffer(T&&... args)
        : vector<unsigned char>(std::forward<T>(args)...)
    {}
    ~secure_buffer()
    {
        std::fill(begin(), end(), '\0');
    }
};
 
struct login_info
{
    std::string username, server;
    secure_buffer key;
    login_info(const std::string& username, const std::string& server, const secure_buffer& key)
        : username(username), server(server), key(key)
    {}
    login_info(const std::string& username, const std::string& server)
        : username(username), server(server), key()
    {}
    std::size_t size() const
    {
        return 3 + username.size() + server.size() + key.size();
    }
};
 
struct option
{
    option(const config& pref)
    : type()
    , name(pref["name"].t_str())
    , description(pref["description"].t_str())
    , field(pref["field"].str())
    , cfg(pref)
    {
        const std::string p_type = cfg["type"];
 
        if(p_type == "boolean") {
            type = avd_type::TOGGLE;
        } else if(p_type == "int") {
            type = avd_type::SLIDER;
        } else if(p_type == "combo") {
            type = avd_type::COMBO;
        } else if(p_type == "custom") {
            type = avd_type::SPECIAL;
        } else {
            throw std::invalid_argument("Unknown type '" + p_type + "' for advanced preference " + name);
        }
    }
 
    enum class avd_type { TOGGLE, SLIDER, COMBO, SPECIAL };
 
    /** The preference type. */
    avd_type type;
 
    /** Displayed name. */
    t_string name;
 
    /** Displayed description. */
    t_string description;
 
    /** The actual field saved in the prefs file and by which this preference may be accessed. */
    std::string field;
 
    /** The full config, including type-specific options. */
    config cfg;
};
};
 
#define PREF_GETTER_SETTER(pref, type, def)        \
void set_##pref(const type& value) {               \
    preferences_[prefs_list::pref] = value;        \
}                                                  \
type pref() const {                                \
    return preferences_[prefs_list::pref].to(def); \
}
 
class prefs
{
    friend struct preferences_dialog_friend;
    friend int impl_preferences_set(lua_State* L);
    friend int impl_preferences_get(lua_State* L);
 
    public:
        static prefs& get()
        {
            static prefs prefs_manager;
            return prefs_manager;
        }
 
        ~prefs();
 
        void write_preferences();
        void load_advanced_prefs(const game_config_view& gc);
        void migrate_preferences(const std::string& prefs_dir);
        void reload_preferences();
        std::set<std::string> all_attributes();
 
        // Proxies for preferences_dialog
        void load_hotkeys();
        void save_hotkeys();
        void clear_hotkeys();
 
        // not actually preferences
        bool show_fps();
        void set_show_fps(bool value);
 
        bool message_private();
        void set_message_private(bool value);
 
        static void disable_preferences_save() {
            no_preferences_save = true;
        }
 
        static bool preferences_save() {
            return no_preferences_save;
        }
 
        // getter-only
        bool message_bell();
        bool middle_click_scrolls();
        /** Gets the threshold for when to scroll. This scrolling happens when the mouse is in the application and near the border. */
        int mouse_scroll_threshold();
        bool confirm_load_save_from_different_version();
        bool use_twelve_hour_clock_format();
        sort_order::type addon_manager_saved_order_direction();
        void set_addon_manager_saved_order_direction(sort_order::type value);
        bool get_show_deprecation(bool def);
        bool get_scroll_when_mouse_outside(bool def);
        bool auto_open_whisper_windows();
        bool show_combat();
        std::string get_chat_timestamp(const std::time_t& t);
        compression::format save_compression_format();
        std::vector<std::string>* get_history(const std::string& id);
        std::vector<preferences::option>& get_advanced_preferences() {return advanced_prefs_;}
 
        // non-trivial getters+setters
        point resolution();
        void set_resolution(const point& res);
 
        int pixel_scale();
        void set_pixel_scale(const int scale);
 
        bool turbo();
        void set_turbo(bool ison);
 
        int font_scaling();
        void set_font_scaling(int scale);
        int font_scaled(int size);
 
        int keepalive_timeout();
        void keepalive_timeout(int seconds);
 
        bool sound();
        bool set_sound(bool ison);
 
        unsigned int sample_rate();
        void save_sample_rate(const unsigned int rate);
 
        std::size_t sound_buffer_size();
        void save_sound_buffer_size(const std::size_t size);
 
        int sound_volume();
        void set_sound_volume(int vol);
 
        int bell_volume();
        void set_bell_volume(int vol);
 
        int ui_volume();
        void set_ui_volume(int vol);
 
        bool music_on();
        bool set_music(bool ison);
 
        int music_volume();
        void set_music_volume(int vol);
 
        bool turn_bell();
        bool set_turn_bell(bool ison);
 
        bool ui_sound_on();
        bool set_ui_sound(bool ison);
 
        void add_alias(const std::string& alias, const std::string& command);
        optional_const_config get_alias();
 
        std::string allied_color();
        void set_allied_color(const std::string& color_id);
 
        std::string enemy_color();
        void set_enemy_color(const std::string& color_id);
 
        std::string unmoved_color();
        void set_unmoved_color(const std::string& color_id);
 
        std::string partial_color();
        void set_partial_color(const std::string& color_id);
 
        std::string moved_color();
        void set_moved_color(const std::string& color_id);
 
        int scroll_speed();
        void set_scroll_speed(const int scroll);
 
        void set_dir_bookmarks(const config& cfg);
        optional_const_config dir_bookmarks();
 
        std::size_t editor_mru_limit();
        std::vector<std::string> do_read_editor_mru();
        void do_commit_editor_mru(const std::vector<std::string>& mru);
        /** Retrieves the list of recently opened files. */
        std::vector<std::string> recent_files();
        /** Adds an entry to the recent files list. */
        void add_recent_files_entry(const std::string& path);
 
        bool use_color_cursors();
        void set_color_cursors(bool value);
 
        bool show_standing_animations();
        void set_show_standing_animations(bool value);
 
        void show_wesnothd_server_search();
        bool show_theme_dialog();
 
        void set_theme(const std::string& theme);
        std::string theme();
 
        void set_mp_server_program_name(const std::string&);
        std::string get_mp_server_program_name();
 
        bool parse_should_show_lobby_join(const std::string& sender, const std::string& message);
        pref_constants::lobby_joins get_lobby_joins();
        void set_lobby_joins(pref_constants::lobby_joins show);
 
        const std::map<std::string, preferences::acquaintance>& get_acquaintances();
        const std::string get_ignored_delim();
        std::map<std::string, std::string> get_acquaintances_nice(const std::string& filter);
        std::pair<preferences::acquaintance*, bool> add_acquaintance(const std::string& nick, const std::string& mode, const std::string& notes);
        void add_completed_campaign(const std::string&campaign_id, const std::string& difficulty_level);
        bool remove_acquaintance(const std::string& nick);
        bool is_friend(const std::string& nick);
        bool is_ignored(const std::string& nick);
        bool is_campaign_completed(const std::string& campaign_id);
        bool is_campaign_completed(const std::string& campaign_id, const std::string& difficulty_level);
 
        const std::vector<game_config::server_info>& builtin_servers_list();
        std::vector<game_config::server_info> user_servers_list();
        void set_user_servers_list(const std::vector<game_config::server_info>& value);
 
        std::string network_host();
        void set_network_host(const std::string& host);
 
        std::string campaign_server();
        void set_campaign_server(const std::string& host);
 
        const config& options();
        void set_options(const config& values);
 
        int countdown_init_time();
        void set_countdown_init_time(int value);
        void clear_countdown_init_time();
 
        int countdown_turn_bonus();
        void set_countdown_turn_bonus(int value);
        void clear_countdown_turn_bonus();
 
        int countdown_reservoir_time();
        void set_countdown_reservoir_time(int value);
        void clear_countdown_reservoir_time();
 
        int countdown_action_bonus();
        void set_countdown_action_bonus(int value);
        void clear_countdown_action_bonus();
 
        int village_gold();
        void set_village_gold(int value);
 
        int village_support();
        void set_village_support(int value);
 
        int xp_modifier();
        void set_xp_modifier(int value);
 
        bool remember_password();
        void set_remember_password(bool remember);
 
        std::string login();
        void set_login(const std::string& login);
 
        std::string password(const std::string& server, const std::string& login);
        void set_password(const std::string& server, const std::string& login, const std::string& key);
 
        const std::vector<std::string>& modifications(bool mp = true);
        void set_modifications(const std::vector<std::string>& value, bool mp = true);
 
        std::set<std::string>& encountered_units();
        std::set<t_translation::terrain_code>& encountered_terrains();
 
        // Ask for end turn confirmation
        bool yellow_confirm();
        bool green_confirm();
        bool confirm_no_moves();
 
        // Add all recruitable units as encountered so that information
        // about them are displayed to the user in the help system.
        void encounter_recruitable_units(const std::vector<team>& teams);
 
        // Add all units that exist at the start to the encountered units so
        // that information about them are displayed to the user in the help
        // system.
        void encounter_start_units(const unit_map& units);
 
        // Add all units that are recallable as encountered units.
        void encounter_recallable_units(const std::vector<team>& teams);
 
        // Add all terrains on the map as encountered terrains.
        void encounter_map_terrain(const gamemap& map);
 
        // Calls all of the above functions on the current game board
        void encounter_all_content(const game_board& gb);
 
        /**
         * @param content_for The achievement group the achievement is part of.
         * @param id The ID of the achievement within the achievement group.
         * @return True if the achievement exists and is completed, false otherwise.
         */
        bool achievement(const std::string& content_for, const std::string& id);
        /**
         * Marks the specified achievement as completed.
         *
         * @param content_for The achievement group the achievement is part of.
         * @param id The ID of the achievement within the achievement group.
         */
        void set_achievement(const std::string& content_for, const std::string& id);
 
        /**
         * Increments the achievement's current progress by @a amount if it hasn't already been completed.
         * If you only want to check the achievement's current progress, then omit the last three arguments.
         * @a amount defaults to 0, which will result in the current progress value being returned without being changed (x + 0 == x).
         *
         * Note that this uses the same [in_progress] as is used for set_sub_achievement().
         *
         * @param content_for The id of the achievement group this achievement is in.
         * @param id The id for the specific achievement in the achievement group.
         * @param limit The maximum value that a specific call to this function can increase the achievement progress value.
         * @param max_progress The value when the achievement is considered completed.
         * @param amount The amount to progress the achievement.
         * @return The achievement's current progress, or -1 if it has already been completed.
         */
        int progress_achievement(const std::string& content_for, const std::string& id, int limit = 999999, int max_progress = 999999, int amount = 0);
 
        /**
         * @param content_for The achievement group the achievement is part of.
         * @param id The ID of the achievement within the achievement group.
         * @param sub_id The ID of the sub-achievement within the achievement.
         * @return True if the sub-achievement exists and is completed, false otherwise.
         */
        bool sub_achievement(const std::string& content_for, const std::string& id, const std::string& sub_id);
 
        /**
         * Marks the specified sub-achievement as completed.
         *
         * Note that this uses the same [in_progress] as is used for progress_achievement().
         *
         * @param content_for The achievement group the achievement is part of.
         * @param id The ID of the achievement within the achievement group.
         * @param sub_id The ID of the sub-achievement within the achievement.
         */
        void set_sub_achievement(const std::string& content_for, const std::string& id, const std::string& sub_id);
 
        PREF_GETTER_SETTER(show_ally_orb, bool, game_config::show_ally_orb)
        PREF_GETTER_SETTER(show_status_on_ally_orb, bool, game_config::show_status_on_ally_orb)
        PREF_GETTER_SETTER(show_enemy_orb, bool, game_config::show_enemy_orb)
        PREF_GETTER_SETTER(show_moved_orb, bool, game_config::show_moved_orb)
        PREF_GETTER_SETTER(show_unmoved_orb, bool, game_config::show_unmoved_orb)
        PREF_GETTER_SETTER(show_partial_orb, bool, game_config::show_partial_orb)
        PREF_GETTER_SETTER(show_disengaged_orb, bool, game_config::show_disengaged_orb)
        PREF_GETTER_SETTER(core, std::string, std::string("default"))
        PREF_GETTER_SETTER(scroll_to_action, bool, true)
        PREF_GETTER_SETTER(auto_pixel_scale, bool, true)
        PREF_GETTER_SETTER(maximized, bool, !fullscreen())
        PREF_GETTER_SETTER(fullscreen, bool, true)
        PREF_GETTER_SETTER(vsync, bool, true)
        PREF_GETTER_SETTER(turbo_speed, double, 2.0)
        PREF_GETTER_SETTER(idle_anim, bool, true)
        PREF_GETTER_SETTER(idle_anim_rate, int, 0)
        PREF_GETTER_SETTER(locale, std::string, std::string(""))
        PREF_GETTER_SETTER(gui2_theme, std::string, std::string(""))
        PREF_GETTER_SETTER(stop_music_in_background, bool, false)
        PREF_GETTER_SETTER(tile_size, unsigned, 0)
        PREF_GETTER_SETTER(mouse_scrolling, bool, true)
        PREF_GETTER_SETTER(draw_delay, int, -1)
        PREF_GETTER_SETTER(animate_map, bool, true)
        PREF_GETTER_SETTER(animate_water, bool, true)
        PREF_GETTER_SETTER(minimap_movement_coding, bool, true)
        PREF_GETTER_SETTER(minimap_terrain_coding, bool, true)
        PREF_GETTER_SETTER(minimap_draw_units, bool, true)
        PREF_GETTER_SETTER(minimap_draw_villages, bool, true)
        PREF_GETTER_SETTER(minimap_draw_terrain, bool, true)
        PREF_GETTER_SETTER(show_side_colors, bool, true)
        PREF_GETTER_SETTER(grid, bool, false)
        PREF_GETTER_SETTER(disable_auto_moves, bool, false)
        PREF_GETTER_SETTER(damage_prediction_allow_monte_carlo_simulation, bool, true)
        PREF_GETTER_SETTER(addon_manager_saved_order_name, std::string, std::string(""))
        PREF_GETTER_SETTER(selected_achievement_group, std::string, std::string(""))
        /** The most recently selected add-on id from the editor. May be an empty string. */
        PREF_GETTER_SETTER(editor_chosen_addon, std::string, std::string(""))
        PREF_GETTER_SETTER(_last_cache_cleaned_ver, std::string, std::string(""))
        PREF_GETTER_SETTER(lobby_whisper_friends_only, bool, false)
        PREF_GETTER_SETTER(fi_invert, bool, false)
        PREF_GETTER_SETTER(fi_vacant_slots, bool, false)
        PREF_GETTER_SETTER(fi_friends_in_game, bool, false)
        PREF_GETTER_SETTER(fi_blocked_in_game, bool, false)
        PREF_GETTER_SETTER(editor_auto_update_transitions, int, pref_constants::TRANSITION_UPDATE_PARTIAL)
        PREF_GETTER_SETTER(editor_draw_terrain_codes, bool, false)
        PREF_GETTER_SETTER(editor_draw_hex_coordinates, bool, false)
        PREF_GETTER_SETTER(editor_draw_num_of_bitmaps, bool, false)
        PREF_GETTER_SETTER(turn_dialog, bool, false)
        PREF_GETTER_SETTER(enable_planning_mode_on_start, bool, false)
        PREF_GETTER_SETTER(hide_whiteboard, bool, false)
        PREF_GETTER_SETTER(allow_observers, bool, true)
        PREF_GETTER_SETTER(shuffle_sides, bool, false)
        PREF_GETTER_SETTER(random_faction_mode, std::string, std::string(""))
        PREF_GETTER_SETTER(mp_use_map_settings, bool, true)
        PREF_GETTER_SETTER(mp_server_warning_disabled, int, 0)
        PREF_GETTER_SETTER(mp_random_start_time, bool, true)
        PREF_GETTER_SETTER(mp_fog, bool, true)
        PREF_GETTER_SETTER(mp_shroud, bool, true)
        PREF_GETTER_SETTER(mp_turns, int, 0)
        PREF_GETTER_SETTER(skip_mp_replay, bool, false)
        PREF_GETTER_SETTER(blindfold_replay, bool, false)
        PREF_GETTER_SETTER(mp_countdown, bool, false)
        PREF_GETTER_SETTER(mp_era, std::string, std::string(""))
        PREF_GETTER_SETTER(mp_level, std::string, std::string(""))
        PREF_GETTER_SETTER(mp_level_type, int, 0)
        PREF_GETTER_SETTER(skip_ai_moves, bool, false)
        PREF_GETTER_SETTER(save_replays, bool, true)
        PREF_GETTER_SETTER(delete_saves, bool, false)
        PREF_GETTER_SETTER(ask_delete, bool, true)
        PREF_GETTER_SETTER(ally_sighted_interrupts, bool, true)
        PREF_GETTER_SETTER(auto_save_max, int, 10)
        PREF_GETTER_SETTER(floating_labels, bool, true)
        PREF_GETTER_SETTER(chat_timestamp, bool, false)
        PREF_GETTER_SETTER(chat_lines, int, 6)
        PREF_GETTER_SETTER(chat_message_aging, int, 20)
        PREF_GETTER_SETTER(show_all_units_in_help, bool, false)
        PREF_GETTER_SETTER(custom_command, std::string, std::string(""))
        PREF_GETTER_SETTER(player_joins_sound, bool, true)
        PREF_GETTER_SETTER(player_joins_lobby, bool, false)
        PREF_GETTER_SETTER(player_joins_notif, bool, false)
        PREF_GETTER_SETTER(player_leaves_sound, bool, true)
        PREF_GETTER_SETTER(player_leaves_lobby, bool, false)
        PREF_GETTER_SETTER(player_leaves_notif, bool, false)
        PREF_GETTER_SETTER(private_message_sound, bool, true)
        PREF_GETTER_SETTER(private_message_lobby, bool, desktop::notifications::available())
        PREF_GETTER_SETTER(private_message_notif, bool, true)
        PREF_GETTER_SETTER(friend_message_sound, bool, false)
        PREF_GETTER_SETTER(friend_message_lobby, bool, false)
        PREF_GETTER_SETTER(friend_message_notif, bool, false)
        PREF_GETTER_SETTER(public_message_sound, bool, false)
        PREF_GETTER_SETTER(public_message_lobby, bool, false)
        PREF_GETTER_SETTER(public_message_notif, bool, false)
        PREF_GETTER_SETTER(server_message_sound, bool, true)
        PREF_GETTER_SETTER(server_message_lobby, bool, false)
        PREF_GETTER_SETTER(server_message_notif, bool, true)
        PREF_GETTER_SETTER(ready_for_start_sound, bool, true)
        PREF_GETTER_SETTER(ready_for_start_lobby, bool, desktop::notifications::available())
        PREF_GETTER_SETTER(ready_for_start_notif, bool, false)
        PREF_GETTER_SETTER(game_has_begun_sound, bool, true)
        PREF_GETTER_SETTER(game_has_begun_lobby, bool, desktop::notifications::available())
        PREF_GETTER_SETTER(game_has_begun_notif, bool, false)
        PREF_GETTER_SETTER(turn_changed_sound, bool, true)
        PREF_GETTER_SETTER(turn_changed_lobby, bool, desktop::notifications::available())
        PREF_GETTER_SETTER(turn_changed_notif, bool, false)
        PREF_GETTER_SETTER(game_created_sound, bool, true)
        PREF_GETTER_SETTER(game_created_lobby, bool, desktop::notifications::available())
        PREF_GETTER_SETTER(game_created_notif, bool, true)
        PREF_GETTER_SETTER(editor_help_text_shown, bool, true)
#undef PREF_GETTER_SETTER
        void clear_mp_alert_prefs();
 
    private:
        prefs();
        // don't move, assign, or copy a singleton
        prefs(const prefs& p) = delete;
        prefs& operator=(const prefs& p) = delete;
        prefs(const prefs&& p) = delete;
        prefs& operator=(const prefs&& p) = delete;
 
        inline static bool no_preferences_save = false;
 
        config preferences_;
        bool fps_;
        std::map<std::string, std::set<std::string>> completed_campaigns_;
        std::set<std::string> encountered_units_set_;
        std::set<t_translation::terrain_code> encountered_terrains_set_;
        std::map<std::string, std::vector<std::string>> history_map_;
        std::map<std::string, preferences::acquaintance> acquaintances_;
        config option_values_;
        bool options_initialized_;
        std::vector<std::string> mp_modifications_;
        bool mp_modifications_initialized_;
        std::vector<std::string> sp_modifications_;
        bool sp_modifications_initialized_;
        bool message_private_on_;
        std::vector<preferences::login_info> credentials_;
        std::vector<preferences::option> advanced_prefs_;
 
        void load_preferences();
        void clear_preferences() {preferences_.clear();}
        void load_credentials();
        void save_credentials();
        void clear_credentials();
 
        void set_child(const std::string& key, const config& val);
        optional_const_config get_child(const std::string &key);
        std::string get(const std::string& key, const std::string& def);
        config::attribute_value get_as_attribute(const std::string& key);
 
        std::string get_system_username();
        /**
         * Encrypts the value of @a text using @a key and a hard coded IV using AES.
         * Max size of @a text must not be larger than 1008 bytes.
         *
         * NOTE: This is not meant to provide strong protections against a determined attacker.
         * This is meant to hide the passwords from malware scanning files for passwords, family/friends poking around, etc.
         *
         * @param text The original unencrypted data.
         * @param key The value to use to encrypt the data. See build_key() for key generation.
         * @return secure_buffer The encrypted data.
         */
        preferences::secure_buffer aes_encrypt(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 data.
         */
        preferences::secure_buffer aes_decrypt(const preferences::secure_buffer& text, const preferences::secure_buffer& key);
        /**
         * Fills a secure_buffer with 32 bytes of deterministically generated bytes, then overwrites it with the system login name, server login name, and server name.
         * If this is more than 32 bytes, then it's truncated. If it's less than 32 bytes, then the pre-generated bytes are used to pad it.
         *
         * @param server The server being logged into.
         * @param login The username being used to login.
         * @return secure_buffer The data to be used as the encryption key.
         */
        preferences::secure_buffer build_key(const std::string& server, const std::string& login);
        preferences::secure_buffer escape(const preferences::secure_buffer& text);
        preferences::secure_buffer unescape(const preferences::secure_buffer& text);
 
        std::set<std::string> unknown_synced_attributes_;
        std::set<std::string> unknown_unsynced_attributes_;
        std::set<std::string> unknown_synced_children_;
        std::set<std::string> unknown_unsynced_children_;
 
        // a bit verbose, but it being a compile time error if a preference hasn't been added is nice
        static constexpr std::array synced_attributes_{
            prefs_list::player_joins_sound,
            prefs_list::player_joins_notif,
            prefs_list::player_joins_lobby,
            prefs_list::player_leaves_sound,
            prefs_list::player_leaves_notif,
            prefs_list::player_leaves_lobby,
            prefs_list::private_message_sound,
            prefs_list::private_message_notif,
            prefs_list::private_message_lobby,
            prefs_list::friend_message_sound,
            prefs_list::friend_message_notif,
            prefs_list::friend_message_lobby,
            prefs_list::public_message_sound,
            prefs_list::public_message_notif,
            prefs_list::public_message_lobby,
            prefs_list::server_message_sound,
            prefs_list::server_message_notif,
            prefs_list::server_message_lobby,
            prefs_list::ready_for_start_sound,
            prefs_list::ready_for_start_notif,
            prefs_list::ready_for_start_lobby,
            prefs_list::game_has_begun_sound,
            prefs_list::game_has_begun_notif,
            prefs_list::game_has_begun_lobby,
            prefs_list::turn_changed_sound,
            prefs_list::turn_changed_notif,
            prefs_list::turn_changed_lobby,
            prefs_list::game_created_sound,
            prefs_list::game_created_notif,
            prefs_list::game_created_lobby,
            prefs_list::_last_cache_cleaned_ver,
            prefs_list::addon_manager_saved_order_direction,
            prefs_list::addon_manager_saved_order_name,
            prefs_list::alias,
            prefs_list::allow_observers,
            prefs_list::ally_orb_color,
            prefs_list::ally_sighted_interrupts,
            prefs_list::auto_save_max,
            prefs_list::blindfold_replay,
            prefs_list::campaign_server,
            prefs_list::chat_lines,
            prefs_list::chat_timestamp,
            prefs_list::confirm_end_turn,
            prefs_list::custom_command,
            prefs_list::delete_saves,
            prefs_list::disable_auto_moves,
            prefs_list::editor_auto_update_transitions,
            prefs_list::editor_draw_hex_coordinates,
            prefs_list::editor_draw_num_of_bitmaps,
            prefs_list::editor_draw_terrain_codes,
            prefs_list::enable_planning_mode_on_start,
            prefs_list::encountered_terrain_list,
            prefs_list::encountered_units,
            prefs_list::enemy_orb_color,
            prefs_list::fi_blocked_in_game,
            prefs_list::fi_friends_in_game,
            prefs_list::fi_invert,
            prefs_list::fi_vacant_slots,
            prefs_list::floating_labels,
            prefs_list::grid,
            prefs_list::hide_whiteboard,
            prefs_list::host,
            prefs_list::idle_anim,
            prefs_list::idle_anim_rate,
            prefs_list::lobby_joins,
            prefs_list::lobby_whisper_friends_only,
            prefs_list::locale,
            prefs_list::login,
            prefs_list::message_bell,
            prefs_list::minimap_draw_terrain,
            prefs_list::minimap_draw_units,
            prefs_list::minimap_draw_villages,
            prefs_list::minimap_movement_coding,
            prefs_list::minimap_terrain_coding,
            prefs_list::moved_orb_color,
            prefs_list::mp_countdown,
            prefs_list::mp_countdown_action_bonus,
            prefs_list::mp_countdown_init_time,
            prefs_list::mp_countdown_reservoir_time,
            prefs_list::mp_countdown_turn_bonus,
            prefs_list::mp_fog,
            prefs_list::mp_level_type,
            prefs_list::mp_random_start_time,
            prefs_list::mp_server_warning_disabled,
            prefs_list::mp_shroud,
            prefs_list::mp_turns,
            prefs_list::mp_use_map_settings,
            prefs_list::mp_village_gold,
            prefs_list::mp_village_support,
            prefs_list::mp_xp_modifier,
            prefs_list::music,
            prefs_list::partial_orb_color,
            prefs_list::random_faction_mode,
            prefs_list::remember_password,
            prefs_list::save_replays,
            prefs_list::scroll,
            prefs_list::scroll_threshold,
            prefs_list::show_ally_orb,
            prefs_list::show_disengaged_orb,
            prefs_list::show_enemy_orb,
            prefs_list::show_moved_orb,
            prefs_list::show_partial_orb,
            prefs_list::show_side_colors,
            prefs_list::show_status_on_ally_orb,
            prefs_list::show_unmoved_orb,
            prefs_list::shuffle_sides,
            prefs_list::skip_ai_moves,
            prefs_list::skip_mp_replay,
            prefs_list::sound,
            prefs_list::sample_rate,
            prefs_list::stop_music_in_background,
            prefs_list::turbo,
            prefs_list::turbo_speed,
            prefs_list::turn_bell,
            prefs_list::turn_dialog,
            prefs_list::ui_sound,
            prefs_list::unit_standing_animations,
            prefs_list::unmoved_orb_color,
            prefs_list::ask_delete,
            prefs_list::chat_message_aging,
            prefs_list::color_cursors,
            prefs_list::compress_saves,
            prefs_list::confirm_load_save_from_different_version,
            prefs_list::damage_prediction_allow_monte_carlo_simulation,
            prefs_list::editor_max_recent_files,
            prefs_list::keepalive_timeout,
            prefs_list::lobby_auto_open_whisper_windows,
            prefs_list::middle_click_scrolls,
            prefs_list::mouse_scrolling,
            prefs_list::scroll_to_action,
            prefs_list::scroll_when_mouse_outside,
            prefs_list::show_all_units_in_help,
            prefs_list::show_combat,
            prefs_list::show_deprecation,
            prefs_list::use_twelve_hour_clock_format,
            prefs_list::mp_era,
            prefs_list::mp_level,
            prefs_list::mp_modifications,
            prefs_list::selected_achievement_group,
            prefs_list::sp_modifications,
            prefs_list::animate_map,
            prefs_list::animate_water,
        };
        static constexpr std::array synced_children_{
            prefs_list::achievements,
            prefs_list::completed_campaigns,
            prefs_list::history,
            prefs_list::options,
        };
        static constexpr std::array unsynced_attributes_{
            prefs_list::auto_pixel_scale,
            prefs_list::core,
            prefs_list::draw_delay,
            prefs_list::editor_chosen_addon,
            prefs_list::gui2_theme,
            prefs_list::mp_server_program_name,
            prefs_list::pixel_scale,
            prefs_list::sound_buffer_size,
            prefs_list::theme,
            prefs_list::tile_size,
            prefs_list::vsync,
            prefs_list::xresolution,
            prefs_list::yresolution,
            prefs_list::font_scale,
            prefs_list::bell_volume,
            prefs_list::music_volume,
            prefs_list::sound_volume,
            prefs_list::ui_volume,
            prefs_list::fullscreen,
            prefs_list::maximized,
        };
        static constexpr std::array unsynced_children_{
            prefs_list::editor_recent_files,
            prefs_list::dir_bookmarks,
        };
        static_assert(synced_attributes_.size() + synced_children_.size() + unsynced_attributes_.size() + unsynced_children_.size() == prefs_list::values.size(), "attribute missing from lists of synced or unsynced preferences!");
};
 
//
// might be overkill, but it does best limit the private functionality being exposed
//
 
struct preferences_dialog_friend
{
    friend class preferences_dialog;
 
    static void set(const std::string& pref, bool value)
    {
        prefs::get().preferences_[pref] = value;
    }
    static void set(const std::string& pref, int value)
    {
        prefs::get().preferences_[pref] = value;
    }
    static void set(const std::string& pref, const std::string& value)
    {
        prefs::get().preferences_[pref] = value;
    }
 
    static bool get(const std::string& pref, bool def)
    {
        return prefs::get().preferences_[pref].to_bool(def);
    }
    static int get(const std::string& pref, int def)
    {
        return prefs::get().preferences_[pref].to_int(def);
    }
    static std::string get(const std::string& pref, const std::string& def)
    {
        return prefs::get().get(pref, def);
    }
};