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.
96 * Before you start screaming, this definition is only used here, so moving it to a header is pointless.
97 * Yes, it's horrid. Blame cl for being different. -- w00t
100 typedef nspace::hash_map<irc::string, std::deque<User*>, irc::hash> watchentries;
101 typedef std::map<irc::string, std::string> watchlist;
103 /* Who's watching each nickname.
104 * NOTE: We do NOT iterate this to display a user's WATCH list!
105 * See the comments above!
107 watchentries* whos_watching_me;
109 class CommandSVSWatch : public Command
112 CommandSVSWatch(Module* Creator) : Command(Creator,"SVSWATCH", 2)
114 syntax = "<target> [C|L|S]|[+|-<nick>]";
115 TRANSLATE3(TR_NICK, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
118 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
120 if (!ServerInstance->ULine(user->server))
123 User *u = ServerInstance->FindNick(parameters[0]);
129 ServerInstance->Parser->CallHandler("WATCH", parameters, u);
135 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
137 User* target = ServerInstance->FindNick(parameters[0]);
139 return ROUTE_OPT_UCAST(target->server);
140 return ROUTE_LOCALONLY;
146 class CommandWatch : public Command
148 unsigned int& MAX_WATCH;
150 SimpleExtItem<watchlist> ext;
151 CmdResult remove_watch(User* user, const char* nick)
153 // removing an item from the list
154 if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
156 user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick.c_str(), nick);
160 watchlist* wl = ext.get(user);
163 /* Yup, is on my list */
164 watchlist::iterator n = wl->find(nick);
168 if (!n->second.empty())
169 user->WriteNumeric(602, "%s %s %s :stopped watching", user->nick.c_str(), n->first.c_str(), n->second.c_str());
171 user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick.c_str(), nick);
181 watchentries::iterator x = whos_watching_me->find(nick);
182 if (x != whos_watching_me->end())
184 /* People are watching this user, am i one of them? */
185 std::deque<User*>::iterator n2 = std::find(x->second.begin(), x->second.end(), user);
186 if (n2 != x->second.end())
187 /* I'm no longer watching you... */
190 if (x->second.empty())
191 /* nobody else is, either. */
192 whos_watching_me->erase(nick);
199 CmdResult add_watch(User* user, const char* nick)
201 if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
203 user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick.c_str(),nick);
207 watchlist* wl = ext.get(user);
210 wl = new watchlist();
214 if (wl->size() >= MAX_WATCH)
216 user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick.c_str(), nick);
220 watchlist::iterator n = wl->find(nick);
223 /* Don't already have the user on my watch list, proceed */
224 watchentries::iterator x = whos_watching_me->find(nick);
225 if (x != whos_watching_me->end())
227 /* People are watching this user, add myself */
228 x->second.push_back(user);
232 std::deque<User*> newlist;
233 newlist.push_back(user);
234 (*(whos_watching_me))[nick] = newlist;
237 User* target = ServerInstance->FindNick(nick);
238 if ((target) && (target->registered == REG_ALL))
240 (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
241 user->WriteNumeric(604, "%s %s %s :is online",user->nick.c_str(), nick, (*wl)[nick].c_str());
244 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);
250 user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick.c_str(), nick);
257 CommandWatch(Module* parent, unsigned int &maxwatch) : Command(parent,"WATCH", 0), MAX_WATCH(maxwatch), ext("watchlist", parent)
259 syntax = "[C|L|S]|[+|-<nick>]";
260 TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
263 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
265 if (parameters.empty())
267 watchlist* wl = ext.get(user);
270 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
272 if (!q->second.empty())
273 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
276 user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
278 else if (parameters.size() > 0)
280 for (int x = 0; x < (int)parameters.size(); x++)
282 const char *nick = parameters[x].c_str();
283 if (!strcasecmp(nick,"C"))
286 watchlist* wl = ext.get(user);
289 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
291 watchentries::iterator i2 = whos_watching_me->find(i->first);
292 if (i2 != whos_watching_me->end())
294 /* People are watching this user, am i one of them? */
295 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
296 if (n != i2->second.end())
297 /* I'm no longer watching you... */
300 if (i2->second.empty())
301 /* nobody else is, either. */
302 whos_watching_me->erase(i2);
309 else if (!strcasecmp(nick,"L"))
311 watchlist* wl = ext.get(user);
314 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
316 User* targ = ServerInstance->FindNick(q->first.c_str());
317 if (targ && !q->second.empty())
319 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
322 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);
326 user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick.c_str(), q->first.c_str());
329 user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
331 else if (!strcasecmp(nick,"S"))
333 watchlist* wl = ext.get(user);
340 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
341 list.append(q->first.c_str()).append(" ");
342 you_have = wl->size();
345 watchentries::iterator i2 = whos_watching_me->find(user->nick.c_str());
346 if (i2 != whos_watching_me->end())
347 youre_on = i2->second.size();
349 user->WriteNumeric(603, "%s :You have %d and are on %d WATCH entries", user->nick.c_str(), you_have, youre_on);
350 user->WriteNumeric(606, "%s :%s",user->nick.c_str(), list.c_str());
351 user->WriteNumeric(607, "%s :End of WATCH S",user->nick.c_str());
353 else if (nick[0] == '-')
356 remove_watch(user, nick);
358 else if (nick[0] == '+')
361 add_watch(user, nick);
369 class Modulewatch : public Module
371 unsigned int maxwatch;
377 : maxwatch(32), cmdw(this, maxwatch), sw(this)
379 whos_watching_me = new watchentries();
385 ServerInstance->Modules->AddService(cmdw);
386 ServerInstance->Modules->AddService(sw);
387 ServerInstance->Modules->AddService(cmdw.ext);
388 Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric, I_OnSetAway };
389 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
392 virtual void OnRehash(User* user)
394 maxwatch = ServerInstance->Config->ConfValue("watch")->getInt("maxentries", 32);
399 virtual ModResult OnSetAway(User *user, const std::string &awaymsg)
406 numeric = user->nick + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :is no longer away";
411 numeric = user->nick + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :" + awaymsg;
415 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
416 if (x != whos_watching_me->end())
418 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
420 (*n)->WriteNumeric(inum, (*n)->nick + " " + numeric);
424 return MOD_RES_PASSTHRU;
427 virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
429 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
430 if (x != whos_watching_me->end())
432 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
434 (*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());
436 watchlist* wl = cmdw.ext.get(*n);
438 /* We were on somebody's notify list, set ourselves offline */
439 (*wl)[user->nick.c_str()].clear();
443 /* Now im quitting, if i have a notify list, im no longer watching anyone */
444 watchlist* wl = cmdw.ext.get(user);
447 /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
448 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
450 watchentries::iterator i2 = whos_watching_me->find(i->first);
451 if (i2 != whos_watching_me->end())
453 /* People are watching this user, am i one of them? */
454 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
455 if (n != i2->second.end())
456 /* I'm no longer watching you... */
459 if (i2->second.empty())
460 /* and nobody else is, either. */
461 whos_watching_me->erase(i2);
467 virtual void OnGarbageCollect()
469 watchentries* old_watch = whos_watching_me;
470 whos_watching_me = new watchentries();
472 for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
473 whos_watching_me->insert(*n);
478 virtual void OnPostConnect(User* user)
480 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
481 if (x != whos_watching_me->end())
483 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
485 (*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);
487 watchlist* wl = cmdw.ext.get(*n);
489 /* We were on somebody's notify list, set ourselves online */
490 (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
495 virtual void OnUserPostNick(User* user, const std::string &oldnick)
497 watchentries::iterator new_offline = whos_watching_me->find(oldnick.c_str());
498 watchentries::iterator new_online = whos_watching_me->find(user->nick.c_str());
500 if (new_offline != whos_watching_me->end())
502 for (std::deque<User*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
504 watchlist* wl = cmdw.ext.get(*n);
507 (*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);
508 (*wl)[oldnick.c_str()].clear();
513 if (new_online != whos_watching_me->end())
515 for (std::deque<User*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
517 watchlist* wl = cmdw.ext.get(*n);
520 (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
521 (*n)->WriteNumeric(600, "%s %s %s :arrived online", (*n)->nick.c_str(), user->nick.c_str(), (*wl)[user->nick.c_str()].c_str());
527 virtual void On005Numeric(std::string &output)
529 // we don't really have a limit...
530 output = output + " WATCH=" + ConvToStr(maxwatch);
533 virtual ~Modulewatch()
535 delete whos_watching_me;
538 virtual Version GetVersion()
540 return Version("Provides support for the /WATCH command", VF_OPTCOMMON | VF_VENDOR);
544 MODULE_INIT(Modulewatch)