config_cache.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 2025
    by Pauli Nieminen <paniemin@cc.hut.fi>
    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 "config_cache.hpp"
#include "filesystem.hpp"
#include "gettext.hpp"
#include "log.hpp"
#include "hash.hpp"
#include "serialization/binary_or_text.hpp"
#include "serialization/parser.hpp"
#include "serialization/string_utils.hpp"
#include "game_version.hpp"
 
#include <boost/algorithm/string/replace.hpp>
#include <boost/iostreams/filter/gzip.hpp>
 
static lg::log_domain log_cache("cache");
#define ERR_CACHE LOG_STREAM(err, log_cache)
#define LOG_CACHE LOG_STREAM(info, log_cache)
#define DBG_CACHE LOG_STREAM(debug, log_cache)
 
namespace game_config
{
 
namespace
{
 
void add_builtin_defines(preproc_map& target)
{
#ifdef __APPLE__
    target.try_emplace("APPLE");
#endif
 
#ifdef __ANDROID__
    target.try_emplace("ANDROID");
#endif
 
#if defined(MOUSE_TOUCH_EMULATION) || defined(TARGET_OS_IPHONE)
    target.try_emplace("IPHONEOS");
#endif
 
    target.try_emplace("WESNOTH_VERSION", game_config::wesnoth_version.str());
 
    target.try_emplace("WESNOTH_VERSION_MAJOR", std::to_string(game_config::wesnoth_version.major_version()));
    target.try_emplace("WESNOTH_VERSION_MINOR", std::to_string(game_config::wesnoth_version.minor_version()));
    target.try_emplace("WESNOTH_VERSION_REVISION", std::to_string(game_config::wesnoth_version.revision_level()));
    target.try_emplace("WESNOTH_VERSION_SPECIAL", game_config::wesnoth_version.special_version());
}
 
}
 
config_cache& config_cache::instance()
{
    static config_cache cache;
    return cache;
}
 
config_cache::config_cache()
    : force_valid_cache_(false)
    , use_cache_(true)
    , fake_invalid_cache_(false)
    , defines_map_()
    , cache_file_prefix_("cache-v" + boost::algorithm::replace_all_copy(game_config::revision, ":", "_") + "-")
{
    // To set-up initial defines map correctly
    clear_defines();
}
 
const preproc_map& config_cache::get_preproc_map() const
{
    return defines_map_;
}
 
void config_cache::clear_defines()
{
    LOG_CACHE << "Clearing defines map!";
    defines_map_.clear();
 
    //
    // Set-up default defines map.
    //
 
    add_builtin_defines(defines_map_);
}
 
config config_cache::get_config(const std::string& file_path, abstract_validator* validator)
{
    return load_configs(file_path, validator);
}
 
void config_cache::write_file(const std::string& file_path, const config& cfg)
{
    filesystem::scoped_ostream stream = filesystem::ostream_file(file_path);
    config_writer writer(*stream, true, game_config::cache_compression_level);
    writer.write(cfg);
}
 
void config_cache::write_file(const std::string& file_path, const preproc_map& defines)
{
    if(defines.empty()) {
        if(filesystem::file_exists(file_path)) {
            filesystem::delete_directory(file_path);
        }
        return;
    }
 
    filesystem::scoped_ostream stream = filesystem::ostream_file(file_path);
    config_writer writer(*stream, true, game_config::cache_compression_level);
 
    // Write all defines to stream.
    for(const preproc_map::value_type& define : defines) {
        define.second.write(writer, define.first);
    }
}
 
config config_cache::read_file(const std::string& file_path)
{
    return io::read_gz(*filesystem::istream_file(file_path));
}
 
preproc_map& config_cache::make_copy_map()
{
    preproc_map& res = config_cache_transaction::instance().get_active_map(defines_map_);
    // HACK: copy_map doesn't have built-in defines in some cases (issue #1924)
    //       or they may be out of date, so brute-force them in.
    add_builtin_defines(res);
    return res;
}
 
void config_cache::add_defines_map_diff(preproc_map& defines_map)
{
    config_cache_transaction::instance().add_defines_map_diff(defines_map);
}
 
std::pair<config, preproc_map> config_cache::read_configs(const std::string& file_path, abstract_validator* validator)
{
    preproc_map copy_map = make_copy_map();
    config cfg = read_configs(file_path, copy_map, validator);
    return { std::move(cfg), std::move(copy_map) };
}
 
config config_cache::read_configs(const std::string& file_path, preproc_map& defines_map, abstract_validator* validator)
{
    return io::read(*preprocess_file(file_path, defines_map), validator);
}
 
config config_cache::read_cache(const std::string& file_path, abstract_validator* validator)
{
    static const std::string extension = ".gz";
 
    std::stringstream defines_string;
    defines_string << file_path;
 
    bool is_valid = true;
 
    //
    // Only WESNOTH_VERSION and its variants are allowed to be non-empty.
    //
    static const std::set<std::string> allowed_non_empty_define_keys = {
        "WESNOTH_VERSION",
        "WESNOTH_VERSION_MAJOR",
        "WESNOTH_VERSION_MINOR",
        "WESNOTH_VERSION_REVISION",
        "WESNOTH_VERSION_SPECIAL"
    };
 
    for(const auto& [key, define] : defines_map_) {
        if((!define.value.empty() || !define.arguments.empty()) && allowed_non_empty_define_keys.find(key) == allowed_non_empty_define_keys.end()) {
            is_valid = false;
            ERR_CACHE << "Invalid preprocessor define: " << key;
            break;
        }
 
        defines_string << " " << key;
    }
 
    // Do cache check only if define map is valid and
    // caching is allowed.
    const std::string& cache_path = filesystem::get_cache_dir();
 
    if(is_valid && !cache_path.empty()) {
        // Use a hash for a shorter display of the defines.
        const std::string fname = cache_path + "/" +
                                  cache_file_prefix_ +
                                  utils::md5(defines_string.str()).hex_digest();
        const std::string fname_checksum = fname + ".checksum" + extension;
 
        filesystem::file_tree_checksum dir_checksum;
 
        if(!force_valid_cache_ && !fake_invalid_cache_) {
            try {
                if(filesystem::file_exists(fname_checksum)) {
                    DBG_CACHE << "Reading checksum: " << fname_checksum;
                    dir_checksum = filesystem::file_tree_checksum{read_file(fname_checksum)};
                }
            } catch(const config::error&) {
                ERR_CACHE << "cache checksum is corrupt";
            } catch(const filesystem::io_exception&) {
                ERR_CACHE << "error reading cache checksum";
            } catch(const std::ios_base::failure&) {
                ERR_CACHE << "error reading cache checksum";
            }
        }
 
        if(force_valid_cache_) {
            LOG_CACHE << "skipping cache validation (forced)";
        }
 
        if(filesystem::file_exists(fname + extension) && (force_valid_cache_ || (dir_checksum == filesystem::data_tree_checksum()))) {
            LOG_CACHE << "found valid cache at '" << fname << extension << "' with defines_map " << defines_string.str();
            log_scope("read cache");
 
            try {
                config cfg = read_file(fname + extension);
                const std::string define_file = fname + ".define" + extension;
 
                if(filesystem::file_exists(define_file)) {
                    config_cache_transaction::instance().add_define_file(define_file);
                }
 
                return cfg;
            } catch(const config::error& e) {
                ERR_CACHE << "cache " << fname << extension << " is corrupt. Loading from files: "<< e.message;
            } catch(const filesystem::io_exception&) {
                ERR_CACHE << "error reading cache " << fname << extension << ". Loading from files";
            } catch (const boost::iostreams::gzip_error& e) {
                //read_file -> ... -> read_gz can throw this exception.
                ERR_CACHE << "cache " << fname << extension << " is corrupt. Error code: " << e.error();
            }
        }
 
        LOG_CACHE << "no valid cache found. Writing cache to '" << fname << extension << " with defines_map "<< defines_string.str() << "'";
 
        // Now we need queued defines so read them to memory
        read_defines_queue();
 
        auto [cfg, defines] = read_configs(file_path, validator);
        add_defines_map_diff(defines);
 
        try {
            write_file(fname + extension, cfg);
            write_file(fname + ".define" + extension, defines);
 
            config checksum_cfg;
 
            filesystem::data_tree_checksum().write(checksum_cfg);
            write_file(fname_checksum, checksum_cfg);
        } catch(const filesystem::io_exception&) {
            ERR_CACHE << "could not write to cache '" << fname << "'";
        }
 
        return cfg;
    }
 
    LOG_CACHE << "Loading plain config instead of cache";
 
    auto [cfg, defines] = read_configs(file_path, validator);
    add_defines_map_diff(defines);
    return cfg;
}
 
void config_cache::read_defines_file(const std::string& file_path)
{
    DBG_CACHE << "Reading cached defines from: " << file_path;
    config file_cfg = read_file(file_path);
 
    for(const auto [key, cfg] : file_cfg.all_children_view()) {
        preproc_define::insert(config_cache_transaction::instance().get_active_map(defines_map_), cfg);
    }
}
 
void config_cache::read_defines_queue()
{
    for(const std::string& p : config_cache_transaction::instance().get_define_files()) {
        read_defines_file(p);
    }
}
 
config config_cache::load_configs(const std::string& config_path, abstract_validator* validator)
{
    // Make sure that we have fake transaction if no real one is going on
    fake_transaction fake;
 
    if(use_cache_) {
        return read_cache(config_path, validator);
    } else {
        auto [cfg, defines] = read_configs(config_path, validator);
        add_defines_map_diff(defines);
        return cfg;
    }
}
 
void config_cache::set_force_invalid_cache(bool force)
{
    fake_invalid_cache_ = force;
}
 
void config_cache::set_use_cache(bool use)
{
    use_cache_ = use;
}
 
void config_cache::set_force_valid_cache(bool force)
{
    force_valid_cache_ = force;
}
 
void config_cache::recheck_filetree_checksum()
{
    filesystem::data_tree_checksum(true);
}
 
void config_cache::add_define(const std::string& define)
{
    DBG_CACHE << "adding define: " << define;
    defines_map_.try_emplace(define);
 
    if(config_cache_transaction::is_active()) {
        // we have to add this to active map too
        config_cache_transaction::instance().get_active_map(defines_map_).try_emplace(define);
    }
}
 
void config_cache::remove_define(const std::string& define)
{
    DBG_CACHE << "removing define: " << define;
    defines_map_.erase(define);
 
    if(config_cache_transaction::is_active()) {
        // we have to remove this from active map too
        config_cache_transaction::instance().get_active_map(defines_map_).erase(define);
    }
}
 
bool config_cache::clean_cache()
{
    std::vector<std::string> files, dirs;
    filesystem::get_files_in_dir(filesystem::get_cache_dir(), &files, &dirs, filesystem::name_mode::ENTIRE_FILE_PATH);
 
    LOG_CACHE << "clean_cache(): " << files.size() << " files, "
              << dirs.size() << " dirs to check";
 
    const std::string& exclude_current = cache_file_prefix_ + "*";
 
    bool status = true;
 
    status &= delete_cache_files(files, exclude_current);
    status &= delete_cache_files(dirs, exclude_current);
 
    LOG_CACHE << "clean_cache(): done";
 
    return status;
}
 
bool config_cache::purge_cache()
{
    std::vector<std::string> files, dirs;
    filesystem::get_files_in_dir(filesystem::get_cache_dir(), &files, &dirs, filesystem::name_mode::ENTIRE_FILE_PATH);
 
    LOG_CACHE << "purge_cache(): deleting " << files.size() << " files, "
              << dirs.size() << " dirs";
 
    bool status = true;
 
    status &= delete_cache_files(files);
    status &= delete_cache_files(dirs);
 
    LOG_CACHE << "purge_cache(): done";
    return status;
}
 
bool config_cache::delete_cache_files(const std::vector<std::string>& paths,
                                      const std::string& exclude_pattern)
{
    const bool delete_everything = exclude_pattern.empty();
    bool status = true;
 
    for(const std::string& file_path : paths)
    {
        if(!delete_everything) {
            const std::string& fn = filesystem::base_name(file_path);
 
            if(utils::wildcard_string_match(fn, exclude_pattern)) {
                LOG_CACHE << "delete_cache_files(): skipping " << file_path
                          << " excluded by '" << exclude_pattern << "'";
                continue;
            }
        }
 
        LOG_CACHE << "delete_cache_files(): deleting " << file_path;
        if(!filesystem::delete_directory(file_path)) {
            ERR_CACHE << "delete_cache_files(): could not delete "
                      << file_path;
            status = false;
        }
    }
 
    return status;
}
 
config_cache_transaction::config_cache_transaction()
    : define_filenames_()
    , active_map_()
{
    assert(state_ == FREE);
    state_ = NEW;
    active_ = this;
}
 
config_cache_transaction::~config_cache_transaction()
{
    state_ = FREE;
    active_ = nullptr;
}
 
void config_cache_transaction::lock()
{
    state_ = LOCKED;
}
 
const std::vector<std::string>& config_cache_transaction::get_define_files() const
{
    return define_filenames_;
}
 
void config_cache_transaction::add_define_file(const std::string& file)
{
    define_filenames_.push_back(file);
}
 
preproc_map& config_cache_transaction::get_active_map(const preproc_map& defines_map)
{
    if(active_map_.empty()) {
        active_map_.insert(defines_map.begin(), defines_map.end());
        if(get_state() == NEW) {
            state_ = ACTIVE;
        }
    }
 
    return active_map_;
}
 
void config_cache_transaction::add_defines_map_diff(preproc_map& new_map)
{
    switch(get_state()) {
    case ACTIVE: {
        preproc_map temp;
        std::set_difference(new_map.begin(),
                new_map.end(),
                active_map_.begin(),
                active_map_.end(),
                std::insert_iterator(temp, temp.begin()));
 
        active_map_.insert(temp.begin(), temp.end());
        std::swap(temp, new_map);
        break;
    }
 
    case LOCKED:
        new_map.clear();
        break;
 
    default:
        break;
    }
}
 
} // namespace game_config