-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2003, 2007 Craig Edwards <craigedwards@brainbox.cc>
*
- * 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 <http://www.gnu.org/licenses/>.
*/
-
-#ifndef __CTABLES_H__
-#define __CTABLES_H__
-
-#include "inspircd_config.h"
-#include "hash_map.h"
-#include "base.h"
-/* Forward declarations - required */
-class userrec;
-class InspIRCd;
+#ifndef CTABLES_H
+#define CTABLES_H
/** Used to indicate command success codes
*/
CMD_FAILURE = 0, /* Command exists, but failed */
CMD_SUCCESS = 1, /* Command exists, and succeeded */
CMD_INVALID = 2, /* Command doesnt exist at all! */
- CMD_USER_DELETED = 3 /* User was deleted - DEPRECIATED */
+ 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 */
};
-/** 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.
+/** 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)
*/
-#define CMD_LOCALONLY CMD_FAILURE
+enum RouteType
+{
+ ROUTE_TYPE_LOCALONLY,
+ ROUTE_TYPE_BROADCAST,
+ ROUTE_TYPE_UNICAST,
+ ROUTE_TYPE_MESSAGE,
+ ROUTE_TYPE_OPT_BCAST,
+ ROUTE_TYPE_OPT_UCAST
+};
+/** Defines routing information for a command, containing a destination
+ * server id (if applicable) and a routing type from the enum above.
+ */
+struct RouteDescriptor
+{
+ /** Routing type from the enum above
+ */
+ RouteType type;
+ /** For unicast, the destination server's name
+ */
+ std::string serverdest;
+
+ /** Create a RouteDescriptor
+ */
+ RouteDescriptor(RouteType t, const std::string &d)
+ : type(t), serverdest(d) { }
+};
+
+/** 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_t.
+ * in InspIRCd must be defined as derived from Command.
*/
-class CoreExport command_t : public Extensible
+class CoreExport Command : 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
*/
- int min_params;
+ 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.
+ */
+ const unsigned int max_params;
+
/** used by /stats m
*/
- long use_count;
+ unsigned long use_count;
+
/** used by /stats m
- */
- float total_bytes;
- /** used for resource tracking between modules
*/
- std::string source;
+ unsigned long total_bytes;
+
/** 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<TranslateType> translation;
+ /** How many seconds worth of penalty does this command have?
+ */
+ 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 modes required to execute the command.
- * 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_t(InspIRCd* Instance, const std::string &cmd, char flags, int minpara, int before_reg = false) : ServerInstance(Instance), command(cmd), flags_needed(flags), min_params(minpara), disabled(false), works_before_reg(before_reg)
+ 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), allow_empty_last_param(true),
+ Penalty(1)
{
- use_count = 0;
- total_bytes = 0;
- source = "<core>";
- syntax = "";
- translation.clear();
}
/** Handle the command from a user.
* @param parameters The parameters for the command.
- * @param pcnt The number of parameters available in 'parameters'
* @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 char** parameters, int pcnt, userrec* user) = 0;
+ virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
- /** 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 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+ {
+ return ROUTE_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<classbase*> ¶ms)
+ virtual void EncodeParameter(std::string& parameter, int index)
{
- return CMD_INVALID;
}
- /** Handle the command from a server.
+ /** Decode a parameter from server->server transmission.
* Not currently used in this version of InspIRCd.
- * @param parameters The parameters given
- * @param pcnt The number of parameters available
- * @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.
+ * Used for parameters for which the translation type is TR_CUSTOM.
+ * @param parameter The parameter to decode. Can be modified in place.
+ * @param index The parameter index (0 == first parameter).
*/
- virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
+ virtual void DecodeParameter(std::string& parameter, int index)
{
- return CMD_INVALID;
}
/** Disable or enable this command.
return works_before_reg;
}
- /** Standard constructor gubbins
- */
- virtual ~command_t() {}
+ virtual ~Command();
};
-/** A hash of commands used by the core
- */
-typedef nspace::hash_map<std::string,command_t*> command_table;
+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<std::string>& parameters, User* user);
+ virtual CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
+ virtual CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* user);
+ virtual CmdResult HandleServer(const std::vector<std::string>& 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);
translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
#endif
-
projects / user / henk / code / inspircd.git / blobdiff