1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef INSPIRCD_LISTMODE_PROVIDER
15 #define INSPIRCD_LISTMODE_PROVIDER
27 /* $ModDesc: Provides support for easily creating listmodes, stores the time set, the user, and a parameter. */
29 /* Updated to use the <banlist> config tag if it exists */
30 /* Written by Om <omster@gmail.com>, December 2005. */
31 /* Based on code previously written by Om - April 2005 */
32 /* Updated to new API July 8th 2006 by Brain */
33 /* Originally based on m_chanprotect and m_silence */
35 inline std::string stringtime()
37 std::ostringstream TIME;
42 /** An item in a listmode's list
44 class ListItem : public classbase
52 /** The number of items a listmode's list may contain
54 class ListLimit : public classbase
61 // Just defining the type we use for the exception list here...
62 typedef std::vector<ListItem> modelist;
63 typedef std::vector<ListLimit> limitlist;
65 class ListModeRequest : public Request
71 ListModeRequest(Module* sender, Module* target, userrec* u, chanrec* c) : Request(sender, target, "LM_CHECKLIST"), user(u), chan(c)
80 /** The base class for listmodes defined by u_listmode.h
82 class ListModeBase : public ModeHandler
86 std::string listnumeric;
87 std::string endoflistnumeric;
88 std::string endofliststring;
90 std::string configtag;
94 ListModeBase(InspIRCd* Instance, char modechar, const std::string &eolstr, const std::string &lnum, const std::string &eolnum, bool autotidy, const std::string &ctag = "banlist")
95 : ModeHandler(Instance, modechar, 1, 1, true, MODETYPE_CHANNEL, false), listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy), configtag(ctag)
98 infokey = "listbase_mode_" + std::string(1, mode) + "_list";
101 std::pair<bool,std::string> ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter)
104 channel->GetExt(infokey, el);
107 for (modelist::iterator it = el->begin(); it != el->end(); it++)
109 if(parameter == it->mask)
111 return std::make_pair(true, parameter);
115 return std::make_pair(false, parameter);
118 virtual void DisplayList(userrec* user, chanrec* channel)
121 channel->GetExt(infokey, el);
124 for(modelist::iterator it = el->begin(); it != el->end(); it++)
126 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());
129 user->WriteServ("%s %s %s :%s", endoflistnumeric.c_str(), user->nick, channel->name, endofliststring.c_str());
132 virtual void RemoveMode(chanrec* channel)
134 ServerInstance->Log(DEBUG,"Removing listmode base from %s %s",channel->name,infokey.c_str());
136 channel->GetExt(infokey, el);
139 ServerInstance->Log(DEBUG,"Channel is extended with a list");
140 irc::modestacker modestack(false);
141 std::deque<std::string> stackresult;
142 const char* mode_junk[MAXMODES+1];
143 mode_junk[0] = channel->name;
144 userrec* n = new userrec(ServerInstance);
145 n->SetFd(FD_MAGIC_NUMBER);
146 for(modelist::iterator it = el->begin(); it != el->end(); it++)
148 modestack.Push(this->GetModeChar(), it->mask);
150 while (modestack.GetStackedLine(stackresult))
152 for (size_t j = 0; j < stackresult.size(); j++)
154 mode_junk[j+1] = stackresult[j].c_str();
156 ServerInstance->SendMode(mode_junk, stackresult.size() + 1, n);
163 virtual void RemoveMode(userrec* user)
165 /* Listmodes dont get set on users */
168 virtual void DoRehash()
170 ConfigReader Conf(ServerInstance);
174 for(int i = 0; i < Conf.Enumerate(configtag); i++)
176 // For each <banlist> tag
178 limit.mask = Conf.ReadValue(configtag, "chan", i);
179 limit.limit = Conf.ReadInteger(configtag, "limit", i, true);
181 if(limit.mask.size() && limit.limit > 0)
182 chanlimits.push_back(limit);
184 if(chanlimits.size() == 0)
189 chanlimits.push_back(limit);
193 virtual void DoImplements(char* List)
195 List[I_OnChannelDelete] = List[I_OnSyncChannel] = List[I_OnCleanup] = List[I_OnRehash] = 1;
198 virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
200 // Try and grab the list
202 channel->GetExt(infokey, el);
206 // If there was no list
211 channel->Extend(infokey, el);
216 ModeParser::CleanMask(parameter);
218 // Check if the item already exists in the list
219 for (modelist::iterator it = el->begin(); it != el->end(); it++)
221 if(parameter == it->mask)
223 /* Give a subclass a chance to error about this */
224 TellAlreadyOnList(source, channel, parameter);
226 // it does, deny the change
227 return MODEACTION_DENY;
231 unsigned int maxsize = 0;
233 for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
235 if (match(channel->name, it->mask.c_str()))
237 // We have a pattern matching the channel...
238 maxsize = el->size();
239 if (maxsize < it->limit)
241 /* Ok, it *could* be allowed, now give someone subclassing us
242 * a chance to validate the parameter.
243 * The param is passed by reference, so they can both modify it
244 * and tell us if we allow it or not.
246 * eg, the subclass could:
248 * 2) 'fix' parameter and then allow
251 if(ValidateParam(source, channel, parameter))
253 // And now add the mask onto the list...
256 e.nick = source->nick;
257 e.time = stringtime();
260 return MODEACTION_ALLOW;
264 /* If they deny it they have the job of giving an error message */
265 return MODEACTION_DENY;
271 /* List is full, give subclass a chance to send a custom message */
272 if(!TellListTooLong(source, channel, parameter))
274 source->WriteServ("478 %s %s %s :Channel ban/ignore list is full", source->nick, channel->name, parameter.c_str());
278 return MODEACTION_DENY;
282 // We're taking the mode off
285 for (modelist::iterator it = el->begin(); it != el->end(); it++)
287 if(parameter == it->mask)
292 channel->Shrink(infokey);
295 return MODEACTION_ALLOW;
298 /* Tried to remove something that wasn't set */
299 TellNotSet(source, channel, parameter);
301 return MODEACTION_DENY;
305 /* Hmm, taking an exception off a non-existant list, DIE */
306 TellNotSet(source, channel, parameter);
308 return MODEACTION_DENY;
311 return MODEACTION_DENY;
314 virtual std::string& GetInfoKey()
319 virtual void DoChannelDelete(chanrec* chan)
322 chan->GetExt(infokey, list);
326 chan->Shrink(infokey);
331 virtual void DoSyncChannel(chanrec* chan, Module* proto, void* opaque)
334 chan->GetExt(infokey, list);
335 irc::modestacker modestack(true);
336 std::deque<std::string> stackresult;
339 for (modelist::iterator it = list->begin(); it != list->end(); it++)
341 modestack.Push(std::string(1, mode)[0], it->mask);
344 while (modestack.GetStackedLine(stackresult))
346 irc::stringjoiner mode_join(" ", stackresult, 0, stackresult.size() - 1);
347 std::string line = mode_join.GetJoined();
348 proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, line);
352 virtual void DoCleanup(int target_type, void* item)
356 virtual bool ValidateParam(userrec* source, chanrec* channel, std::string ¶meter)
361 virtual bool TellListTooLong(userrec* source, chanrec* channel, std::string ¶meter)
366 virtual void TellAlreadyOnList(userrec* source, chanrec* channel, std::string ¶meter)
370 virtual void TellNotSet(userrec* source, chanrec* channel, std::string ¶meter)