Tons more sanity checks and length checks

[user/henk/code/inspircd.git] / include / modules.h

diff --git a/include/modules.h b/include/modules.h
index b26554d563e698621ebb3a01319a8f831ebdcb9d..74d7800d3813d3f629a86da2a8032f1a89631751 100644 (file)
--- a/include/modules.h
+++ b/include/modules.h
@@ -35,7 +35,26 @@ typedef file_cache string_list;
 
 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
 
+// This define is similar to the one above but returns a result in MOD_RESULT.
+// The first module to return a nonzero result is the value to be accepted,
+// and any modules after are ignored.
+
+// *********************************************************************************************
+
+#define FOREACH_RESULT(x) { MOD_RESULT = 0; \
+                       for (int i = 0; i <= MODCOUNT; i++) { \
+                       int res = modules[i]->x ; \
+                       if (res) { \
+                               MOD_RESULT = res; \
+                               break; \
+                       } \
+               } \
+   } 
+   
+// *********************************************************************************************
+
 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
+extern void server_mode(char **parameters, int pcnt, userrec *user);
 
 // class Version holds the version information of a Module, returned
 // by Module::GetVersion (thanks RD)
@@ -116,7 +135,7 @@ class Module : public classbase
         * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
         * and will be called before ANY other operations within the ircd core program.
         */
-       virtual void Module::OnPacketTransmit(char *p);
+       virtual void OnPacketTransmit(char *p);
 
        /** Called after a packet is received from another irc server.
         * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
@@ -125,7 +144,7 @@ class Module : public classbase
         * and will be called immediately after the packet is received but before any other operations with the
         * core of the ircd.
         */
-       virtual void Module::OnPacketReceive(char *p);
+       virtual void OnPacketReceive(char *p);
 
        /** Called on rehash.
         * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
@@ -151,7 +170,21 @@ class Module : public classbase
         * If the mode is not a channel mode, chanrec* chan is null, and should not be read from or written to.
         */
        virtual bool OnExtendedMode(userrec* user, chanrec* chan, char modechar, int type, bool mode_on, string_list &params);
-        
+       
+       /** Called whenever a user is about to join a channel, before any processing is done.
+        * Returning any nonzero value from this function stops the process immediately, causing no
+        * output to be sent to the user by the core. If you do this you must produce your own numerics,
+        * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.
+        *
+        * IMPORTANT NOTE!
+        *
+        * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
+        * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
+        * processing on the actual channel record at this point, however the channel NAME will still be passed in
+        * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
+        */
+       virtual int Module::OnUserPreJoin(userrec* user, chanrec* chan, char* cname);
+ 
 };
 
 
@@ -291,6 +324,28 @@ class Server : public classbase
         */
        virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
         
+       /** Sends a servermode.
+        * you must format the parameters array with the target, modes and parameters for those modes.
+        *
+        * For example:
+        *
+        * char *modes[3];
+        *
+        * modes[0] = ChannelName;
+        *
+        * modes[1] = "+o";
+        *
+        * modes[2] = user->nick;
+        *
+        * Srv->SendMode(modes,3,user);
+        *
+        * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
+        * will be sent to the user you provide as the third parameter.
+        * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
+        * your server in an unstable state!
+        */
+
+       virtual void SendMode(char **parameters, int pcnt, userrec *user);
 };
 
 /** Allows reading of values from configuration files