blacklist.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2014 - 2024
    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.
*/
 
#pragma once
 
#include "config.hpp"
 
namespace campaignd
{
 
/**
 * Add-on blacklist table.
 *
 * A path to a blacklist WML file may be provided in the campaignd
 * configuration. The file's contents are used to maintain a blacklist to
 * check certain add-on metadata fields against it every time a new or
 * existing add-on is uploaded ([upload] request).
 *
 * Blacklist entries are glob patterns accepting the '*' and '?' wildcards for
 * matching any number of characters and a single character, respectively. The
 * lists are expected to be comma-delimited.
 *
 *     ip = (net address masks)
 *     email = (email address patterns)
 *     name = (add-on id/dirname patterns)
 *     title = (add-on title patterns)
 *     author = (add-on author patterns)
 *     description = (add-on description patterns)
 */
class blacklist
{
public:
    typedef std::vector<std::string> globlist;
 
    blacklist(const blacklist&) = delete;
    blacklist& operator=(const blacklist&) = delete;
 
    blacklist();
    explicit blacklist(const config& cfg);
 
    void clear();
 
    /**
     * Initializes the blacklist from WML.
     *
     * @param cfg WML node object with the contents of the [blacklist] tag.
     */
    void read(const config& cfg);
 
    /**
     * Writes the blacklist to a WML node.
     *
     * @param cfg WML node object to write to. Any existing contents are
     *            erased by this method.
     */
    void write(config& cfg) const;
 
    /**
     * Whether an add-on described by these fields is blacklisted.
     *
     * Empty parameters are ignored.
     */
    bool is_blacklisted(const std::string& name,
                        const std::string& title,
                        const std::string& description,
                        const std::string& author,
                        const std::string& ip,
                        const std::string& email) const;
 
private:
    globlist names_;
    globlist titles_;
    globlist descriptions_;
 
    globlist authors_;
    globlist ips_;
    globlist emails_;
 
    void parse_str_to_globlist(const std::string& str, globlist& glist);
 
    bool is_in_globlist(const std::string& str, const globlist& glist) const;
 
    bool is_in_ip_masklist(const std::string& ip, const globlist& mlist) const;
    bool ip_matches(const std::string& ip, const std::string& ip_mask) const;
};
 
}