src/modules/m_watch.cpp

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