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/>.
27 * Okay, it's nice that this was documented and all, but I at least understood very little
28 * of it, so I'm going to attempt to explain the data structures in here a bit more.
30 * For efficiency, many data structures are kept.
32 * The first is a global list `watchentries':
33 * hash_map<irc::string, std::deque<User*> >
35 * That is, if nick 'w00t' is being watched by user pointer 'Brain' and 'Om', <w00t, (Brain, Om)>
36 * will be in the watchentries list.
38 * The second is that each user has a per-user data structure attached to their user record via Extensible:
39 * std::map<irc::string, std::string> watchlist;
40 * So, in the above example with w00t watched by Brain and Om, we'd have:
46 * Hopefully this helps any brave soul that ventures into this file other than me. :-)
47 * -- w00t (mar 30, 2008)
51 /* This module has been refactored to provide a very efficient (in terms of cpu time)
52 * implementation of /WATCH.
54 * To improve the efficiency of watch, many lists are kept. The first primary list is
55 * a hash_map of who's being watched by who. For example:
57 * KEY: Brain ---> Watched by: Boo, w00t, Om
58 * KEY: Boo ---> Watched by: Brain, w00t
60 * This is used when we want to tell all the users that are watching someone that
61 * they are now available or no longer available. For example, if the hash was
62 * populated as shown above, then when Brain signs on, messages are sent to Boo, w00t
63 * and Om by reading their 'watched by' list. When this occurs, their online status
64 * in each of these users lists (see below) is also updated.
66 * Each user also has a seperate (smaller) map attached to their User whilst they
67 * have any watch entries, which is managed by class Extensible. When they add or remove
68 * a watch entry from their list, it is inserted here, as well as the main list being
69 * maintained. This map also contains the user's online status. For users that are
70 * offline, the key points at an empty string, and for users that are online, the key
71 * points at a string containing "users-ident users-host users-signon-time". This is
72 * stored in this manner so that we don't have to FindUser() to fetch this info, the
73 * users signon can populate the field for us.
75 * For example, going again on the example above, this would be w00t's watchlist:
77 * KEY: Boo ---> Status: "Boo brains.sexy.babe 535342348"
78 * KEY: Brain ---> Status: ""
80 * In this list we can see that Boo is online, and Brain is offline. We can then
81 * use this list for 'WATCH L', and 'WATCH S' can be implemented as a combination
82 * of the above two data structures, with minimum CPU penalty for doing so.
84 * In short, the least efficient this ever gets is O(n), and thats only because
85 * there are parts that *must* loop (e.g. telling all users that are watching a
86 * nick that the user online), however this is a *major* improvement over the
87 * 1.0 implementation, which in places had O(n^n) and worse in it, because this
88 * implementation scales based upon the sizes of the watch entries, whereas the
89 * old system would scale (or not as the case may be) according to the total number
90 * of users using WATCH.
93 typedef TR1NS::unordered_map<irc::string, std::deque<User*>, irc::hash> watchentries;
94 typedef std::map<irc::string, std::string> watchlist;
96 /* Who's watching each nickname.
97 * NOTE: We do NOT iterate this to display a user's WATCH list!
98 * See the comments above!
100 watchentries* whos_watching_me;
102 class CommandSVSWatch : public Command
105 CommandSVSWatch(Module* Creator) : Command(Creator,"SVSWATCH", 2)
107 syntax = "<target> [C|L|S]|[+|-<nick>]";
108 TRANSLATE2(TR_NICK, TR_TEXT); /* we watch for a nick. not a UID. */
111 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
113 if (!user->server->IsULine())
116 User *u = ServerInstance->FindNick(parameters[0]);
122 ServerInstance->Parser.CallHandler("WATCH", parameters, u);
128 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
130 User* target = ServerInstance->FindNick(parameters[0]);
132 return ROUTE_OPT_UCAST(target->server);
133 return ROUTE_LOCALONLY;
139 class CommandWatch : public Command
141 unsigned int& MAX_WATCH;
143 SimpleExtItem<watchlist> ext;
144 CmdResult remove_watch(User* user, const char* nick)
146 // removing an item from the list
147 if (!ServerInstance->IsNick(nick))
149 user->WriteNumeric(942, "%s :Invalid nickname", nick);
153 watchlist* wl = ext.get(user);
156 /* Yup, is on my list */
157 watchlist::iterator n = wl->find(nick);
161 if (!n->second.empty())
162 user->WriteNumeric(602, "%s %s :stopped watching", n->first.c_str(), n->second.c_str());
164 user->WriteNumeric(602, "%s * * 0 :stopped watching", nick);
174 watchentries::iterator x = whos_watching_me->find(nick);
175 if (x != whos_watching_me->end())
177 /* People are watching this user, am i one of them? */
178 std::deque<User*>::iterator n2 = std::find(x->second.begin(), x->second.end(), user);
179 if (n2 != x->second.end())
180 /* I'm no longer watching you... */
183 if (x->second.empty())
184 /* nobody else is, either. */
185 whos_watching_me->erase(nick);
192 CmdResult add_watch(User* user, const char* nick)
194 if (!ServerInstance->IsNick(nick))
196 user->WriteNumeric(942, "%s :Invalid nickname", nick);
200 watchlist* wl = ext.get(user);
203 wl = new watchlist();
207 if (wl->size() >= MAX_WATCH)
209 user->WriteNumeric(512, "%s :Too many WATCH entries", nick);
213 watchlist::iterator n = wl->find(nick);
216 /* Don't already have the user on my watch list, proceed */
217 watchentries::iterator x = whos_watching_me->find(nick);
218 if (x != whos_watching_me->end())
220 /* People are watching this user, add myself */
221 x->second.push_back(user);
225 std::deque<User*> newlist;
226 newlist.push_back(user);
227 (*(whos_watching_me))[nick] = newlist;
230 User* target = ServerInstance->FindNick(nick);
231 if ((target) && (target->registered == REG_ALL))
233 (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
234 user->WriteNumeric(604, "%s %s :is online", nick, (*wl)[nick].c_str());
235 if (target->IsAway())
237 user->WriteNumeric(609, "%s %s %s %lu :is away", target->nick.c_str(), target->ident.c_str(), target->dhost.c_str(), (unsigned long) target->awaytime);
243 user->WriteNumeric(605, "%s * * 0 :is offline", nick);
250 CommandWatch(Module* parent, unsigned int &maxwatch) : Command(parent,"WATCH", 0), MAX_WATCH(maxwatch), ext("watchlist", ExtensionItem::EXT_USER, parent)
252 syntax = "[C|L|S]|[+|-<nick>]";
255 CmdResult Handle (const std::vector<std::string> ¶meters, User *user)
257 if (parameters.empty())
259 watchlist* wl = ext.get(user);
262 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
264 if (!q->second.empty())
265 user->WriteNumeric(604, "%s %s :is online", q->first.c_str(), q->second.c_str());
268 user->WriteNumeric(607, ":End of WATCH list");
270 else if (parameters.size() > 0)
272 for (int x = 0; x < (int)parameters.size(); x++)
274 const char *nick = parameters[x].c_str();
275 if (!strcasecmp(nick,"C"))
278 watchlist* wl = ext.get(user);
281 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
283 watchentries::iterator i2 = whos_watching_me->find(i->first);
284 if (i2 != whos_watching_me->end())
286 /* People are watching this user, am i one of them? */
287 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
288 if (n != i2->second.end())
289 /* I'm no longer watching you... */
292 if (i2->second.empty())
293 /* nobody else is, either. */
294 whos_watching_me->erase(i2);
301 else if (!strcasecmp(nick,"L"))
303 watchlist* wl = ext.get(user);
306 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
308 User* targ = ServerInstance->FindNick(q->first.c_str());
309 if (targ && !q->second.empty())
311 user->WriteNumeric(604, "%s %s :is online", q->first.c_str(), q->second.c_str());
314 user->WriteNumeric(609, "%s %s %s %lu :is away", targ->nick.c_str(), targ->ident.c_str(), targ->dhost.c_str(), (unsigned long) targ->awaytime);
318 user->WriteNumeric(605, "%s * * 0 :is offline", q->first.c_str());
321 user->WriteNumeric(607, ":End of WATCH list");
323 else if (!strcasecmp(nick,"S"))
325 watchlist* wl = ext.get(user);
332 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
333 list.append(q->first.c_str()).append(" ");
334 you_have = wl->size();
337 watchentries::iterator i2 = whos_watching_me->find(user->nick.c_str());
338 if (i2 != whos_watching_me->end())
339 youre_on = i2->second.size();
341 user->WriteNumeric(603, ":You have %d and are on %d WATCH entries", you_have, youre_on);
342 user->WriteNumeric(606, ":%s", list.c_str());
343 user->WriteNumeric(607, ":End of WATCH S");
345 else if (nick[0] == '-')
348 remove_watch(user, nick);
350 else if (nick[0] == '+')
353 add_watch(user, nick);
361 class Modulewatch : public Module
363 unsigned int maxwatch;
369 : maxwatch(32), cmdw(this, maxwatch), sw(this)
371 whos_watching_me = new watchentries();
374 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
376 maxwatch = ServerInstance->Config->ConfValue("watch")->getInt("maxentries", 32);
381 ModResult OnSetAway(User *user, const std::string &awaymsg) CXX11_OVERRIDE
388 numeric = user->nick + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :is no longer away";
393 numeric = user->nick + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :" + awaymsg;
397 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
398 if (x != whos_watching_me->end())
400 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
402 (*n)->WriteNumeric(inum, numeric);
406 return MOD_RES_PASSTHRU;
409 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE
411 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
412 if (x != whos_watching_me->end())
414 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
416 (*n)->WriteNumeric(601, "%s %s %s %lu :went offline", user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) ServerInstance->Time());
418 watchlist* wl = cmdw.ext.get(*n);
420 /* We were on somebody's notify list, set ourselves offline */
421 (*wl)[user->nick.c_str()].clear();
425 /* Now im quitting, if i have a notify list, im no longer watching anyone */
426 watchlist* wl = cmdw.ext.get(user);
429 /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
430 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
432 watchentries::iterator i2 = whos_watching_me->find(i->first);
433 if (i2 != whos_watching_me->end())
435 /* People are watching this user, am i one of them? */
436 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
437 if (n != i2->second.end())
438 /* I'm no longer watching you... */
441 if (i2->second.empty())
442 /* and nobody else is, either. */
443 whos_watching_me->erase(i2);
449 void OnGarbageCollect()
451 watchentries* old_watch = whos_watching_me;
452 whos_watching_me = new watchentries();
454 for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
455 whos_watching_me->insert(*n);
460 void OnPostConnect(User* user) CXX11_OVERRIDE
462 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
463 if (x != whos_watching_me->end())
465 for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
467 (*n)->WriteNumeric(600, "%s %s %s %lu :arrived online", user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) user->age);
469 watchlist* wl = cmdw.ext.get(*n);
471 /* We were on somebody's notify list, set ourselves online */
472 (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
477 void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE
479 watchentries::iterator new_offline = whos_watching_me->find(oldnick.c_str());
480 watchentries::iterator new_online = whos_watching_me->find(user->nick.c_str());
482 if (new_offline != whos_watching_me->end())
484 for (std::deque<User*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
486 watchlist* wl = cmdw.ext.get(*n);
489 (*n)->WriteNumeric(601, "%s %s %s %lu :went offline", oldnick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) user->age);
490 (*wl)[oldnick.c_str()].clear();
495 if (new_online != whos_watching_me->end())
497 for (std::deque<User*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
499 watchlist* wl = cmdw.ext.get(*n);
502 (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
503 (*n)->WriteNumeric(600, "%s %s :arrived online", user->nick.c_str(), (*wl)[user->nick.c_str()].c_str());
509 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
511 tokens["WATCH"] = ConvToStr(maxwatch);
516 delete whos_watching_me;
519 Version GetVersion() CXX11_OVERRIDE
521 return Version("Provides support for the /WATCH command", VF_OPTCOMMON | VF_VENDOR);
525 MODULE_INIT(Modulewatch)