+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2008 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 <stdio.h>
-#include <string>
-#include <sstream>
-#include <vector>
-#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 <omster@gmail.com>, 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;
return TIME.str();
}
-class ListItem
+/** An item in a listmode's list
+ */
+class ListItem : public classbase
{
public:
std::string nick;
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...
+/** Items stored in the channel's list
+ */
typedef std::vector<ListItem> modelist;
+/** Max items per channel by name
+ */
typedef std::vector<ListLimit> limitlist;
-class ListModeBaseModule : public Module
+/** 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:
- int maxlist;
- char mode;
+ 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;
+
+ public:
+ /** 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 = "listbase_mode_" + std::string(1, mode) + "_list";
+ }
- Server* Srv;
- ConfigReader* Conf;
-public:
- ListModeBaseModule(Server* serv, char modechar, std::string eolstr, std::string lnum, std::string eolnum) : Module::Module(serv)
+ /** See mode.h
+ */
+ std::pair<bool,std::string> ModeSet(User*, User*, Channel* channel, const std::string ¶meter)
{
- 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);
+ 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 OnRehash(std::string param)
+
+ /** 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)
{
- delete Conf;
- Conf = new ConfigReader;
-
- chanlimits.clear();
-
- for(int i = 0; i < Conf->Enumerate("banlist"); i++)
+ modelist* el;
+ channel->GetExt(infokey, el);
+ if (el)
{
- // 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)
+ for (modelist::reverse_iterator it = el->rbegin(); it != el->rend(); ++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());
+ user->WriteNumeric(listnumeric, "%s %s %s %s %s", user->nick.c_str(), channel->name.c_str(), it->mask.c_str(), it->nick.c_str(), it->time.c_str());
}
- else
+ }
+ 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<std::string> stackresult;
+ std::vector<std::string> 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))
{
- log(DEBUG, "m_exceptionbase.so: Invalid tag");
+ for (size_t j = 0; j < stackresult.size(); j++)
+ {
+ mode_junk.push_back(stackresult[j]);
+ }
+
+ ServerInstance->SendMode(mode_junk, ServerInstance->FakeClient);
}
}
-
- 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(ServerInstance);
+
+ chanlimits.clear();
+
+ for (int i = 0; i < Conf.Enumerate(configtag); i++)
+ {
+ // For each <banlist> 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 = "*";
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_OnCleanup, I_OnRehash, I_OnRequest };
+ ServerInstance->Modules->Attach(eventlist, m, 5);
}
-
- 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, bool servermode)
{
- // 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;
}
-
- 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...
- if(el->size() < 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 = servermode ? ServerInstance->Config->ServerName : 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, maxlist);
- 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;
+ channel->Shrink(infokey);
+ delete el;
}
+ 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;
}
- }
-
- 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 */
+ TellNotSet(source, channel, parameter);
+ 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)
+ /** Get Extensible key for this mode
+ */
+ virtual std::string& GetInfoKey()
{
- modelist* list = (modelist*)chan->GetExt(infokey);
-
- if(list)
+ return infokey;
+ }
+
+ /** Handle channel deletion.
+ * See modules.h.
+ * @param chan Channel being deleted
+ */
+ virtual void DoChannelDelete(Channel* chan)
+ {
+ modelist* mlist;
+ chan->GetExt(infokey, mlist);
+
+ if (mlist)
{
chan->Shrink(infokey);
- delete list;
+ delete mlist;
}
}
-
- virtual void OnSyncChannel(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<std::string> stackresult;
+ 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);
}
}
+ 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);
+ }
+ }
+
+ /** Clean up module on unload
+ * @param target_type Type of target to clean
+ * @param item Item to clean
+ */
+ virtual void DoCleanup(int, void*)
+ {
+ }
+
+ /** 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&)
+ {
}
- virtual void OnCleanup(int target_type, void* item)
+ /** 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)
+ }
+
+ virtual const char* DoOnRequest(Request* request)
+ {
+ ListModeRequest* LM = (ListModeRequest*)request;
+ if (strcmp("LM_CHECKLIST", request->GetId()) == 0)
{
- chanrec* chan = (chanrec*)item;
-
- modelist* list = (modelist*)chan->GetExt(infokey);
-
- if(list)
+ modelist* mlist;
+ LM->chan->GetExt(GetInfoKey(), mlist);
+ if (mlist)
{
- chan->Shrink(infokey);
- delete list;
+ 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 (mlist)
+ {
+ 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] == ':')
+ {
+ static 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
+