src/modules/m_watch.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 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                 User* target = ServerInstance->FindNick(parameters[0]);
 132                 if (target)
 133                         return ROUTE_OPT_UCAST(target->server);
 134                 return ROUTE_LOCALONLY;
 135         }
 136 };
 137
 138 /** Handle /WATCH
 139  */
 140 class CommandWatch : public Command
 141 {
 142         unsigned int& MAX_WATCH;
 143  public:
 144         SimpleExtItem<watchlist> ext;
 145         CmdResult remove_watch(User* user, const char* nick)
 146         {
 147                 // removing an item from the list
 148                 if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
 149                 {
 150                         user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick.c_str(), nick);
 151                         return CMD_FAILURE;
 152                 }
 153
 154                 watchlist* wl = ext.get(user);
 155                 if (wl)
 156                 {
 157                         /* Yup, is on my list */
 158                         watchlist::iterator n = wl->find(nick);
 159
 160                         if (!wl)
 161                                 return CMD_FAILURE;
 162
 163                         if (n != wl->end())
 164                         {
 165                                 if (!n->second.empty())
 166                                         user->WriteNumeric(602, "%s %s %s :stopped watching", user->nick.c_str(), n->first.c_str(), n->second.c_str());
 167                                 else
 168                                         user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick.c_str(), nick);
 169
 170                                 wl->erase(n);
 171                         }
 172
 173                         if (wl->empty())
 174                         {
 175                                 ext.unset(user);
 176                         }
 177
 178                         watchentries::iterator x = whos_watching_me->find(nick);
 179                         if (x != whos_watching_me->end())
 180                         {
 181                                 /* People are watching this user, am i one of them? */
 182                                 std::deque<User*>::iterator n2 = std::find(x->second.begin(), x->second.end(), user);
 183                                 if (n2 != x->second.end())
 184                                         /* I'm no longer watching you... */
 185                                         x->second.erase(n2);
 186
 187                                 if (x->second.empty())
 188                                         /* nobody else is, either. */
 189                                         whos_watching_me->erase(nick);
 190                         }
 191                 }
 192
 193                 return CMD_SUCCESS;
 194         }
 195
 196         CmdResult add_watch(User* user, const char* nick)
 197         {
 198                 if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
 199                 {
 200                         user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick.c_str(),nick);
 201                         return CMD_FAILURE;
 202                 }
 203
 204                 watchlist* wl = ext.get(user);
 205                 if (!wl)
 206                 {
 207                         wl = new watchlist();
 208                         ext.set(user, wl);
 209                 }
 210
 211                 if (wl->size() == MAX_WATCH)
 212                 {
 213                         user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick.c_str(), nick);
 214                         return CMD_FAILURE;
 215                 }
 216
 217                 watchlist::iterator n = wl->find(nick);
 218                 if (n == wl->end())
 219                 {
 220                         /* Don't already have the user on my watch list, proceed */
 221                         watchentries::iterator x = whos_watching_me->find(nick);
 222                         if (x != whos_watching_me->end())
 223                         {
 224                                 /* People are watching this user, add myself */
 225                                 x->second.push_back(user);
 226                         }
 227                         else
 228                         {
 229                                 std::deque<User*> newlist;
 230                                 newlist.push_back(user);
 231                                 (*(whos_watching_me))[nick] = newlist;
 232                         }
 233
 234                         User* target = ServerInstance->FindNick(nick);
 235                         if (target)
 236                         {
 237                                 (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
 238                                 user->WriteNumeric(604, "%s %s %s :is online",user->nick.c_str(), nick, (*wl)[nick].c_str());
 239                                 if (IS_AWAY(target))
 240                                 {
 241                                         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);
 242                                 }
 243                         }
 244                         else
 245                         {
 246                                 (*wl)[nick] = "";
 247                                 user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick.c_str(), nick);
 248                         }
 249                 }
 250
 251                 return CMD_SUCCESS;
 252         }
 253
 254         CommandWatch(Module* parent, unsigned int &maxwatch) : Command(parent,"WATCH", 0), MAX_WATCH(maxwatch), ext("watchlist", parent)
 255         {
 256                 syntax = "[C|L|S]|[+|-<nick>]";
 257                 TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
 258         }
 259
 260         CmdResult Handle (const std::vector<std::string> &parameters, User *user)
 261         {
 262                 if (parameters.empty())
 263                 {
 264                         watchlist* wl = ext.get(user);
 265                         if (wl)
 266                         {
 267                                 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
 268                                 {
 269                                         if (!q->second.empty())
 270                                                 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
 271                                 }
 272                         }
 273                         user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
 274                 }
 275                 else if (parameters.size() > 0)
 276                 {
 277                         for (int x = 0; x < (int)parameters.size(); x++)
 278                         {
 279                                 const char *nick = parameters[x].c_str();
 280                                 if (!strcasecmp(nick,"C"))
 281                                 {
 282                                         // watch clear
 283                                         watchlist* wl = ext.get(user);
 284                                         if (wl)
 285                                         {
 286                                                 for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
 287                                                 {
 288                                                         watchentries::iterator i2 = whos_watching_me->find(i->first);
 289                                                         if (i2 != whos_watching_me->end())
 290                                                         {
 291                                                                 /* People are watching this user, am i one of them? */
 292                                                                 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
 293                                                                 if (n != i2->second.end())
 294                                                                         /* I'm no longer watching you... */
 295                                                                         i2->second.erase(n);
 296
 297                                                                 if (i2->second.empty())
 298                                                                         /* nobody else is, either. */
 299                                                                         whos_watching_me->erase(i2);
 300                                                         }
 301                                                 }
 302
 303                                                 ext.unset(user);
 304                                         }
 305                                 }
 306                                 else if (!strcasecmp(nick,"L"))
 307                                 {
 308                                         watchlist* wl = ext.get(user);
 309                                         if (wl)
 310                                         {
 311                                                 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
 312                                                 {
 313                                                         if (!q->second.empty())
 314                                                         {
 315                                                                 user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str());
 316                                                                 User *targ = ServerInstance->FindNick(q->first.c_str());
 317                                                                 if (IS_AWAY(targ))
 318                                                                 {
 319                                                                         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);
 320                                                                 }
 321                                                         }
 322                                                         else
 323                                                                 user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick.c_str(), q->first.c_str());
 324                                                 }
 325                                         }
 326                                         user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
 327                                 }
 328                                 else if (!strcasecmp(nick,"S"))
 329                                 {
 330                                         watchlist* wl = ext.get(user);
 331                                         int you_have = 0;
 332                                         int youre_on = 0;
 333                                         std::string list;
 334
 335                                         if (wl)
 336                                         {
 337                                                 for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
 338                                                         list.append(q->first.c_str()).append(" ");
 339                                                 you_have = wl->size();
 340                                         }
 341
 342                                         watchentries::iterator i2 = whos_watching_me->find(user->nick.c_str());
 343                                         if (i2 != whos_watching_me->end())
 344                                                 youre_on = i2->second.size();
 345
 346                                         user->WriteNumeric(603, "%s :You have %d and are on %d WATCH entries", user->nick.c_str(), you_have, youre_on);
 347                                         user->WriteNumeric(606, "%s :%s",user->nick.c_str(), list.c_str());
 348                                         user->WriteNumeric(607, "%s :End of WATCH S",user->nick.c_str());
 349                                 }
 350                                 else if (nick[0] == '-')
 351                                 {
 352                                         nick++;
 353                                         remove_watch(user, nick);
 354                                 }
 355                                 else if (nick[0] == '+')
 356                                 {
 357                                         nick++;
 358                                         add_watch(user, nick);
 359                                 }
 360                         }
 361                 }
 362                 return CMD_SUCCESS;
 363         }
 364 };
 365
 366 class Modulewatch : public Module
 367 {
 368         unsigned int maxwatch;
 369         CommandWatch cmdw;
 370         CommandSVSWatch sw;
 371
 372  public:
 373         Modulewatch()
 374                 : maxwatch(32), cmdw(this, maxwatch), sw(this)
 375         {
 376                 OnRehash(NULL);
 377                 whos_watching_me = new watchentries();
 378                 ServerInstance->AddCommand(&cmdw);
 379                 ServerInstance->AddCommand(&sw);
 380                 ServerInstance->Extensions.Register(&cmdw.ext);
 381                 Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric, I_OnSetAway };
 382                 ServerInstance->Modules->Attach(eventlist, this, 7);
 383         }
 384
 385         virtual void OnRehash(User* user)
 386         {
 387                 ConfigReader Conf;
 388                 maxwatch = Conf.ReadInteger("watch", "maxentries", 0, true);
 389                 if (!maxwatch)
 390                         maxwatch = 32;
 391         }
 392
 393         virtual ModResult OnSetAway(User *user, const std::string &awaymsg)
 394         {
 395                 std::string numeric;
 396                 int inum;
 397
 398                 if (awaymsg.empty())
 399                 {
 400                         numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :is no longer away";
 401                         inum = 599;
 402                 }
 403                 else
 404                 {
 405                         numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :" + awaymsg;
 406                         inum = 598;
 407                 }
 408
 409                 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
 410                 if (x != whos_watching_me->end())
 411                 {
 412                         for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
 413                         {
 414                                 (*n)->WriteNumeric(inum, numeric);
 415                         }
 416                 }
 417
 418                 return MOD_RES_PASSTHRU;
 419         }
 420
 421         virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 422         {
 423                 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
 424                 if (x != whos_watching_me->end())
 425                 {
 426                         for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
 427                         {
 428                                 (*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());
 429
 430                                 watchlist* wl = cmdw.ext.get(*n);
 431                                 if (wl)
 432                                         /* We were on somebody's notify list, set ourselves offline */
 433                                         (*wl)[user->nick.c_str()] = "";
 434                         }
 435                 }
 436
 437                 /* Now im quitting, if i have a notify list, im no longer watching anyone */
 438                 watchlist* wl = cmdw.ext.get(user);
 439                 if (wl)
 440                 {
 441                         /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
 442                         for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
 443                         {
 444                                 watchentries::iterator i2 = whos_watching_me->find(i->first);
 445                                 if (i2 != whos_watching_me->end())
 446                                 {
 447                                                 /* People are watching this user, am i one of them? */
 448                                                 std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
 449                                                 if (n != i2->second.end())
 450                                                         /* I'm no longer watching you... */
 451                                                         i2->second.erase(n);
 452
 453                                                 if (i2->second.empty())
 454                                                         /* and nobody else is, either. */
 455                                                         whos_watching_me->erase(i2);
 456                                 }
 457                         }
 458                 }
 459         }
 460
 461         virtual void OnGarbageCollect()
 462         {
 463                 watchentries* old_watch = whos_watching_me;
 464                 whos_watching_me = new watchentries();
 465
 466                 for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
 467                         whos_watching_me->insert(*n);
 468
 469                 delete old_watch;
 470         }
 471
 472         virtual void OnPostConnect(User* user)
 473         {
 474                 watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
 475                 if (x != whos_watching_me->end())
 476                 {
 477                         for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
 478                         {
 479                                 (*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);
 480
 481                                 watchlist* wl = cmdw.ext.get(*n);
 482                                 if (wl)
 483                                         /* We were on somebody's notify list, set ourselves online */
 484                                         (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
 485                         }
 486                 }
 487         }
 488
 489         virtual void OnUserPostNick(User* user, const std::string &oldnick)
 490         {
 491                 watchentries::iterator new_offline = whos_watching_me->find(oldnick.c_str());
 492                 watchentries::iterator new_online = whos_watching_me->find(user->nick.c_str());
 493
 494                 if (new_offline != whos_watching_me->end())
 495                 {
 496                         for (std::deque<User*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
 497                         {
 498                                 watchlist* wl = cmdw.ext.get(*n);
 499                                 if (wl)
 500                                 {
 501                                         (*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);
 502                                         (*wl)[oldnick.c_str()] = "";
 503                                 }
 504                         }
 505                 }
 506
 507                 if (new_online != whos_watching_me->end())
 508                 {
 509                         for (std::deque<User*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
 510                         {
 511                                 watchlist* wl = cmdw.ext.get(*n);
 512                                 if (wl)
 513                                 {
 514                                         (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
 515                                         (*n)->WriteNumeric(600, "%s %s %s :arrived online", (*n)->nick.c_str(), user->nick.c_str(), (*wl)[user->nick.c_str()].c_str());
 516                                 }
 517                         }
 518                 }
 519         }
 520
 521         virtual void On005Numeric(std::string &output)
 522         {
 523                 // we don't really have a limit...
 524                 output = output + " WATCH=" + ConvToStr(maxwatch);
 525         }
 526
 527         virtual ~Modulewatch()
 528         {
 529                 delete whos_watching_me;
 530         }
 531
 532         virtual Version GetVersion()
 533         {
 534                 return Version("Provides support for the /WATCH command", VF_OPTCOMMON | VF_VENDOR);
 535         }
 536 };
 537
 538 MODULE_INIT(Modulewatch)
 539