X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=abf65f56127122f2e742b76592b3b65fdd8f23fe;hb=8c71a2a6304f0d77aa7738e04a44f366a158cadd;hp=ad2135b1e578dcb7641d462ea8e2064e247fb97b;hpb=61185fc62b7d3d05e33a116fca26aa9dc72ab691;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index ad2135b1e..abf65f561 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -1,18 +1,27 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2003, 2007 Craig Edwards * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd 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, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ - -#ifndef __CTABLES_H__ -#define __CTABLES_H__ + + +#pragma once /** Used to indicate command success codes */ @@ -20,124 +29,150 @@ enum CmdResult { CMD_FAILURE = 0, /* Command exists, but failed */ CMD_SUCCESS = 1, /* Command exists, and succeeded */ - CMD_INVALID = 2 /* Command doesnt exist at all! */ + CMD_INVALID = 2, /* Command doesnt exist at all! */ + CMD_EPERM = 3 /* Command failed because of a permission check */ }; +/** Flag for commands that are only allowed from servers */ +const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works + +/** Translation types for translation of parameters to UIDs. + * This allows the core commands to not have to be aware of how UIDs + * work (making it still possible to write other linking modules which + * do not use UID (but why would you want to?) + */ enum TranslateType { - TR_END, /* End of known parameters, everything after this is TR_TEXT */ TR_TEXT, /* Raw text, leave as-is */ TR_NICK, /* Nickname, translate to UUID for server->server */ - TR_NICKLIST, /* Comma seperated nickname list, translate to UUIDs */ - TR_SPACENICKLIST /* Space seperated nickname list, translate to UUIDs */ + TR_CUSTOM /* Custom translation handled by EncodeParameter/DecodeParameter */ +}; + +/** Routing types for a command. Any command which is created defaults + * to having its command broadcasted on success. This behaviour may be + * overridden to one of the route types shown below (see the #defines + * below for more information on each one's behaviour) + */ +enum RouteType +{ + ROUTE_TYPE_LOCALONLY, + ROUTE_TYPE_BROADCAST, + ROUTE_TYPE_UNICAST, + ROUTE_TYPE_MESSAGE, + ROUTE_TYPE_OPT_BCAST, + ROUTE_TYPE_OPT_UCAST }; -/** For commands which should not be replicated to other - * servers, we usually return CMD_FAILURE. this isnt readable, - * so we define this alias for CMD_FAILURE called - * CMD_LOCALONLY, which of course does the same thing but is - * much more readable. +/** Defines routing information for a command, containing a destination + * server id (if applicable) and a routing type from the enum above. */ -#define CMD_LOCALONLY CMD_FAILURE +struct RouteDescriptor +{ + /** Routing type from the enum above + */ + RouteType type; + /** For unicast, the destination server's name + */ + std::string serverdest; + + /** For unicast, the destination Server + */ + Server* server; + + /** Create a RouteDescriptor + */ + RouteDescriptor(RouteType t, const std::string &d) + : type(t), serverdest(d), server(NULL) { } + + RouteDescriptor(RouteType t, Server* srv) + : type(t), server(srv) { } +}; +/** Do not route this command */ +#define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, "")) +/** Route this command to all servers, fail if not understood */ +#define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, "")) +/** Route this command to a single server (do nothing if own server name specified) */ +#define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x)) +/** Route this command as a message with the given target (any of user, #channel, @#channel, $servermask) */ +#define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x)) +/** Route this command to all servers wrapped via ENCAP, so ignored if not understood */ +#define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, "")) +/** Route this command to a single server wrapped via ENCAP, so ignored if not understood */ +#define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x)) /** A structure that defines a command. Every command available * in InspIRCd must be defined as derived from Command. */ -class CoreExport Command : public Extensible +class CoreExport CommandBase : public ServiceProvider { - protected: - /** Owner/Creator object - */ - InspIRCd* ServerInstance; public: - /** Command name - */ - std::string command; /** User flags needed to execute the command or 0 */ char flags_needed; + /** Minimum number of parameters command takes */ - unsigned int min_params; - /** used by /stats m + const unsigned int min_params; + + /** Maximum number of parameters command takes. + * This is used by the command parser to join extra parameters into one last param. + * If not set, no munging is done to this command. */ - long double use_count; + const unsigned int max_params; + /** used by /stats m - */ - long double total_bytes; - /** used for resource tracking between modules */ - std::string source; + unsigned long use_count; + /** True if the command is disabled to non-opers */ bool disabled; + /** True if the command can be issued before registering */ bool works_before_reg; + + /** True if the command allows an empty last parameter. + * When false and the last parameter is empty, it's popped BEFORE + * checking there are enough params, etc. (i.e. the handler won't + * be called if there aren't enough params after popping the empty + * param). + * True by default + */ + bool allow_empty_last_param; + /** Syntax string for the command, displayed if non-empty string. * This takes place of the text in the 'not enough parameters' numeric. */ std::string syntax; + /** Translation type list for possible parameters, used to tokenize + * parameters into UIDs and SIDs etc. + */ std::vector translation; /** How many seconds worth of penalty does this command have? */ - const int Penalty; + int Penalty; /** Create a new command. - * @param Instance Pointer to creator class + * @param me The module which created this command. * @param cmd Command name. This must be UPPER CASE. - * @param flags User mode required to execute the command. May ONLY be one mode - it's a string to give warnings if people mix params up. - * For oper only commands, set this to 'o', otherwise use 0. * @param minpara Minimum parameters required for the command. - * @param before_reg If this is set to true, the command will - * be allowed before the user is 'registered' (has sent USER, - * NICK, optionally PASS, and been resolved). + * @param maxpara Maximum number of parameters this command may have - extra parameters + * will be tossed into one last space-seperated param. */ - Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), disabled(false), works_before_reg(before_reg), Penalty(penalty) - { - use_count = 0; - total_bytes = 0; - source = ""; - syntax = ""; - translation.clear(); - } + CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); - /** Handle the command from a user. - * @param parameters The parameters for the command. - * @param user The user who issued the command. - * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. - * If the command succeeds but should remain local to this server, - * return CMD_LOCALONLY. - */ - virtual CmdResult Handle(const std::vector& parameters, User* user) = 0; + virtual RouteDescriptor GetRouting(User* user, const std::vector& parameters); - /** Handle an internal request from another command, the core, or a module - * @param Command ID - * @param Zero or more parameters, whos form is specified by the command ID. - * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. - * If the command succeeds but should remain local to this server, - * return CMD_LOCALONLY. + /** Encode a parameter for server->server transmission. + * Used for parameters for which the translation type is TR_CUSTOM. + * @param parameter The parameter to encode. Can be modified in place. + * @param index The parameter index (0 == first parameter). */ - virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque& /* params */) - { - return CMD_INVALID; - } - - /** Handle the command from a server. - * Not currently used in this version of InspIRCd. - * @param parameters The parameters given - * @param servername The server name which issued the command - * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. - * If the command succeeds but should remain local to this server, - * return CMD_LOCALONLY. - */ - virtual CmdResult HandleServer(const std::vector& /* parameters */, const std::string& /* servername */) - { - return CMD_INVALID; - } + virtual void EncodeParameter(std::string& parameter, int index); /** Disable or enable this command. * @param setting True to disable the command. @@ -163,18 +198,45 @@ class CoreExport Command : public Extensible return works_before_reg; } - /** Standard constructor gubbins + virtual ~CommandBase(); +}; + +class CoreExport Command : public CommandBase +{ + public: + /** If true, the command will not be forwarded by the linking module even if it comes via ENCAP. + * Can be used to forward commands before their effects. */ - virtual ~Command() - { - syntax.clear(); - } + bool force_manual_route; + + Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); + + /** Handle the command from a user. + * @param parameters The parameters for the command. + * @param user The user who issued the command. + * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. + */ + virtual CmdResult Handle(const std::vector& parameters, User* user) = 0; + + /** Destructor + * Removes this command from the command parser + */ + ~Command(); }; -/** A hash of commands used by the core - */ -typedef nspace::hash_map Commandtable; +class CoreExport SplitCommand : public Command +{ + public: + SplitCommand(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) + : Command(me, cmd, minpara, maxpara) {} + virtual CmdResult Handle(const std::vector& parameters, User* user); + virtual CmdResult HandleLocal(const std::vector& parameters, LocalUser* user); + virtual CmdResult HandleRemote(const std::vector& parameters, RemoteUser* user); + virtual CmdResult HandleServer(const std::vector& parameters, FakeUser* user); +}; +/** Shortcut macros for defining translation lists + */ #define TRANSLATE1(x1) translation.push_back(x1); #define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2); #define TRANSLATE3(x1,x2,x3) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3); @@ -187,6 +249,3 @@ typedef nspace::hash_map Commandtable; translation.push_back(x5);translation.push_back(x6);translation.push_back(x7); #define TRANSLATE8(x1,x2,x3,x4,x5,x6,x7,x8) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\ translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8); - -#endif -