+/* +------------------------------------+
+ * | 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 <stdio.h>
-#include <string>
-#include <sstream>
-#include <vector>
-#include "users.h"
-#include "channels.h"
-#include "modules.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 */
-
+/** Get the time as a string
+ */
inline std::string stringtime()
{
std::ostringstream TIME;
- TIME << time(NULL);
+ TIME << ServerInstance->Time();
return TIME.str();
}
+/** An item in a listmode's list
+ */
class ListItem : public classbase
{
public:
std::string time;
};
+/** The number of items a listmode's list may contain
+ */
class ListLimit : public classbase
{
public:
unsigned int limit;
};
-// Just defining the type we use for the exception list here...
-typedef std::vector<ListItem> modelist;
-typedef std::vector<ListLimit> limitlist;
+/** Items stored in the channel's list
+ */
+typedef std::list<ListItem> modelist;
+/** Max items per channel by name
+ */
+typedef std::list<ListLimit> limitlist;
+/** The base class for list modes, should be inherited.
+ */
class ListModeBase : public ModeHandler
{
protected:
- 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;
- std::string configtag;
+ /** 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:
- 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)
+ /** Storage key
+ */
+ SimpleExtItem<modelist> 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)
{
+ list = true;
this->DoRehash();
- infokey = "exceptionbase_mode_" + std::string(1, mode) + "_list";
+ Extensible::Register(&extItem);
}
- std::pair<bool,std::string> ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter)
+ /** See mode.h
+ */
+ std::pair<bool,std::string> ModeSet(User*, User*, Channel* channel, const std::string ¶meter)
{
- modelist* el;
- channel->GetExt(infokey, el);
+ modelist* el = extItem.get(channel);
if (el)
{
for (modelist::iterator it = el->begin(); it != el->end(); it++)
return std::make_pair(false, parameter);
}
- virtual void DisplayList(userrec* user, chanrec* channel)
+ /** 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);
+ modelist* el = extItem.get(channel);
if (el)
{
- for(modelist::iterator it = el->begin(); it != el->end(); it++)
+ for (modelist::reverse_iterator it = el->rbegin(); it != el->rend(); ++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->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->WriteServ("%s %s %s %s", endoflistnumeric.c_str(), user->nick, channel->name, endofliststring.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());
}
- virtual void RemoveMode(chanrec* channel)
+ /** 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)
{
- ServerInstance->Log(DEBUG,"Removing listmode base from %s %s",channel->name,infokey.c_str());
- modelist* el;
- channel->GetExt(infokey, el);
+ modelist* el = extItem.get(channel);
if (el)
{
- ServerInstance->Log(DEBUG,"Channel is extended with a list");
- char moderemove[MAXBUF];
- userrec* n = new userrec(ServerInstance);
- n->SetFd(FD_MAGIC_NUMBER);
- for(modelist::iterator it = el->begin(); it != el->end(); it++)
+ irc::modestacker modestack(false);
+
+ for (modelist::iterator it = el->begin(); it != el->end(); it++)
{
- ServerInstance->Log(DEBUG,"Remove item %s",it->mask.c_str());
- sprintf(moderemove,"-%c",this->GetModeChar());
- const char* parameters[] = { channel->name, moderemove, it->mask.c_str() };
- ServerInstance->SendMode(parameters, 3, n);
+ if (stack)
+ stack->Push(this->GetModeChar(), it->mask);
+ else
+ modestack.Push(this->GetModeChar(), it->mask);
+ }
+
+ if (stack)
+ return;
+
+ std::vector<std::string> stackresult;
+ stackresult.push_back(channel->name);
+ while (modestack.GetStackedLine(stackresult))
+ {
+ ServerInstance->SendMode(stackresult, ServerInstance->FakeClient);
+ stackresult.clear();
+ stackresult.push_back(channel->name);
}
- delete n;
}
}
- virtual void RemoveMode(userrec* user)
+ /** 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);
+ ConfigReader Conf;
chanlimits.clear();
- for(int i = 0; i < Conf.Enumerate(configtag); i++)
+ 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)
+ if (limit.mask.size() && limit.limit > 0)
chanlimits.push_back(limit);
}
- if(chanlimits.size() == 0)
+ if (chanlimits.size() == 0)
{
ListLimit limit;
limit.mask = "*";
}
}
- virtual void DoImplements(char* List)
+ /** Populate the Implements list with the correct events for a List Mode
+ */
+ virtual void DoImplements(Module* m)
{
- 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 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)
{
// Try and grab the list
- modelist* el;
- channel->GetExt(infokey, el);
+ modelist* el = extItem.get(channel);
if (adding)
{
{
// Make one
el = new modelist;
- channel->Extend(infokey, el);
+ extItem.set(channel, el);
}
// Clean the mask up
// 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
return MODEACTION_DENY;
}
for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
{
- if (match(channel->name, it->mask.c_str()))
+ 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))
{
/* Ok, it *could* be allowed, now give someone subclassing us
* a chance to validate the parameter.
* 2) 'fix' parameter and then allow
* 3) deny
*/
- if(ValidateParam(source, channel, parameter))
+ if (ValidateParam(source, channel, parameter))
{
// And now add the mask onto the list...
ListItem e;
}
/* List is full, give subclass a chance to send a custom message */
- if(!TellListTooLong(source, channel, parameter))
+ if (!TellListTooLong(source, channel, parameter))
{
- source->WriteServ("478 %s %s %s :Channel ban/ignore list is full", source->nick, channel->name, parameter.c_str());
+ 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;
+ return MODEACTION_DENY;
}
else
{
{
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;
+ extItem.unset(channel);
}
return MODEACTION_ALLOW;
}
- else
- {
- /* Tried to remove something that wasn't set */
- TellNotSet(source, channel, parameter);
- }
}
+ /* 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;
}
return MODEACTION_DENY;
}
- virtual std::string& GetInfoKey()
- {
- return infokey;
- }
-
- virtual void DoChannelDelete(chanrec* chan)
+ /** 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;
- chan->GetExt(infokey, list);
-
- if (list)
+ modelist* mlist = extItem.get(chan);
+ irc::modestacker modestack(true);
+ std::vector<std::string> stackresult;
+ std::vector<TranslateType> types;
+ types.push_back(TR_TEXT);
+ if (mlist)
{
- chan->Shrink(infokey);
- delete list;
- }
- }
-
- virtual void DoSyncChannel(chanrec* chan, Module* proto, void* opaque)
- {
- modelist* list;
- chan->GetExt(infokey, list);
- if (list)
- {
- 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))
+ {
+ types.assign(stackresult.size(), this->GetTranslateType());
+ proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, stackresult, types);
+ stackresult.clear();
+ }
}
- 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*)
{
}
-
- virtual bool ValidateParam(userrec* source, chanrec* channel, std::string ¶meter)
+
+ /** 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;
}
-
- virtual bool TellListTooLong(userrec* source, chanrec* channel, std::string ¶meter)
+
+ /** 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;
}
-
- virtual void TellAlreadyOnList(userrec* source, chanrec* channel, std::string ¶meter)
+
+ /** 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 TellNotSet(userrec* source, chanrec* channel, std::string ¶meter)
+
+ /** 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&)
{
-
}
};
projects / user / henk / code / inspircd.git / blobdiff