X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fu_listmode.h;h=981e2a369bbc411b5312d6f373038d9eb32c5ce6;hb=c4d6ce8c5e1802e5b834d5845e31c3adf7700585;hp=233dd5310d29b5809546d69a5264ffba77a78b68;hpb=3d2a89504ac933c87e92032c27be84b24dc4bdff;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/u_listmode.h b/include/u_listmode.h index 233dd5310..981e2a369 100644 --- a/include/u_listmode.h +++ b/include/u_listmode.h @@ -1,29 +1,31 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits + * + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + #ifndef INSPIRCD_LISTMODE_PROVIDER #define INSPIRCD_LISTMODE_PROVIDER -#include -#include -#include -#include -#include "users.h" -#include "channels.h" -#include "modules.h" -#include "helperfuncs.h" - -/* $ModDesc: Provides support for easily creating listmodes, stores the time set, the user, and a parameter. */ - -/* Written by Om , December 2005. */ -/* Based on code previously written by Om - April 2005 */ -/* Originally based on m_chanprotect and m_silence */ - +/** Get the time as a string + */ inline std::string stringtime() { std::ostringstream TIME; - TIME << time(NULL); + TIME << ServerInstance->Time(); return TIME.str(); } -class ListItem +/** An item in a listmode's list + */ +class ListItem : public classbase { public: std::string nick; @@ -31,70 +33,170 @@ public: std::string time; }; -class ListLimit +/** The number of items a listmode's list may contain + */ +class ListLimit : public classbase { public: std::string mask; unsigned int limit; }; -// Just defining the type we use for the excpetion list here... -typedef std::vector modelist; -typedef std::vector limitlist; +/** Items stored in the channel's list + */ +typedef std::list modelist; +/** Max items per channel by name + */ +typedef std::list limitlist; -class ListModeBaseModule : public Module +/** The base class for list modes, should be inherited. + */ +class ListModeBase : public ModeHandler { -protected: - char mode; - std::string infokey; - std::string listnumeric; - std::string endoflistnumeric; + protected: + /** 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; - Server* Srv; - ConfigReader* Conf; -public: - ListModeBaseModule(Server* serv, char modechar, std::string eolstr, std::string lnum, std::string eolnum) : Module::Module(serv) + public: + /** Storage key + */ + SimpleExtItem extItem; + + /** 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(Module* Creator, const std::string& Name, char modechar, const std::string &eolstr, unsigned int lnum, unsigned int eolnum, bool autotidy, const std::string &ctag = "banlist") + : ModeHandler(Creator, Name, modechar, PARAM_ALWAYS, MODETYPE_CHANNEL), + listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy), + configtag(ctag), extItem("listbase_mode_" + name + "_list", Creator) { - Srv = serv; - Conf = new ConfigReader; - mode = modechar; - listnumeric = lnum; - endoflistnumeric = eolnum; - endofliststring = eolstr; - - OnRehash(""); - infokey = "exceptionbase_mode_" + std::string(1, mode) + "_list"; - Srv->AddExtendedListMode(modechar); + list = true; + this->DoRehash(); + Extensible::Register(&extItem); } - - virtual void OnRehash(std::string param) + + /** See mode.h + */ + std::pair ModeSet(User*, User*, Channel* channel, const std::string ¶meter) { - delete Conf; - Conf = new ConfigReader; - - chanlimits.clear(); - - for(int i = 0; i < Conf->Enumerate("banlist"); i++) + modelist* el = extItem.get(channel); + if (el) { - // For each 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) + for (modelist::iterator it = el->begin(); it != el->end(); it++) { - chanlimits.push_back(limit); - log(DEBUG, "m_exceptionbase.so: Read channel listmode limit of %u for mask '%s'", limit.limit, limit.mask.c_str()); + if(parameter == it->mask) + { + return std::make_pair(true, parameter); + } } - else + } + 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 = extItem.get(channel); + 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.c_str()), 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 = extItem.get(channel); + if (el) + { + irc::modestacker modestack(false); + + 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; + + std::vector stackresult; + stackresult.push_back(channel->name); + while (modestack.GetStackedLine(stackresult)) { - log(DEBUG, "m_exceptionbase.so: Invalid tag"); + ServerInstance->SendMode(stackresult, ServerInstance->FakeClient); + stackresult.clear(); + stackresult.push_back(channel->name); } } - - if(chanlimits.size() == 0) + } + + /** 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; + + chanlimits.clear(); + + for (int i = 0; i < Conf.Enumerate(configtag); i++) + { + // For each 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 = "*"; @@ -102,169 +204,210 @@ public: chanlimits.push_back(limit); } } - - void DoImplements(char* List) + + /** Populate the Implements list with the correct events for a List Mode + */ + virtual void DoImplements(Module* m) { - List[I_OnExtendedMode] = List[I_OnSendList] = List[I_OnChannelDelete] = List[I_OnSyncChannel] = List[I_OnCleanup] = List[I_OnRehash] = 1; + Implementation eventlist[] = { I_OnChannelDelete, I_OnSyncChannel, I_OnRehash }; + ServerInstance->Modules->Attach(eventlist, m, 3); } - - virtual int OnExtendedMode(userrec *user, void *target, char modechar, int type, bool mode_on, string_list ¶ms) + + /** Handle the list mode. + * See mode.h + */ + virtual ModeAction OnModeChange(User* source, User*, Channel* 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 = extItem.get(channel); + + 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; + extItem.set(channel, 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; - } - - 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; - } + /* 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++) + } + + unsigned int maxsize = 0; + + for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++) + { + if (InspIRCd::Match(channel->name, it->mask)) { - if(Srv->MatchText(chan->name, it->mask)) + // We have a pattern matching the channel... + maxsize = el->size(); + if (IS_LOCAL(source) || (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->WriteNumeric(478, "%s %s %s :Channel ban/ignore list is full", source->nick.c_str(), channel->name.c_str(), 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; + extItem.unset(channel); } + return MODEACTION_ALLOW; } - 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; } + /* 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 0; + return MODEACTION_DENY; } - - virtual void OnSendList(userrec* user, chanrec* chan, char modechar) + + /** 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) { - if(modechar == mode) + modelist* mlist = extItem.get(chan); + irc::modestacker modestack(true); + std::vector stackresult; + std::vector types; + types.push_back(TR_TEXT); + if (mlist) { - 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 = mlist->begin(); it != mlist->end(); it++) { - 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()); - } + modestack.Push(std::string(1, mode)[0], it->mask); } - - WriteServ(user->fd, "%s %s %s %s", endoflistnumeric.c_str(), user->nick, chan->name, endofliststring.c_str()); + } + while (modestack.GetStackedLine(stackresult)) + { + types.assign(stackresult.size(), this->GetTranslateType()); + proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, stackresult, types); + stackresult.clear(); } } - virtual void OnChannelDelete(chanrec* chan) + /** Clean up module on unload + * @param target_type Type of target to clean + * @param item Item to clean + */ + virtual void DoCleanup(int, void*) { - modelist* list = (modelist*)chan->GetExt(infokey); - - if(list) - { - chan->Shrink(infokey); - delete list; - } } - - virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque) + + /** 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&) { - modelist* list = (modelist*)chan->GetExt(infokey); - if(list) - { - for(modelist::iterator it = list->begin(); it != list->end(); it++) - { - proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, "+" + std::string(1, mode) + " " + it->mask); - } - } + return true; } - - virtual void OnCleanup(int target_type, void* item) + + /** 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&) { - if (target_type == TYPE_CHANNEL) - { - chanrec* chan = (chanrec*)item; - - modelist* list = (modelist*)chan->GetExt(infokey); - - if(list) - { - chan->Shrink(infokey); - delete list; - } - } } };