1 /* +------------------------------------+
\r * | Inspire Internet Relay Chat Daemon |
\r * +------------------------------------+
\r *
\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team
\r * See: http://www.inspircd.org/wiki/index.php/Credits
\r *
\r * This program is free but copyrighted software; see
\r * the file COPYING for details.
\r *
\r * ---------------------------------------------------
\r */
\r\r#include "inspircd.h"
\r#include "users.h"
\r#include "channels.h"
\r#include "modules.h"
\r#include "hashcomp.h"
\r\r/* $ModDesc: Provides support for the /WATCH command */
\r\r/* This module has been refactored to provide a very efficient (in terms of cpu time)
\r * implementation of /WATCH.
\r *
\r * To improve the efficiency of watch, many lists are kept. The first primary list is
\r * a hash_map of who's being watched by who. For example:
\r *
\r * KEY: Brain ---> Watched by: Boo, w00t, Om
\r * KEY: Boo ---> Watched by: Brain, w00t
\r *
\r * This is used when we want to tell all the users that are watching someone that
\r * they are now available or no longer available. For example, if the hash was
\r * populated as shown above, then when Brain signs on, messages are sent to Boo, w00t
\r * and Om by reading their 'watched by' list. When this occurs, their online status
\r * in each of these users lists (see below) is also updated.
\r *
\r * Each user also has a seperate (smaller) map attached to their userrec whilst they
\r * have any watch entries, which is managed by class Extensible. When they add or remove
\r * a watch entry from their list, it is inserted here, as well as the main list being
\r * maintained. This map also contains the user's online status. For users that are
\r * offline, the key points at an empty string, and for users that are online, the key
\r * points at a string containing "users-ident users-host users-signon-time". This is
\r * stored in this manner so that we don't have to FindUser() to fetch this info, the
\r * users signon can populate the field for us.
\r *
\r * For example, going again on the example above, this would be w00t's watchlist:
\r *
\r * KEY: Boo ---> Status: "Boo brains.sexy.babe 535342348"
\r * KEY: Brain ---> Status: ""
\r *
\r * In this list we can see that Boo is online, and Brain is offline. We can then
\r * use this list for 'WATCH L', and 'WATCH S' can be implemented as a combination
\r * of the above two data structures, with minimum CPU penalty for doing so.
\r *
\r * In short, the least efficient this ever gets is O(n), and thats only because
\r * there are parts that *must* loop (e.g. telling all users that are watching a
\r * nick that the user online), however this is a *major* improvement over the
\r * 1.0 implementation, which in places had O(n^n) and worse in it, because this
\r * implementation scales based upon the sizes of the watch entries, whereas the
\r * old system would scale (or not as the case may be) according to the total number
\r * of users using WATCH.
\r */
\r\r/*
\r * Before you start screaming, this definition is only used here, so moving it to a header is pointless.
\r * Yes, it's horrid. Blame cl for being different. -- w00t
\r */
\r#ifdef WINDOWS
\rtypedef nspace::hash_map<irc::string, std::deque<userrec*>, nspace::hash_compare<irc::string, less<irc::string> > > watchentries;
\r#else
\rtypedef nspace::hash_map<irc::string, std::deque<userrec*>, nspace::hash<irc::string> > watchentries;
\r#endif
\rtypedef std::map<irc::string, std::string> watchlist;
\r\r/* Who's watching each nickname.
\r * NOTE: We do NOT iterate this to display a user's WATCH list!
\r * See the comments above!
\r */
\rwatchentries* whos_watching_me;
\r\r/** Handle /WATCH
\r */
\rclass cmd_watch : public command_t
\r{
\r unsigned int& MAX_WATCH;
\r public:
\r CmdResult remove_watch(userrec* user, const char* nick)
\r {
\r // removing an item from the list
\r if (!ServerInstance->IsNick(nick))
\r {
\r user->WriteServ("942 %s %s :Invalid nickname", user->nick, nick);
\r return CMD_FAILURE;
\r }
\r\r watchlist* wl;
\r if (user->GetExt("watchlist", wl))
\r {
\r /* Yup, is on my list */
\r watchlist::iterator n = wl->find(nick);
\r if (n != wl->end())
\r {
\r if (!n->second.empty())
\r user->WriteServ("602 %s %s %s :stopped watching", user->nick, n->first.c_str(), n->second.c_str());
\r else
\r user->WriteServ("602 %s %s * * 0 :stopped watching", user->nick, nick);
\r\r wl->erase(n);
\r }
\r\r if (!wl->size())
\r {
\r user->Shrink("watchlist");
\r delete wl;
\r }
\r\r watchentries::iterator x = whos_watching_me->find(nick);
\r if (x != whos_watching_me->end())
\r {
\r /* People are watching this user, am i one of them? */
\r std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
\r if (n != x->second.end())
\r /* I'm no longer watching you... */
\r x->second.erase(n);
\r\r if (!x->second.size())
\r whos_watching_me->erase(nick);
\r }
\r }
\r\r /* This might seem confusing, but we return CMD_FAILURE
\r * to indicate that this message shouldnt be routed across
\r * the network to other linked servers.
\r */
\r return CMD_FAILURE;
\r }
\r\r CmdResult add_watch(userrec* user, const char* nick)
\r {
\r if (!ServerInstance->IsNick(nick))
\r {
\r user->WriteServ("942 %s %s :Invalid nickname",user->nick,nick);
\r return CMD_FAILURE;
\r }
\r\r watchlist* wl;
\r if (!user->GetExt("watchlist", wl))
\r {
\r wl = new watchlist();
\r user->Extend("watchlist", wl);
\r }
\r\r if (wl->size() == MAX_WATCH)
\r {
\r user->WriteServ("512 %s %s :Too many WATCH entries", user->nick, nick);
\r return CMD_FAILURE;
\r }
\r\r watchlist::iterator n = wl->find(nick);
\r if (n == wl->end())
\r {
\r /* Don't already have the user on my watch list, proceed */
\r watchentries::iterator x = whos_watching_me->find(nick);
\r if (x != whos_watching_me->end())
\r {
\r /* People are watching this user, add myself */
\r x->second.push_back(user);
\r }
\r else
\r {
\r std::deque<userrec*> newlist;
\r newlist.push_back(user);
\r (*(whos_watching_me))[nick] = newlist;
\r }
\r\r userrec* target = ServerInstance->FindNick(nick);
\r if (target)
\r {
\r if (target->Visibility && !target->Visibility->VisibleTo(user))
\r {
\r (*wl)[nick] = "";
\r user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick);
\r return CMD_FAILURE;
\r }
\r\r (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
\r user->WriteServ("604 %s %s %s :is online",user->nick, nick, (*wl)[nick].c_str());
\r }
\r else
\r {
\r (*wl)[nick] = "";
\r user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick);
\r }
\r }
\r\r return CMD_FAILURE;
\r }
\r\r cmd_watch (InspIRCd* Instance, unsigned int &maxwatch) : command_t(Instance,"WATCH",0,0), MAX_WATCH(maxwatch)
\r {
\r this->source = "m_watch.so";
\r syntax = "[C|L|S]|[+|-<nick>]";
\r }
\r\r CmdResult Handle (const char** parameters, int pcnt, userrec *user)
\r {
\r if (!pcnt)
\r {
\r watchlist* wl;
\r if (user->GetExt("watchlist", wl))
\r {
\r for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
\r {
\r if (!q->second.empty())
\r user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
\r }
\r }
\r user->WriteServ("607 %s :End of WATCH list",user->nick);
\r }
\r else if (pcnt > 0)
\r {
\r for (int x = 0; x < pcnt; x++)
\r {
\r const char *nick = parameters[x];
\r if (!strcasecmp(nick,"C"))
\r {
\r // watch clear
\r watchlist* wl;
\r if (user->GetExt("watchlist", wl))
\r {
\r for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
\r {
\r watchentries::iterator x = whos_watching_me->find(i->first);
\r if (x != whos_watching_me->end())
\r {
\r /* People are watching this user, am i one of them? */
\r std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
\r if (n != x->second.end())
\r /* I'm no longer watching you... */
\r x->second.erase(n);
\r\r if (!x->second.size())
\r whos_watching_me->erase(user->nick);
\r }
\r }
\r\r delete wl;
\r user->Shrink("watchlist");
\r }
\r }
\r else if (!strcasecmp(nick,"L"))
\r {
\r watchlist* wl;
\r if (user->GetExt("watchlist", wl))
\r {
\r for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
\r {
\r if (!q->second.empty())
\r user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
\r else
\r user->WriteServ("605 %s %s * * 0 :is offline", user->nick, q->first.c_str());
\r }
\r }
\r user->WriteServ("607 %s :End of WATCH list",user->nick);
\r }
\r else if (!strcasecmp(nick,"S"))
\r {
\r watchlist* wl;
\r int you_have = 0;
\r int youre_on = 0;
\r std::string list;
\r\r if (user->GetExt("watchlist", wl))
\r {
\r for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
\r list.append(q->first.c_str()).append(" ");
\r you_have = wl->size();
\r }
\r\r watchentries::iterator x = whos_watching_me->find(user->nick);
\r if (x != whos_watching_me->end())
\r youre_on = x->second.size();
\r\r user->WriteServ("603 %s :You have %d and are on %d WATCH entries", user->nick, you_have, youre_on);
\r user->WriteServ("606 %s :%s",user->nick, list.c_str());
\r user->WriteServ("607 %s :End of WATCH S",user->nick);
\r }
\r else if (nick[0] == '-')
\r {
\r nick++;
\r remove_watch(user, nick);
\r }
\r else if (nick[0] == '+')
\r {
\r nick++;
\r add_watch(user, nick);
\r }
\r }
\r }
\r /* So that spanningtree doesnt pass the WATCH commands to the network! */
\r return CMD_FAILURE;
\r }
\r};
\r\rclass Modulewatch : public Module
\r{
\r cmd_watch* mycommand;
\r unsigned int maxwatch;
\r public:
\r\r Modulewatch(InspIRCd* Me)
\r : Module(Me), maxwatch(32)
\r {
\r OnRehash(NULL, "");
\r whos_watching_me = new watchentries();
\r mycommand = new cmd_watch(ServerInstance, maxwatch);
\r ServerInstance->AddCommand(mycommand);
\r }
\r\r virtual void OnRehash(userrec* user, const std::string ¶meter)
\r {
\r ConfigReader Conf(ServerInstance);
\r maxwatch = Conf.ReadInteger("watch", "maxentries", 0, true);
\r if (!maxwatch)
\r maxwatch = 32;
\r }
\r\r void Implements(char* List)
\r {
\r List[I_OnRehash] = List[I_OnGarbageCollect] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1;
\r }
\r\r virtual void OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
\r {
\r watchentries::iterator x = whos_watching_me->find(user->nick);
\r if (x != whos_watching_me->end())
\r {
\r for (std::deque<userrec*>::iterator n = x->second.begin(); n != x->second.end(); n++)
\r {
\r if (!user->Visibility || user->Visibility->VisibleTo(user))
\r (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick ,user->nick, user->ident, user->dhost, ServerInstance->Time());
\r\r watchlist* wl;
\r if ((*n)->GetExt("watchlist", wl))
\r /* We were on somebody's notify list, set ourselves offline */
\r (*wl)[user->nick] = "";
\r }
\r }
\r\r /* Now im quitting, if i have a notify list, im no longer watching anyone */
\r watchlist* wl;
\r if (user->GetExt("watchlist", wl))
\r {
\r /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
\r for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
\r {
\r watchentries::iterator x = whos_watching_me->find(i->first);
\r if (x != whos_watching_me->end())
\r {
\r /* People are watching this user, am i one of them? */
\r std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
\r if (n != x->second.end())
\r /* I'm no longer watching you... */
\r x->second.erase(n);
\r \r if (!x->second.size())
\r whos_watching_me->erase(user->nick);
\r }
\r }
\r\r /* User's quitting, we're done with this. */
\r delete wl;
\r }
\r }
\r\r virtual void OnGarbageCollect()
\r {
\r watchentries* old_watch = whos_watching_me;
\r whos_watching_me = new watchentries();
\r\r for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
\r whos_watching_me->insert(*n);
\r\r delete old_watch;
\r }
\r\r virtual void OnCleanup(int target_type, void* item)
\r {
\r if (target_type == TYPE_USER)
\r {
\r watchlist* wl;
\r userrec* user = (userrec*)item;
\r\r if (user->GetExt("watchlist", wl))
\r {
\r user->Shrink("watchlist");
\r delete wl;
\r }
\r }
\r }
\r\r virtual void OnPostConnect(userrec* user)
\r {
\r watchentries::iterator x = whos_watching_me->find(user->nick);
\r if (x != whos_watching_me->end())
\r {
\r for (std::deque<userrec*>::iterator n = x->second.begin(); n != x->second.end(); n++)
\r {
\r if (!user->Visibility || user->Visibility->VisibleTo(user))
\r (*n)->WriteServ("600 %s %s %s %s %lu :arrived online", (*n)->nick, user->nick, user->ident, user->dhost, user->age);
\r\r watchlist* wl;
\r if ((*n)->GetExt("watchlist", wl))
\r /* We were on somebody's notify list, set ourselves online */
\r (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
\r }
\r }
\r }
\r\r virtual void OnUserPostNick(userrec* user, const std::string &oldnick)
\r {
\r watchentries::iterator new_online = whos_watching_me->find(user->nick);
\r watchentries::iterator new_offline = whos_watching_me->find(assign(oldnick));
\r\r if (new_online != whos_watching_me->end())
\r {
\r for (std::deque<userrec*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
\r {
\r watchlist* wl;
\r if ((*n)->GetExt("watchlist", wl))
\r {
\r (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
\r if (!user->Visibility || user->Visibility->VisibleTo(user))
\r (*n)->WriteServ("600 %s %s %s :arrived online", (*n)->nick, user->nick, (*wl)[user->nick].c_str());
\r }
\r }
\r }
\r\r if (new_offline != whos_watching_me->end())
\r {
\r for (std::deque<userrec*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
\r {
\r watchlist* wl;
\r if ((*n)->GetExt("watchlist", wl))
\r {
\r if (!user->Visibility || user->Visibility->VisibleTo(user))
\r (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick, oldnick.c_str(), user->ident, user->dhost, user->age);
\r (*wl)[oldnick.c_str()] = "";
\r }
\r }
\r }
\r }
\r\r virtual void On005Numeric(std::string &output)
\r {
\r // we don't really have a limit...
\r output = output + " WATCH=" + ConvToStr(maxwatch);
\r }
\r \r virtual ~Modulewatch()
\r {
\r delete whos_watching_me;
\r }
\r \r virtual Version GetVersion()
\r {
\r return Version(1,1,0,1,VF_VENDOR,API_VERSION);
\r }
\r};
\r\rMODULE_INIT(Modulewatch)
\r\r