The Battle for Wesnoth  1.17.23+dev
edit_pbl.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2023 - 2023
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 "editor/editor_common.hpp"
20 #include "filesystem.hpp"
21 #include "gettext.hpp"
25 #include "gui/dialogs/message.hpp"
26 #include "gui/widgets/button.hpp"
27 #include "gui/widgets/drawing.hpp"
28 #include "gui/widgets/label.hpp"
29 #include "gui/widgets/listbox.hpp"
32 #include "gui/widgets/text_box.hpp"
34 #include "serialization/base64.hpp"
36 #include "serialization/parser.hpp"
39 
40 #include <boost/algorithm/string/replace.hpp>
41 
42 namespace gui2::dialogs
43 {
44 
45 REGISTER_DIALOG(editor_edit_pbl)
46 
47 const std::array type_values = {
48  "",
49  "core",
50  "campaign",
51  "campaign_sp_mp",
52  "campaign_mp",
53  "scenario",
54  "scenario_mp",
55  "faction",
56  "era",
57  "map_pack",
58  "mod_mp",
59  "media",
60  "other",
61 };
62 
63 const std::array tag_values = {
64  "cooperative",
65  "cosmetic",
66  "difficulty",
67  "rng",
68  "survival",
69  "terraforming",
70 };
71 
72 editor_edit_pbl::editor_edit_pbl(const std::string& pbl, const std::string& current_addon)
73  : modal_dialog(window_id())
74  , pbl_(pbl)
75  , current_addon_(current_addon)
76  , dirs_()
77 {
79  find_widget<toggle_button>(get_window(), "forum_auth", false), std::bind(&editor_edit_pbl::toggle_auth, this));
80  connect_signal_mouse_left_click(find_widget<button>(get_window(), "translations_add", false),
81  std::bind(&editor_edit_pbl::add_translation, this));
82  connect_signal_mouse_left_click(find_widget<button>(get_window(), "translations_delete", false),
83  std::bind(&editor_edit_pbl::delete_translation, this));
85  find_widget<button>(get_window(), "validate", false), std::bind(&editor_edit_pbl::validate, this));
87  find_widget<button>(get_window(), "select_icon", false), std::bind(&editor_edit_pbl::select_icon_file, this));
89  find_widget<text_box>(get_window(), "icon", false), std::bind(&editor_edit_pbl::update_icon_preview, this));
90  connect_signal_notify_modified(find_widget<text_box>(get_window(), "forum_thread", false),
91  std::bind(&editor_edit_pbl::update_url_preview, this));
92  label& url = find_widget<label>(get_window(), "forum_url", false);
93  url.set_link_aware(true);
94  url.set_use_markup(true);
95  // not setting this to some value causes the modified signal to not update the label text
96  url.set_label("https://r.wesnoth.org/t");
97 }
98 
100 {
101  config pbl;
103  try {
104  read(pbl, *preprocess_file(pbl_));
105  } catch(const config::error& e) {
106  ERR_ED << "Caught a config error while parsing file " << pbl_ << "\n" << e.message;
107  }
108  }
109 
110  text_box* name = find_widget<text_box>(&win, "name", false, true);
111  name->set_value(pbl["title"]);
112  win.keyboard_capture(name);
113 
114  find_widget<text_box>(&win, "description", false).set_value(pbl["description"]);
115  find_widget<text_box>(&win, "icon", false).set_value(pbl["icon"]);
116  if(!pbl["icon"].empty()) {
117  drawing& img = find_widget<drawing>(&win, "preview", false);
118  img.set_label(pbl["icon"]);
119  }
120  find_widget<text_box>(&win, "author", false).set_value(pbl["author"]);
121  find_widget<text_box>(&win, "version", false).set_value(pbl["version"]);
122 
123  multimenu_button& dependencies = find_widget<multimenu_button>(&win, "dependencies", false);
124  std::vector<config> addons_list;
126  if(dirs_.size() > 0) {
127  dirs_.erase(std::remove(dirs_.begin(), dirs_.end(), current_addon_));
128  }
129 
130  for(const std::string& dir : dirs_) {
131  addons_list.emplace_back("label", dir, "checkbox", false);
132  }
133  dependencies.set_values(addons_list);
134 
135  std::vector<std::string> existing_dependencies = utils::split(pbl["dependencies"].str(), ',');
136  for(unsigned i = 0; i < dirs_.size(); i++) {
137  if(std::find(existing_dependencies.begin(), existing_dependencies.end(), dirs_[i]) != existing_dependencies.end()) {
138  dependencies.select_option(i);
139  }
140  }
141 
142  if(pbl["forum_auth"].to_bool()) {
143  find_widget<toggle_button>(&win, "forum_auth", false).set_value(true);
144  find_widget<text_box>(&win, "email", false).set_visible(gui2::widget::visibility::invisible);
145  find_widget<label>(&win, "email_label", false).set_visible(gui2::widget::visibility::invisible);
146  find_widget<text_box>(&win, "password", false).set_visible(gui2::widget::visibility::invisible);
147  find_widget<label>(&win, "password_label", false).set_visible(gui2::widget::visibility::invisible);
148  find_widget<text_box>(&win, "secondary_authors", false).set_visible(gui2::widget::visibility::visible);
149  find_widget<label>(&win, "secondary_authors_label", false).set_visible(gui2::widget::visibility::visible);
150  } else {
151  find_widget<text_box>(&win, "email", false).set_value(pbl["email"]);
152  find_widget<text_box>(&win, "password", false).set_value(pbl["passphrase"]);
153  find_widget<text_box>(&win, "secondary_authors", false).set_visible(gui2::widget::visibility::invisible);
154  find_widget<label>(&win, "secondary_authors_label", false).set_visible(gui2::widget::visibility::invisible);
155  }
156 
157  if(pbl.has_child("feedback")) {
158  find_widget<text_box>(&win, "forum_thread", false).set_value(pbl.mandatory_child("feedback")["topic_id"]);
159  }
160 
161  unsigned selected = 0;
162  for(unsigned i = 0; i < type_values.size(); i++) {
163  if(type_values[i] == pbl["type"]) {
164  selected = i;
165  break;
166  }
167  }
168 
169  menu_button& types = find_widget<menu_button>(&win, "type", false);
170  std::vector<config> type_list;
171  type_list.emplace_back("label", "");
172  type_list.emplace_back("label", _("Core"));
173  type_list.emplace_back("label", _("Campaign"));
174  type_list.emplace_back("label", _("Hybrid Campaign"));
175  type_list.emplace_back("label", _("Multiplayer Campaign"));
176  type_list.emplace_back("label", _("Scenario"));
177  type_list.emplace_back("label", _("Multiplayer Scenario"));
178  type_list.emplace_back("label", _("Faction"));
179  type_list.emplace_back("label", _("Era"));
180  type_list.emplace_back("label", _("Map Pack"));
181  type_list.emplace_back("label", _("Modification"));
182  type_list.emplace_back("label", _("Media"));
183  type_list.emplace_back("label", _("Other"));
184  types.set_values(type_list);
185  types.set_selected(selected);
186 
187  multimenu_button& tags = find_widget<multimenu_button>(&win, "tags", false);
188  std::vector<config> tags_list;
189  tags_list.emplace_back("label", _("Cooperative"), "checkbox", false);
190  tags_list.emplace_back("label", _("Cosmetic"), "checkbox", false);
191  tags_list.emplace_back("label", _("Difficulty"), "checkbox", false);
192  tags_list.emplace_back("label", _("RNG"), "checkbox", false);
193  tags_list.emplace_back("label", _("Survival"), "checkbox", false);
194  tags_list.emplace_back("label", _("Terraforming"), "checkbox", false);
195  tags.set_values(tags_list);
196 
197  std::vector<std::string> chosen_tags = utils::split(pbl["tags"].str(), ',');
198  for(unsigned i = 0; i < tag_values.size(); i++) {
199  if(std::find(chosen_tags.begin(), chosen_tags.end(), tag_values[i]) != chosen_tags.end()) {
200  tags.select_option(i);
201  }
202  }
203 
204  listbox& translations = find_widget<listbox>(&win, "translations", false);
205  button& translations_delete = find_widget<button>(&win, "translations_delete", false);
206 
207  for(const config& child : pbl.child_range("translation")) {
208  const widget_data& entry{
209  {"translations_language", widget_item{{"label", child["language"].str()}}},
210  {"translations_title", widget_item{{"label", child["title"].str()}}},
211  {"translations_description", widget_item{{"label", child["description"].str()}}},
212  };
213  translations.add_row(entry);
214  }
215 
216  if(translations.get_item_count() == 0) {
217  translations_delete.set_active(false);
218  }
219 }
220 
222 {
223  if(get_retval() != retval::OK) {
224  return;
225  }
226 
227  std::stringstream wml_stream;
228  config_writer out(wml_stream, false);
229  out.write(create_cfg());
230  filesystem::write_file(pbl_, wml_stream.str());
231 }
232 
234 {
235  config cfg;
236 
237  if(const std::string& name = find_widget<text_box>(get_window(), "name", false).get_value(); !name.empty()) {
238  cfg["title"] = name;
239  }
240  if(const std::string& description = find_widget<text_box>(get_window(), "description", false).get_value(); !description.empty()) {
241  cfg["description"] = description;
242  }
243  if(const std::string& icon = find_widget<text_box>(get_window(), "icon", false).get_value(); !icon.empty()) {
244  cfg["icon"] = icon;
245  }
246  if(const std::string& author = find_widget<text_box>(get_window(), "author", false).get_value(); !author.empty()) {
247  cfg["author"] = author;
248  }
249  if(const std::string& version = find_widget<text_box>(get_window(), "version", false).get_value(); !version.empty()) {
250  cfg["version"] = version;
251  }
252 
253  multimenu_button& dependencies = find_widget<multimenu_button>(get_window(), "dependencies", false);
254  boost::dynamic_bitset<> dep_states = dependencies.get_toggle_states();
255  std::vector<std::string> chosen_deps;
256  for(unsigned i = 0; i < dep_states.size(); i++) {
257  if(dep_states[i] == 1) {
258  chosen_deps.emplace_back(dirs_[i]);
259  }
260  }
261  if(chosen_deps.size() > 0) {
262  cfg["dependencies"] = utils::join(chosen_deps, ",");
263  }
264 
265  if(find_widget<toggle_button>(get_window(), "forum_auth", false).get_value_bool()) {
266  cfg["forum_auth"] = true;
267  } else {
268  if(const std::string& email = find_widget<text_box>(get_window(), "email", false).get_value(); !email.empty()) {
269  cfg["email"] = email;
270  }
271  if(const std::string& passphrase = find_widget<text_box>(get_window(), "password", false).get_value(); !passphrase.empty()) {
272  cfg["passphrase"] = passphrase;
273  }
274  }
275 
276  if(const std::string& topic_id = find_widget<text_box>(get_window(), "forum_thread", false).get_value(); !topic_id.empty()) {
277  config& feedback = cfg.add_child("feedback");
278  feedback["topic_id"] = topic_id;
279  }
280 
281  if(unsigned value = find_widget<menu_button>(get_window(), "type", false).get_value(); value != 0) {
282  cfg["type"] = type_values[value];
283  }
284 
285  multimenu_button& tags = find_widget<multimenu_button>(get_window(), "tags", false);
286  boost::dynamic_bitset<> tag_states = tags.get_toggle_states();
287  std::vector<std::string> chosen_tags;
288  for(unsigned i = 0; i < tag_states.size(); i++) {
289  if(tag_states[i] == 1) {
290  chosen_tags.emplace_back(dirs_[i]);
291  }
292  }
293  if(chosen_tags.size() > 0) {
294  cfg["tags"] = utils::join(chosen_tags, ",");
295  }
296 
297  listbox& translations = find_widget<listbox>(get_window(), "translations", false);
298  for(unsigned i = 0; i < translations.get_item_count(); i++) {
299  grid* row = translations.get_row_grid(i);
300  config& translation = cfg.add_child("translation");
301 
302  translation["language"] = dynamic_cast<label*>(row->find("translations_language", false))->get_label();
303  translation["title"] = dynamic_cast<label*>(row->find("translations_title", false))->get_label();
304  translation["description"] = dynamic_cast<label*>(row->find("translations_description", false))->get_label();
305  }
306 
307  return cfg;
308 }
309 
311 {
312  toggle_button& forum_auth = find_widget<toggle_button>(get_window(), "forum_auth", false);
313  if(forum_auth.get_value_bool()) {
314  find_widget<text_box>(get_window(), "email", false).set_visible(gui2::widget::visibility::invisible);
315  find_widget<text_box>(get_window(), "password", false).set_visible(gui2::widget::visibility::invisible);
316  find_widget<label>(get_window(), "email_label", false).set_visible(gui2::widget::visibility::invisible);
317  find_widget<label>(get_window(), "password_label", false).set_visible(gui2::widget::visibility::invisible);
318  find_widget<text_box>(get_window(), "secondary_authors", false).set_visible(gui2::widget::visibility::visible);
319  find_widget<label>(get_window(), "secondary_authors_label", false).set_visible(gui2::widget::visibility::visible);
320  } else {
321  find_widget<text_box>(get_window(), "email", false).set_visible(gui2::widget::visibility::visible);
322  find_widget<text_box>(get_window(), "password", false).set_visible(gui2::widget::visibility::visible);
323  find_widget<label>(get_window(), "email_label", false).set_visible(gui2::widget::visibility::visible);
324  find_widget<label>(get_window(), "password_label", false).set_visible(gui2::widget::visibility::visible);
325  find_widget<text_box>(get_window(), "secondary_authors", false).set_visible(gui2::widget::visibility::invisible);
326  find_widget<label>(get_window(), "secondary_authors_label", false).set_visible(gui2::widget::visibility::invisible);
327  }
328 }
329 
331 {
332  std::string language;
333  std::string title;
334  std::string description;
335  editor_edit_pbl_translation::execute(language, title, description);
336 
337  if(!language.empty() && !title.empty()) {
338  listbox& translations = find_widget<listbox>(get_window(), "translations", false);
339  const widget_data& entry{
340  {"translations_language", widget_item{{"label", language}}},
341  {"translations_title", widget_item{{"label", title}}},
342  {"translations_description", widget_item{{"label", description}}},
343  };
344  translations.add_row(entry);
345  find_widget<button>(get_window(), "translations_delete", false).set_active(true);
346  }
347 }
348 
350 {
351  listbox& translations = find_widget<listbox>(get_window(), "translations", false);
352  translations.remove_row(translations.get_selected_row());
353 
354  button& translations_delete = find_widget<button>(get_window(), "translations_delete", false);
355  if(translations.get_item_count() == 0) {
356  translations_delete.set_active(false);
357  }
358 }
359 
361 {
362  std::unique_ptr<schema_validation::schema_validator> validator;
363  validator.reset(new schema_validation::schema_validator(filesystem::get_wml_location("schema/pbl.cfg")));
364  validator->set_create_exceptions(false);
365 
366  config temp;
367  std::stringstream ss;
368  ss << create_cfg();
369  read(temp, ss.str(), validator.get());
370  if(!validator->get_errors().empty()) {
371  gui2::show_error_message(utils::join(validator->get_errors(), "\n"));
372  } else {
373  gui2::show_message(_("Success"), _("No validation errors"), gui2::dialogs::message::button_style::auto_close);
374  }
375 }
376 
378 {
379  std::string icon = find_widget<text_box>(get_window(), "icon", false).get_value();
380  if(icon.find(".png") != std::string::npos || icon.find(".jpg") != std::string::npos || icon.find(".webp") != std::string::npos) {
381  std::string path = filesystem::get_core_images_dir() + icon;
382  drawing& img = find_widget<drawing>(get_window(), "preview", false);
383 
384  if(filesystem::file_exists(path) || icon.find("data:image") != std::string::npos) {
385  img.set_label(icon);
386  } else {
387  img.set_label("");
388  ERR_ED << "Failed to find icon file: " << path;
389  }
390  }
391 }
392 
394 {
395  std::string topic = find_widget<text_box>(get_window(), "forum_thread", false).get_value();
396  find_widget<label>(get_window(), "forum_url", false).set_label("https://r.wesnoth.org/t" + topic);
397 }
398 
400 {
402 
403  dlg.set_title(_("Choose an icon")).set_path(filesystem::get_core_images_dir() + "/icons/");
404 
405  if(dlg.show()) {
406  std::string path = dlg.path();
407  if(path.find(filesystem::get_core_images_dir()) == 0) {
408  std::string icon = path.substr(filesystem::get_core_images_dir().length() + 1);
409  // setting this programmatically doesn't seem to trigger connect_signal_notify_modified()
410  find_widget<text_box>(get_window(), "icon", false).set_value(icon);
411  find_widget<drawing>(get_window(), "preview", false).set_label(icon);
412  } else {
413  std::string uri = filesystem::read_file_as_data_uri(path);
414 
415  if(!uri.empty()) {
416  find_widget<text_box>(get_window(), "icon", false).set_value(uri);
417  find_widget<drawing>(get_window(), "preview", false).set_label(uri);
418  }
419  }
420  }
421 }
422 
423 } // namespace gui2::dialogs
Class for writing a config out to a file in pieces.
void write(const config &cfg)
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:161
config & mandatory_child(config_key_type key, int n=0)
Returns the nth child with the given key, or throws an error if there is none.
Definition: config.cpp:371
bool has_child(config_key_type key) const
Determine whether a config has a child or not.
Definition: config.cpp:321
child_itors child_range(config_key_type key)
Definition: config.cpp:277
const attribute_value * get(config_key_type key) const
Returns a pointer to the attribute with the given key or nullptr if it does not exist.
Definition: config.cpp:691
config & add_child(config_key_type key)
Definition: config.cpp:445
Simple push button.
Definition: button.hpp:37
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: button.cpp:65
editor_edit_pbl(const std::string &pbl, const std::string &current_addon)
Definition: edit_pbl.cpp:72
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
Definition: edit_pbl.cpp:221
virtual void pre_show(window &window) override
The execute function.
Definition: edit_pbl.cpp:99
std::vector< std::string > dirs_
Definition: edit_pbl.hpp:70
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
std::string path() const
Gets the current file selection.
Abstract base class for all modal dialogs.
bool show(const unsigned auto_close_time=0)
Shows the window.
int get_retval() const
Returns the cached window exit code.
window * get_window()
Returns a pointer to the dialog's window.
A drawing is widget with a fixed size and gives access to the canvas of the widget in the window inst...
Definition: drawing.hpp:53
Base container class.
Definition: grid.hpp:32
void set_active(const bool active)
Activates all children.
Definition: grid.cpp:167
widget * find(const std::string &id, const bool must_be_active) override
See widget::find.
Definition: grid.cpp:645
A label displays text that can be wrapped but no scrollbars are provided.
Definition: label.hpp:57
void set_link_aware(bool l)
Definition: label.cpp:92
The listbox class.
Definition: listbox.hpp:46
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:62
const grid * get_row_grid(const unsigned row) const
Returns the grid of the wanted row.
Definition: listbox.cpp:233
void remove_row(const unsigned row, unsigned count=1)
Removes a row in the listbox.
Definition: listbox.cpp:82
int get_selected_row() const
Returns the first selected row.
Definition: listbox.cpp:271
unsigned get_item_count() const
Returns the number of items in the listbox.
Definition: listbox.cpp:127
A menu_button is a styled_widget to choose an element from a list of elements.
Definition: menu_button.hpp:62
void set_selected(unsigned selected, bool fire_event=true)
void set_values(const std::vector<::config > &values, unsigned selected=0)
A multimenu_button is a styled_widget to choose an element from a list of elements.
void set_values(const std::vector<::config > &values)
Set the available menu options.
void select_option(const unsigned option, const bool selected=true)
Select an option in the menu.
boost::dynamic_bitset get_toggle_states() const
Get the current state of the menu options.
const t_string & get_label() const
virtual void set_label(const t_string &label)
virtual void set_use_markup(bool use_markup)
virtual void set_value(const std::string &text)
The set_value is virtual for the password_box class.
Class for a single line text area.
Definition: text_box.hpp:142
Class for a toggle button.
@ visible
The user sets the widget visible, that means:
@ invisible
The user set the widget invisible, that means:
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:67
void keyboard_capture(widget *widget)
Definition: window.cpp:1224
Realization of serialization/validator.hpp abstract validator.
Main (common) editor header.
#define ERR_ED
Declarations for File-IO.
std::size_t i
Definition: function.cpp:968
static std::string _(const char *str)
Definition: gettext.hpp:93
std::map< std::string, addon_info > addons_list
Definition: info.hpp:28
#define REGISTER_DIALOG(window_id)
Wrapper for REGISTER_DIALOG2.
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:407
static bool file_exists(const bfs::path &fpath)
Definition: filesystem.cpp:321
std::string get_wml_location(const std::string &filename, const std::string &current_dir)
Returns a complete path to the actual WML file or directory or an empty string if the file isn't pres...
std::string read_file_as_data_uri(const std::string &fname)
void write_file(const std::string &fname, const std::string &data, std::ios_base::openmode mode)
Throws io_exception if an error occurs.
std::string get_addons_dir()
std::string get_core_images_dir()
std::string selected
std::string path
Definition: filesystem.cpp:86
void remove()
Removes a tip.
Definition: tooltip.cpp:111
const std::array type_values
Definition: edit_pbl.cpp:47
const std::array tag_values
Definition: edit_pbl.cpp:63
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:205
void connect_signal_mouse_left_click(dispatcher &dispatcher, const signal &signal)
Connects a signal handler for a left mouse button click.
Definition: dispatcher.cpp:179
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:35
std::map< std::string, t_string > widget_item
Definition: widget.hpp:32
void show_error_message(const std::string &msg, bool message_use_markup)
Shows an error message to the user.
Definition: message.cpp:204
void show_message(const std::string &title, const std::string &msg, const std::string &button_caption, const bool auto_close, const bool message_use_markup, const bool title_use_markup)
Shows a message to the user.
Definition: message.cpp:151
@ OK
Dialog was closed with the OK button.
Definition: retval.hpp:35
std::string language()
Definition: general.cpp:535
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)
filesystem::scoped_istream preprocess_file(const std::string &fname, preproc_map *defines)
Function to use the WML preprocessor on a file.
One of the realizations of serialization/validator.hpp abstract validator.
void read(config &cfg, std::istream &in, abstract_validator *validator)
Definition: parser.cpp:627
#define e