migrate_version_selection.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 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.
*/
 
#define GETTEXT_DOMAIN "wesnoth-lib"
 
#include "gui/dialogs/migrate_version_selection.hpp"
 
#include "addon/manager_ui.hpp"
#include "filesystem.hpp"
#include "game_version.hpp"
#include "gettext.hpp"
#include "gui/auxiliary/find_widget.hpp"
#include "gui/widgets/listbox.hpp"
#include "gui/widgets/window.hpp"
#include "preferences/credentials.hpp"
#include "preferences/game.hpp"
#include "serialization/parser.hpp"
 
#include <boost/algorithm/string.hpp>
 
static lg::log_domain log_version_migration{"gui/dialogs/migrate_version_selection"};
#define ERR_LOG_VERSION_MIGRATION LOG_STREAM(err, log_version_migration)
#define WRN_LOG_VERSION_MIGRATION LOG_STREAM(warn, log_version_migration)
#define LOG_LOG_VERSION_MIGRATION LOG_STREAM(info, log_version_migration)
#define DBG_LOG_VERSION_MIGRATION LOG_STREAM(debug, log_version_migration)
 
namespace gui2::dialogs
{
REGISTER_DIALOG(migrate_version_selection)
 
void migrate_version_selection::execute()
{
    migrate_version_selection mig = migrate_version_selection();
    if(mig.versions_.size() > 0) {
        mig.show();
    }
}
 
migrate_version_selection::migrate_version_selection()
    : modal_dialog(window_id())
{
    version_info current_version = game_config::wesnoth_version;
    std::string current_version_str = filesystem::get_version_path_suffix();
 
    for(unsigned int i = 1; i < current_version.minor_version(); i++) {
        std::string previous_version_str = std::to_string(current_version.major_version()) + "."
            + std::to_string(current_version.minor_version() - i);
        std::string previous_addons_dir
            = boost::replace_all_copy(filesystem::get_addons_dir(), current_version_str, previous_version_str);
 
        if(previous_addons_dir != filesystem::get_addons_dir() && filesystem::file_exists(previous_addons_dir)) {
            versions_.push_back(previous_version_str);
        }
    }
}
 
void migrate_version_selection::pre_show(window& window)
{
    listbox& version_list = find_widget<listbox>(&window, "versions_listbox", false);
 
    for(const auto& version : versions_) {
        widget_data data;
        widget_item item_label;
 
        item_label["label"] = version;
        data["version_label"] = item_label;
 
        version_list.add_row(data);
    }
}
 
void migrate_version_selection::post_show(window& window)
{
    if(get_retval() == gui2::OK) {
        std::string current_version_str = filesystem::get_version_path_suffix();
        listbox& version_list = find_widget<listbox>(&window, "versions_listbox", false);
        int selected_row = version_list.get_selected_row();
        std::string selected = versions_.at(selected_row);
 
        std::string migrate_addons_dir
            = boost::replace_all_copy(filesystem::get_addons_dir(), current_version_str, selected);
        std::string migrate_prefs_file
            = boost::replace_all_copy(filesystem::get_prefs_file(), current_version_str, selected);
        std::string migrate_credentials_file
            = boost::replace_all_copy(filesystem::get_credentials_file(), current_version_str, selected);
 
        // given self-compilation and linux distros being able to do whatever they want plus command line options to
        // alter locations make sure the directories/files are actually different before doing anything with them
        if(migrate_addons_dir != filesystem::get_addons_dir()) {
            std::vector<std::string> old_addons;
            std::vector<std::string> current_addons;
            std::vector<std::string> migrate_addons;
 
            filesystem::get_files_in_dir(migrate_addons_dir, nullptr, &old_addons);
            filesystem::get_files_in_dir(filesystem::get_addons_dir(), nullptr, &current_addons);
 
            std::set_difference(old_addons.begin(), old_addons.end(), current_addons.begin(), current_addons.end(), std::back_inserter(migrate_addons));
 
            if(migrate_addons.size() > 0) {
                ad_hoc_addon_fetch_session(migrate_addons);
            }
        }
 
        if(migrate_prefs_file != filesystem::get_prefs_file() && filesystem::file_exists(migrate_prefs_file)) {
            // if the file doesn't exist, just copy the file over
            // else need to merge the preferences file
            if(!filesystem::file_exists(filesystem::get_prefs_file())) {
                filesystem::copy_file(migrate_prefs_file, filesystem::get_prefs_file());
            } else {
                config current_cfg;
                filesystem::scoped_istream current_stream = filesystem::istream_file(filesystem::get_prefs_file(), false);
                read(current_cfg, *current_stream);
                config old_cfg;
                filesystem::scoped_istream old_stream = filesystem::istream_file(migrate_prefs_file, false);
                read(old_cfg, *old_stream);
 
                // when both files have the same attribute, use the one from whichever was most recently modified
                bool current_prefs_are_older = filesystem::file_modified_time(filesystem::get_prefs_file()) < filesystem::file_modified_time(migrate_prefs_file);
                for(const config::attribute& val : old_cfg.attribute_range()) {
                    if(current_prefs_are_older || !current_cfg.has_attribute(val.first)) {
                        preferences::set(val.first, val.second);
                    }
                }
 
                // don't touch child tags
 
                preferences::write_preferences();
            }
        }
 
        // don't touch the credentials file on migrator re-run if it already exists
        if(migrate_credentials_file != filesystem::get_credentials_file() && filesystem::file_exists(migrate_credentials_file) && !filesystem::file_exists(filesystem::get_credentials_file())) {
            filesystem::copy_file(migrate_credentials_file, filesystem::get_credentials_file());
        }
 
        // reload preferences and credentials
        // otherwise the copied files won't be used and also will get overwritten/deleted when Wesnoth closes
        preferences::load_base_prefs();
        preferences::load_game_prefs();
        preferences::load_credentials();
    }
}
} // namespace gui2::dialogs