#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "helperfuncs.h"
+
+#include "wildcard.h"
+#include "inspircd.h"
/* $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()
return TIME.str();
}
-class ListItem
+class ListItem : public classbase
{
public:
std::string nick;
std::string time;
};
-class ListLimit
+class ListLimit : public classbase
{
public:
std::string mask;
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;
std::string endofliststring;
+ bool tidy;
+ std::string configtag;
limitlist chanlimits;
-
- Server* Srv;
- ConfigReader* Conf;
-public:
- ListModeBaseModule(Server* serv, char modechar, std::string eolstr, std::string lnum, std::string eolnum) : Module::Module(serv)
+
+ public:
+ ListModeBase(InspIRCd* Instance, char modechar, const std::string &eolstr, const std::string &lnum, const std::string &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)
{
- Srv = serv;
- Conf = new ConfigReader;
- mode = modechar;
- 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)
+
+ std::pair<bool,std::string> ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter)
+ {
+ 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);
+ }
+
+ virtual void DisplayList(userrec* user, chanrec* channel)
{
- delete Conf;
- Conf = new ConfigReader;
-
+ modelist* el;
+ channel->GetExt(infokey, el);
+ if (el)
+ {
+ for(modelist::iterator it = el->begin(); it != el->end(); it++)
+ {
+ 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());
+ }
+ }
+ user->WriteServ( "%s %s %s %s", endoflistnumeric.c_str(), user->nick, channel->name, endofliststring.c_str());
+ }
+
+ virtual void DoRehash()
+ {
+ ConfigReader Conf(ServerInstance);
+
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());
- }
- else
- {
- log(DEBUG, "m_exceptionbase.so: Invalid tag");
- }
}
-
if(chanlimits.size() == 0)
{
ListLimit limit;
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 ¶ms)
+
+ virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
{
- // First, check it's our mode
- if ((modechar == mode) && (type == MT_CHANNEL))
+ // Try and grab the list
+ modelist* el;
+ channel->GetExt(infokey, el);
+
+ 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, el);
+ }
- // Try and grab the list
- modelist* el = (modelist*)chan->GetExt(infokey);
+ // Clean the mask up
+ if (this->tidy)
+ 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;
- }
+ /* Give a subclass a chance to error about this */
+ TellAlreadyOnList(source, channel, parameter);
- for (modelist::iterator it = el->begin(); it != el->end(); it++)
- {
- Srv->Log(DEBUG, "m_exceptionbase.so: Iterating over exception list, current mask: " + it->mask);
- if(params[0] == it->mask)
- {
- Srv->Log(DEBUG, "m_exceptionbase.so: Someone tried to set an exception which was already set, returning -1");
- return -1;
- }
+ // it does, deny the change
+ return MODEACTION_DENY;
}
-
- unsigned int maxsize = 0;
-
- for(limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
+ }
+
+ unsigned int maxsize = 0;
+
+ for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
+ {
+ if (match(channel->name, it->mask.c_str()))
{
- if(Srv->MatchText(chan->name, it->mask))
+ // We have a pattern matching the channel...
+ maxsize = el->size();
+ if (maxsize < it->limit)
{
- // We have a pattern matching the channel...
- maxsize = el->size();
- if(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 = params[0];
- e.nick = user->nick;
+ e.mask = parameter;
+ e.nick = source->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;
+ return MODEACTION_ALLOW;
+ }
+ else
+ {
+ /* If they deny it they have the job of giving an error message */
+ return MODEACTION_DENY;
}
}
}
+ }
- // 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;
+ /* List is full, give subclass a chance to send a custom message */
+ if(!TellListTooLong(source, channel, parameter))
+ {
+ source->WriteServ("478 %s %s %s :Channel ban/ignore list is full", source->nick, channel->name, parameter.c_str());
}
- else
- {
- // We're taking the mode off
- if(el)
+
+ parameter = "";
+ return MODEACTION_DENY;
+ }
+ else
+ {
+ // We're taking the mode off
+ if (el)
+ {
+ for (modelist::iterator it = el->begin(); it != el->end(); it++)
{
- for (modelist::iterator it = el->begin(); it != el->end(); it++)
+ if(parameter == it->mask)
{
- Srv->Log(DEBUG, "m_exceptionbase.so: Removing mode, iterating over exception list, current mask: " + it->mask);
- if(params[0] == it->mask)
+ el->erase(it);
+ if(el->size() == 0)
{
- 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;
+ channel->Shrink(infokey);
+ delete el;
}
+ return MODEACTION_ALLOW;
+ }
+ else
+ {
+ /* Tried to remove something that wasn't set */
+ TellNotSet(source, channel, parameter);
}
- 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;
}
+ parameter = "";
+ return MODEACTION_DENY;
}
- }
-
- return 0;
- }
-
- virtual void OnSendList(userrec* user, chanrec* chan, char modechar)
- {
- 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)
+ else
{
- 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());
- }
+ // Hmm, taking an exception off a non-existant list, DIE
+ parameter = "";
+ return MODEACTION_DENY;
}
-
- WriteServ(user->fd, "%s %s %s %s", endoflistnumeric.c_str(), user->nick, chan->name, endofliststring.c_str());
}
+ return MODEACTION_DENY;
}
- virtual void OnChannelDelete(chanrec* chan)
+ virtual std::string& GetInfoKey()
{
- modelist* list = (modelist*)chan->GetExt(infokey);
-
- if(list)
+ return infokey;
+ }
+
+ virtual void DoChannelDelete(chanrec* chan)
+ {
+ modelist* list;
+ chan->GetExt(infokey, 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;
+ chan->GetExt(infokey, list);
+ 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)
+
+ modelist* list;
+ chan->GetExt(infokey, list);
+
+ if (list)
{
chan->Shrink(infokey);
delete list;
}
}
}
+
+ virtual bool ValidateParam(userrec* source, chanrec* channel, std::string ¶meter)
+ {
+ return true;
+ }
+
+ virtual bool TellListTooLong(userrec* source, chanrec* channel, std::string ¶meter)
+ {
+ return false;
+ }
+
+ virtual void TellAlreadyOnList(userrec* source, chanrec* channel, std::string ¶meter)
+ {
+ }
+
+ virtual void TellNotSet(userrec* source, chanrec* channel, std::string ¶meter)
+ {
+
+ }
};
#endif
projects / user / henk / code / inspircd.git / blobdiff