Admin.h

Go to the documentation of this file.

#pragma once

#include <string>
#include "../Common/Streams.h"

enum e_command_result;

namespace commands
{
    class CArgParser;
}

namespace Admin
{
    enum result_t
    {
        E_OK = 0,
        E_HASH_INUSE,
        E_LEVEL_NOT_EXIST,
        E_NAME_INUSE,
        E_NOT_ADMIN,
        E_NOT_ALLOWED,
    };

    // Attempts to add the the admin to the list
    result_t add(const std::string& hash, const std::string& authname, int level);

    // Removes an existing admin, does nothing if they're not an admin.
    void remove(const std::string& hash);

    // Checks if a player is an admin
    bool isAdmin(const std::string& hash);

    // Gets an admin's access level.
    bool getLevel(const std::string& hash, int* level);

    // Checks if hash challenging is enabled (defaults to true)
    bool isChallengeEnabled();

    // Checks if a player can execute the specified command
    // Returns E_OK if there are no admins (the system is inactive)
    result_t canUseCommand(const std::string& hash, const std::string& command,
        std::string* authName=NULL);

    // Initialize the admin system, outputting errors to 'out'.
    // Errors aren't output if 'out' is NULL.
    void initialize(COutStream* out);

    // Reloads the admin/access files
    void reload();

    // -------------------------------------------------------------------
    //
    e_command_result sv_admin_add(void*, commands::CArgParser& args, COutStream& out);

    e_command_result sv_admin_del(void*, commands::CArgParser& args, COutStream& out);

    e_command_result sv_admin_list(void*, commands::CArgParser& args, COutStream& out);

    e_command_result sv_admin_cur(void*, commands::CArgParser& args, COutStream& out);

    e_command_result sv_admin_reload(void*, commands::CArgParser& args, COutStream& out);

    e_command_result sv_commands(void* player, commands::CArgParser& args, COutStream& out);

    e_command_result sv_admin_check(void*, commands::CArgParser& args, COutStream& out);
    e_command_result sv_public(void*, commands::CArgParser& args, COutStream& out);
}