X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=f016dd4c5b4fae6e30e1d2dd4f1ae26dce701fe8;hb=808a0a09577009c2d6e494979c2189426b332aef;hp=95db50b1a14317f41cacf10fe1a647a8d8a7d5ff;hpb=bec20ca4531c5a6634a8deb991396ecd22aeb644;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index 95db50b1a..f016dd4c5 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -1,18 +1,28 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/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__ + +#ifndef CTABLES_H +#define CTABLES_H /** Used to indicate command success codes */ @@ -20,10 +30,13 @@ enum CmdResult { CMD_FAILURE = 0, /* Command exists, but failed */ CMD_SUCCESS = 1, /* Command exists, and succeeded */ - CMD_INVALID = 2 /* Command doesnt exist at all! */ -#define CMD_LOCALONLY CMD_FAILURE + 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 @@ -47,6 +60,7 @@ enum RouteType ROUTE_TYPE_LOCALONLY, ROUTE_TYPE_BROADCAST, ROUTE_TYPE_UNICAST, + ROUTE_TYPE_MESSAGE, ROUTE_TYPE_OPT_BCAST, ROUTE_TYPE_OPT_UCAST }; @@ -58,10 +72,10 @@ struct RouteDescriptor { /** Routing type from the enum above */ - const RouteType type; + RouteType type; /** For unicast, the destination server's name */ - const std::string serverdest; + std::string serverdest; /** Create a RouteDescriptor */ @@ -75,6 +89,8 @@ struct RouteDescriptor #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 */ @@ -83,20 +99,9 @@ struct RouteDescriptor /** 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 Command : public ServiceProvider { - protected: - /** Owner/Creator object - */ - InspIRCd* ServerInstance; public: - /** Command name - */ - std::string command; - - /** Creator module, NULL for core commands */ - Module* creator; - /** User flags needed to execute the command or 0 */ char flags_needed; @@ -113,11 +118,11 @@ class CoreExport Command : public Extensible /** used by /stats m */ - long double use_count; + long use_count; /** used by /stats m */ - long double total_bytes; + long total_bytes; /** True if the command is disabled to non-opers */ @@ -139,72 +144,31 @@ class CoreExport Command : public Extensible /** 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 maxpara Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param. - * @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, Module* me, const std::string &cmd, const char *flags, int minpara, bool before_reg = false, int penalty = 1) : - ServerInstance(Instance), command(cmd), creator(me), flags_needed(flags ? *flags : 0), - min_params(minpara), max_params(0), disabled(false), works_before_reg(before_reg), Penalty(penalty) + Command(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) : + ServiceProvider(me, cmd, SERVICE_COMMAND), flags_needed(0), min_params(minpara), max_params(maxpara), + use_count(0), total_bytes(0), disabled(false), works_before_reg(false), Penalty(1) { - use_count = 0; - total_bytes = 0; - } - - Command(InspIRCd* Instance, Module* me, const std::string &cmd, const char *flags, int minpara, int maxpara, bool before_reg = false, int penalty = 1) : - ServerInstance(Instance), command(cmd), creator(me), flags_needed(flags ? *flags : 0), - min_params(minpara), max_params(maxpara), disabled(false), works_before_reg(before_reg), Penalty(penalty) - { - use_count = 0; - total_bytes = 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) { - return ROUTE_BROADCAST; - } - - /** 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. - */ - 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; + return ROUTE_LOCALONLY; } /** Encode a parameter for server->server transmission. @@ -250,17 +214,19 @@ class CoreExport Command : public Extensible return works_before_reg; } - /** Standard constructor gubbins - */ - virtual ~Command() - { - syntax.clear(); - } + virtual ~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 */