src/modules/m_watch.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15
  16 /* $ModDesc: Provides support for the /WATCH command */
  17
  18
  19 /*
  20  * Okay, it's nice that this was documented and all, but I at least understood very little
  21  * of it, so I'm going to attempt to explain the data structures in here a bit more.
  22  *
  23  * For efficiency, many data structures are kept.
  24  *
  25  * The first is a global list `watchentries':
  26  *      hash_map<irc::string, std::deque<User*> >
  27  *
  28  * That is, if nick 'w00t' is being watched by user pointer 'Brain' and 'Om', <w00t, (Brain, Om)>
  29  * will be in the watchentries list.
  30  *
  31  * The second is that each user has a per-user data structure attached to their user record via Extensible:
  32  *      std::map<irc::string, std::string> watchlist;
  33  * So, in the above example with w00t watched by Brain and Om, we'd have:
  34  *      Brain-
  35  *            `- w00t
  36  *      Om-
  37  *         `- w00t
  38  *
  39  * Hopefully this helps any brave soul that ventures into this file other than me. :-)
  40  *              -- w00t (mar 30, 2008)
  41  */
  42
  43
  44 /* This module has been refactored to provide a very efficient (in terms of cpu time)
  45  * implementation of /WATCH.
  46  *
  47  * To improve the efficiency of watch, many lists are kept. The first primary list is
  48  * a hash_map of who's being watched by who. For example:
  49  *
  50  * KEY: Brain   --->  Watched by:  Boo, w00t, Om
  51  * KEY: Boo     --->  Watched by:  Brain, w00t
  52  *
  53  * This is used when we want to tell all the users that are watching someone that
  54  * they are now available or no longer available. For example, if the hash was
  55  * populated as shown above, then when Brain signs on, messages are sent to Boo, w00t
  56  * and Om by reading their 'watched by' list. When this occurs, their online status
  57  * in each of these users lists (see below) is also updated.
  58  *
  59  * Each user also has a seperate (smaller) map attached to their User whilst they
  60  * have any watch entries, which is managed by class Extensible. When they add or remove
  61  * a watch entry from their list, it is inserted here, as well as the main list being
  62  * maintained. This map also contains the user's online status. For users that are
  63  * offline, the key points at an empty string, and for users that are online, the key
  64  * points at a string containing "users-ident users-host users-signon-time". This is
  65  * stored in this manner so that we don't have to FindUser() to fetch this info, the
  66  * users signon can populate the field for us.
  67  *
  68  * For example, going again on the example above, this would be w00t's watchlist:
  69  *
  70  * KEY: Boo    --->  Status: "Boo brains.sexy.babe 535342348"
  71  * KEY: Brain  --->  Status: ""
  72  *
  73  * In this list we can see that Boo is online, and Brain is offline. We can then
  74  * use this list for 'WATCH L', and 'WATCH S' can be implemented as a combination
  75  * of the above two data structures, with minimum CPU penalty for doing so.
  76  *
  77  * In short, the least efficient this ever gets is O(n), and thats only because
  78  * there are parts that *must* loop (e.g. telling all users that are watching a
  79  * nick that the user online), however this is a *major* improvement over the
  80  * 1.0 implementation, which in places had O(n^n) and worse in it, because this
  81  * implementation scales based upon the sizes of the watch entries, whereas the
  82  * old system would scale (or not as the case may be) according to the total number
  83  * of users using WATCH.
  84  */
  85
  86 /*
  87  * Before you start screaming, this definition is only used here, so moving it to a header is pointless.
  88  * Yes, it's horrid. Blame cl for being different. -- w00t
  89  */
  90 #if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
  91         typedef nspace::hash_map<irc::string, std::deque<User*>, nspace::hash_compare<irc::string, std::less<irc::string> > > watchentries;
  92 #else
  93         typedef nspace::hash_map<irc::string, std::deque<User*>, nspace::hash<irc::string> > watchentries;
  94 #endif
  95 typedef std::map<irc::string, std::string> watchlist;
  96
  97 /* Who's watching each nickname.
  98  * NOTE: We do NOT iterate this to display a user's WATCH list!
  99  * See the comments above!
 100  */
 101 watchentries* whos_watching_me;
 102
 103 class CommandSVSWatch : public Command
 104 {
 105  public:
 106         CommandSVSWatch(Module* Creator) : Command(Creator,"SVSWATCH", 2)
 107         {
 108                 syntax = "<target> [C|L|S]|[+|-<nick>]";
 109                 TRANSLATE3(TR_NICK, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
 110         }
 111
 112         CmdResult Handle (const std::vector<std::string> &parameters, User *user)
 113         {
 114                 if (!ServerInstance->ULine(user->server))
 115                         return CMD_FAILURE;
 116
 117                 User *u = ServerInstance->FindNick(parameters[0]);
 118                 if (!u)
 119                         return CMD_FAILURE;
 120
 121                 if (IS_LOCAL(u))
 122                 {
 123                         ServerInstance->Parser->CallHandler("WATCH", parameters, u);
 124                 }
 125
 126                 return CMD_SUCCESS;
 127         }
 128
 129         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 130         {
 131                 return ROUTE_BROADCAST;
 132         }
 133 };
 134
 135 /** Handle /WATCH
 136  */
 137 class CommandWatch : public Command
 138 {
 139         unsigned int& MAX_WATCH;
 140  public:
 141         SimpleExtItem<watchlist> ext;
 142         CmdResult remove_watch(User* user, const char* nick)
 143         {
 144                 // removing an item from the list
 145                 if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
 146                 {
 147                         user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick.c_str(), nick);
 148                         return CMD_FAILURE;
 149                 }
 150
 151                 watchlist* wl = ext.get(user);
 152                 if (wl)
 153                 {
 154                         /* Yup, is on my list */
 155                         watchlist::iterator n = wl->find(nick);
 156
 157                         if (!wl)
 158                                 return CMD_FAILURE;
 159
 160                         if (n != wl->end())
 161                         {
 162                                 if (!n->second.empty())
 163                                         user->WriteNumeric(602, "%s %s %s :stopped watching", user->nick.c_str(), n->first.c_str(), n->second.c_str());
 164                                 else
 165                                         user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick.c_str(), nick);
 166
 167                                 wl->erase(n);
 168                         }
 169
 170                         if (wl->empty())
 171                         {
 172                                 ext.unset(user);
 173                         }
 174
 175                         watchentries::iterator x = whos_watching_me->find(nick);
 176                         if (x != whos_watching_me->end())
 177                         {
 178                                 /* People are watching this user, am i one of them? */
 179                                 std::deque<User*>::iterator n2 = std::find(x->second.begin(), x->second.end(), user);
 180                                 if (n2 != x->second.end())
 181                                         /* I'm no longer watching you... */
 182                                         x->second.erase(n2);
 183
 184                                 if (x->second.empty())
 185                                         /* nobody else is, either. */
 186                                         whos_watching_me->erase(nick);
 187                         }
 188                 }
 189
 190                 return CMD_SUCCESS;
 191         }
 192
 193         CmdResult add_watch(User* user, const char* nick)
 194         {
 195                 if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
 196                 {
 197                         user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick.c_str(),nick);
 198                         return CMD_FAILURE;
 199                 }
 200
 201                 watchlist* wl = ext.get(user);
 202                 if (!wl)
 203                 {
 204                         wl = new watchlist();
 205                         ext.set(user, wl);
 206                 }
 207
 208                 if (wl->size() == MAX_WATCH)
 209                 {
 210                         user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick.c_str(), nick);
 211                         return CMD_FAILURE;
 212                 }
 213
 214                 watchlist::iterator n = wl->find(nick);
 215                 if (n == wl->end())
 216                 {
 217                         /* Don't already have the user on my watch list, proceed */
 218                         watchentries::iterator x = whos_watching_me->find(nick);
 219                         if (x != whos_watching_me->end())
 220                         {
 221                                 /* People are watching this user, add myself */
 222                                 x->second.push_back(user);
 223                         }
 224                         else
 225                         {
 226                                 std::deque<User*> newlist;
 227                                 newlist.push_back(user);
 228                                 (*(whos_watching_me))[nick] = newlist;
 229                         }
 230
 231                         User* target = ServerInstance->FindNick(nick);
 232                         if (target)
 233                         {
 234                                 (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
 235                                 user->WriteNumeric(604, "%s %s %s :is online",user->nick.c_str(), nick, (*wl)[nick].c_str());
 236                                 if (IS_AWAY(target))
 237                                 {
 238                                         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);
 239                                 }
 240                         }
 241                         else
 242                         {
 243                                 (*wl)[nick] = "";
 244                                 user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick.c_str(), nick);
 245                         }
 246                 }
 247
 248                 return CMD_SUCCESS;
 249         }
 250
 251         CommandWatch(Module* parent, unsigned int &maxwatch) : Command(parent,"WATCH", 0), MAX_WATCH(maxwatch), ext("watchlist", parent)
 252         {
 253                 syntax = "[C|L|S]|[+|-<nick>]";
 254                 TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
 255         }
 256
 257         CmdResult Handle (const std::vector<std::string> &parameters, User *user)
 258         {
 259                 if (parameters.empty())
 260                 {
 261                         watchlist* wl = ext.get(user);
 262                         if (wl)
 263                         {
 264                                 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
 265                                 {
 266                                         if (!q->second.empty())
 267                                                 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
 268                                 }
 269                         }
 270                         user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
 271                 }
 272                 else if (parameters.size() > 0)
 273                 {
 274                         for (int x = 0; x < (int)parameters.size(); x++)
 275                         {
 276                                 const char *nick = parameters[x].c_str();
 277                                 if (!strcasecmp(nick,"C"))
 278                                 {
 279                                         // watch clear
 280                                         watchlist* wl = ext.get(user);
 281                                         if (wl)
 282                                         {
 283                                                 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
 284                                                 {
 285                                                         watchentries::iterator i2 = whos_watching_me->find(i->first);
 286                                                         if (i2 != whos_watching_me->end())
 287                                                         {
 288                                                                 /* People are watching this user, am i one of them? */
 289                                                                 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
 290                                                                 if (n != i2->second.end())
 291                                                                         /* I'm no longer watching you... */
 292                                                                         i2->second.erase(n);
 293
 294                                                                 if (i2->second.empty())
 295                                                                         /* nobody else is, either. */
 296                                                                         whos_watching_me->erase(i2);
 297                                                         }
 298                                                 }
 299
 300                                                 ext.unset(user);
 301                                         }
 302                                 }
 303                                 else if (!strcasecmp(nick,"L"))
 304                                 {
 305                                         watchlist* wl = ext.get(user);
 306                                         if (wl)
 307                                         {
 308                                                 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
 309                                                 {
 310                                                         if (!q->second.empty())
 311                                                         {
 312                                                                 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
 313                                                                 User *targ = ServerInstance->FindNick(q->first.c_str());
 314                                                                 if (IS_AWAY(targ))
 315                                                                 {
 316                                                                         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);
 317                                                                 }
 318                                                         }
 319                                                         else
 320                                                                 user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick.c_str(), q->first.c_str());
 321                                                 }
 322                                         }
 323                                         user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
 324                                 }
 325                                 else if (!strcasecmp(nick,"S"))
 326                                 {
 327                                         watchlist* wl = ext.get(user);
 328                                         int you_have = 0;
 329                                         int youre_on = 0;
 330                                         std::string list;
 331
 332                                         if (wl)
 333                                         {
 334                                                 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
 335                                                         list.append(q->first.c_str()).append(" ");
 336                                                 you_have = wl->size();
 337                                         }
 338
 339                                         watchentries::iterator i2 = whos_watching_me->find(user->nick.c_str());
 340                                         if (i2 != whos_watching_me->end())
 341                                                 youre_on = i2->second.size();
 342
 343                                         user->WriteNumeric(603, "%s :You have %d and are on %d WATCH entries", user->nick.c_str(), you_have, youre_on);
 344                                         user->WriteNumeric(606, "%s :%s",user->nick.c_str(), list.c_str());
 345                                         user->WriteNumeric(607, "%s :End of WATCH S",user->nick.c_str());
 346                                 }
 347                                 else if (nick[0] == '-')
 348                                 {
 349                                         nick++;
 350                                         remove_watch(user, nick);
 351                                 }
 352                                 else if (nick[0] == '+')
 353                                 {
 354                                         nick++;
 355                                         add_watch(user, nick);
 356                                 }
 357                         }
 358                 }
 359                 return CMD_SUCCESS;
 360         }
 361 };
 362
 363 class Modulewatch : public Module
 364 {
 365         unsigned int maxwatch;
 366         CommandWatch cmdw;
 367         CommandSVSWatch sw;
 368
 369  public:
 370         Modulewatch()
 371                 : maxwatch(32), cmdw(this, maxwatch), sw(this)
 372         {
 373                 OnRehash(NULL);
 374                 whos_watching_me = new watchentries();
 375                 ServerInstance->AddCommand(&cmdw);
 376                 ServerInstance->AddCommand(&sw);
 377                 Extensible::Register(&cmdw.ext);
 378                 Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnCleanup, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric, I_OnSetAway };
 379                 ServerInstance->Modules->Attach(eventlist, this, 8);
 380         }
 381
 382         virtual void OnRehash(User* user)
 383         {
 384                 ConfigReader Conf;
 385                 maxwatch = Conf.ReadInteger("watch", "maxentries", 0, true);
 386                 if (!maxwatch)
 387                         maxwatch = 32;
 388         }
 389
 390         virtual ModResult OnSetAway(User *user, const std::string &awaymsg)
 391         {
 392                 std::string numeric;
 393                 int inum;
 394
 395                 if (awaymsg.empty())
 396                 {
 397                         numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :is no longer away";
 398                         inum = 599;
 399                 }
 400                 else
 401                 {
 402                         numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :" + awaymsg;
 403                         inum = 598;
 404                 }
 405
 406                 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
 407                 if (x != whos_watching_me->end())
 408                 {
 409                         for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
 410                         {
 411                                 (*n)->WriteNumeric(inum, numeric);
 412                         }
 413                 }
 414
 415                 return MOD_RES_PASSTHRU;
 416         }
 417
 418         virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 419         {
 420                 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
 421                 if (x != whos_watching_me->end())
 422                 {
 423                         for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
 424                         {
 425                                 (*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());
 426
 427                                 watchlist* wl = cmdw.ext.get(*n);
 428                                 if (wl)
 429                                         /* We were on somebody's notify list, set ourselves offline */
 430                                         (*wl)[user->nick.c_str()] = "";
 431                         }
 432                 }
 433
 434                 /* Now im quitting, if i have a notify list, im no longer watching anyone */
 435                 watchlist* wl = cmdw.ext.get(user);
 436                 if (wl)
 437                 {
 438                         /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
 439                         for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
 440                         {
 441                                 watchentries::iterator i2 = whos_watching_me->find(i->first);
 442                                 if (i2 != whos_watching_me->end())
 443                                 {
 444                                                 /* People are watching this user, am i one of them? */
 445                                                 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
 446                                                 if (n != i2->second.end())
 447                                                         /* I'm no longer watching you... */
 448                                                         i2->second.erase(n);
 449
 450                                                 if (i2->second.empty())
 451                                                         /* and nobody else is, either. */
 452                                                         whos_watching_me->erase(i2);
 453                                 }
 454                         }
 455                 }
 456         }
 457
 458         virtual void OnGarbageCollect()
 459         {
 460                 watchentries* old_watch = whos_watching_me;
 461                 whos_watching_me = new watchentries();
 462
 463                 for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
 464                         whos_watching_me->insert(*n);
 465
 466                 delete old_watch;
 467         }
 468
 469         virtual void OnPostConnect(User* user)
 470         {
 471                 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
 472                 if (x != whos_watching_me->end())
 473                 {
 474                         for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
 475                         {
 476                                 (*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);
 477
 478                                 watchlist* wl = cmdw.ext.get(*n);
 479                                 if (wl)
 480                                         /* We were on somebody's notify list, set ourselves online */
 481                                         (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
 482                         }
 483                 }
 484         }
 485
 486         virtual void OnUserPostNick(User* user, const std::string &oldnick)
 487         {
 488                 watchentries::iterator new_offline = whos_watching_me->find(oldnick.c_str());
 489                 watchentries::iterator new_online = whos_watching_me->find(user->nick.c_str());
 490
 491                 if (new_offline != whos_watching_me->end())
 492                 {
 493                         for (std::deque<User*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
 494                         {
 495                                 watchlist* wl = cmdw.ext.get(*n);
 496                                 if (wl)
 497                                 {
 498                                         (*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);
 499                                         (*wl)[oldnick.c_str()] = "";
 500                                 }
 501                         }
 502                 }
 503
 504                 if (new_online != whos_watching_me->end())
 505                 {
 506                         for (std::deque<User*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
 507                         {
 508                                 watchlist* wl = cmdw.ext.get(*n);
 509                                 if (wl)
 510                                 {
 511                                         (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
 512                                         (*n)->WriteNumeric(600, "%s %s %s :arrived online", (*n)->nick.c_str(), user->nick.c_str(), (*wl)[user->nick.c_str()].c_str());
 513                                 }
 514                         }
 515                 }
 516         }
 517
 518         virtual void On005Numeric(std::string &output)
 519         {
 520                 // we don't really have a limit...
 521                 output = output + " WATCH=" + ConvToStr(maxwatch);
 522         }
 523
 524         virtual ~Modulewatch()
 525         {
 526                 delete whos_watching_me;
 527         }
 528
 529         virtual Version GetVersion()
 530         {
 531                 return Version("Provides support for the /WATCH command", VF_COMMON | VF_VENDOR, API_VERSION);
 532         }
 533 };
 534
 535 MODULE_INIT(Modulewatch)
 536