X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fu_listmode.h;h=88b5fb3eea17c66a4643903147af900f1a9da925;hb=526f5a4a02882b19056fe755dff1f64b764ff313;hp=f016253f9338aa5b1a39ed572b94444b6cfd9c4c;hpb=793d2364d907a73918eef1166b60f964ed0d384b;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/u_listmode.h b/include/u_listmode.h index f016253f9..88b5fb3ee 100644 --- a/include/u_listmode.h +++ b/include/u_listmode.h @@ -1,31 +1,31 @@ +/* +------------------------------------+ + * | 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 -#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. */ - -/* Updated to use the config tag if it exists */ -/* Written by Om , 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() +/** Get the time as a string + */ +inline std::string stringtime(InspIRCd* Instance) { std::ostringstream TIME; - TIME << time(NULL); + TIME << Instance->Time(); return TIME.str(); } -class ListItem +/** An item in a listmode's list + */ +class ListItem : public classbase { public: std::string nick; @@ -33,79 +33,226 @@ 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 exception 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; +/** 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; - std::string listnumeric; - std::string endoflistnumeric; + /** 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: - 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; - mode = modechar; - listnumeric = lnum; - endoflistnumeric = eolnum; - endofliststring = eolstr; + /** 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 = "exceptionbase_mode_" + std::string(1, mode) + "_list"; + infokey = "listbase_mode_" + std::string(1, mode) + "_list"; } - virtual void DisplayList(userrec* user, chanrec* channel) + /** See mode.h + */ + std::pair ModeSet(User*, User*, Channel* channel, const std::string ¶meter) { - modelist* el = (modelist*)channel->GetExt(infokey); + modelist* el; + channel->GetExt(infokey, el); if (el) { - for(modelist::iterator it = el->begin(); it != el->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, channel->name, it->mask.c_str(), it->nick.c_str(), it->time.c_str()); + if(parameter == it->mask) + { + return std::make_pair(true, parameter); + } } } - WriteServ(user->fd, "%s %s %s %s", endoflistnumeric.c_str(), user->nick, channel->name, endofliststring.c_str()); + 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 stackresult; + std::vector 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() { - delete Conf; - Conf = new ConfigReader; + 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 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) - { + 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) + if (chanlimits.size() == 0) { ListLimit limit; limit.mask = "*"; @@ -114,15 +261,22 @@ class ListModeBase : public ModeHandler } } - virtual 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_OnCleanup, I_OnRehash, I_OnRequest }; + ServerInstance->Modules->Attach(eventlist, m, 5); } - virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding) + /** Handle the list mode. + * See mode.h + */ + virtual ModeAction OnModeChange(User* source, User*, Channel* channel, std::string ¶meter, bool adding, bool servermode) { // Try and grab the list - modelist* el = (modelist*)channel->GetExt(infokey); + modelist* el; + channel->GetExt(infokey, el); if (adding) { @@ -131,19 +285,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) + 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; } } @@ -152,26 +309,48 @@ class ListModeBase : public ModeHandler for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++) { - if (Srv->MatchText(channel->name, it->mask)) + if (InspIRCd::Match(channel->name, it->mask)) { // We have a pattern matching the channel... maxsize = el->size(); - if (maxsize < it->limit) + if (IS_LOCAL(source) || (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 = servermode ? ServerInstance->Config->ServerName : source->nick; + e.time = stringtime(ServerInstance); - 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)) + { + 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; } @@ -182,10 +361,10 @@ class ListModeBase : public ModeHandler { for (modelist::iterator it = el->begin(); it != el->end(); it++) { - if(parameter == it->mask) + if (parameter == it->mask) { el->erase(it); - if(el->size() == 0) + if (el->size() == 0) { channel->Shrink(infokey); delete el; @@ -193,12 +372,15 @@ class ListModeBase : public ModeHandler 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 + /* Hmm, taking an exception off a non-existant list, DIE */ + TellNotSet(source, channel, parameter); parameter = ""; return MODEACTION_DENY; } @@ -206,49 +388,178 @@ class ListModeBase : public ModeHandler return MODEACTION_DENY; } + /** Get Extensible key for this mode + */ virtual std::string& GetInfoKey() { return infokey; } - virtual void DoChannelDelete(chanrec* chan) + /** Handle channel deletion. + * See modules.h. + * @param chan Channel being deleted + */ + virtual void DoChannelDelete(Channel* chan) { - modelist* list = (modelist*)chan->GetExt(infokey); + modelist* mlist; + chan->GetExt(infokey, mlist); - if (list) + if (mlist) { chan->Shrink(infokey); - delete list; + delete mlist; } } - virtual void DoSyncChannel(chanrec* chan, Module* proto, void* opaque) + /** 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* list = (modelist*)chan->GetExt(infokey); - if (list) + modelist* mlist; + chan->GetExt(infokey, mlist); + irc::modestacker modestack(ServerInstance, true); + std::deque stackresult; + std::vector types; + types.push_back(TR_TEXT); + if (mlist) { - for (modelist::iterator it = list->begin(); it != list->end(); it++) + for (modelist::iterator it = mlist->begin(); it != mlist->end(); it++) { - proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, "+" + std::string(1, mode) + " " + it->mask); + modestack.Push(std::string(1, mode)[0], it->mask); + types.push_back(this->GetTranslateType()); } } + while (modestack.GetStackedLine(stackresult)) + { + irc::stringjoiner mode_join(" ", stackresult, 0, stackresult.size() - 1); + std::string line = mode_join.GetJoined(); + proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, line, types); + } } - virtual void DoCleanup(int target_type, void* item) + /** Clean up module on unload + * @param target_type Type of target to clean + * @param item Item to clean + */ + virtual void DoCleanup(int, void*) { - if (target_type == TYPE_CHANNEL) - { - chanrec* chan = (chanrec*)item; + } + + /** 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&) + { + } - modelist* list = (modelist*)chan->GetExt(infokey); + 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 (list) + if (mlist) { - chan->Shrink(infokey); - delete list; + 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