]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/u_listmode.h
Did some renaming so that the methods for modes in chanrec and userrec are identical.
[user/henk/code/inspircd.git] / include / u_listmode.h
index 233dd5310d29b5809546d69a5264ffba77a78b68..32206199145c0c6daf0f3b3ac8e45963fc941930 100644 (file)
 
 /* $ModDesc: Provides support for easily creating listmodes, stores the time set, the user, and a parameter. */
 
+/* Updated to use the <banlist> config tag if it exists */
 /* Written by Om <omster@gmail.com>, December 2005. */
 /* Based on code previously written by Om - April 2005 */
+/* Updated to new API July 8th 2006 by Brain */
 /* Originally based on m_chanprotect and m_silence */
 
 inline std::string stringtime()
@@ -38,14 +40,13 @@ public:
        unsigned int limit;
 };
 
-// Just defining the type we use for the excpetion list here...
+// Just defining the type we use for the exception list here...
 typedef std::vector<ListItem> modelist;
 typedef std::vector<ListLimit> limitlist;
 
-class ListModeBaseModule : public Module
+class ListModeBase : public ModeHandler
 {
-protected:
-       char mode;
+ protected:
        std::string infokey;
        std::string listnumeric;
        std::string endoflistnumeric;
@@ -54,8 +55,8 @@ protected:
 
        Server* Srv;
        ConfigReader* Conf;
-public:
-       ListModeBaseModule(Server* serv, char modechar, std::string eolstr, std::string lnum, std::string eolnum) : Module::Module(serv)
+ public:
+       ListModeBase(Server* serv, char modechar, const std::string &eolstr, const std::string &lnum, const std::string &eolnum) : ModeHandler(modechar, 1, 1, true, MODETYPE_CHANNEL, false)
        {
                Srv = serv;
                Conf = new ConfigReader;
@@ -63,26 +64,37 @@ public:
                listnumeric = lnum;
                endoflistnumeric = eolnum;
                endofliststring = eolstr;
-               
-               OnRehash("");
+               this->DoRehash();
                infokey = "exceptionbase_mode_" + std::string(1, mode) + "_list";
-               Srv->AddExtendedListMode(modechar);             
        }
-       
-       virtual void OnRehash(std::string param)
+
+       virtual void DisplayList(userrec* user, chanrec* channel)
+       {
+               modelist* el = (modelist*)channel->GetExt(infokey);
+               if (el)
+               {
+                       for(modelist::iterator it = el->begin(); it != el->end(); it++)
+                       {
+                               WriteServ(user->fd, "%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());
+                       }
+               }
+               WriteServ(user->fd, "%s %s %s %s", endoflistnumeric.c_str(), user->nick, channel->name, endofliststring.c_str());
+       }
+
+       virtual void DoRehash()
        {
                delete Conf;
                Conf = new ConfigReader;
-               
+
                chanlimits.clear();
-               
+
                for(int i = 0; i < Conf->Enumerate("banlist"); i++)
                {
                        // For each <banlist> tag
                        ListLimit limit;
                        limit.mask = Conf->ReadValue("banlist", "chan", i);
                        limit.limit = Conf->ReadInteger("banlist", "limit", i, true);
-                       
+
                        if(limit.mask.size() && limit.limit > 0)
                        {
                                chanlimits.push_back(limit);
@@ -93,7 +105,6 @@ public:
                                log(DEBUG, "m_exceptionbase.so: Invalid tag");
                        }
                }
-               
                if(chanlimits.size() == 0)
                {
                        ListLimit limit;
@@ -102,164 +113,136 @@ public:
                        chanlimits.push_back(limit);
                }
        }
-       
-       void DoImplements(char* List)
+
+       virtual void DoImplements(char* List)
        {
-               List[I_OnExtendedMode] = List[I_OnSendList] = List[I_OnChannelDelete] = List[I_OnSyncChannel] = List[I_OnCleanup] = List[I_OnRehash] = 1;
+               List[I_OnChannelDelete] = List[I_OnSyncChannel] = List[I_OnCleanup] = List[I_OnRehash] = 1;
        }
-       
-       virtual int OnExtendedMode(userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)
+
+       virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
        {
-               // First, check it's our mode
-               if ((modechar == mode) && (type == MT_CHANNEL))
+               // Try and grab the list
+               modelist* el = (modelist*)channel->GetExt(infokey);
+
+               if (adding)
                {
-                       Srv->Log(DEBUG, "m_exceptionbase.so: General listmode handler called, handling mode '" + std::string(1, mode) + "'");
-                       chanrec* chan = (chanrec*)target;
+                       // If there was no list
+                       if (!el)
+                       {
+                               // Make one
+                               el = new modelist;
+                               channel->Extend(infokey, (char*)el);
+                       }
 
-                       // Try and grab the list
-                       modelist* el = (modelist*)chan->GetExt(infokey);
+                       // Clean the mask up
+                       ModeParser::CleanMask(parameter);
 
-                       if(mode_on)
+                       // Check if the item already exists in the list
+                       for (modelist::iterator it = el->begin(); it != el->end(); it++)
                        {
-                               // If there was no list
-                               if(!el)
+                               if(parameter == it->mask)
                                {
-                                       // Make one
-                                       Srv->Log(DEBUG, "m_exceptionbase.so: Creating new list");
-                                       el = new modelist;
-                                       chan->Extend(infokey, (char*)el);
-                               }
-                               
-                               if(!Srv->IsValidMask(params[0]))
-                               {       
-                                       Srv->Log(DEBUG, "m_exceptionbase.so: Banmask was invalid, returning -1");
-                                       return -1;
+                                       // it does, deny the change
+                                       parameter = "";
+                                       return MODEACTION_DENY;
                                }
-                                       
-                               for (modelist::iterator it = el->begin(); it != el->end(); it++)
+                       }
+
+                       unsigned int maxsize = 0;
+
+                       for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
+                       {
+                               if (Srv->MatchText(channel->name, it->mask))
                                {
-                                       Srv->Log(DEBUG, "m_exceptionbase.so: Iterating over exception list, current mask: " + it->mask);
-                                       if(params[0] == it->mask)
+                                       // We have a pattern matching the channel...
+                                       maxsize = el->size();
+                                       if (maxsize < it->limit)
                                        {
-                                               Srv->Log(DEBUG, "m_exceptionbase.so: Someone tried to set an exception which was already set, returning -1");
-                                               return -1;
+                                               // And now add the mask onto the list...
+                                               ListItem e;
+                                               e.mask = parameter;
+                                               e.nick = source->nick;
+                                               e.time = stringtime();
+
+                                               el->push_back(e);
+                                               return MODEACTION_ALLOW;
                                        }
                                }
-                               
-                               unsigned int maxsize = 0;
-                               
-                               for(limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
+                       }
+
+                       // List is full
+                       WriteServ(source->fd, "478 %s %s %s :Channel ban/ignore list is full", source->nick, channel->name, 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(Srv->MatchText(chan->name, it->mask))
+                                       if(parameter == it->mask)
                                        {
-                                               // We have a pattern matching the channel...
-                                               maxsize = el->size();
-                                               if(maxsize < it->limit)
+                                               el->erase(it);
+                                               if(el->size() == 0)
                                                {
-                                                       // And now add the mask onto the list...
-                                                       ListItem e;
-                                                       e.mask = params[0];
-                                                       e.nick = user->nick;
-                                                       e.time = stringtime();
-                               
-                                                       Srv->Log(DEBUG, "m_exceptionbase.so: All checks passed, adding exception mask to list and returning 1");
-                                                       el->push_back(e);
-                                                       return 1;
+                                                       channel->Shrink(infokey);
+                                                       delete el;
                                                }
+                                               return MODEACTION_ALLOW;
                                        }
                                }
-
-                               // List is full
-                               WriteServ(user->fd, "478 %s %s %s :Channel ban/ignore list is full", user->nick, chan->name, params[0].c_str());
-                               log(DEBUG, "m_exceptionbase.so: %s tried to set mask %s on %s but the list is full (max %d)", user->nick, params[0].c_str(), chan->name, maxsize);
-                               return -1;
+                               parameter = "";
+                               return MODEACTION_DENY;
                        }
                        else
-                       {
-                               // We're taking the mode off
-                               if(el)
-                               {
-                                       for (modelist::iterator it = el->begin(); it != el->end(); it++)
-                                       {
-                                               Srv->Log(DEBUG, "m_exceptionbase.so: Removing mode, iterating over exception list, current mask: " + it->mask);
-                                               if(params[0] == it->mask)
-                                               {
-                                                       Srv->Log(DEBUG, "m_exceptionbase.so: Found match for removal of exception, removing and returning 1");
-                                                       el->erase(it);
-                                                       if(el->size() == 0)
-                                                       {
-                                                               Srv->Log(DEBUG, "m_exceptionbase.so: Erased the last entry on the exception list, removing the list");
-                                                               chan->Shrink(infokey);
-                                                               delete el;
-                                                       }
-                                                       return 1;
-                                               }
-                                       }
-                                       Srv->Log(DEBUG, "m_exceptionbase.so: No match found for attempted removing of exception, returning -1");
-                                       return -1;
-                               }
-                               else
-                               {
-                                       // Hmm, taking an exception off a non-existant list, DIE
-                                       Srv->Log(DEBUG, "m_exceptionbase.so: Attempted removal of an exception, when there was no exception list created, returning -1");
-                                       return -1;
-                               }
+                       {
+                               // Hmm, taking an exception off a non-existant list, DIE
+                               parameter = "";
+                               return MODEACTION_DENY;
                        }
                }
-               
-               return 0;
+               return MODEACTION_DENY;
        }
-       
-       virtual void OnSendList(userrec* user, chanrec* chan, char modechar)
+
+       virtual std::string& GetInfoKey()
        {
-               if(modechar == mode)
-               {
-                       modelist* el = (modelist*)chan->GetExt(infokey);
-                       Srv->Log(DEBUG, "m_exceptionbase.so: " + std::string(user->nick)+" is listing listmodes on "+std::string(chan->name));
-                       if (el)
-                       {
-                               for(modelist::iterator it = el->begin(); it != el->end(); it++)
-                               {
-                                       WriteServ(user->fd, "%s %s %s %s %s %s", listnumeric.c_str(), user->nick, chan->name, it->mask.c_str(), it->nick.c_str(), it->time.c_str());
-                               }
-                       }
-                       
-                       WriteServ(user->fd, "%s %s %s %s", endoflistnumeric.c_str(), user->nick, chan->name, endofliststring.c_str());
-               }
+               return infokey;
        }
 
-       virtual void OnChannelDelete(chanrec* chan)
+       virtual void DoChannelDelete(chanrec* chan)
        {
                modelist* list = (modelist*)chan->GetExt(infokey);
-                       
-               if(list)
+
+               if (list)
                {
                        chan->Shrink(infokey);
                        delete list;
                }
        }
-       
-       virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque)
+
+       virtual void DoSyncChannel(chanrec* chan, Module* proto, void* opaque)
        {
-               modelist* list = (modelist*)chan->GetExt(infokey);              
-               if(list)
+               modelist* list = (modelist*)chan->GetExt(infokey);
+               if (list)
                {
-                       for(modelist::iterator it = list->begin(); it != list->end(); it++)
+                       for (modelist::iterator it = list->begin(); it != list->end(); it++)
                        {
                                proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, "+" + std::string(1, mode) + " " + it->mask);
                        }
                }
        }
-       
-       virtual void OnCleanup(int target_type, void* item)
+
+       virtual void DoCleanup(int target_type, void* item)
        {
                if (target_type == TYPE_CHANNEL)
                {
                        chanrec* chan = (chanrec*)item;
-                       
+
                        modelist* list = (modelist*)chan->GetExt(infokey);
-                       
-                       if(list)
+
+                       if (list)
                        {
                                chan->Shrink(infokey);
                                delete list;