* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
*
- * Written by Craig Edwards, Craig McLure, and others.
* This program is free but copyrighted software; see
* the file COPYING for details.
*
#ifndef __COMMAND_PARSE_H
#define __COMMAND_PARSE_H
-#include <string>
-#include "users.h"
-#include "ctables.h"
-#include "typedefs.h"
-
-class InspIRCd;
-
+/** A list of dll/so files containing the command handlers for the core
+ */
typedef std::map<std::string, void*> SharedObjectList;
/** This class handles command management and parsing.
* call command handlers by name, and chop up comma seperated
* parameters into multiple calls.
*/
-class CommandParser : public classbase
+class CoreExport CommandParser : public classbase
{
private:
/** The creator of this class
*/
InspIRCd* ServerInstance;
+ /** Parameter buffer
+ */
+ std::vector<std::string> para;
+
/** Process a parameter string into a list of items
* @param command_p The output list of items
* @param parameters The input string
* @return The number of parameters parsed into command_p
*/
- int ProcessParameters(char **command_p,char *parameters);
+ int ProcessParameters(std::vector<std::string>& command_p, char* parameters);
/** Process a command from a user.
* @param user The user to parse the command for
* @param cmd The command string to process
*/
- void ProcessCommand(userrec *user, std::string &cmd);
+ bool ProcessCommand(User *user, std::string &cmd);
- /** Insert the default RFC1459 commands into the command hash.
+ /** Finds the init_command symbol in a .so file
+ * @param v A function pointer to be initialized
+ * @param h A valid shared object handle
+ * @param name The filename being loaded, used for error reporting
+ * @return True if the symbol could be found
*/
- void SetupCommandTable();
-
- void FindSym(void** v, void* h);
+ bool FindSym(void** v, void* h, const std::string &name);
+ /** A list of core-implemented modes and their shared object handles
+ */
SharedObjectList RFCCommands;
- void LoadCommand(const char* name);
+ /** Load a command from a shared object on disk.
+ * @param name The shared object to load (without path)
+ * @return NULL on success, pointer to dlerrr() error message on failure
+ */
+ const char* LoadCommand(const char* name);
- public:
- /** Command list, a hash_map of command names to command_t*
+ /** Removes a command if the sources match. Used as a helper for
+ * safe hash_map delete while iter in RemoveCommands(const char* source).
*/
- command_table cmdlist;
+ void RemoveCommand(nspace::hash_map<std::string,Command*>::iterator safei, const char* source);
+
- bool ReloadCommand(const char* cmd);
+ public:
+ /** Command list, a hash_map of command names to Command*
+ */
+ Commandtable cmdlist;
+
+ /** Reload a core command.
+ * This will only reload commands implemented by the core,
+ * to reload a modular command, you must reload that module.
+ * @param cmd The command to reload. This will cause the shared
+ * object which implements this command to be closed, and then reloaded.
+ * @return True if the command was reloaded, false if it could not be found
+ * or another error occured
+ */
+ bool ReloadCommand(std::string cmd, User* user);
/** Default constructor.
* @param Instance The creator of this class
/** Calls the handler for a given command.
* @param commandname The command to find. This should be in uppercase.
- * @param parameters Parameter list as an array of array of char (that's not a typo).
- * @param pcnt The number of items in the parameters list
+ * @param parameters Parameter list
* @param user The user to call the handler on behalf of
- * @return This method will return true if the command handler was found and called
+ * @return This method will return CMD_SUCCESS if the command handler was found and called,
+ * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
+ * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
+ * command simply did not exist at all or the wrong number of parameters were given, or the user
+ * was not privilaged enough to execute the command.
*/
- bool CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
+ CmdResult CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user);
+
+ /** Get the handler function for a command.
+ * @param commandname The command required. Always use uppercase for this parameter.
+ * @return a pointer to the command handler, or NULL
+ */
+ Command* GetHandler(const std::string &commandname);
/** This function returns true if a command is valid with the given number of parameters and user.
* @param commandname The command name to check
* equal to or greater than the minimum number of parameters to the given command, then this
* function will return true, otherwise it will return false.
*/
- bool IsValidCommand(const std::string &commandname, int pcnt, userrec * user);
-
+ bool IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user);
+
/** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
* There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
* We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
* @return This function will return 1 when there are no more parameters to process. When this occurs, its
* caller should return without doing anything, otherwise it should continue into its main section of code.
*/
- int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere, unsigned int extra);
+ int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra);
/** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
* There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
* @return This function will return 1 when there are no more parameters to process. When this occurs, its
* caller should return without doing anything, otherwise it should continue into its main section of code.
*/
- int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere);
+ int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere);
/** Take a raw input buffer from a recvq, and process it on behalf of a user.
* @param buffer The buffer line to process
* @param user The user to whom this line belongs
*/
- void ProcessBuffer(std::string &buffer,userrec *user);
+ bool ProcessBuffer(std::string &buffer,User *user);
+
+ /** Process lines in a users sendq.
+ * @param current The user to process
+ * @param one_only if one_only is set only one command is processed from the sendq.
+ */
+ void DoLines(User* current, bool one_only = false);
/** Remove all commands relating to module 'source'.
* @param source A module name which has introduced new commands
- * @return True This function returns true if commands were removed
*/
- bool RemoveCommands(const char* source);
+ void RemoveCommands(const char* source);
/** Add a new command to the commands hash
- * @param f The new command_t to add to the list
+ * @param f The new Command to add to the list
* @param so_handle The handle to the shared object where the command can be found.
* Only core commands loaded via cmd_*.so files should set this parameter to anything
* meaningful. Module authors should leave this parameter at its default of NULL.
* @return True if the command was added
*/
- bool CreateCommand(command_t *f, void* so_handle = NULL);
+ bool CreateCommand(Command *f, void* so_handle = NULL);
+
+ /** Insert the default RFC1459 commands into the command hash.
+ */
+ void SetupCommandTable();
+
+ /** Translate nicknames in a string into UIDs, based on the TranslationType given.
+ * @param to The translation type to use for the process.
+ * @param source The input string
+ * @param dest The output string, it is safe to pass source and dest as the same variable only for translation type TR_TEXT.
+ * @return returns the number of substitutions made. Will always be 0 or 1 for TR_TEXT and 0..n for other types.
+ */
+ int TranslateUIDs(TranslateType to, const std::string &source, std::string &dest);
+
+ int TranslateUIDs(const std::deque<TranslateType> to, const std::deque<std::string> &source, std::string &dest);
};
/** Command handler class for the RELOAD command.
* A command cant really reload itself, so this has to be in here.
*/
-class cmd_reload : public command_t
+class CommandReload : public Command
{
public:
/** Standard constructor
*/
- cmd_reload (InspIRCd* Instance) : command_t(Instance,"RELOAD",'o',1) { syntax = "<core-command>"; }
+ CommandReload (InspIRCd* Instance) : Command(Instance,"RELOAD","o",1) { syntax = "<core-command>"; }
/** Handle RELOAD
*/
- void Handle(const char** parameters, int pcnt, userrec *user);
+ CmdResult Handle(const std::vector<std::string>& parameters, User *user);
};
-
+/** A lookup table of values for multiplier characters used by
+ * InspIRCd::Duration(). In this lookup table, the indexes for
+ * the ascii values 'm' and 'M' have the value '60', the indexes
+ * for the ascii values 'D' and 'd' have a value of '86400', etc.
+ */
+const int duration_multi[] =
+{
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
+ 1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 604800, 1, 31557600, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31557600,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
+ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
+};
#endif
projects / user / henk / code / inspircd.git / blobdiff