game_cache_options.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2014 - 2022
    by Iris Morelle <shadowm2006@gmail.com>
    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/game_cache_options.hpp"

#include "desktop/clipboard.hpp"
#include "config_cache.hpp"
#include "cursor.hpp"
#include "desktop/open.hpp"
#include "filesystem.hpp"
#include "gui/auxiliary/find_widget.hpp"
#include "gui/dialogs/message.hpp"
#include "gui/widgets/button.hpp"
#include "gui/widgets/label.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/text_box.hpp"
#include "gui/widgets/window.hpp"

#include <functional>

#include "gettext.hpp"

namespace gui2::dialogs
{

REGISTER_DIALOG(game_cache_options)

game_cache_options::game_cache_options()
    : modal_dialog(window_id())
    , cache_path_(filesystem::get_cache_dir())
    , clean_button_(nullptr)
    , purge_button_(nullptr)
    , size_label_(nullptr)
{
}

void game_cache_options::pre_show(window& window)
{
    clean_button_ = find_widget<button>(&window, "clean", false, true);
    purge_button_ = find_widget<button>(&window, "purge", false, true);
    size_label_ = find_widget<label>(&window, "size", false, true);

    update_cache_size_display();

    text_box_base& path_box = find_widget<text_box_base>(&window, "path", false);
    path_box.set_value(cache_path_);
    path_box.set_active(false);

    button& copy = find_widget<button>(&window, "copy", false);
    connect_signal_mouse_left_click(copy,
                                    std::bind(&game_cache_options::copy_to_clipboard_callback,
                                                this));
    if (!desktop::clipboard::available()) {
        copy.set_active(false);
        copy.set_tooltip(_("Clipboard support not found, contact your packager"));
    }

    button& browse = find_widget<button>(&window, "browse", false);
    connect_signal_mouse_left_click(browse,
                                    std::bind(&game_cache_options::browse_cache_callback,
                                                this));

    connect_signal_mouse_left_click(*clean_button_,
                                    std::bind(&game_cache_options::clean_cache_callback,
                                                this));

    connect_signal_mouse_left_click(*purge_button_,
                                    std::bind(&game_cache_options::purge_cache_callback,
                                                this));
}

void game_cache_options::post_show(window& /*window*/)
{
    size_label_ = nullptr;
}

void game_cache_options::update_cache_size_display()
{
    if(!size_label_) {
        return;
    }

    const cursor::setter cs(cursor::WAIT);
    const int size = filesystem::dir_size(cache_path_);

    if(size < 0) {
        size_label_->set_label(_("dir_size^Unknown"));
    } else {
        size_label_->set_label(utils::si_string(size, true, _("unit_byte^B")));
    }

    if(size == 0) {
        clean_button_->set_active(false);
        purge_button_->set_active(false);
    }
}

void game_cache_options::copy_to_clipboard_callback()
{
    desktop::clipboard::copy_to_clipboard(cache_path_, false);
}

void game_cache_options::browse_cache_callback()
{
    desktop::open_object(cache_path_);
}

void game_cache_options::clean_cache_callback()
{
    if(clean_cache()) {
        show_message(
                     _("Cache Cleaned"),
                     _("The game data cache has been cleaned."));
    } else {
        show_error_message(_("The game data cache could not be completely cleaned."));
    }

    update_cache_size_display();
}

bool game_cache_options::clean_cache()
{
    const cursor::setter cs(cursor::WAIT);
    return game_config::config_cache::instance().clean_cache();
}

void game_cache_options::purge_cache_callback()
{
    if(purge_cache()) {
        show_message(
                     _("Cache Purged"),
                     _("The game data cache has been purged."));
    } else {
        show_error_message(_("The game data cache could not be purged."));
    }

    update_cache_size_display();
}

bool game_cache_options::purge_cache()
{
    const cursor::setter cs(cursor::WAIT);
    return game_config::config_cache::instance().purge_cache();
}

} // namespace dialogs