* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
#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.
* @param user The user to parse the command for
* @param cmd The command string to process
*/
- void ProcessCommand(userrec *user, std::string &cmd);
-
- /** Insert the default RFC1459 commands into the command hash.
- */
- void SetupCommandTable();
+ bool ProcessCommand(User *user, std::string &cmd);
/** 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
*/
- bool 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
*/
/** 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
*/
- void LoadCommand(const char* name);
+ const char* LoadCommand(const char* name);
/** Removes a command if the sources match. Used as a helper for
* safe hash_map delete while iter in RemoveCommands(const char* source).
*/
- void RemoveCommand(nspace::hash_map<std::string,command_t*>::iterator safei, const char* source);
+ void RemoveCommand(nspace::hash_map<std::string,Command*>::iterator safei, const char* source);
public:
- /** Command list, a hash_map of command names to command_t*
+ /** Command list, a hash_map of command names to Command*
*/
- command_table cmdlist;
+ Commandable cmdlist;
/** Reload a core command.
* This will only reload commands implemented by the core,
* @return True if the command was reloaded, false if it could not be found
* or another error occured
*/
- bool ReloadCommand(const char* cmd);
+ bool ReloadCommand(const char* cmd, User* user);
/** Default constructor.
* @param Instance The creator of this class
* 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.
*/
- CmdResult CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
+ CmdResult CallHandler(const std::string &commandname,const char* const* parameters, int pcnt, User *user);
- command_t* GetHandler(const std::string &commandname);
+ /** 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, 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.
* @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 char* const* parameters, int pcnt, 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 char* const* parameters, int pcnt, 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
bool 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.
+ * Ignore any already loaded commands.
+ * @param user User to spool errors to, or if NULL, when an error occurs spool the errors to
+ * stdout then exit with EXIT_STATUS_HANDLER.
+ */
+ void SetupCommandTable(User* user);
+
+ /** 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);
};
/** 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 cmd_reload : public Command
{
public:
/** Standard constructor
*/
- cmd_reload (InspIRCd* Instance) : command_t(Instance,"RELOAD",'o',1) { syntax = "<core-command>"; }
+ cmd_reload (InspIRCd* Instance) : Command(Instance,"RELOAD","o",1) { syntax = "<core-command>"; }
/** Handle RELOAD
*/
- CmdResult Handle(const char** parameters, int pcnt, userrec *user);
+ CmdResult Handle(const char* const* parameters, int pcnt, User *user);
};
/** A lookup table of values for multiplier characters used by
projects / user / henk / code / inspircd.git / blobdiff