src/modules/m_watch.cpp

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