addon/manager.cpp

Go to the documentation of this file.

/* $Id: manager.cpp 53411 2012-03-03 19:33:27Z shadowmaster $ */
/*
   Copyright (C) 2003 - 2008 by David White <dave@whitevine.net>
                 2008 - 2012 by Ignacio R. Morelle <shadowm2006@gmail.com>
   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.
*/

#include "global.hpp"

#include "addon/manager.hpp"
#include "addon/manager_ui.hpp"
#include "dialogs.hpp"
#include "filesystem.hpp"
#include "foreach.hpp"
#include "formatter.hpp"
#include "game_display.hpp"
#include "game_preferences.hpp"
#include "gettext.hpp"
#include "gui/dialogs/addon_connect.hpp"
#include "gui/dialogs/addon_list.hpp"
#include "gui/dialogs/addon/description.hpp"
#include "gui/dialogs/addon/uninstall_list.hpp"
#include "gui/dialogs/message.hpp"
#include "gui/dialogs/network_transmission.hpp"
#include "gui/dialogs/simple_item_selector.hpp"
#include "gui/dialogs/transient_message.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/window.hpp"
#include "log.hpp"
#include "marked-up_text.hpp"
#include "serialization/parser.hpp"
#include "version.hpp"
#include "wml_separators.hpp"
#include "formula_string_utils.hpp"
#include "addon/client.hpp"

static lg::log_domain log_config("config");
#define ERR_CFG LOG_STREAM(err , log_config)
#define LOG_CFG LOG_STREAM(info, log_config)
#define WRN_CFG LOG_STREAM(warn, log_config)

static lg::log_domain log_filesystem("filesystem");
#define ERR_FS  LOG_STREAM(err , log_filesystem)

static lg::log_domain log_network("network");
#define ERR_NET LOG_STREAM(err , log_network)
#define LOG_NET LOG_STREAM(info, log_network)

namespace {
    std::string get_pbl_file_path(const std::string& addon_name)
    {
        const std::string& parentd = get_addon_campaigns_dir();
        // Cope with old-style or new-style file organization
        const std::string exterior = parentd + "/" + addon_name + ".pbl";
        const std::string interior = parentd + "/" + addon_name + "/_server.pbl";
        return file_exists(exterior) ? exterior : interior;
    }

    inline std::string get_info_file_path(const std::string& addon_name)
    {
        return get_addon_campaigns_dir() + "/" + addon_name + "/_info.cfg";
    }
}

bool have_addon_in_vcs_tree(const std::string& addon_name)
{
    static const std::string parentd = get_addon_campaigns_dir();
    return
        file_exists(parentd+"/"+addon_name+"/.svn") ||
        file_exists(parentd+"/"+addon_name+"/.git") ||
        file_exists(parentd+"/"+addon_name+"/.hg");
}

bool have_addon_pbl_info(const std::string& addon_name)
{
    static const std::string parentd = get_addon_campaigns_dir();
    return
        file_exists(parentd+"/"+addon_name+".pbl") ||
        file_exists(parentd+"/"+addon_name+"/_server.pbl");
}

void get_addon_pbl_info(const std::string& addon_name, config& cfg)
{
    scoped_istream stream = istream_file(get_pbl_file_path(addon_name));
    read(cfg, *stream);
}

void set_addon_pbl_info(const std::string& addon_name, const config& cfg)
{
    scoped_ostream stream = ostream_file(get_pbl_file_path(addon_name));
    write(*stream, cfg);
}

bool remove_local_addon(const std::string& addon)
{
    bool ret = true;
    const std::string addon_dir = get_addon_campaigns_dir() + "/" + addon;

    LOG_CFG << "removing local add-on: " << addon << '\n';

    if(file_exists(addon_dir) && !delete_directory(addon_dir, true)) {
        ERR_CFG << "Failed to delete directory/file: " << addon_dir << '\n';
        ret = false;
    }

    if(file_exists(addon_dir + ".cfg") && !delete_directory(addon_dir + ".cfg", true)) {
        ERR_CFG << "Failed to delete directory/file: " << addon_dir << ".cfg\n";
        ret = false;
    }

    if(!ret) {
        ERR_CFG << "removal of add-on " << addon << " failed!\n";
    }

    return ret;
}

std::vector<std::string> available_addons()
{
    std::vector<std::string> res;
    std::vector<std::string> files, dirs;
    const std::string parentd = get_addon_campaigns_dir();
    get_files_in_dir(parentd,&files,&dirs);

    for(std::vector<std::string>::const_iterator i = dirs.begin(); i != dirs.end(); ++i) {
        const std::string external_cfg_file = *i + ".cfg";
        const std::string internal_cfg_file = *i + "/_main.cfg";
        const std::string external_pbl_file = *i + ".pbl";
        const std::string internal_pbl_file = *i + "/_server.pbl";
        if((std::find(files.begin(),files.end(),external_cfg_file) != files.end() || file_exists(parentd + "/" + internal_cfg_file)) &&
           (std::find(files.begin(),files.end(),external_pbl_file) != files.end() || (file_exists(parentd + "/" + internal_pbl_file)))) {
            res.push_back(*i);
        }
    }
    for(std::vector<std::string>::const_iterator i = files.begin(); i != files.end(); ++i) {
        const size_t length = i->size() - 4;
        if (i->rfind(".cfg", length) != length) continue;
        const std::string name = i->substr(0, length);
        // Continue if there is a dir (which we already processed).
        if (std::find(dirs.begin(), dirs.end(), name) != dirs.end()) continue;
        if (std::find(files.begin(), files.end(), name + ".pbl") != files.end()) {
            res.push_back(name);
        }
    }

    return res;
}

std::vector<std::string> installed_addons()
{
    std::vector<std::string> res;
    const std::string parentd = get_addon_campaigns_dir();
    std::vector<std::string> files, dirs;
    get_files_in_dir(parentd,&files,&dirs);

    for(std::vector<std::string>::const_iterator i = dirs.begin(); i != dirs.end(); ++i) {
        const std::string external_cfg_file = *i + ".cfg";
        const std::string internal_cfg_file = *i + "/_main.cfg";
        if(std::find(files.begin(),files.end(),external_cfg_file) != files.end() || file_exists(parentd + "/" + internal_cfg_file)) {
            res.push_back(*i);
        }
    }

    return res;
}

bool is_addon_installed(const std::string& addon_name)
{
    const std::string namestem = get_addon_campaigns_dir() + "/" + addon_name;

    return file_exists(namestem + ".cfg") || file_exists(namestem + "/_main.cfg");
}

static inline bool IsCR(const char& c)
{
    return c == '\x0D';
}

static std::string strip_cr(std::string str, bool strip)
{
    if(!strip)
        return str;
    std::string::iterator new_end = std::remove_if(str.begin(), str.end(), IsCR);
    str.erase(new_end, str.end());
    return str;
}

namespace {
    void append_default_ignore_patterns(std::pair<std::vector<std::string>, std::vector<std::string> >& patterns)
    {
        std::vector<std::string>& files = patterns.first;
        std::vector<std::string>& dirs  = patterns.second;

        /* Don't upload dot-files/dirs, which are hidden files in
           UNIX platforms */
        files.push_back(".*");
        dirs.push_back(".*");
        /* MacOS X metadata-like cruft (http://floatingsun.net/2007/02/07/whats-with-__macosx-in-zip-files/) */
        dirs.push_back("__MACOSX");

        files.push_back("#*#");
        files.push_back("*~");
        files.push_back("*-bak");
        files.push_back("*.swp");
        files.push_back("*.pbl");
        files.push_back("*.ign");
        files.push_back("_info.cfg");
        files.push_back("*.exe");
        files.push_back("*.bat");
        files.push_back("*.cmd");
        files.push_back("*.com");
        files.push_back("*.scr");
        files.push_back("*.sh");
        files.push_back("*.js");
        files.push_back("*.vbs");
        files.push_back("*.o");
        /* Remove junk created by certain file manager ;) */
        files.push_back("Thumbs.db");
        /* Eclipse plugin */
        files.push_back("*.wesnoth");
        files.push_back("*.project");
    }
}

static std::pair<std::vector<std::string>, std::vector<std::string> > read_ignore_patterns(const std::string& addon_name)
{
    const std::string parentd = get_addon_campaigns_dir();
    const std::string exterior = parentd + "/" + addon_name + ".ign";
    const std::string interior = parentd + "/" + addon_name + "/_server.ign";

    std::pair<std::vector<std::string>, std::vector<std::string> > patterns;
    std::string ign_file;
    LOG_CFG << "searching for .ign file for '" << addon_name << "'...\n";
    if (file_exists(interior)) {
        ign_file = interior;
    } else if (file_exists(exterior)) {
        ign_file = exterior;
    } else {
        LOG_CFG << "no .ign file found for '" << addon_name << "'\n"
                << "inserting default ignore patterns...\n";
        append_default_ignore_patterns(patterns);
        return patterns; // just default patterns
    }
    LOG_CFG << "found .ign file: " << ign_file << '\n';
    std::istream *stream = istream_file(ign_file);
    std::string line;
    while (std::getline(*stream, line)) {
        utils::strip(line);
        const size_t l = line.size();
        if (line[l - 1] == '/') { // directory; we strip the last /
            patterns.second.push_back(line.substr(0, l - 1));
        } else { // file
            patterns.first.push_back(line);
        }
    }
    return patterns;
}

static void archive_file(const std::string& path, const std::string& fname, config& cfg)
{
    cfg["name"] = fname;
    const bool is_cfg = (fname.size() > 4 ? (fname.substr(fname.size() - 4) == ".cfg") : false);
    cfg["contents"] = encode_binary(strip_cr(read_file(path + '/' + fname),is_cfg));
}

static void archive_dir(const std::string& path, const std::string& dirname, config& cfg, std::pair<std::vector<std::string>, std::vector<std::string> >& ignore_patterns)
{
    cfg["name"] = dirname;
    const std::string dir = path + '/' + dirname;

    std::vector<std::string> files, dirs;
    get_files_in_dir(dir,&files,&dirs);
    for(std::vector<std::string>::const_iterator i = files.begin(); i != files.end(); ++i) {
        bool valid = !looks_like_pbl(*i);
        for(std::vector<std::string>::const_iterator p = ignore_patterns.first.begin(); p != ignore_patterns.first.end(); ++p) {
            if (utils::wildcard_string_match(*i, *p)) {
                valid = false;
                break;
            }
        }
        if (valid) {
            archive_file(dir,*i,cfg.add_child("file"));
        }
    }

    for(std::vector<std::string>::const_iterator j = dirs.begin(); j != dirs.end(); ++j) {
        bool valid = true;
        for(std::vector<std::string>::const_iterator p = ignore_patterns.second.begin(); p != ignore_patterns.second.end(); ++p) {
            if (utils::wildcard_string_match(*j, *p)) {
                valid = false;
                break;
            }
        }
        if (valid) {
            archive_dir(dir,*j,cfg.add_child("dir"),ignore_patterns);
        }
    }
}

void archive_addon(const std::string& addon_name, config& cfg)
{
    const std::string parentd = get_addon_campaigns_dir();

    std::pair<std::vector<std::string>, std::vector<std::string> > ignore_patterns;
    // External .cfg may not exist; newer campaigns have a _main.cfg
    const std::string external_cfg = addon_name + ".cfg";
    if (file_exists(parentd + "/" + external_cfg)) {
        archive_file(parentd, external_cfg, cfg.add_child("file"));
    }
    ignore_patterns = read_ignore_patterns(addon_name);
    archive_dir(parentd, addon_name, cfg.add_child("dir"), ignore_patterns);
}

static void unarchive_file(const std::string& path, const config& cfg)
{
    write_file(path + '/' + cfg["name"].str(), unencode_binary(cfg["contents"]));
}

static void unarchive_dir(const std::string& path, const config& cfg)
{
    std::string dir;
    if (cfg["name"].empty())
        dir = path;
    else
        dir = path + '/' + cfg["name"].str();

    make_directory(dir);

    foreach (const config &d, cfg.child_range("dir")) {
        unarchive_dir(dir, d);
    }

    foreach (const config &f, cfg.child_range("file")) {
        unarchive_file(dir, f);
    }
}

void unarchive_addon(const config& cfg)
{
    const std::string parentd = get_addon_campaigns_dir();
    unarchive_dir(parentd, cfg);
}

namespace {
    std::map< std::string, version_info > version_info_cache;
} // end unnamed namespace 5

void refresh_addon_version_info_cache()
{
    version_info_cache.clear();

    LOG_CFG << "refreshing add-on versions cache\n";

    const std::vector<std::string>& addons = installed_addons();
    if(addons.empty()) {
        return;
    }

    std::vector<std::string> addon_info_files(addons.size());

    std::transform(addons.begin(), addons.end(),
                   addon_info_files.begin(), get_info_file_path);

    for(size_t i = 0; i < addon_info_files.size(); ++i) {
        assert(i < addons.size());

        const std::string& addon = addons[i];
        const std::string& info_file = addon_info_files[i];

        if(file_exists(info_file)) {
            scoped_istream stream = istream_file(info_file);

            config cfg;
            read(cfg, *stream);

            const config& info_cfg = cfg.child("info");
            if(!info_cfg) {
                continue;
            }

            const std::string& version = info_cfg["version"].str();
            LOG_CFG << "cached add-on version: " << addon << " [" << version << "]\n";

            version_info_cache[addon] = version;
        } else if (!have_addon_pbl_info(addon) && !have_addon_in_vcs_tree(addon)) {
            // Don't print the warning if the user is clearly the author
            WRN_CFG << "add-on '" << addon << "' has no _info.cfg; cannot read version info\n";
        }
    }
}

version_info get_addon_version_info(const std::string& addon)
{
    static const version_info nil(0,0,0,false);
    std::map< std::string, version_info >::iterator entry = version_info_cache.find(addon);
    return entry != version_info_cache.end() ? entry->second : nil;
}