manager.cpp

/*
   Copyright (C) 2008 - 2016 by Mark de Wever <koraq@xs4all.nl>
   Part of the Battle for Wesnoth Project http://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/addon/manager.hpp"

#include "addon/info.hpp"
#include "addon/manager.hpp"
#include "addon/state.hpp"

#include "desktop/clipboard.hpp"
#include "desktop/open.hpp"

#include "config_assign.hpp"
#include "help/help.hpp"
#include "gettext.hpp"
#include "gui/auxiliary/filter.hpp"
#include "gui/auxiliary/find_widget.hpp"
#include "gui/dialogs/addon/filter_options.hpp"
#include "gui/dialogs/helper.hpp"
#include "gui/dialogs/message.hpp"
#include "gui/dialogs/transient_message.hpp"
#include "gui/widgets/addon_list.hpp"
#include "gui/widgets/button.hpp"
#include "gui/widgets/label.hpp"
#include "gui/widgets/menu_button.hpp"
#include "gui/widgets/stacked_widget.hpp"
#include "gui/widgets/drawing.hpp"
#include "gui/widgets/image.hpp"
#ifdef GUI2_EXPERIMENTAL_LISTBOX
#include "gui/widgets/list.hpp"
#else
#include "gui/widgets/listbox.hpp"
#endif
#include "gui/widgets/pane.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/toggle_button.hpp"
#include "gui/widgets/text_box.hpp"
#include "gui/widgets/window.hpp"
#include "serialization/string_utils.hpp"
#include "formula/string_utils.hpp"
#include "image.hpp"
#include "language.hpp"
#include "preferences.hpp"
#include "utils/general.hpp"

#include "config.hpp"

#include "utils/functional.hpp"

#include <iomanip>
#include <sstream>
#include <stdexcept>
#include "utils/io.hpp"

namespace gui2
{
namespace dialogs
{

/*WIKI
 * @page = GUIWindowDefinitionWML
 * @order = 2_addon_list
 *
 * == Addon list ==
 *
 * This shows the dialog with the addons to install. This dialog is under
 * construction and only used with --new-widgets.
 *
 * @begin{table}{dialog_widgets}
 *
 * addons & & listbox & m &
 *        A listbox that will contain the info about all addons on the server. $
 *
 * -name & & styled_widget & o &
 *        The name of the addon. $
 *
 * -version & & styled_widget & o &
 *        The version number of the addon. $
 *
 * -author & & styled_widget & o &
 *        The author of the addon. $
 *
 * -downloads & & styled_widget & o &
 *        The number of times the addon has been downloaded. $
 *
 * -size & & styled_widget & o &
 *        The size of the addon. $
 *
 * @end{table}
 */

namespace {
	struct filter_transform
	{
		filter_transform(const std::vector<std::string>& filtertext) : filtertext_(filtertext) {}
		bool operator()(const config& cfg) const
		{
			for(const auto& filter : filtertext_)
			{
				bool found = false;
				for(const auto& attribute : cfg.attribute_range())
				{
					std::string val = attribute.second.str();
					if(std::search(val.begin(),
						val.end(),
						filter.begin(),
						filter.end(),
						chars_equal_insensitive)
						!= val.end())
					{
						found = true;
						break;
					}
				}
				if(!found) {
					return false;
				}
			}
			return true;
		}
		const std::vector<std::string> filtertext_;
	};

	/**
	 * Retrieves an element from the given associative container or dies in some
	 * way.
	 *
	 * It fails an @a assert() check or throws an exception if the requested element
	 * does not exist.
	 *
	 * @return An element from the container that is guranteed to have existed
	 *         before running this function.
	 */
	template <typename MapT>
	typename MapT::mapped_type const& const_at(typename MapT::key_type const& key,
										   MapT const& map)
	{
		typename MapT::const_iterator it = map.find(key);
		if(it == map.end()) {
			assert(it != map.end());
			throw std::out_of_range(
					"const_at()"); // Shouldn't get here without disabling assert()
		}
		return it->second;
	}

	std::string make_display_dependencies(const std::string& addon_id,
									  const addons_list& addons_list,
									  const addons_tracking_list& addon_states)
	{
		const addon_info& addon = const_at(addon_id, addons_list);
		std::string str;

		const std::set<std::string>& deps = addon.resolve_dependencies(addons_list);

		for(const auto& dep_id : deps) {
			addon_info dep;
			addon_tracking_info depstate;

			addons_list::const_iterator ali = addons_list.find(dep_id);
			addons_tracking_list::const_iterator tli = addon_states.find(dep_id);

			if(ali == addons_list.end()) {
				dep.id = dep_id; // Build dummy addon_info.
			} else {
				dep = ali->second;
			}

			if(tli == addon_states.end()) {
				depstate = get_addon_tracking_info(dep);
			} else {
				depstate = tli->second;
			}

			if(!str.empty()) {
				str += ", ";
			}

			str += addon_list::colorify_addon_state_string(dep.display_title(), depstate.state);
		}

		return str;
	}

	std::string langcode_to_string(const std::string& lcode)
	{
		for(const auto & ld : get_languages())
		{
			if(ld.localename == lcode || ld.localename.substr(0, 2) == lcode) {
				return ld.language;
			}
		}

		return "";
	}
}

REGISTER_DIALOG(addon_manager)

addon_manager::addon_manager(addons_client& client)
	: orders_()
	, cfg_()
	, cfg_iterators_(cfg_.child_range("campaign"))
	, client_(client)
	, addons_()
	, tracking_info_()
{
	status_filter_types_ = {
		{FILTER_ALL,           _("addons_view^All Add-ons")},
		{FILTER_INSTALLED,     _("addons_view^Installed")},
		{FILTER_UPGRADABLE,    _("addons_view^Upgradable")},
		{FILTER_NOT_INSTALLED, _("addons_view^Not Installed")},
	};
}

void addon_manager::on_filtertext_changed(text_box_base* textbox, const std::string& text)
{
	addon_list& addons = find_widget<addon_list>(textbox->get_window(), "addons", true);
	filter_transform filter(utils::split(text, ' '));
	boost::dynamic_bitset<> res;

	const config::const_child_itors& addon_cfgs = cfg_.child_range("campaign");

	for(const auto& a : addons_)
	{
		const config& addon_cfg = *std::find_if(addon_cfgs.begin(), addon_cfgs.end(),
			[&a](const config& cfg)
		{
			return cfg["name"] == a.first;
		});

		res.push_back(filter(addon_cfg));
	}

	addons.set_addon_shown(res);
}

static std::string describe_status_verbose(const addon_tracking_info& state)
{
	std::string s;

	utils::string_map i18n_symbols {{"local_version", state.installed_version.str()}};

	switch(state.state) {
		case ADDON_NONE:
			s = !state.can_publish
				? _("addon_state^Not installed")
				: _("addon_state^Published, not installed");
			break;
		case ADDON_INSTALLED:
			s = !state.can_publish
				? _("addon_state^Installed")
				: _("addon_state^Published");
			break;
		case ADDON_NOT_TRACKED:
			s = !state.can_publish
				? _("addon_state^Installed, not tracking local version")
				// Published add-ons often don't have local status information,
				// hence untracked. This should be considered normal.
				: _("addon_state^Published, not tracking local version");
			break;
		case ADDON_INSTALLED_UPGRADABLE: {
			const std::string vstr = !state.can_publish
				? _("addon_state^Installed ($local_version|), upgradable")
				: _("addon_state^Published ($local_version| installed), upgradable");

			s = utils::interpolate_variables_into_string(vstr, &i18n_symbols);
		} break;
		case ADDON_INSTALLED_OUTDATED: {
			const std::string vstr = !state.can_publish
				? _("addon_state^Installed ($local_version|), outdated on server")
				: _("addon_state^Published ($local_version| installed), outdated on server");

			s = utils::interpolate_variables_into_string(vstr, &i18n_symbols);
		} break;
		case ADDON_INSTALLED_BROKEN:
			s = !state.can_publish
				? _("addon_state^Installed, broken")
				: _("addon_state^Published, broken");
			break;
		default:
			s = _("addon_state^Unknown");
	}

	return addon_list::colorify_addon_state_string(s, state.state);
}

void addon_manager::pre_show(window& window)
{
	addon_list& list = find_widget<addon_list>(&window, "addons", false);

	text_box& filter = find_widget<text_box>(&window, "filter", false);
	filter.set_text_changed_callback(std::bind(&addon_manager::on_filtertext_changed, this, _1, _2));

#ifdef GUI2_EXPERIMENTAL_LISTBOX
	connect_signal_notify_modified(list,
		std::bind(&addon_manager::on_addon_select, *this, std::ref(window)));
#else
	list.set_install_function(std::bind(&addon_manager::install_addon,
		this, std::placeholders::_1, std::ref(window)));
	list.set_uninstall_function(std::bind(&addon_manager::uninstall_addon,
		this, std::placeholders::_1, std::ref(window)));

	list.set_publish_function(std::bind(&addon_manager::do_remote_addon_publish,
		this, std::placeholders::_1, std::ref(window)));
	list.set_delete_function(std::bind(&addon_manager::do_remote_addon_delete,
		this, std::placeholders::_1, std::ref(window)));

	list.set_callback_value_change(
		dialog_callback<addon_manager, &addon_manager::on_addon_select>);
#endif

	load_addon_list(window);

	menu_button& status_filter = find_widget<menu_button>(&window, "install_status_filter", false);

	std::vector<config> status_filter_entries;
	for(const auto& f : status_filter_types_) {
		status_filter_entries.push_back(config_of("label", f.second));
	}

	// TODO: initial selection based on preferences
	status_filter.set_values(status_filter_entries);
	status_filter.connect_click_handler(std::bind(&addon_manager::status_filter_callback, this, std::ref(window)));

	button& url_go_button = find_widget<button>(&window, "url_go", false);
	button& url_copy_button = find_widget<button>(&window, "url_copy", false);
	text_box& url_textbox = find_widget<text_box>(&window, "url", false);

	url_textbox.set_active(false);

	if (!desktop::clipboard::available()) {
		url_copy_button.set_active(false);
		url_copy_button.set_tooltip(_("Clipboard support not found, contact your packager"));
	}

	if(!desktop::open_object_is_supported()) {
		// No point in displaying the button on platforms that can't do
		// open_object().
		url_go_button.set_visible(styled_widget::visibility::invisible);
	}

	connect_signal_mouse_left_click(
		find_widget<button>(&window, "install", false),
		std::bind(&addon_manager::install_selected_addon, this, std::ref(window)));

	connect_signal_mouse_left_click(
		find_widget<button>(&window, "uninstall", false),
		std::bind(&addon_manager::uninstall_selected_addon, this, std::ref(window)));

	connect_signal_mouse_left_click(
		url_go_button,
		std::bind(&addon_manager::browse_url_callback, this, std::ref(url_textbox)));

	connect_signal_mouse_left_click(
		url_copy_button,
		std::bind(&addon_manager::copy_url_callback, this, std::ref(url_textbox)));

	connect_signal_mouse_left_click(
		find_widget<button>(&window, "options", false),
		std::bind(&addon_manager::options_button_callback, this, std::ref(window)));

	connect_signal_mouse_left_click(
		find_widget<button>(&window, "show_help", false),
		std::bind(&addon_manager::show_help, this, std::ref(window)));

	on_addon_select(window);

	window.keyboard_capture(&filter);

	// TODO: figure out forwarding keyboard events to the widget from the window?
	//       Or perhaps handle them in the widget?
	//window.add_to_keyboard_chain(&list);
}

void addon_manager::load_addon_list(window& window)
{
	refresh_addon_version_info_cache();

	client_.request_addons_list(cfg_);
	if(!cfg_) {
		show_error_message(window.video(),
			_("An error occurred while downloading the "
			"add-ons list from the server."));
		window.close();
	}

	read_addons_list(cfg_, addons_);

	addon_list& list = find_widget<addon_list>(&window, "addons", false);
	list.set_addons(addons_);

	for(const auto& a : addons_) {
		tracking_info_[a.first] = get_addon_tracking_info(a.second);
	}
}

void addon_manager::options_button_callback(window& window)
{
	gui2::dialogs::addon_filter_options dlg;

	// TODO
	//dlg.set_displayed_status(f_.status);
	//dlg.set_displayed_types(f_.types);
	//dlg.set_sort(f_.sort);
	//dlg.set_direction(f_.direction);

	dlg.show(window.video());
}

void addon_manager::status_filter_callback(window& window)
{
	menu_button& status_filter = find_widget<menu_button>(&window, "install_status_filter", false);
	const ADDON_STATUS_FILTER selection = status_filter_types_[status_filter.get_value()].first;

	boost::dynamic_bitset<> res;
	for(const auto& a : addons_) {
		const ADDON_STATUS state = tracking_info_[a.second.id].state;

		res.push_back(
			(selection == FILTER_ALL) ||
			(selection == FILTER_INSTALLED     && is_installed_addon_status(state)) ||
			(selection == FILTER_UPGRADABLE    && state == ADDON_INSTALLED_UPGRADABLE) ||
			(selection == FILTER_NOT_INSTALLED && state == ADDON_NONE)
		);
	}

	find_widget<addon_list>(&window, "addons", false).set_addon_shown(res);
}

void addon_manager::install_selected_addon(window& window)
{
	addon_list& addons = find_widget<addon_list>(&window, "addons", false);
	const addon_info* addon = addons.get_selected_addon();

	if(addon == nullptr) {
		return;
	}

	install_addon(*addon, window);
}

void addon_manager::install_addon(addon_info addon, window& window)
{
	addon_list& addons = find_widget<addon_list>(&window, "addons", false);

	addons_client::install_result result =
		client_.install_addon_with_checks(addons_, addon);

	if(result.outcome != addons_client::install_outcome::abort) {
		load_addon_list(window);

		// Reselect the add-on.
		addons.select_addon(addon.id);
		on_addon_select(window);
	}
}

void addon_manager::uninstall_selected_addon(window& window)
{
	addon_list& addons = find_widget<addon_list>(&window, "addons", false);
	const addon_info* addon = addons.get_selected_addon();

	if(addon == nullptr) {
		return;
	}

	uninstall_addon(*addon, window);
}

void addon_manager::uninstall_addon(addon_info addon, window& window)
{
	addon_list& addons = find_widget<addon_list>(&window, "addons", false);

	if(have_addon_pbl_info(addon.id) || have_addon_in_vcs_tree(addon.id)) {
		show_error_message(window.video(),
			_("The following add-on appears to have publishing or version control information stored locally, and will not be removed:") + " " +
				addon.display_title());
		return;
	}

	bool success = remove_local_addon(addon.id);

	if(!success) {
		show_error_message(window.video(), _("The following add-on could not be deleted properly:") + " " + addon.display_title());
	} else {
		load_addon_list(window);

		// Reselect the add-on.
		addons.select_addon(addon.id);
		on_addon_select(window);
	}
}

/** Performs all backend and UI actions for publishing the specified add-on. */
void addon_manager::do_remote_addon_publish(const std::string& addon_id, window& window)
{
	std::string server_msg;

	config cfg;
	get_addon_pbl_info(addon_id, cfg);

	const version_info& version_to_publish = cfg["version"].str();

	if(version_to_publish <= tracking_info_[addon_id].remote_version) {
		const int res = gui2::show_message(window.video(), _("Warning"),
			_("The remote version of this add-on is greater or equal to the version being uploaded. Do you really wish to continue?"),
			gui2::dialogs::message::yes_no_buttons);

		if(res != gui2::window::OK) {
			return;
		}
	}

	if(!::image::exists(cfg["icon"].str())) {
		gui2::show_error_message(window.video(), _("Invalid icon path. Make sure the path points to a valid image."));
	} else if(!client_.request_distribution_terms(server_msg)) {
		gui2::show_error_message(window.video(),
			_("The server responded with an error:") + "\n" +
			client_.get_last_server_error());
	} else if(gui2::show_message(window.video(), _("Terms"), server_msg, gui2::dialogs::message::ok_cancel_buttons) == gui2::window::OK) {
		if(!client_.upload_addon(addon_id, server_msg, cfg)) {
			gui2::show_error_message(window.video(),
				_("The server responded with an error:") + "\n" +
				client_.get_last_server_error());
		} else {
			gui2::show_transient_message(window.video(), _("Response"), server_msg);
		}
	}
}

/** Performs all backend and UI actions for taking down the specified add-on. */
void addon_manager::do_remote_addon_delete(const std::string& addon_id, window& window)
{
	utils::string_map symbols;
	symbols["addon"] = make_addon_title(addon_id); // FIXME: need the real title!
	const std::string& text = vgettext("Deleting '$addon|' will permanently erase its download and upload counts on the add-ons server. Do you really wish to continue?", symbols);

	const int res = gui2::show_message(
		window.video(), _("Confirm"), text, gui2::dialogs::message::yes_no_buttons);

	if(res != gui2::window::OK) {
		return;
	}

	std::string server_msg;
	if(!client_.delete_remote_addon(addon_id, server_msg)) {
		gui2::show_error_message(	window.video(),
			_("The server responded with an error:") + "\n" +
			client_.get_last_server_error());
	} else {
		// FIXME: translation needed!
		gui2::show_transient_message(window.video(), _("Response"), server_msg);
	}
}

void addon_manager::show_help(window& window)
{
	help::show_help(window.video(), "installing_addons");
}

void addon_manager::browse_url_callback(text_box& url_box)
{
	/* TODO: ask for confirmation */

	desktop::open_object(url_box.get_value());
}

void addon_manager::copy_url_callback(text_box& url_box)
{
	desktop::clipboard::copy_to_clipboard(url_box.get_value(), false);
}

static std::string format_addon_time(time_t time)
{
	if(time) {
		std::ostringstream ss;

		const char* format = preferences::use_twelve_hour_clock_format()
			? "%Y-%m-%d %I:%M %p"
			: "%Y-%m-%d %H:%M";

		ss << util::put_time(std::localtime(&time), format);

		return ss.str();
	}

	return font::unicode_em_dash;
}

void addon_manager::on_addon_select(window& window)
{
	const addon_info* info = find_widget<addon_list>(&window, "addons", false).get_selected_addon();

	if(info == nullptr) {
		return;
	}

	find_widget<drawing>(&window, "image", false).set_label(info->display_icon());

	find_widget<styled_widget>(&window, "title", false).set_label(info->display_title());
	find_widget<styled_widget>(&window, "description", false).set_label(info->description);
	find_widget<styled_widget>(&window, "version", false).set_label(info->version.str());
	find_widget<styled_widget>(&window, "author", false).set_label(info->author);
	find_widget<styled_widget>(&window, "type", false).set_label(info->display_type());

	styled_widget& status = find_widget<styled_widget>(&window, "status", false);
	status.set_label(describe_status_verbose(tracking_info_[info->id]));
	status.set_use_markup(true);

	find_widget<styled_widget>(&window, "size", false).set_label(size_display_string(info->size));
	find_widget<styled_widget>(&window, "downloads", false).set_label(std::to_string(info->downloads));
	find_widget<styled_widget>(&window, "created", false).set_label(format_addon_time(info->created));
	find_widget<styled_widget>(&window, "updated", false).set_label(format_addon_time(info->updated));

	find_widget<styled_widget>(&window, "dependencies", false).set_label(!info->depends.empty()
		? make_display_dependencies(info->id, addons_, tracking_info_)
		: _("None"));

	std::string languages;

	for(const auto& lc : info->locales) {
		const std::string& langlabel = langcode_to_string(lc);
		if(!langlabel.empty()) {
			if(!languages.empty()) {
				languages += ", ";
			}
			languages += langlabel;
		}
	}

	find_widget<styled_widget>(&window, "translations", false).set_label(!languages.empty() ? languages : _("None"));

	const std::string& feedback_url = info->feedback_url;

	if(!feedback_url.empty()) {
		find_widget<stacked_widget>(&window, "feedback_stack", false).select_layer(1);
		find_widget<text_box>(&window, "url", false).set_value(feedback_url);
	} else {
		find_widget<stacked_widget>(&window, "feedback_stack", false).select_layer(0);
	}

	bool installed = is_installed_addon_status(tracking_info_[info->id].state);

	find_widget<button>(&window, "install", false).set_active(!installed);
	find_widget<button>(&window, "uninstall", false).set_active(installed);
}

} // namespace dialogs
} // namespace gui2