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 * ---------------------------------------------------
20 /* $ModDesc: Provides support for the /WATCH command */
22 /* This module has been refactored to provide a very efficient (in terms of cpu time)
23 * implementation of /WATCH.
25 * To improve the efficiency of watch, many lists are kept. The first primary list is
26 * a hash_map of who's being watched by who. For example:
28 * KEY: Brain ---> Watched by: Boo, w00t, Om
29 * KEY: Boo ---> Watched by: Brain, w00t
31 * This is used when we want to tell all the users that are watching someone that
32 * they are now available or no longer available. For example, if the hash was
33 * populated as shown above, then when Brain signs on, messages are sent to Boo, w00t
34 * and Om by reading their 'watched by' list. When this occurs, their online status
35 * in each of these users lists (see below) is also updated.
37 * Each user also has a seperate (smaller) map attached to their userrec whilst they
38 * have any watch entries, which is managed by class Extensible. When they add or remove
39 * a watch entry from their list, it is inserted here, as well as the main list being
40 * maintained. This map also contains the user's online status. For users that are
41 * offline, the key points at an empty string, and for users that are online, the key
42 * points at a string containing "users-ident users-host users-signon-time". This is
43 * stored in this manner so that we don't have to FindUser() to fetch this info, the
44 * users signon can populate the field for us.
46 * For example, going again on the example above, this would be w00t's watchlist:
48 * KEY: Boo ---> Status: "Boo brains.sexy.babe 535342348"
49 * KEY: Brain ---> Status: ""
51 * In this list we can see that Boo is online, and Brain is offline. We can then
52 * use this list for 'WATCH L', and 'WATCH S' can be implemented as a combination
53 * of the above two data structures, with minimum CPU penalty for doing so.
55 * In short, the least efficient this ever gets is O(n), and thats only because
56 * there are parts that *must* loop (e.g. telling all users that are watching a
57 * nick that the user online), however this is a *major* improvement over the
58 * 1.0 implementation, which in places had O(n^n) and worse in it, because this
59 * implementation scales based upon the sizes of the watch entries, whereas the
60 * old system would scale (or not as the case may be) according to the total number
61 * of users using WATCH.
64 typedef nspace::hash_map<irc::string, std::deque<userrec*>, nspace::hash<irc::string> > watchentries;
65 typedef std::map<irc::string, std::string> watchlist;
67 /* Who's watching each nickname.
68 * NOTE: We do NOT iterate this to display a user's WATCH list!
69 * See the comments above!
71 watchentries* whos_watching_me;
75 class cmd_watch : public command_t
77 unsigned int& MAX_WATCH;
79 CmdResult remove_watch(userrec* user, const char* nick)
81 // removing an item from the list
82 if (!ServerInstance->IsNick(nick))
84 user->WriteServ("942 %s %s :Invalid nickname", user->nick, nick);
89 if (user->GetExt("watchlist", wl))
91 /* Yup, is on my list */
92 watchlist::iterator n = wl->find(nick);
95 if (!n->second.empty())
96 user->WriteServ("602 %s %s %s :stopped watching", user->nick, n->first.c_str(), n->second.c_str());
98 user->WriteServ("602 %s %s * * 0 :stopped watching", user->nick, nick);
105 user->Shrink("watchlist");
109 watchentries::iterator x = whos_watching_me->find(nick);
110 if (x != whos_watching_me->end())
112 /* People are watching this user, am i one of them? */
113 std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
114 if (n != x->second.end())
115 /* I'm no longer watching you... */
118 if (!x->second.size())
119 whos_watching_me->erase(nick);
123 /* This might seem confusing, but we return CMD_FAILURE
124 * to indicate that this message shouldnt be routed across
125 * the network to other linked servers.
130 CmdResult add_watch(userrec* user, const char* nick)
132 if (!ServerInstance->IsNick(nick))
134 user->WriteServ("942 %s %s :Invalid nickname",user->nick,nick);
139 if (!user->GetExt("watchlist", wl))
141 wl = new watchlist();
142 user->Extend("watchlist", wl);
145 if (wl->size() == MAX_WATCH)
147 user->WriteServ("512 %s %s :Too many WATCH entries", user->nick, nick);
151 watchlist::iterator n = wl->find(nick);
154 /* Don't already have the user on my watch list, proceed */
155 watchentries::iterator x = whos_watching_me->find(nick);
156 if (x != whos_watching_me->end())
158 /* People are watching this user, add myself */
159 x->second.push_back(user);
163 std::deque<userrec*> newlist;
164 newlist.push_back(user);
165 (*(whos_watching_me))[nick] = newlist;
168 userrec* target = ServerInstance->FindNick(nick);
171 if (target->Visibility && !target->Visibility->VisibleTo(user))
174 user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick);
178 (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
179 user->WriteServ("604 %s %s %s :is online",user->nick, nick, (*wl)[nick].c_str());
184 user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick);
191 cmd_watch (InspIRCd* Instance, unsigned int &maxwatch) : command_t(Instance,"WATCH",0,0), MAX_WATCH(maxwatch)
193 this->source = "m_watch.so";
194 syntax = "[C|L|S]|[+|-<nick>]";
197 CmdResult Handle (const char** parameters, int pcnt, userrec *user)
202 if (user->GetExt("watchlist", wl))
204 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
206 if (!q->second.empty())
207 user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
210 user->WriteServ("607 %s :End of WATCH list",user->nick);
214 for (int x = 0; x < pcnt; x++)
216 const char *nick = parameters[x];
217 if (!strcasecmp(nick,"C"))
221 if (user->GetExt("watchlist", wl))
223 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
225 watchentries::iterator x = whos_watching_me->find(i->first);
226 if (x != whos_watching_me->end())
228 /* People are watching this user, am i one of them? */
229 std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
230 if (n != x->second.end())
231 /* I'm no longer watching you... */
234 if (!x->second.size())
235 whos_watching_me->erase(user->nick);
240 user->Shrink("watchlist");
243 else if (!strcasecmp(nick,"L"))
246 if (user->GetExt("watchlist", wl))
248 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
250 if (!q->second.empty())
251 user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
253 user->WriteServ("605 %s %s * * 0 :is offline", user->nick, q->first.c_str());
256 user->WriteServ("607 %s :End of WATCH list",user->nick);
258 else if (!strcasecmp(nick,"S"))
265 if (user->GetExt("watchlist", wl))
267 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
268 list.append(q->first.c_str()).append(" ");
269 you_have = wl->size();
272 watchentries::iterator x = whos_watching_me->find(user->nick);
273 if (x != whos_watching_me->end())
274 youre_on = x->second.size();
276 user->WriteServ("603 %s :You have %d and are on %d WATCH entries", user->nick, you_have, youre_on);
277 user->WriteServ("606 %s :%s",user->nick, list.c_str());
278 user->WriteServ("607 %s :End of WATCH S",user->nick);
280 else if (nick[0] == '-')
283 remove_watch(user, nick);
285 else if (nick[0] == '+')
288 add_watch(user, nick);
292 /* So that spanningtree doesnt pass the WATCH commands to the network! */
297 class Modulewatch : public Module
299 cmd_watch* mycommand;
300 unsigned int maxwatch;
303 Modulewatch(InspIRCd* Me)
304 : Module::Module(Me), maxwatch(32)
306 whos_watching_me = new watchentries();
307 mycommand = new cmd_watch(ServerInstance, maxwatch);
308 ServerInstance->AddCommand(mycommand);
311 void Implements(char* List)
313 List[I_OnGarbageCollect] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1;
316 virtual void OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
318 watchentries::iterator x = whos_watching_me->find(user->nick);
319 if (x != whos_watching_me->end())
321 for (std::deque<userrec*>::iterator n = x->second.begin(); n != x->second.end(); n++)
323 if (!user->Visibility || user->Visibility->VisibleTo(user))
324 (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick ,user->nick, user->ident, user->dhost, ServerInstance->Time());
327 if ((*n)->GetExt("watchlist", wl))
328 /* We were on somebody's notify list, set ourselves offline */
329 (*wl)[user->nick] = "";
333 /* Now im quitting, if i have a notify list, im no longer watching anyone */
335 if (user->GetExt("watchlist", wl))
337 /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
338 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
340 watchentries::iterator x = whos_watching_me->find(i->first);
341 if (x != whos_watching_me->end())
343 /* People are watching this user, am i one of them? */
344 std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
345 if (n != x->second.end())
346 /* I'm no longer watching you... */
349 if (!x->second.size())
350 whos_watching_me->erase(user->nick);
354 /* User's quitting, we're done with this. */
359 virtual void OnGarbageCollect()
361 watchentries* old_watch = whos_watching_me;
362 whos_watching_me = new watchentries();
364 for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
365 whos_watching_me->insert(*n);
370 virtual void OnCleanup(int target_type, void* item)
372 if (target_type == TYPE_USER)
375 userrec* user = (userrec*)item;
377 if (user->GetExt("watchlist", wl))
379 user->Shrink("watchlist");
385 virtual void OnPostConnect(userrec* user)
387 watchentries::iterator x = whos_watching_me->find(user->nick);
388 if (x != whos_watching_me->end())
390 for (std::deque<userrec*>::iterator n = x->second.begin(); n != x->second.end(); n++)
392 if (!user->Visibility || user->Visibility->VisibleTo(user))
393 (*n)->WriteServ("600 %s %s %s %s %lu :arrived online", (*n)->nick, user->nick, user->ident, user->dhost, user->age);
396 if ((*n)->GetExt("watchlist", wl))
397 /* We were on somebody's notify list, set ourselves online */
398 (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
403 virtual void OnUserPostNick(userrec* user, const std::string &oldnick)
405 watchentries::iterator new_online = whos_watching_me->find(user->nick);
406 watchentries::iterator new_offline = whos_watching_me->find(assign(oldnick));
408 if (new_online != whos_watching_me->end())
410 for (std::deque<userrec*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
413 if ((*n)->GetExt("watchlist", wl))
415 (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
416 if (!user->Visibility || user->Visibility->VisibleTo(user))
417 (*n)->WriteServ("600 %s %s %s :arrived online", (*n)->nick, user->nick, (*wl)[user->nick].c_str());
422 if (new_offline != whos_watching_me->end())
424 for (std::deque<userrec*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
427 if ((*n)->GetExt("watchlist", wl))
429 if (!user->Visibility || user->Visibility->VisibleTo(user))
430 (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick, oldnick.c_str(), user->ident, user->dhost, user->age);
431 (*wl)[user->nick] = "";
437 virtual void On005Numeric(std::string &output)
439 // we don't really have a limit...
440 output = output + " WATCH=32";
443 virtual ~Modulewatch()
445 delete whos_watching_me;
448 virtual Version GetVersion()
450 return Version(1,1,0,1,VF_VENDOR,API_VERSION);
455 class ModulewatchFactory : public ModuleFactory
462 ~ModulewatchFactory()
466 virtual Module * CreateModule(InspIRCd* Me)
468 return new Modulewatch(Me);
474 extern "C" void * init_module( void )
476 return new ModulewatchFactory;