]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/command_parse.h
Merge pull request #1018 from SaberUK/insp20+hidekills
[user/henk/code/inspircd.git] / include / command_parse.h
index 10dbef58d6106072afd63983c91189bd835f716a..f9e3a740c3012bc3e955f2b6da841600707cdde7 100644 (file)
@@ -1,35 +1,36 @@
-/*       +------------------------------------+
- *       | 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-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2005-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 __COMMAND_PARSE_H
-#define __COMMAND_PARSE_H
 
-/** A list of dll/so files containing the command handlers for the core
- */
-typedef std::map<std::string, void*> SharedObjectList;
+#ifndef COMMAND_PARSE_H
+#define COMMAND_PARSE_H
 
 /** This class handles command management and parsing.
  * It allows you to add and remove commands from the map,
  * call command handlers by name, and chop up comma seperated
  * parameters into multiple calls.
  */
-class CoreExport CommandParser : public classbase
+class CoreExport CommandParser
 {
  private:
-       /** 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
@@ -41,13 +42,7 @@ class CoreExport CommandParser : public classbase
         * @param user The user to parse the command for
         * @param cmd The command string to process
         */
-       bool ProcessCommand(User *user, std::string &cmd);
-
-       /** 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*>::iterator safei, Module* source);
-
+       bool ProcessCommand(LocalUser *user, std::string &cmd);
 
  public:
        /** Command list, a hash_map of command names to Command*
@@ -55,7 +50,6 @@ class CoreExport CommandParser : public classbase
        Commandtable cmdlist;
 
        /** Default constructor.
-        * @param Instance The creator of this class
         */
        CommandParser();
 
@@ -92,7 +86,7 @@ class CoreExport CommandParser : public classbase
         * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
         * the channel names and their keys as follows:
         *
-        * JOIN #chan1,#chan2,#chan3 key1,,key3
+        * JOIN \#chan1,\#chan2,\#chan3 key1,,key3
         *
         * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
         * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
@@ -102,59 +96,29 @@ class CoreExport CommandParser : public classbase
         * @param user The user who sent the command
         * @param CommandObj the command object to call for each parameter in the list
         * @param parameters Parameter list as an array of array of char (that's not a typo).
-        * @param The number of items in the parameters list
         * @param splithere The first parameter index to split as a comma seperated list
         * @param extra The second parameter index to split as a comma seperated list
+        * @param usemax Limit the command to MaxTargets targets
         * @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(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.
-        * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
-        * the channel names and their keys as follows:
-        *
-        * JOIN #chan1,#chan2,#chan3 key1,,key3
-        *
-        * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
-        * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
-        * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
-        * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
-        *
-        * @param user The user who sent the command
-        * @param CommandObj the command object to call for each parameter in the list
-        * @param parameters Parameter list as an array of array of char (that's not a typo).
-        * @param The number of items in the parameters list
-        * @param splithere The first parameter index to split as a comma seperated list
-        * @param extra The second parameter index to split as a comma seperated list
-        * @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(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere);
+       int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, int extra = -1, bool usemax = true);
 
        /** 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
         */
-       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 which has introduced new commands
-        */
-       void RemoveCommands(Module* source);
+       bool ProcessBuffer(std::string &buffer,LocalUser *user);
 
        /** Add a new command to the commands hash
         * @param f The new Command to add to the list
         * @return True if the command was added
         */
-       bool CreateCommand(Command *f);
+       bool AddCommand(Command *f);
+
+       /** Removes a command.
+        */
+       void RemoveCommand(Command* x);
 
        /** Translate nicknames in a string into UIDs, based on the TranslationType given.
         * @param to The translation type to use for the process.