2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2005-2008 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 /* $ModDesc: Provides support for the /WATCH command */
29 * Okay, it's nice that this was documented and all, but I at least understood very little
30 * of it, so I'm going to attempt to explain the data structures in here a bit more.
32 * For efficiency, many data structures are kept.
34 * The first is a global list `watchentries':
35 * hash_map<irc::string, std::deque<User*> >
37 * That is, if nick 'w00t' is being watched by user pointer 'Brain' and 'Om', <w00t, (Brain, Om)>
38 * will be in the watchentries list.
40 * The second is that each user has a per-user data structure attached to their user record via Extensible:
41 * std::map<irc::string, std::string> watchlist;
42 * So, in the above example with w00t watched by Brain and Om, we'd have:
48 * Hopefully this helps any brave soul that ventures into this file other than me. :-)
49 * -- w00t (mar 30, 2008)
53 /* This module has been refactored to provide a very efficient (in terms of cpu time)
54 * implementation of /WATCH.
56 * To improve the efficiency of watch, many lists are kept. The first primary list is
57 * a hash_map of who's being watched by who. For example:
59 * KEY: Brain ---> Watched by: Boo, w00t, Om
60 * KEY: Boo ---> Watched by: Brain, w00t
62 * This is used when we want to tell all the users that are watching someone that
63 * they are now available or no longer available. For example, if the hash was
64 * populated as shown above, then when Brain signs on, messages are sent to Boo, w00t
65 * and Om by reading their 'watched by' list. When this occurs, their online status
66 * in each of these users lists (see below) is also updated.
68 * Each user also has a seperate (smaller) map attached to their User whilst they
69 * have any watch entries, which is managed by class Extensible. When they add or remove
70 * a watch entry from their list, it is inserted here, as well as the main list being
71 * maintained. This map also contains the user's online status. For users that are
72 * offline, the key points at an empty string, and for users that are online, the key
73 * points at a string containing "users-ident users-host users-signon-time". This is
74 * stored in this manner so that we don't have to FindUser() to fetch this info, the
75 * users signon can populate the field for us.
77 * For example, going again on the example above, this would be w00t's watchlist:
79 * KEY: Boo ---> Status: "Boo brains.sexy.babe 535342348"
80 * KEY: Brain ---> Status: ""
82 * In this list we can see that Boo is online, and Brain is offline. We can then
83 * use this list for 'WATCH L', and 'WATCH S' can be implemented as a combination
84 * of the above two data structures, with minimum CPU penalty for doing so.
86 * In short, the least efficient this ever gets is O(n), and thats only because
87 * there are parts that *must* loop (e.g. telling all users that are watching a
88 * nick that the user online), however this is a *major* improvement over the
89 * 1.0 implementation, which in places had O(n^n) and worse in it, because this
90 * implementation scales based upon the sizes of the watch entries, whereas the
91 * old system would scale (or not as the case may be) according to the total number
92 * of users using WATCH.
95 typedef TR1NS::unordered_map<irc::string, std::deque<User*>, irc::hash> watchentries;
96 typedef std::map<irc::string, std::string> watchlist;
98 /* Who's watching each nickname.
99 * NOTE: We do NOT iterate this to display a user's WATCH list!
100 * See the comments above!
102 watchentries* whos_watching_me;
104 class CommandSVSWatch : public Command
107 CommandSVSWatch(Module* Creator) : Command(Creator,"SVSWATCH", 2)
109 syntax = "<target> [C|L|S]|[+|-<nick>]";
110 TRANSLATE3(TR_NICK, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
113 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
115 if (!ServerInstance->ULine(user->server))
118 User *u = ServerInstance->FindNick(parameters[0]);
124 ServerInstance->Parser->CallHandler("WATCH", parameters, u);
130 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
132 User* target = ServerInstance->FindNick(parameters[0]);
134 return ROUTE_OPT_UCAST(target->server);
135 return ROUTE_LOCALONLY;
141 class CommandWatch : public Command
143 unsigned int& MAX_WATCH;
145 SimpleExtItem<watchlist> ext;
146 CmdResult remove_watch(User* user, const char* nick)
148 // removing an item from the list
149 if (!ServerInstance->IsNick(nick))
151 user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick.c_str(), nick);
155 watchlist* wl = ext.get(user);
158 /* Yup, is on my list */
159 watchlist::iterator n = wl->find(nick);
166 if (!n->second.empty())
167 user->WriteNumeric(602, "%s %s %s :stopped watching", user->nick.c_str(), n->first.c_str(), n->second.c_str());
169 user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick.c_str(), nick);
179 watchentries::iterator x = whos_watching_me->find(nick);
180 if (x != whos_watching_me->end())
182 /* People are watching this user, am i one of them? */
183 std::deque<User*>::iterator n2 = std::find(x->second.begin(), x->second.end(), user);
184 if (n2 != x->second.end())
185 /* I'm no longer watching you... */
188 if (x->second.empty())
189 /* nobody else is, either. */
190 whos_watching_me->erase(nick);
197 CmdResult add_watch(User* user, const char* nick)
199 if (!ServerInstance->IsNick(nick))
201 user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick.c_str(),nick);
205 watchlist* wl = ext.get(user);
208 wl = new watchlist();
212 if (wl->size() == MAX_WATCH)
214 user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick.c_str(), nick);
218 watchlist::iterator n = wl->find(nick);
221 /* Don't already have the user on my watch list, proceed */
222 watchentries::iterator x = whos_watching_me->find(nick);
223 if (x != whos_watching_me->end())
225 /* People are watching this user, add myself */
226 x->second.push_back(user);
230 std::deque<User*> newlist;
231 newlist.push_back(user);
232 (*(whos_watching_me))[nick] = newlist;
235 User* target = ServerInstance->FindNick(nick);
238 (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
239 user->WriteNumeric(604, "%s %s %s :is online",user->nick.c_str(), nick, (*wl)[nick].c_str());
240 if (target->IsAway())
242 user->WriteNumeric(609, "%s %s %s %s %lu :is away", user->nick.c_str(), target->nick.c_str(), target->ident.c_str(), target->dhost.c_str(), (unsigned long) target->awaytime);
248 user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick.c_str(), nick);
255 CommandWatch(Module* parent, unsigned int &maxwatch) : Command(parent,"WATCH", 0), MAX_WATCH(maxwatch), ext("watchlist", parent)
257 syntax = "[C|L|S]|[+|-<nick>]";
258 TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
261 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
263 if (parameters.empty())
265 watchlist* wl = ext.get(user);
268 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
270 if (!q->second.empty())
271 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
274 user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
276 else if (parameters.size() > 0)
278 for (int x = 0; x < (int)parameters.size(); x++)
280 const char *nick = parameters[x].c_str();
281 if (!strcasecmp(nick,"C"))
284 watchlist* wl = ext.get(user);
287 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
289 watchentries::iterator i2 = whos_watching_me->find(i->first);
290 if (i2 != whos_watching_me->end())
292 /* People are watching this user, am i one of them? */
293 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
294 if (n != i2->second.end())
295 /* I'm no longer watching you... */
298 if (i2->second.empty())
299 /* nobody else is, either. */
300 whos_watching_me->erase(i2);
307 else if (!strcasecmp(nick,"L"))
309 watchlist* wl = ext.get(user);
312 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
314 if (!q->second.empty())
316 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
317 User *targ = ServerInstance->FindNick(q->first.c_str());
320 user->WriteNumeric(609, "%s %s %s %s %lu :is away", user->nick.c_str(), targ->nick.c_str(), targ->ident.c_str(), targ->dhost.c_str(), (unsigned long) targ->awaytime);
324 user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick.c_str(), q->first.c_str());
327 user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
329 else if (!strcasecmp(nick,"S"))
331 watchlist* wl = ext.get(user);
338 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
339 list.append(q->first.c_str()).append(" ");
340 you_have = wl->size();
343 watchentries::iterator i2 = whos_watching_me->find(user->nick.c_str());
344 if (i2 != whos_watching_me->end())
345 youre_on = i2->second.size();
347 user->WriteNumeric(603, "%s :You have %d and are on %d WATCH entries", user->nick.c_str(), you_have, youre_on);
348 user->WriteNumeric(606, "%s :%s",user->nick.c_str(), list.c_str());
349 user->WriteNumeric(607, "%s :End of WATCH S",user->nick.c_str());
351 else if (nick[0] == '-')
354 remove_watch(user, nick);
356 else if (nick[0] == '+')
359 add_watch(user, nick);
367 class Modulewatch : public Module
369 unsigned int maxwatch;
375 : maxwatch(32), cmdw(this, maxwatch), sw(this)
377 whos_watching_me = new watchentries();
380 void init() CXX11_OVERRIDE
383 ServerInstance->Modules->AddService(cmdw);
384 ServerInstance->Modules->AddService(sw);
385 ServerInstance->Modules->AddService(cmdw.ext);
386 Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric, I_OnSetAway };
387 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
390 void OnRehash(User* user) CXX11_OVERRIDE
392 maxwatch = ServerInstance->Config->ConfValue("watch")->getInt("maxentries", 32);
397 ModResult OnSetAway(User *user, const std::string &awaymsg) CXX11_OVERRIDE
404 numeric = user->nick + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :is no longer away";
409 numeric = user->nick + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :" + awaymsg;
413 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
414 if (x != whos_watching_me->end())
416 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
418 (*n)->WriteNumeric(inum, numeric);
422 return MOD_RES_PASSTHRU;
425 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE
427 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
428 if (x != whos_watching_me->end())
430 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
432 (*n)->WriteNumeric(601, "%s %s %s %s %lu :went offline", (*n)->nick.c_str() ,user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) ServerInstance->Time());
434 watchlist* wl = cmdw.ext.get(*n);
436 /* We were on somebody's notify list, set ourselves offline */
437 (*wl)[user->nick.c_str()].clear();
441 /* Now im quitting, if i have a notify list, im no longer watching anyone */
442 watchlist* wl = cmdw.ext.get(user);
445 /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
446 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
448 watchentries::iterator i2 = whos_watching_me->find(i->first);
449 if (i2 != whos_watching_me->end())
451 /* People are watching this user, am i one of them? */
452 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
453 if (n != i2->second.end())
454 /* I'm no longer watching you... */
457 if (i2->second.empty())
458 /* and nobody else is, either. */
459 whos_watching_me->erase(i2);
465 void OnGarbageCollect()
467 watchentries* old_watch = whos_watching_me;
468 whos_watching_me = new watchentries();
470 for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
471 whos_watching_me->insert(*n);
476 void OnPostConnect(User* user) CXX11_OVERRIDE
478 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
479 if (x != whos_watching_me->end())
481 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
483 (*n)->WriteNumeric(600, "%s %s %s %s %lu :arrived online", (*n)->nick.c_str(), user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) user->age);
485 watchlist* wl = cmdw.ext.get(*n);
487 /* We were on somebody's notify list, set ourselves online */
488 (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
493 void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE
495 watchentries::iterator new_offline = whos_watching_me->find(oldnick.c_str());
496 watchentries::iterator new_online = whos_watching_me->find(user->nick.c_str());
498 if (new_offline != whos_watching_me->end())
500 for (std::deque<User*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
502 watchlist* wl = cmdw.ext.get(*n);
505 (*n)->WriteNumeric(601, "%s %s %s %s %lu :went offline", (*n)->nick.c_str(), oldnick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) user->age);
506 (*wl)[oldnick.c_str()].clear();
511 if (new_online != whos_watching_me->end())
513 for (std::deque<User*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
515 watchlist* wl = cmdw.ext.get(*n);
518 (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
519 (*n)->WriteNumeric(600, "%s %s %s :arrived online", (*n)->nick.c_str(), user->nick.c_str(), (*wl)[user->nick.c_str()].c_str());
525 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
527 tokens["WATCH"] = ConvToStr(maxwatch);
532 delete whos_watching_me;
535 Version GetVersion() CXX11_OVERRIDE
537 return Version("Provides support for the /WATCH command", VF_OPTCOMMON | VF_VENDOR);
541 MODULE_INIT(Modulewatch)