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
};
/** Translation types for translation of parameters to UIDs.
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_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
{
- const RouteType type;
+ /** Routing type from the enum above
+ */
+ RouteType type;
/** For unicast, the destination server's name
*/
- const std::string serverdest;
- RouteDescriptor(RouteType t, const std::string d)
+ 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.
*/
class CoreExport Command : public Extensible
{
- protected:
- /** Owner/Creator object
- */
- InspIRCd* ServerInstance;
public:
/** Command name
*/
- std::string command;
+ std::string command;
+
+ /** Creator module - never NULL */
+ Module* const creator;
/** User flags needed to execute the command or 0
*/
long double use_count;
/** used by /stats m
- */
- long double total_bytes;
-
- /** used for resource tracking between modules
*/
- std::string source;
+ long double total_bytes;
/** True if the command is disabled to non-opers
*/
/** 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
* be allowed before the user is 'registered' (has sent USER,
* NICK, optionally PASS, and been resolved).
*/
- Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, bool before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(0), disabled(false), works_before_reg(before_reg), Penalty(penalty)
- {
- use_count = 0;
- total_bytes = 0;
- source = "<core>";
- syntax = "";
- translation.clear();
- }
-
- Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int maxpara, bool before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(maxpara), disabled(false), works_before_reg(before_reg), Penalty(penalty)
+ Command(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
+ command(cmd), creator(me), 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;
- source = "<core>";
- syntax = "";
- translation.clear();
}
/** 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<std::string>& parameters, User* user) = 0;
virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& 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<classbase*>& /* 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<std::string>& /* parameters */, const std::string& /* servername */)
- {
- return CMD_INVALID;
+ return ROUTE_LOCALONLY;
}
/** Encode a parameter for server->server transmission.
return works_before_reg;
}
- /** Standard constructor gubbins
- */
virtual ~Command()
{
- syntax.clear();
}
};
projects / user / henk / code / inspircd.git / blobdiff