]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/u_listmode.h
Include explicit parameter list in ProtocolInterface::SendMode
[user/henk/code/inspircd.git] / include / u_listmode.h
index 3b2ff13d6fc28775cfceddd24c49f7607b46547f..1e7d1cceb21f7a8e18e0a11fca76b3e8c2f68774 100644 (file)
@@ -1 +1,563 @@
-/*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef INSPIRCD_LISTMODE_PROVIDER\r#define INSPIRCD_LISTMODE_PROVIDER\r\r#include <stdio.h>\r#include <string>\r#include <sstream>\r#include <vector>\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "wildcard.h"\r#include "inspircd.h"\r\r/* Updated to use the <banlist> config tag if it exists\r * Written by Om <omster@gmail.com>, December 2005.\r * Based on code previously written by Om - April 2005\r * Updated to new API July 8th 2006 by Brain\r * Originally based on m_chanprotect and m_silence\r */\r\r/** Get the time as a string\r */\rinline std::string stringtime()\r{\r    std::ostringstream TIME;\r       TIME << time(NULL); \r   return TIME.str();\r}\r\r/** An item in a listmode's list\r */\rclass ListItem : public classbase\r{\rpublic:\r std::string nick;\r      irc::string mask;\r      std::string time;\r};\r\r/** The number of items a listmode's list may contain\r */\rclass ListLimit : public classbase\r{\rpublic:\r   std::string mask;\r      unsigned int limit;\r};\r\r/** Items stored in the channel's list\r */\rtypedef std::vector<ListItem> modelist;\r/** Max items per channel by name\r */\rtypedef std::vector<ListLimit> limitlist;\r\r/** A request used to check if a user is on a channel's list or not\r */\rclass ListModeRequest : public Request\r{\r public:\r  userrec* user;\r chanrec* chan;\r\r        /** Check if a user is on a channel's list.\r     * The Event::Send() event returns true if the user is on the channel's list.\r   * @param sender Sending module\r         * @param target Target module\r  * @param u User to check against\r       * @param c Channel to check against\r    */\r    ListModeRequest(Module* sender, Module* target, userrec* u, chanrec* c) : Request(sender, target, "LM_CHECKLIST"), user(u), chan(c)\r    {\r      }\r\r     /** Destructor\r  */\r    ~ListModeRequest()\r     {\r      }\r};\r\r/** The base class for list modes, should be inherited.\r */\rclass ListModeBase : public ModeHandler\r{\r protected:\r        /** Storage key\r         */\r    std::string infokey;\r   /** Numeric to use when outputting the list\r     */\r    std::string listnumeric;\r       /** Numeric to indicate end of list\r     */\r    std::string endoflistnumeric;\r  /** String to send for end of list\r      */\r    std::string endofliststring;\r   /** Automatically tidy up entries\r       */\r    bool tidy;\r     /** Config tag to check for max items per channel\r       */\r    std::string configtag;\r /** Limits on a per-channel basis read from the tag\r     * specified in ListModeBase::configtag\r         */\r    limitlist chanlimits;\r \r public:\r       /** Constructor.\r        * @param Instance The creator of this class\r    * @param modechar Mode character\r       * @param eolstr End of list string\r     * @pram lnum List numeric\r      * @param eolnum End of list numeric\r    * @param autotidy Automatically tidy list entries on add\r       * @param ctag Configuration tag to get limits from\r     */\r    ListModeBase(InspIRCd* Instance, char modechar, const std::string &eolstr, const std::string &lnum, const std::string &eolnum, bool autotidy, const std::string &ctag = "banlist")\r     : ModeHandler(Instance, modechar, 1, 1, true, MODETYPE_CHANNEL, false), listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy), configtag(ctag)\r  {\r              this->DoRehash();\r              infokey = "listbase_mode_" + std::string(1, mode) + "_list";\r   }\r\r     /** See mode.h \r         */\r    std::pair<bool,std::string> ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter)\r    {\r              modelist* el;\r          channel->GetExt(infokey, el);\r          if (el)\r                {\r                      for (modelist::iterator it = el->begin(); it != el->end(); it++)\r                       {\r                              if(parameter == it->mask)\r                              {\r                                      return std::make_pair(true, parameter);\r                                }\r                      }\r              }\r              return std::make_pair(false, parameter);\r       }\r\r     /** Display the list for this mode\r      * @param user The user to send the list to\r     * @param channel The channel the user is requesting the list for\r       */\r    virtual void DisplayList(userrec* user, chanrec* channel)\r      {\r              modelist* el;\r          channel->GetExt(infokey, el);\r          if (el)\r                {\r                      for (modelist::reverse_iterator it = el->rbegin(); it != el->rend(); ++it)\r                     {\r                              user->WriteServ("%s %s %s %s %s %s", listnumeric.c_str(), user->nick, channel->name, it->mask.c_str(), it->nick.c_str(), it->time.c_str());\r                    }\r              }\r              user->WriteServ("%s %s %s :%s", endoflistnumeric.c_str(), user->nick, channel->name, endofliststring.c_str());\r }\r\r     /** Remove all instances of the mode from a channel.\r    * See mode.h\r   * @param channel The channel to remove all instances of the mode from\r  */\r    virtual void RemoveMode(chanrec* channel)\r      {\r              modelist* el;\r          channel->GetExt(infokey, el);\r          if (el)\r                {\r                      irc::modestacker modestack(false);\r                     std::deque<std::string> stackresult;\r                   const char* mode_junk[MAXMODES+2];\r                     mode_junk[0] = channel->name;\r                  userrec* n = new userrec(ServerInstance);\r                      n->SetFd(FD_MAGIC_NUMBER);\r                     for (modelist::iterator it = el->begin(); it != el->end(); it++)\r                       {\r                              modestack.Push(this->GetModeChar(), assign(it->mask));\r                 }\r                      while (modestack.GetStackedLine(stackresult))\r                  {\r                              for (size_t j = 0; j < stackresult.size(); j++)\r                                {\r                                      mode_junk[j+1] = stackresult[j].c_str();\r                               }\r                              ServerInstance->SendMode(mode_junk, stackresult.size() + 1, n);         \r                       }\r\r                     delete n;\r              }\r      }\r\r     /** See mode.h\r  */\r    virtual void RemoveMode(userrec* user)\r {\r              /* Listmodes dont get set on users */\r  }\r\r     /** Perform a rehash of this mode's configuration data\r  */\r    virtual void DoRehash()\r        {\r              ConfigReader Conf(ServerInstance);\r\r            chanlimits.clear();\r\r           for (int i = 0; i < Conf.Enumerate(configtag); i++)\r            {\r                      // For each <banlist> tag\r                      ListLimit limit;\r                       limit.mask = Conf.ReadValue(configtag, "chan", i);\r                     limit.limit = Conf.ReadInteger(configtag, "limit", i, true);\r\r                  if (limit.mask.size() && limit.limit > 0)\r                              chanlimits.push_back(limit);\r           }\r              if (chanlimits.size() == 0)\r            {\r                      ListLimit limit;\r                       limit.mask = "*";\r                      limit.limit = 64;\r                      chanlimits.push_back(limit);\r           }\r      }\r\r     /** Populate the Implements list with the correct events for a List Mode\r        */\r    virtual void DoImplements(char* List)\r  {\r              List[I_OnChannelDelete] = List[I_OnSyncChannel] = List[I_OnCleanup] = List[I_OnRehash] = 1;\r    }\r\r     /** Handle the list mode.\r       * See mode.h\r   */\r    virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)\r {\r              // Try and grab the list\r               modelist* el;\r          channel->GetExt(infokey, el);\r\r         if (adding)\r            {\r                      // If there was no list\r                        if (!el)\r                       {\r                              // Make one\r                            el = new modelist;\r                             channel->Extend(infokey, el);\r                  }\r\r                     // Clean the mask up\r                   if (this->tidy)\r                                ModeParser::CleanMask(parameter);\r\r                     // Check if the item already exists in the list\r                        for (modelist::iterator it = el->begin(); it != el->end(); it++)\r                       {\r                              if (parameter == it->mask)\r                             {\r                                      /* Give a subclass a chance to error about this */\r                                     TellAlreadyOnList(source, channel, parameter);\r                                 \r                                       // it does, deny the change\r                                    return MODEACTION_DENY;\r                                }\r                      }\r\r                     unsigned int maxsize = 0;\r\r                     for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)\r                        {\r                              if (match(channel->name, it->mask.c_str()))\r                            {\r                                      // We have a pattern matching the channel...\r                                   maxsize = el->size();\r                                  if (maxsize < it->limit)\r                                       {\r                                              /* Ok, it *could* be allowed, now give someone subclassing us\r                                           * a chance to validate the parameter.\r                                          * The param is passed by reference, so they can both modify it\r                                                 * and tell us if we allow it or not.\r                                           *\r                                              * eg, the subclass could:\r                                              * 1) allow\r                                             * 2) 'fix' parameter and then allow\r                                            * 3) deny\r                                              */\r                                            if (ValidateParam(source, channel, parameter))\r                                         {\r                                                      // And now add the mask onto the list...\r                                                       ListItem e;\r                                                    e.mask = assign(parameter);\r                                                    e.nick = source->nick;\r                                                 e.time = stringtime();\r\r                                                        el->push_back(e);\r                                                      return MODEACTION_ALLOW;\r                                               }\r                                              else\r                                           {\r                                                      /* If they deny it they have the job of giving an error message */\r                                                     return MODEACTION_DENY;\r                                                }\r                                      }\r                              }\r                      }\r\r                     /* List is full, give subclass a chance to send a custom message */\r                    if (!TellListTooLong(source, channel, parameter))\r                      {\r                              source->WriteServ("478 %s %s %s :Channel ban/ignore list is full", source->nick, channel->name, parameter.c_str());\r                    }\r                      \r                       parameter = "";\r                        return MODEACTION_DENY; \r               }\r              else\r           {\r                      // We're taking the mode off\r                   if (el)\r                        {\r                              for (modelist::iterator it = el->begin(); it != el->end(); it++)\r                               {\r                                      if (parameter == it->mask)\r                                     {\r                                              el->erase(it);\r                                         if (el->size() == 0)\r                                           {\r                                                      channel->Shrink(infokey);\r                                                      delete el;\r                                             }\r                                              return MODEACTION_ALLOW;\r                                       }\r                              }\r                              /* Tried to remove something that wasn't set */\r                                TellNotSet(source, channel, parameter);\r                                parameter = "";\r                                return MODEACTION_DENY;\r                        }\r                      else\r                   {\r                              /* Hmm, taking an exception off a non-existant list, DIE */\r                            TellNotSet(source, channel, parameter);\r                                parameter = "";\r                                return MODEACTION_DENY;\r                        }\r              }\r              return MODEACTION_DENY;\r        }\r\r     /** Get Extensible key for this mode\r    */\r    virtual std::string& GetInfoKey()\r      {\r              return infokey;\r        }\r\r     /** Handle channel deletion.\r    * See modules.h.\r       * @param chan Channel being deleted\r    */\r    virtual void DoChannelDelete(chanrec* chan)\r    {\r              modelist* list;\r                chan->GetExt(infokey, list);\r\r          if (list)\r              {\r                      chan->Shrink(infokey);\r                 delete list;\r           }\r      }\r\r     /** Syncronize channel item list with another server.\r   * See modules.h\r        * @param chan Channel to syncronize\r    * @param proto Protocol module pointer\r         * @param opaque Opaque connection handle\r       */\r    virtual void DoSyncChannel(chanrec* chan, Module* proto, void* opaque)\r {\r              modelist* list;\r                chan->GetExt(infokey, list);\r           irc::modestacker modestack(true);\r              std::deque<std::string> stackresult;\r           if (list)\r              {\r                      for (modelist::iterator it = list->begin(); it != list->end(); it++)\r                   {\r                              modestack.Push(std::string(1, mode)[0], assign(it->mask));\r                     }\r              }\r              while (modestack.GetStackedLine(stackresult))\r          {\r                      irc::stringjoiner mode_join(" ", stackresult, 0, stackresult.size() - 1);\r                      std::string line = mode_join.GetJoined();\r                      proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, line);\r                }\r      }\r\r     /** Clean up module on unload\r   * @param target_type Type of target to clean\r   * @param item Item to clean\r    */\r    virtual void DoCleanup(int target_type, void* item)\r    {\r      }\r      \r       /** Validate parameters.\r        * Overridden by implementing module.\r   * @param source Source user adding the parameter\r       * @param channel Channel the parameter is being added to\r       * @param parameter The actual parameter being added\r    * @return true if the parameter is valid\r       */\r    virtual bool ValidateParam(userrec* source, chanrec* channel, std::string &parameter)\r  {\r              return true;\r   }\r      \r       /** Tell the user the list is too long.\r         * Overridden by implementing module.\r   * @param source Source user adding the parameter\r       * @param channel Channel the parameter is being added to\r       * @param parameter The actual parameter being added\r    * @return Ignored\r      */\r    virtual bool TellListTooLong(userrec* source, chanrec* channel, std::string &parameter)\r        {\r              return false;\r  }\r      \r       /** Tell the user an item is already on the list.\r       * Overridden by implementing module.\r   * @param source Source user adding the parameter\r       * @param channel Channel the parameter is being added to\r       * @param parameter The actual parameter being added\r    */\r    virtual void TellAlreadyOnList(userrec* source, chanrec* channel, std::string &parameter)\r      {\r      }\r      \r       /** Tell the user that the parameter is not in the list.\r        * Overridden by implementing module.\r   * @param source Source user removing the parameter\r     * @param channel Channel the parameter is being removed from\r   * @param parameter The actual parameter being removed\r  */\r    virtual void TellNotSet(userrec* source, chanrec* channel, std::string &parameter)\r     {\r      }\r};\r\r#endif\r\r
\ No newline at end of file
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
+ * This program is free but copyrighted software; see
+ *         the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#ifndef INSPIRCD_LISTMODE_PROVIDER
+#define INSPIRCD_LISTMODE_PROVIDER
+
+/** Get the time as a string
+ */
+inline std::string stringtime(InspIRCd* Instance)
+{
+       std::ostringstream TIME;
+       TIME << Instance->Time();
+       return TIME.str();
+}
+
+/** An item in a listmode's list
+ */
+class ListItem : public classbase
+{
+public:
+       std::string nick;
+       std::string mask;
+       std::string time;
+};
+
+/** The number of items a listmode's list may contain
+ */
+class ListLimit : public classbase
+{
+public:
+       std::string mask;
+       unsigned int limit;
+};
+
+/** Items stored in the channel's list
+ */
+typedef std::list<ListItem> modelist;
+/** Max items per channel by name
+ */
+typedef std::list<ListLimit> limitlist;
+
+/** A request used to check if a user is on a channel's list or not
+ */
+class ListModeRequest : public Request
+{
+ public:
+       User* user;
+       std::string literal;
+       const char extban;
+       Channel* chan;
+
+       /** Check if a user is on a channel's list.
+        * The Event::Send() event returns the ban string if the user is on the channel's list,
+        * or NULL if the user is not on the list.
+        * @param sender Sending module
+        * @param target Target module
+        * @param u User to check against
+        * @param c Channel to check against
+        */
+       ListModeRequest(Module* sender, Module* target, User* u, Channel* c) : Request(sender, target, "LM_CHECKLIST"), user(u), literal(""), extban(0), chan(c)
+       {
+       }
+
+       /** Check if a literal string is on a channel's list, optionally using an extban char.
+        * The Event::Send() event returns the ban string if the user is on the channel's list,
+        * or NULL if the user is not on the list.
+        * @param sender Sending module
+        * @param target Target module
+        * @param literalstr String to check against, e.g. "Bob!Bobbertson@weeblshouse"
+        * @param extbanchar Extended ban character to use for the match, or a null char if not using extban
+        */
+       ListModeRequest(Module* sender, Module* target, std::string literalstr, char extbanchar, Channel* channel) : Request(sender, target, "LM_CHECKLIST_EX"), user(NULL), literal(literalstr), extban(extbanchar), chan(channel)
+       {
+       }
+
+       /** Check if a literal string is on a channel's list, optionally using an extban char.
+        * The Event::Send() event returns the ban string if the user is on the channel's list,
+        * or NULL if the user is not on the list.
+        * @param sender Sending module
+        * @param target Target module
+        * @param User to check against, e.g. "Bob!Bobbertson@weeblshouse"
+        * @param extbanchar Extended ban character to use for the match, or a null char if not using extban
+        */
+       ListModeRequest(Module* sender, Module* target, User* u, char extbanchar, Channel* channel) : Request(sender, target, "LM_CHECKLIST_EX"), user(u), literal(""), extban(extbanchar), chan(channel)
+       {
+       }
+
+       /** Destructor
+        */
+       ~ListModeRequest()
+       {
+       }
+};
+
+/** The base class for list modes, should be inherited.
+ */
+class ListModeBase : public ModeHandler
+{
+ protected:
+       /** Storage key
+        */
+       std::string infokey;
+       /** Numeric to use when outputting the list
+        */
+       unsigned int listnumeric;
+       /** Numeric to indicate end of list
+        */
+       unsigned int endoflistnumeric;
+       /** String to send for end of list
+        */
+       std::string endofliststring;
+       /** Automatically tidy up entries
+        */
+       bool tidy;
+       /** Config tag to check for max items per channel
+        */
+       std::string configtag;
+       /** Limits on a per-channel basis read from the tag
+        * specified in ListModeBase::configtag
+        */
+       limitlist chanlimits;
+
+ public:
+       /** Constructor.
+        * @param Instance The creator of this class
+        * @param modechar Mode character
+        * @param eolstr End of list string
+        * @pram lnum List numeric
+        * @param eolnum End of list numeric
+        * @param autotidy Automatically tidy list entries on add
+        * @param ctag Configuration tag to get limits from
+        */
+       ListModeBase(InspIRCd* Instance, char modechar, const std::string &eolstr, unsigned int lnum, unsigned int eolnum, bool autotidy, const std::string &ctag = "banlist")
+       : ModeHandler(Instance, modechar, 1, 1, true, MODETYPE_CHANNEL, false), listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy), configtag(ctag)
+       {
+               this->DoRehash();
+               infokey = "listbase_mode_" + std::string(1, mode) + "_list";
+       }
+
+       /** See mode.h
+        */
+       std::pair<bool,std::string> ModeSet(User*, User*, Channel* channel, const std::string &parameter)
+       {
+               modelist* el;
+               channel->GetExt(infokey, el);
+               if (el)
+               {
+                       for (modelist::iterator it = el->begin(); it != el->end(); it++)
+                       {
+                               if(parameter == it->mask)
+                               {
+                                       return std::make_pair(true, parameter);
+                               }
+                       }
+               }
+               return std::make_pair(false, parameter);
+       }
+
+       /** Display the list for this mode
+        * @param user The user to send the list to
+        * @param channel The channel the user is requesting the list for
+        */
+       virtual void DisplayList(User* user, Channel* channel)
+       {
+               modelist* el;
+               channel->GetExt(infokey, el);
+               if (el)
+               {
+                       for (modelist::reverse_iterator it = el->rbegin(); it != el->rend(); ++it)
+                       {
+                               user->WriteNumeric(listnumeric, "%s %s %s %s %s", user->nick.c_str(), channel->name.c_str(), it->mask.c_str(), (it->nick.length() ? it->nick.c_str() : ServerInstance->Config->ServerName), it->time.c_str());
+                       }
+               }
+               user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
+       }
+
+       virtual void DisplayEmptyList(User* user, Channel* channel)
+       {
+               user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
+       }
+
+       /** Remove all instances of the mode from a channel.
+        * See mode.h
+        * @param channel The channel to remove all instances of the mode from
+        */
+       virtual void RemoveMode(Channel* channel, irc::modestacker* stack)
+       {
+               modelist* el;
+               channel->GetExt(infokey, el);
+               if (el)
+               {
+                       irc::modestacker modestack(ServerInstance, false);
+                       std::deque<std::string> stackresult;
+                       std::vector<std::string> mode_junk;
+                       mode_junk.push_back(channel->name);
+
+                       for (modelist::iterator it = el->begin(); it != el->end(); it++)
+                       {
+                               if (stack)
+                                       stack->Push(this->GetModeChar(), it->mask);
+                               else
+                                       modestack.Push(this->GetModeChar(), it->mask);
+                       }
+
+                       if (stack)
+                               return;
+
+                       while (modestack.GetStackedLine(stackresult))
+                       {
+                               for (size_t j = 0; j < stackresult.size(); j++)
+                               {
+                                       mode_junk.push_back(stackresult[j]);
+                               }
+
+                               ServerInstance->SendMode(mode_junk, ServerInstance->FakeClient);
+                       }
+               }
+       }
+
+       /** See mode.h
+        */
+       virtual void RemoveMode(User*, irc::modestacker* stack)
+       {
+               /* Listmodes dont get set on users */
+       }
+
+       /** Perform a rehash of this mode's configuration data
+        */
+       virtual void DoRehash()
+       {
+               ConfigReader Conf(ServerInstance);
+
+               chanlimits.clear();
+
+               for (int i = 0; i < Conf.Enumerate(configtag); i++)
+               {
+                       // For each <banlist> tag
+                       ListLimit limit;
+                       limit.mask = Conf.ReadValue(configtag, "chan", i);
+                       limit.limit = Conf.ReadInteger(configtag, "limit", i, true);
+
+                       if (limit.mask.size() && limit.limit > 0)
+                               chanlimits.push_back(limit);
+               }
+               if (chanlimits.size() == 0)
+               {
+                       ListLimit limit;
+                       limit.mask = "*";
+                       limit.limit = 64;
+                       chanlimits.push_back(limit);
+               }
+       }
+
+       /** Populate the Implements list with the correct events for a List Mode
+        */
+       virtual void DoImplements(Module* m)
+       {
+               Implementation eventlist[] = { I_OnChannelDelete, I_OnSyncChannel, I_OnCleanup, I_OnRehash, I_OnRequest };
+               ServerInstance->Modules->Attach(eventlist, m, 5);
+       }
+
+       /** Handle the list mode.
+        * See mode.h
+        */
+       virtual ModeAction OnModeChange(User* source, User*, Channel* channel, std::string &parameter, bool adding, bool servermode)
+       {
+               // Try and grab the list
+               modelist* el;
+               channel->GetExt(infokey, el);
+
+               if (adding)
+               {
+                       // If there was no list
+                       if (!el)
+                       {
+                               // Make one
+                               el = new modelist;
+                               channel->Extend(infokey, el);
+                       }
+
+                       // Clean the mask up
+                       if (this->tidy)
+                               ModeParser::CleanMask(parameter);
+
+                       // Check if the item already exists in the list
+                       for (modelist::iterator it = el->begin(); it != el->end(); it++)
+                       {
+                               if (parameter == it->mask)
+                               {
+                                       /* Give a subclass a chance to error about this */
+                                       TellAlreadyOnList(source, channel, parameter);
+
+                                       // it does, deny the change
+                                       return MODEACTION_DENY;
+                               }
+                       }
+
+                       unsigned int maxsize = 0;
+
+                       for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
+                       {
+                               if (InspIRCd::Match(channel->name, it->mask))
+                               {
+                                       // We have a pattern matching the channel...
+                                       maxsize = el->size();
+                                       if (IS_LOCAL(source) || (maxsize < it->limit))
+                                       {
+                                               /* Ok, it *could* be allowed, now give someone subclassing us
+                                                * a chance to validate the parameter.
+                                                * The param is passed by reference, so they can both modify it
+                                                * and tell us if we allow it or not.
+                                                *
+                                                * eg, the subclass could:
+                                                * 1) allow
+                                                * 2) 'fix' parameter and then allow
+                                                * 3) deny
+                                                */
+                                               if (ValidateParam(source, channel, parameter))
+                                               {
+                                                       // And now add the mask onto the list...
+                                                       ListItem e;
+                                                       e.mask = parameter;
+                                                       e.nick = servermode ? ServerInstance->Config->ServerName : source->nick;
+                                                       e.time = stringtime(ServerInstance);
+
+                                                       el->push_back(e);
+                                                       return MODEACTION_ALLOW;
+                                               }
+                                               else
+                                               {
+                                                       /* If they deny it they have the job of giving an error message */
+                                                       return MODEACTION_DENY;
+                                               }
+                                       }
+                               }
+                       }
+
+                       /* List is full, give subclass a chance to send a custom message */
+                       if (!TellListTooLong(source, channel, parameter))
+                       {
+                               source->WriteNumeric(478, "%s %s %s :Channel ban/ignore list is full", source->nick.c_str(), channel->name.c_str(), parameter.c_str());
+                       }
+
+                       parameter = "";
+                       return MODEACTION_DENY;
+               }
+               else
+               {
+                       // We're taking the mode off
+                       if (el)
+                       {
+                               for (modelist::iterator it = el->begin(); it != el->end(); it++)
+                               {
+                                       if (parameter == it->mask)
+                                       {
+                                               el->erase(it);
+                                               if (el->size() == 0)
+                                               {
+                                                       channel->Shrink(infokey);
+                                                       delete el;
+                                               }
+                                               return MODEACTION_ALLOW;
+                                       }
+                               }
+                               /* Tried to remove something that wasn't set */
+                               TellNotSet(source, channel, parameter);
+                               parameter = "";
+                               return MODEACTION_DENY;
+                       }
+                       else
+                       {
+                               /* Hmm, taking an exception off a non-existant list, DIE */
+                               TellNotSet(source, channel, parameter);
+                               parameter = "";
+                               return MODEACTION_DENY;
+                       }
+               }
+               return MODEACTION_DENY;
+       }
+
+       /** Get Extensible key for this mode
+        */
+       virtual std::string& GetInfoKey()
+       {
+               return infokey;
+       }
+
+       /** Handle channel deletion.
+        * See modules.h.
+        * @param chan Channel being deleted
+        */
+       virtual void DoChannelDelete(Channel* chan)
+       {
+               modelist* mlist;
+               chan->GetExt(infokey, mlist);
+
+               if (mlist)
+               {
+                       chan->Shrink(infokey);
+                       delete mlist;
+               }
+       }
+
+       /** Syncronize channel item list with another server.
+        * See modules.h
+        * @param chan Channel to syncronize
+        * @param proto Protocol module pointer
+        * @param opaque Opaque connection handle
+        */
+       virtual void DoSyncChannel(Channel* chan, Module* proto, void* opaque)
+       {
+               modelist* mlist;
+               chan->GetExt(infokey, mlist);
+               irc::modestacker modestack(ServerInstance, true);
+               std::deque<std::string> stackresult;
+               std::deque<TranslateType> types;
+               types.push_back(TR_TEXT);
+               if (mlist)
+               {
+                       for (modelist::iterator it = mlist->begin(); it != mlist->end(); it++)
+                       {
+                               modestack.Push(std::string(1, mode)[0], it->mask);
+                       }
+               }
+               while (modestack.GetStackedLine(stackresult))
+               {
+                       types.assign(stackresult.size(), this->GetTranslateType());
+                       proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, stackresult, types);
+               }
+       }
+
+       /** Clean up module on unload
+        * @param target_type Type of target to clean
+        * @param item Item to clean
+        */
+       virtual void DoCleanup(int, void*)
+       {
+       }
+
+       /** Validate parameters.
+        * Overridden by implementing module.
+        * @param source Source user adding the parameter
+        * @param channel Channel the parameter is being added to
+        * @param parameter The actual parameter being added
+        * @return true if the parameter is valid
+        */
+       virtual bool ValidateParam(User*, Channel*, std::string&)
+       {
+               return true;
+       }
+
+       /** Tell the user the list is too long.
+        * Overridden by implementing module.
+        * @param source Source user adding the parameter
+        * @param channel Channel the parameter is being added to
+        * @param parameter The actual parameter being added
+        * @return Ignored
+        */
+       virtual bool TellListTooLong(User*, Channel*, std::string&)
+       {
+               return false;
+       }
+
+       /** Tell the user an item is already on the list.
+        * Overridden by implementing module.
+        * @param source Source user adding the parameter
+        * @param channel Channel the parameter is being added to
+        * @param parameter The actual parameter being added
+        */
+       virtual void TellAlreadyOnList(User*, Channel*, std::string&)
+       {
+       }
+
+       /** Tell the user that the parameter is not in the list.
+        * Overridden by implementing module.
+        * @param source Source user removing the parameter
+        * @param channel Channel the parameter is being removed from
+        * @param parameter The actual parameter being removed
+        */
+       virtual void TellNotSet(User*, Channel*, std::string&)
+       {
+       }
+
+       virtual const char* DoOnRequest(Request* request)
+       {
+               ListModeRequest* LM = (ListModeRequest*)request;
+               if (strcmp("LM_CHECKLIST", request->GetId()) == 0)
+               {
+                       modelist* mlist;
+                       LM->chan->GetExt(GetInfoKey(), mlist);
+                       if (mlist)
+                       {
+                               std::string mask = LM->user->nick + "!" + LM->user->ident + "@" + LM->user->GetIPString();
+                               for (modelist::iterator it = mlist->begin(); it != mlist->end(); ++it)
+                               {
+                                       if (InspIRCd::Match(LM->user->GetFullRealHost(), it->mask) || InspIRCd::Match(LM->user->GetFullHost(), it->mask) || (InspIRCd::MatchCIDR(mask, it->mask)))
+                                               return it->mask.c_str();
+                               }
+                               return NULL;
+                       }
+               }
+               else if (strcmp("LM_CHECKLIST_EX", request->GetId()) == 0)
+               {
+                       modelist* mlist;
+                       LM->chan->GetExt(GetInfoKey(), mlist);
+
+                       if (mlist)
+                       {
+                               if (LM->user)
+                               {
+                                       LM->literal = LM->user->nick + "!" + LM->user->ident + "@" + LM->user->GetIPString();
+                               }
+
+                               for (modelist::iterator it = mlist->begin(); it != mlist->end(); it++)
+                               {
+                                       if (LM->extban && it->mask.length() > 1 && it->mask[0] == LM->extban && it->mask[1] == ':')
+                                       {
+                                               std::string ext = it->mask.substr(2);
+                                               if (LM->user)
+                                               {
+                                                       if (InspIRCd::Match(LM->user->GetFullRealHost(), ext) || InspIRCd::Match(LM->user->GetFullHost(), ext) || (InspIRCd::MatchCIDR(LM->literal, ext)))
+                                                       {
+                                                               return it->mask.c_str();
+                                                       }
+                                               }
+                                               else if (InspIRCd::Match(LM->literal, ext))
+                                               {
+                                                       return it->mask.c_str();
+                                               }
+                                       }
+                                       else
+                                       {
+                                               if (LM->user)
+                                               {
+                                                       if (InspIRCd::Match(LM->user->GetFullRealHost(), it->mask) || InspIRCd::Match(LM->user->GetFullHost(), it->mask) || (InspIRCd::MatchCIDR(LM->literal, it->mask)))
+                                                       {
+                                                               return it->mask.c_str();
+                                                       }
+                                               }
+                                               else if (InspIRCd::Match(LM->literal, it->mask))
+                                               {
+                                                       return it->mask.c_str();
+                                               }
+                                       }
+                               }
+                       }
+               }
+               return NULL;
+       }
+
+};
+
+#endif