]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/mode.h
Add timeouts to the http module. Two seperate timeouts, 60 seconds to receive headers...
[user/henk/code/inspircd.git] / include / mode.h
index 0b85a0bac791307aedf53998e163beecef7c7965..070b89a953f3a8a41b1f3e9dfeea1856b8d4e389 100644 (file)
@@ -244,6 +244,26 @@ class ModeHandler : public Extensible
         * This allows the local server to enforce our locally set parameters back to a remote server.
         */
        virtual ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter);
+
+       /**
+        * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
+        * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
+        * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
+        * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
+        * your mode properly from each user.
+        * @param user The user which the server wants to remove your mode from
+        */
+       virtual void RemoveMode(userrec* user);
+
+       /**
+        * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
+        * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
+        * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
+        * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
+        * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
+        * @param channel The channel which the server wants to remove your mode from
+        */
+       virtual void RemoveMode(chanrec* channel);
 };
 
 /**
@@ -340,6 +360,11 @@ class ModeParser : public classbase
         */
        void DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text);
 
+       /** The string representing the last set of modes to be parsed.
+        * Use GetLastParse() to get this value, to be used for  display purposes.
+        */
+       std::string LastParse;
+
  public:
 
        /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
@@ -370,12 +395,27 @@ class ModeParser : public classbase
         * This method can be used on both IPV4 and IPV6 user masks.
         */
        static void CleanMask(std::string &mask);
+       /** Get the last string to be processed, as it was sent to the user or channel. 
+        * Use this to display a string you just sent to be parsed, as the actual output
+        * may be different to what you sent after it has been 'cleaned up' by the parser.
+        * @return Last parsed string, as seen by users.
+        */
+       const std::string& GetLastParse();
        /** Add a mode to the mode parser. The modeletter parameter
         * is purely to save on doing a lookup in the function, as
         * strictly it could be obtained via ModeHandler::GetModeChar().
         * @return True if the mode was successfully added.
         */
        bool AddMode(ModeHandler* mh, unsigned const char modeletter);
+       /** Delete a mode from the mode parser.
+        * When a mode is deleted, the mode handler will be called
+        * for every user (if it is a user mode) or for every  channel
+        * (if it is a channel mode) to unset the mode on all objects.
+        * This prevents modes staying in the system which no longer exist.
+        * @param mh The mode handler to remove
+        * @return True if the mode was successfully removed.
+        */
+       bool DelMode(ModeHandler* mh);
        /** Add a mode watcher.
         * A mode watcher is triggered before and after a mode handler is
         * triggered. See the documentation of class ModeWatcher for more
@@ -437,7 +477,7 @@ class ModeParser : public classbase
        std::string ChanModes();
        /** Used by this class internally during std::sort and 005 generation
         */
-       static bool ModeParser::PrefixComparison(const prefixtype one, const prefixtype two);
+       static bool PrefixComparison(const prefixtype one, const prefixtype two);
 
        /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
         */
@@ -454,18 +494,4 @@ class ModeParser : public classbase
        std::string ModeString(userrec* user, chanrec* channel);
 };
 
-/** Command handler class for the MODE command.
- * put here for completeness.
- */
-class cmd_mode : public command_t
-{
- public:
-       /** Standard constructor
-        */
-       cmd_mode (InspIRCd* Instance) : command_t(Instance,"MODE",0,1) { syntax = "<target> <modes> {<mode-parameters>}"; }
-       /** Handle MODE
-        */
-       void Handle(const char** parameters, int pcnt, userrec *user);
-};
-
 #endif