1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/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
17 /** Get the time as a string
19 inline std::string stringtime(InspIRCd* Instance)
21 std::ostringstream TIME;
22 TIME << Instance->Time();
26 /** An item in a listmode's list
28 class ListItem : public classbase
36 /** The number of items a listmode's list may contain
38 class ListLimit : public classbase
45 /** Items stored in the channel's list
47 typedef std::list<ListItem> modelist;
48 /** Max items per channel by name
50 typedef std::list<ListLimit> limitlist;
52 /** A request used to check if a user is on a channel's list or not
54 class ListModeRequest : public Request
62 /** Check if a user is on a channel's list.
63 * The Event::Send() event returns the ban string if the user is on the channel's list,
64 * or NULL if the user is not on the list.
65 * @param sender Sending module
66 * @param target Target module
67 * @param u User to check against
68 * @param c Channel to check against
70 ListModeRequest(Module* sender, Module* target, User* u, Channel* c) : Request(sender, target, "LM_CHECKLIST"), user(u), literal(""), extban(0), chan(c)
74 /** Check if a literal string is on a channel's list, optionally using an extban char.
75 * The Event::Send() event returns the ban string if the user is on the channel's list,
76 * or NULL if the user is not on the list.
77 * @param sender Sending module
78 * @param target Target module
79 * @param literalstr String to check against, e.g. "Bob!Bobbertson@weeblshouse"
80 * @param extbanchar Extended ban character to use for the match, or a null char if not using extban
82 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)
86 /** Check if a literal string is on a channel's list, optionally using an extban char.
87 * The Event::Send() event returns the ban string if the user is on the channel's list,
88 * or NULL if the user is not on the list.
89 * @param sender Sending module
90 * @param target Target module
91 * @param User to check against, e.g. "Bob!Bobbertson@weeblshouse"
92 * @param extbanchar Extended ban character to use for the match, or a null char if not using extban
94 ListModeRequest(Module* sender, Module* target, User* u, char extbanchar, Channel* channel) : Request(sender, target, "LM_CHECKLIST_EX"), user(u), literal(""), extban(extbanchar), chan(channel)
105 /** The base class for list modes, should be inherited.
107 class ListModeBase : public ModeHandler
110 /** Numeric to use when outputting the list
112 unsigned int listnumeric;
113 /** Numeric to indicate end of list
115 unsigned int endoflistnumeric;
116 /** String to send for end of list
118 std::string endofliststring;
119 /** Automatically tidy up entries
122 /** Config tag to check for max items per channel
124 std::string configtag;
125 /** Limits on a per-channel basis read from the tag
126 * specified in ListModeBase::configtag
128 limitlist chanlimits;
133 SimpleExtItem<modelist> extItem;
136 * @param Instance The creator of this class
137 * @param modechar Mode character
138 * @param eolstr End of list string
139 * @pram lnum List numeric
140 * @param eolnum End of list numeric
141 * @param autotidy Automatically tidy list entries on add
142 * @param ctag Configuration tag to get limits from
144 ListModeBase(InspIRCd* Instance, Module* Creator, char modechar, const std::string &eolstr, unsigned int lnum, unsigned int eolnum, bool autotidy, const std::string &ctag = "banlist")
145 : ModeHandler(Creator, modechar, PARAM_ALWAYS, MODETYPE_CHANNEL),
146 listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy),
147 configtag(ctag), extItem("listbase_mode_" + std::string(1, mode) + "_list", Creator)
151 Extensible::Register(&extItem);
156 std::pair<bool,std::string> ModeSet(User*, User*, Channel* channel, const std::string ¶meter)
158 modelist* el = extItem.get(channel);
161 for (modelist::iterator it = el->begin(); it != el->end(); it++)
163 if(parameter == it->mask)
165 return std::make_pair(true, parameter);
169 return std::make_pair(false, parameter);
172 /** Display the list for this mode
173 * @param user The user to send the list to
174 * @param channel The channel the user is requesting the list for
176 virtual void DisplayList(User* user, Channel* channel)
178 modelist* el = extItem.get(channel);
181 for (modelist::reverse_iterator it = el->rbegin(); it != el->rend(); ++it)
183 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());
186 user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
189 virtual void DisplayEmptyList(User* user, Channel* channel)
191 user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
194 /** Remove all instances of the mode from a channel.
196 * @param channel The channel to remove all instances of the mode from
198 virtual void RemoveMode(Channel* channel, irc::modestacker* stack)
200 modelist* el = extItem.get(channel);
203 irc::modestacker modestack(ServerInstance, false);
205 for (modelist::iterator it = el->begin(); it != el->end(); it++)
208 stack->Push(this->GetModeChar(), it->mask);
210 modestack.Push(this->GetModeChar(), it->mask);
216 std::vector<std::string> stackresult;
217 stackresult.push_back(channel->name);
218 while (modestack.GetStackedLine(stackresult))
220 ServerInstance->SendMode(stackresult, ServerInstance->FakeClient);
222 stackresult.push_back(channel->name);
229 virtual void RemoveMode(User*, irc::modestacker* stack)
231 /* Listmodes dont get set on users */
234 /** Perform a rehash of this mode's configuration data
236 virtual void DoRehash()
238 ConfigReader Conf(ServerInstance);
242 for (int i = 0; i < Conf.Enumerate(configtag); i++)
244 // For each <banlist> tag
246 limit.mask = Conf.ReadValue(configtag, "chan", i);
247 limit.limit = Conf.ReadInteger(configtag, "limit", i, true);
249 if (limit.mask.size() && limit.limit > 0)
250 chanlimits.push_back(limit);
252 if (chanlimits.size() == 0)
257 chanlimits.push_back(limit);
261 /** Populate the Implements list with the correct events for a List Mode
263 virtual void DoImplements(Module* m)
265 Implementation eventlist[] = { I_OnChannelDelete, I_OnSyncChannel, I_OnCleanup, I_OnRehash, I_OnRequest };
266 ServerInstance->Modules->Attach(eventlist, m, 5);
269 /** Handle the list mode.
272 virtual ModeAction OnModeChange(User* source, User*, Channel* channel, std::string ¶meter, bool adding)
274 // Try and grab the list
275 modelist* el = extItem.get(channel);
279 // If there was no list
284 extItem.set(channel, el);
289 ModeParser::CleanMask(parameter);
291 // Check if the item already exists in the list
292 for (modelist::iterator it = el->begin(); it != el->end(); it++)
294 if (parameter == it->mask)
296 /* Give a subclass a chance to error about this */
297 TellAlreadyOnList(source, channel, parameter);
299 // it does, deny the change
300 return MODEACTION_DENY;
304 unsigned int maxsize = 0;
306 for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
308 if (InspIRCd::Match(channel->name, it->mask))
310 // We have a pattern matching the channel...
311 maxsize = el->size();
312 if (IS_LOCAL(source) || (maxsize < it->limit))
314 /* Ok, it *could* be allowed, now give someone subclassing us
315 * a chance to validate the parameter.
316 * The param is passed by reference, so they can both modify it
317 * and tell us if we allow it or not.
319 * eg, the subclass could:
321 * 2) 'fix' parameter and then allow
324 if (ValidateParam(source, channel, parameter))
326 // And now add the mask onto the list...
329 e.nick = source->nick;
330 e.time = stringtime(ServerInstance);
333 return MODEACTION_ALLOW;
337 /* If they deny it they have the job of giving an error message */
338 return MODEACTION_DENY;
344 /* List is full, give subclass a chance to send a custom message */
345 if (!TellListTooLong(source, channel, parameter))
347 source->WriteNumeric(478, "%s %s %s :Channel ban/ignore list is full", source->nick.c_str(), channel->name.c_str(), parameter.c_str());
351 return MODEACTION_DENY;
355 // We're taking the mode off
358 for (modelist::iterator it = el->begin(); it != el->end(); it++)
360 if (parameter == it->mask)
365 extItem.unset(channel);
367 return MODEACTION_ALLOW;
370 /* Tried to remove something that wasn't set */
371 TellNotSet(source, channel, parameter);
373 return MODEACTION_DENY;
377 /* Hmm, taking an exception off a non-existant list, DIE */
378 TellNotSet(source, channel, parameter);
380 return MODEACTION_DENY;
383 return MODEACTION_DENY;
386 /** Syncronize channel item list with another server.
388 * @param chan Channel to syncronize
389 * @param proto Protocol module pointer
390 * @param opaque Opaque connection handle
392 virtual void DoSyncChannel(Channel* chan, Module* proto, void* opaque)
394 modelist* mlist = extItem.get(chan);
395 irc::modestacker modestack(ServerInstance, true);
396 std::vector<std::string> stackresult;
397 std::vector<TranslateType> types;
398 types.push_back(TR_TEXT);
401 for (modelist::iterator it = mlist->begin(); it != mlist->end(); it++)
403 modestack.Push(std::string(1, mode)[0], it->mask);
406 while (modestack.GetStackedLine(stackresult))
408 types.assign(stackresult.size(), this->GetTranslateType());
409 proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, stackresult, types);
414 /** Clean up module on unload
415 * @param target_type Type of target to clean
416 * @param item Item to clean
418 virtual void DoCleanup(int, void*)
422 /** Validate parameters.
423 * Overridden by implementing module.
424 * @param source Source user adding the parameter
425 * @param channel Channel the parameter is being added to
426 * @param parameter The actual parameter being added
427 * @return true if the parameter is valid
429 virtual bool ValidateParam(User*, Channel*, std::string&)
434 /** Tell the user the list is too long.
435 * Overridden by implementing module.
436 * @param source Source user adding the parameter
437 * @param channel Channel the parameter is being added to
438 * @param parameter The actual parameter being added
441 virtual bool TellListTooLong(User*, Channel*, std::string&)
446 /** Tell the user an item is already on the list.
447 * Overridden by implementing module.
448 * @param source Source user adding the parameter
449 * @param channel Channel the parameter is being added to
450 * @param parameter The actual parameter being added
452 virtual void TellAlreadyOnList(User*, Channel*, std::string&)
456 /** Tell the user that the parameter is not in the list.
457 * Overridden by implementing module.
458 * @param source Source user removing the parameter
459 * @param channel Channel the parameter is being removed from
460 * @param parameter The actual parameter being removed
462 virtual void TellNotSet(User*, Channel*, std::string&)
466 virtual const char* DoOnRequest(Request* request)
468 ListModeRequest* LM = (ListModeRequest*)request;
469 if (strcmp("LM_CHECKLIST", request->GetId()) == 0)
471 modelist* mlist = extItem.get(LM->chan);
474 std::string mask = LM->user->nick + "!" + LM->user->ident + "@" + LM->user->GetIPString();
475 for (modelist::iterator it = mlist->begin(); it != mlist->end(); ++it)
477 if (InspIRCd::Match(LM->user->GetFullRealHost(), it->mask) || InspIRCd::Match(LM->user->GetFullHost(), it->mask) || (InspIRCd::MatchCIDR(mask, it->mask)))
478 return it->mask.c_str();
483 else if (strcmp("LM_CHECKLIST_EX", request->GetId()) == 0)
485 modelist* mlist = extItem.get(LM->chan);
491 LM->literal = LM->user->nick + "!" + LM->user->ident + "@" + LM->user->GetIPString();
494 for (modelist::iterator it = mlist->begin(); it != mlist->end(); it++)
496 if (LM->extban && it->mask.length() > 1 && it->mask[0] == LM->extban && it->mask[1] == ':')
498 std::string ext = it->mask.substr(2);
501 if (InspIRCd::Match(LM->user->GetFullRealHost(), ext) || InspIRCd::Match(LM->user->GetFullHost(), ext) || (InspIRCd::MatchCIDR(LM->literal, ext)))
503 return it->mask.c_str();
506 else if (InspIRCd::Match(LM->literal, ext))
508 return it->mask.c_str();
515 if (InspIRCd::Match(LM->user->GetFullRealHost(), it->mask) || InspIRCd::Match(LM->user->GetFullHost(), it->mask) || (InspIRCd::MatchCIDR(LM->literal, it->mask)))
517 return it->mask.c_str();
520 else if (InspIRCd::Match(LM->literal, it->mask))
522 return it->mask.c_str();