The Battle for Wesnoth  1.17.12+dev
migrate_version_selection.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2022
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 #define GETTEXT_DOMAIN "wesnoth-lib"
16 
18 
19 #include "addon/manager_ui.hpp"
20 #include "filesystem.hpp"
21 #include "game_version.hpp"
22 #include "gettext.hpp"
24 #include "gui/dialogs/message.hpp"
25 #include "gui/widgets/listbox.hpp"
26 #include "gui/widgets/window.hpp"
28 #include "preferences/game.hpp"
29 
30 #include <boost/algorithm/string.hpp>
31 
32 static lg::log_domain log_version_migration{"gui/dialogs/migrate_version_selection"};
33 #define ERR_LOG_VERSION_MIGRATION LOG_STREAM(err, log_version_migration)
34 #define WRN_LOG_VERSION_MIGRATION LOG_STREAM(warn, log_version_migration)
35 #define LOG_LOG_VERSION_MIGRATION LOG_STREAM(info, log_version_migration)
36 #define DBG_LOG_VERSION_MIGRATION LOG_STREAM(debug, log_version_migration)
37 
38 namespace gui2::dialogs
39 {
40 REGISTER_DIALOG(migrate_version_selection)
41 
43 {
45  if(mig.versions_.size() > 0) {
46  mig.show();
47  }
48 }
49 
51  : modal_dialog(window_id())
52 {
54  std::string current_version_str = filesystem::get_version_path_suffix();
55 
56  for(unsigned int i = 1; i < current_version.minor_version(); i++) {
57  std::string previous_version_str = std::to_string(current_version.major_version()) + "."
58  + std::to_string(current_version.minor_version() - i);
59  std::string previous_addons_dir
60  = boost::replace_all_copy(filesystem::get_addons_dir(), current_version_str, previous_version_str);
61 
62  if(previous_addons_dir != filesystem::get_addons_dir() && filesystem::file_exists(previous_addons_dir)) {
63  versions_.push_back(previous_version_str);
64  }
65  }
66 }
67 
69 {
70  listbox& version_list = find_widget<listbox>(&window, "versions_listbox", false);
71 
72  for(const auto& version : versions_) {
74  widget_item item_label;
75 
76  item_label["label"] = version;
77  data["version_label"] = item_label;
78 
79  version_list.add_row(data);
80  }
81 }
82 
84 {
85  if(get_retval() == gui2::OK) {
86  std::string current_version_str = filesystem::get_version_path_suffix();
87  listbox& version_list = find_widget<listbox>(&window, "versions_listbox", false);
88  int selected_row = version_list.get_selected_row();
89  std::string selected = versions_.at(selected_row);
90 
91  std::string migrate_addons_dir
92  = boost::replace_all_copy(filesystem::get_addons_dir(), current_version_str, selected);
93  std::string migrate_prefs_file
94  = boost::replace_all_copy(filesystem::get_prefs_file(), current_version_str, selected);
95  std::string migrate_credentials_file
96  = boost::replace_all_copy(filesystem::get_credentials_file(), current_version_str, selected);
97 
98  // given self-compilation and linux distros being able to do whatever they want plus command line options to
99  // alter locations make sure the directories/files are actually different before doing anything with them
100  if(migrate_addons_dir != filesystem::get_addons_dir()) {
101  std::vector<std::string> migrate_addons;
102  filesystem::get_files_in_dir(migrate_addons_dir, nullptr, &migrate_addons);
103  if(migrate_addons.size() > 0) {
104  ad_hoc_addon_fetch_session(migrate_addons);
105  }
106  }
107 
108  if(migrate_prefs_file != filesystem::get_prefs_file() && filesystem::file_exists(migrate_prefs_file)) {
109  filesystem::copy_file(migrate_prefs_file, filesystem::get_prefs_file());
110  }
111 
112  if(migrate_credentials_file != filesystem::get_credentials_file()
113  && filesystem::file_exists(migrate_credentials_file)) {
114  filesystem::copy_file(migrate_credentials_file, filesystem::get_credentials_file());
115  }
116 
117  // reload preferences and credentials
118  // otherwise the copied files won't be used and also will get overwritten/deleted when Wesnoth closes
122  }
123 }
124 } // namespace gui2::dialogs
window(const builder_window::window_resolution &definition)
< Needs to be initialized in show.
Definition: window.cpp:263
Interfaces for manipulating version numbers of engine, add-ons, etc.
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
static bool file_exists(const bfs::path &fpath)
Definition: filesystem.cpp:264
This file contains the window object, this object is a top level container which has the event manage...
std::string_view data
Definition: picture.cpp:206
grid & add_row(const widget_item &item, const int index=-1)
When an item in the list is selected by the user we need to update the state.
Definition: listbox.cpp:61
int get_selected_row() const
Returns the first selected row.
Definition: listbox.cpp:270
bool show(const unsigned auto_close_time=0)
Shows the window.
void load_base_prefs()
Definition: general.cpp:240
The listbox class.
Definition: listbox.hpp:45
This shows the dialog to select a previous version of Wesnoth to migrate preferences from and redownl...
std::map< std::string, t_string > widget_item
Definition: widget.hpp:32
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
bool ad_hoc_addon_fetch_session(const std::vector< std::string > &addon_ids)
Conducts an ad-hoc add-ons server connection to download an add-on with a particular id and all it&#39;s ...
Definition: manager_ui.cpp:259
unsigned int major_version() const
Retrieves the major version number (x1 in "x1.x2.x3").
void get_files_in_dir(const std::string &dir, std::vector< std::string > *files, std::vector< std::string > *dirs, name_mode mode, filter_mode filter, reorder_mode reorder, file_tree_checksum *checksum)
Get a list of all files and/or directories in a given directory.
Definition: filesystem.cpp:350
std::string selected
unsigned int minor_version() const
Retrieves the minor version number (x2 in "x1.x2.x3").
std::size_t i
Definition: function.cpp:968
void load_game_prefs()
Definition: game.cpp:121
void copy_file(const std::string &src, const std::string &dest)
Read a file and then writes it back out.
Declarations for File-IO.
const version_info wesnoth_version(VERSION)
Represents version numbers.
const std::string get_version_path_suffix(const version_info &version)
Definition: filesystem.cpp:513
int get_retval() const
Returns the cached window exit code.
std::string get_addons_dir()
void load_credentials()
std::string get_credentials_file()
Abstract base class for all modal dialogs.
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:35
Dialog was closed with the OK button.
Definition: retval.hpp:35
std::string get_prefs_file()
static lg::log_domain log_version_migration
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:66