]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/u_listmode.h
Change std::pair<bool,std::string> to neater typedef "ModePair"
[user/henk/code/inspircd.git] / include / u_listmode.h
index f016253f9338aa5b1a39ed572b94444b6cfd9c4c..b656196e9a476388c9663b807d976b83ba8fba00 100644 (file)
@@ -25,7 +25,7 @@ inline std::string stringtime()
        return TIME.str();
 }
 
-class ListItem
+class ListItem : public classbase
 {
 public:
        std::string nick;
@@ -33,7 +33,7 @@ public:
        std::string time;
 };
 
-class ListLimit
+class ListLimit : public classbase
 {
 public:
        std::string mask;
@@ -47,30 +47,47 @@ typedef std::vector<ListLimit> limitlist;
 class ListModeBase : public ModeHandler
 {
  protected:
+       Server* Srv;
        std::string infokey;
        std::string listnumeric;
        std::string endoflistnumeric;
        std::string endofliststring;
+       bool tidy;
+       std::string configtag;
        limitlist chanlimits;
-
-       Server* Srv;
-       ConfigReader* Conf;
  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)
+       ListModeBase(Server* serv, char modechar, const std::string &eolstr, const std::string &lnum, const std::string &eolnum, bool autotidy, const std::string &ctag = "banlist")
+       : ModeHandler(modechar, 1, 1, true, MODETYPE_CHANNEL, false), Srv(serv), listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy), configtag(ctag)
        {
-               Srv = serv;
-               Conf = new ConfigReader;
-               mode = modechar;
-               listnumeric = lnum;
-               endoflistnumeric = eolnum;
-               endofliststring = eolstr;
                this->DoRehash();
                infokey = "exceptionbase_mode_" + std::string(1, mode) + "_list";
        }
 
+        std::pair<bool,std::string> ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter)
+        {
+               log(DEBUG,"ListMode: ModeSet()");
+               modelist* el;
+               channel->GetExt(infokey, el);
+               if (el)
+               {
+                       for (modelist::iterator it = el->begin(); it != el->end(); it++)
+                       {
+                               if(parameter == it->mask)
+                               {
+                                       log(DEBUG,"Found item %s",parameter.c_str());
+                                       return std::make_pair(true, parameter);
+                               }
+                       }
+               }
+               log(DEBUG,"Didnt find item %s",parameter.c_str());
+               return std::make_pair(false, parameter);
+        }
+
        virtual void DisplayList(userrec* user, chanrec* channel)
        {
-               modelist* el = (modelist*)channel->GetExt(infokey);
+               modelist* el;
+               channel->GetExt(infokey, el);
                if (el)
                {
                        for(modelist::iterator it = el->begin(); it != el->end(); it++)
@@ -83,26 +100,25 @@ class ListModeBase : public ModeHandler
 
        virtual void DoRehash()
        {
-               delete Conf;
-               Conf = new ConfigReader;
+               ConfigReader Conf;
 
                chanlimits.clear();
 
-               for(int i = 0; i < Conf->Enumerate("banlist"); i++)
+               for(int i = 0; i < Conf.Enumerate(configtag); i++)
                {
                        // For each <banlist> tag
                        ListLimit limit;
-                       limit.mask = Conf->ReadValue("banlist", "chan", i);
-                       limit.limit = Conf->ReadInteger("banlist", "limit", i, true);
+                       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);
-                               log(DEBUG, "m_exceptionbase.so: Read channel listmode limit of %u for mask '%s'", limit.limit, limit.mask.c_str());
+                               log(DEBUG, "Read channel listmode limit of %u for mask '%s'", limit.limit, limit.mask.c_str());
                        }
                        else
                        {
-                               log(DEBUG, "m_exceptionbase.so: Invalid tag");
+                               log(DEBUG, "Invalid tag");
                        }
                }
                if(chanlimits.size() == 0)
@@ -116,13 +132,14 @@ class ListModeBase : public ModeHandler
 
        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 ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
        {
                // Try and grab the list
-               modelist* el = (modelist*)channel->GetExt(infokey);
+               modelist* el;
+               channel->GetExt(infokey, el);
 
                if (adding)
                {
@@ -131,19 +148,22 @@ class ListModeBase : public ModeHandler
                        {
                                // Make one
                                el = new modelist;
-                               channel->Extend(infokey, (char*)el);
+                               channel->Extend(infokey, el);
                        }
 
                        // Clean the mask up
-                       ModeParser::CleanMask(parameter);
+                       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
-                                       parameter = "";
                                        return MODEACTION_DENY;
                                }
                        }
@@ -158,22 +178,44 @@ class ListModeBase : public ModeHandler
                                        maxsize = el->size();
                                        if (maxsize < it->limit)
                                        {
-                                               // And now add the mask onto the list...
-                                               ListItem e;
-                                               e.mask = parameter;
-                                               e.nick = source->nick;
-                                               e.time = stringtime();
+                                               /* 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 = source->nick;
+                                                       e.time = stringtime();
 
-                                               el->push_back(e);
-                                               return MODEACTION_ALLOW;
+                                                       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
-                       WriteServ(source->fd, "478 %s %s %s :Channel ban/ignore list is full", source->nick, channel->name, parameter.c_str());
+                       /* List is full, give subclass a chance to send a custom message */
+                       if(!TellListTooLong(source, channel, parameter))
+                       {
+                               WriteServ(source->fd, "478 %s %s %s :Channel ban/ignore list is full", source->nick, channel->name, parameter.c_str());
+                       }
+                       
                        parameter = "";
-                       return MODEACTION_DENY;
+                       return MODEACTION_DENY; 
                }
                else
                {
@@ -192,6 +234,11 @@ class ListModeBase : public ModeHandler
                                                }
                                                return MODEACTION_ALLOW;
                                        }
+                                       else
+                                       {
+                                               /* Tried to remove something that wasn't set */
+                                               TellNotSet(source, channel, parameter);
+                                       }
                                }
                                parameter = "";
                                return MODEACTION_DENY;
@@ -213,7 +260,8 @@ class ListModeBase : public ModeHandler
 
        virtual void DoChannelDelete(chanrec* chan)
        {
-               modelist* list = (modelist*)chan->GetExt(infokey);
+               modelist* list;
+               chan->GetExt(infokey, list);
 
                if (list)
                {
@@ -224,7 +272,8 @@ class ListModeBase : public ModeHandler
 
        virtual void DoSyncChannel(chanrec* chan, Module* proto, void* opaque)
        {
-               modelist* list = (modelist*)chan->GetExt(infokey);
+               modelist* list;
+               chan->GetExt(infokey, list);
                if (list)
                {
                        for (modelist::iterator it = list->begin(); it != list->end(); it++)
@@ -240,7 +289,8 @@ class ListModeBase : public ModeHandler
                {
                        chanrec* chan = (chanrec*)item;
 
-                       modelist* list = (modelist*)chan->GetExt(infokey);
+                       modelist* list;
+                       chan->GetExt(infokey, list);
 
                        if (list)
                        {
@@ -249,6 +299,25 @@ class ListModeBase : public ModeHandler
                        }
                }
        }
+       
+       virtual bool ValidateParam(userrec* source, chanrec* channel, std::string &parameter)
+       {
+               return true;
+       }
+       
+       virtual bool TellListTooLong(userrec* source, chanrec* channel, std::string &parameter)
+       {
+               return false;
+       }
+       
+       virtual void TellAlreadyOnList(userrec* source, chanrec* channel, std::string &parameter)
+       {
+       }
+       
+       virtual void TellNotSet(userrec* source, chanrec* channel, std::string &parameter)
+       {
+               
+       }
 };
 
 #endif