X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_watch.cpp;h=f1cef7bf0269d7ff8d8c3f54a4c82e306fa66870;hb=3795d18aeecb27f31364c6f32730d0d147819423;hp=faf0792dc11da72fd2c6c8453ee53d51d635bb2d;hpb=73e972340bee8ea9cdbbe5520b1b461fbce1f121;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_watch.cpp b/src/modules/m_watch.cpp index faf0792dc..f1cef7bf0 100644 --- a/src/modules/m_watch.cpp +++ b/src/modules/m_watch.cpp @@ -2,271 +2,421 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ -using namespace std; - -#include -#include -#include #include "users.h" #include "channels.h" #include "modules.h" -#include "helperfuncs.h" #include "hashcomp.h" +#include "inspircd.h" -/* $ModDesc: Provides support for the /watch command */ +/* $ModDesc: Provides support for the /WATCH command */ -static Server *Srv; +/* This module has been refactored to provide a very efficient (in terms of cpu time) + * implementation of /WATCH. + * + * To improve the efficiency of watch, many lists are kept. The first primary list is + * a hash_map of who's being watched by who. For example: + * + * KEY: Brain ---> Watched by: Boo, w00t, Om + * KEY: Boo ---> Watched by: Brain, w00t + * + * This is used when we want to tell all the users that are watching someone that + * they are now available or no longer available. For example, if the hash was + * populated as shown above, then when Brain signs on, messages are sent to Boo, w00t + * and Om by reading their 'watched by' list. When this occurs, their online status + * in each of these users lists (see below) is also updated. + * + * Each user also has a seperate (smaller) map attached to their userrec whilst they + * have any watch entries, which is managed by class Extensible. When they add or remove + * a watch entry from their list, it is inserted here, as well as the main list being + * maintained. This map also contains the user's online status. For users that are + * offline, the key points at an empty string, and for users that are online, the key + * points at a string containing "users-ident users-host users-signon-time". This is + * stored in this manner so that we don't have to FindUser() to fetch this info, the + * users signon can populate the field for us. + * + * For example, going again on the example above, this would be w00t's watchlist: + * + * KEY: Boo ---> Status: "Boo brains.sexy.babe 535342348" + * KEY: Brain ---> Status: "" + * + * In this list we can see that Boo is online, and Brain is offline. We can then + * use this list for 'WATCH L', and 'WATCH S' can be implemented as a combination + * of the above two data structures, with minimum CPU penalty for doing so. + * + * In short, the least efficient this ever gets is O(n), and thats only because + * there are parts that *must* loop (e.g. telling all users that are watching a + * nick that the user online), however this is a *major* improvement over the + * 1.0 implementation, which in places had O(n^n) and worse in it, because this + * implementation scales based upon the sizes of the watch entries, whereas the + * old system would scale (or not as the case may be) according to the total number + * of users using WATCH. + */ -class watchentry : public classbase -{ - public: - userrec* watcher; - std::string target; -}; +typedef nspace::hash_map, nspace::hash > watchentries; +typedef std::map watchlist; -typedef std::vector watchlist; -watchlist watches; +/* Who's watching each nickname. + * NOTE: We do NOT iterate this to display a user's WATCH list! + * See the comments above! + */ +watchentries* whos_watching_me; +/** Handle /WATCH + */ class cmd_watch : public command_t { + unsigned int& MAX_WATCH; public: - cmd_watch() : command_t("WATCH",0,0) + CmdResult remove_watch(userrec* user, const char* nick) + { + // removing an item from the list + if (!ServerInstance->IsNick(nick)) + { + user->WriteServ("942 %s %s :Invalid nickname", user->nick, nick); + return CMD_FAILURE; + } + + watchlist* wl; + if (user->GetExt("watchlist", wl)) + { + /* Yup, is on my list */ + watchlist::iterator n = wl->find(nick); + if (n != wl->end()) + { + if (!n->second.empty()) + user->WriteServ("602 %s %s %s :stopped watching", user->nick, n->first.c_str(), n->second.c_str()); + else + user->WriteServ("602 %s %s * * 0 :stopped watching", user->nick, nick); + + wl->erase(n); + } + + if (!wl->size()) + { + user->Shrink("watchlist"); + delete wl; + } + + watchentries::iterator x = whos_watching_me->find(nick); + if (x != whos_watching_me->end()) + { + /* People are watching this user, am i one of them? */ + std::deque::iterator n = std::find(x->second.begin(), x->second.end(), user); + if (n != x->second.end()) + /* I'm no longer watching you... */ + x->second.erase(n); + + if (!x->second.size()) + whos_watching_me->erase(nick); + } + } + + /* This might seem confusing, but we return CMD_FAILURE + * to indicate that this message shouldnt be routed across + * the network to other linked servers. + */ + return CMD_FAILURE; + } + + CmdResult add_watch(userrec* user, const char* nick) + { + if (!ServerInstance->IsNick(nick)) + { + user->WriteServ("942 %s %s :Invalid nickname",user->nick,nick); + return CMD_FAILURE; + } + + watchlist* wl; + if (!user->GetExt("watchlist", wl)) + { + wl = new watchlist(); + user->Extend("watchlist", wl); + } + + if (wl->size() == MAX_WATCH) + { + user->WriteServ("512 %s %s :Too many WATCH entries", user->nick, nick); + return CMD_FAILURE; + } + + watchlist::iterator n = wl->find(nick); + if (n == wl->end()) + { + /* Don't already have the user on my watch list, proceed */ + watchentries::iterator x = whos_watching_me->find(nick); + if (x != whos_watching_me->end()) + { + /* People are watching this user, add myself */ + x->second.push_back(user); + } + else + { + std::deque newlist; + newlist.push_back(user); + (*(whos_watching_me))[nick] = newlist; + } + + userrec* target = ServerInstance->FindNick(nick); + if (target) + { + (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age)); + user->WriteServ("604 %s %s %s :is online",user->nick, nick, (*wl)[nick].c_str()); + } + else + { + (*wl)[nick] = ""; + user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick); + } + } + + return CMD_FAILURE; + } + + cmd_watch (InspIRCd* Instance, unsigned int &maxwatch) : command_t(Instance,"WATCH",0,0), MAX_WATCH(maxwatch) { this->source = "m_watch.so"; + syntax = "[C|L|S]|[+|-]"; } - void Handle (char **parameters, int pcnt, userrec *user) + CmdResult Handle (const char** parameters, int pcnt, userrec *user) { if (!pcnt) { - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + watchlist* wl; + if (user->GetExt("watchlist", wl)) { - if (q->watcher == user) + for (watchlist::iterator q = wl->begin(); q != wl->end(); q++) { - userrec* targ = Srv->FindNick(q->target); - if (targ) - { - WriteServ(user->fd,"604 %s %s %s %s %lu :is online",user->nick,targ->nick,targ->ident,targ->dhost,targ->age); - } + if (!q->second.empty()) + user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str()); } } - WriteServ(user->fd,"607 %s :End of WATCH list",user->nick); + user->WriteServ("607 %s :End of WATCH list",user->nick); } else if (pcnt > 0) { for (int x = 0; x < pcnt; x++) { - char *nick = parameters[x]; + const char *nick = parameters[x]; if (!strcasecmp(nick,"C")) { // watch clear - bool done = false; - while (!done) + watchlist* wl; + if (user->GetExt("watchlist", wl)) { - done = true; - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + for (watchlist::iterator i = wl->begin(); i != wl->end(); i++) { - if (q->watcher == user) + watchentries::iterator x = whos_watching_me->find(i->first); + if (x != whos_watching_me->end()) { - done = false; - watches.erase(q); - break; + /* People are watching this user, am i one of them? */ + std::deque::iterator n = std::find(x->second.begin(), x->second.end(), user); + if (n != x->second.end()) + /* I'm no longer watching you... */ + x->second.erase(n); + + if (!x->second.size()) + whos_watching_me->erase(user->nick); } } + + delete wl; + user->Shrink("watchlist"); } } else if (!strcasecmp(nick,"L")) { - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + watchlist* wl; + if (user->GetExt("watchlist", wl)) { - if (q->watcher == user) + for (watchlist::iterator q = wl->begin(); q != wl->end(); q++) { - userrec* targ = Srv->FindNick(q->target); - if (targ) - { - WriteServ(user->fd,"604 %s %s %s %s %lu :is online",user->nick,targ->nick,targ->ident,targ->dhost,targ->age); - } + if (!q->second.empty()) + user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str()); + else + user->WriteServ("605 %s %s * * 0 :is offline", user->nick, q->first.c_str()); } } - WriteServ(user->fd,"607 %s :End of WATCH list",user->nick); + user->WriteServ("607 %s :End of WATCH list",user->nick); } else if (!strcasecmp(nick,"S")) { - std::string list = ""; - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + watchlist* wl; + int you_have = 0; + int youre_on = 0; + std::string list; + + if (user->GetExt("watchlist", wl)) { - if (q->watcher == user) - { - list = list + " " + q->target; - } + for (watchlist::iterator q = wl->begin(); q != wl->end(); q++) + list.append(q->first.c_str()).append(" "); + you_have = wl->size(); } - char* l = (char*)list.c_str(); - if (*l == ' ') - l++; - WriteServ(user->fd,"606 %s :%s",user->nick,l); - WriteServ(user->fd,"607 %s :End of WATCH S",user->nick); + + watchentries::iterator x = whos_watching_me->find(user->nick); + if (x != whos_watching_me->end()) + youre_on = x->second.size(); + + user->WriteServ("603 %s :You have %d and are on %d WATCH entries", user->nick, you_have, youre_on); + user->WriteServ("606 %s :%s",user->nick, list.c_str()); + user->WriteServ("607 %s :End of WATCH S",user->nick); } else if (nick[0] == '-') { - // removing an item from the list nick++; - irc::string n1 = nick; - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) - { - if (q->watcher == user) - { - irc::string n2 = q->target.c_str(); - userrec* a = Srv->FindNick(q->target); - if (a) - { - WriteServ(user->fd,"602 %s %s %s %s %lu :stopped watching",user->nick,a->nick,a->ident,a->dhost,a->age); - } - else - { - WriteServ(user->fd,"602 %s %s * * 0 :stopped watching",user->nick,q->target.c_str()); - } - if (n1 == n2) - { - watches.erase(q); - break; - } - } - } + remove_watch(user, nick); } else if (nick[0] == '+') { nick++; - irc::string n1 = nick; - bool exists = false; - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) - { - if (q->watcher == user) - { - irc::string n2 = q->target.c_str(); - if (n1 == n2) - { - // already on watch list - exists = true; - } - } - } - if (!exists) - { - watchentry w; - w.watcher = user; - w.target = nick; - watches.push_back(w); - log(DEBUG,"*** Added %s to watchlist of %s",nick,user->nick); - } - userrec* a = Srv->FindNick(nick); - if (a) - { - WriteServ(user->fd,"604 %s %s %s %s %lu :is online",user->nick,a->nick,a->ident,a->dhost,a->age); - } - else - { - WriteServ(user->fd,"605 %s %s * * 0 :is offline",user->nick,nick); - } + add_watch(user, nick); } } } - return; + /* So that spanningtree doesnt pass the WATCH commands to the network! */ + return CMD_FAILURE; } }; class Modulewatch : public Module { cmd_watch* mycommand; + unsigned int maxwatch; public: - Modulewatch(Server* Me) - : Module::Module(Me) + Modulewatch(InspIRCd* Me) + : Module::Module(Me), maxwatch(32) { - Srv = Me; - mycommand = new cmd_watch(); - Srv->AddCommand(mycommand); + whos_watching_me = new watchentries(); + mycommand = new cmd_watch(ServerInstance, maxwatch); + ServerInstance->AddCommand(mycommand); } void Implements(char* List) { - List[I_OnUserQuit] = List[I_OnGlobalConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1; + List[I_OnGarbageCollect] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1; } virtual void OnUserQuit(userrec* user, const std::string &reason) { - log(DEBUG,"*** WATCH: On global quit: user %s",user->nick); - irc::string n2 = user->nick; - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + watchentries::iterator x = whos_watching_me->find(user->nick); + if (x != whos_watching_me->end()) { - irc::string n1 = q->target.c_str(); - if (n1 == n2) + for (std::deque::iterator n = x->second.begin(); n != x->second.end(); n++) { - log(DEBUG,"*** WATCH: On global quit: user %s is in notify of %s",user->nick,q->watcher->nick); - WriteServ(q->watcher->fd,"601 %s %s %s %s %lu :went offline",q->watcher->nick,user->nick,user->ident,user->dhost,time(NULL)); + (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick ,user->nick, user->ident, user->dhost, ServerInstance->Time()); + watchlist* wl; + if ((*n)->GetExt("watchlist", wl)) + /* We were on somebody's notify list, set ourselves offline */ + (*wl)[user->nick] = ""; } } - bool done = false; - while (!done) + + /* Now im quitting, if i have a notify list, im no longer watching anyone */ + watchlist* wl; + if (user->GetExt("watchlist", wl)) { - done = true; - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + /* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */ + for (watchlist::iterator i = wl->begin(); i != wl->end(); i++) { - if (q->watcher == user) + watchentries::iterator x = whos_watching_me->find(i->first); + if (x != whos_watching_me->end()) { - done = false; - watches.erase(q); - break; + /* People are watching this user, am i one of them? */ + std::deque::iterator n = std::find(x->second.begin(), x->second.end(), user); + if (n != x->second.end()) + /* I'm no longer watching you... */ + x->second.erase(n); + + if (!x->second.size()) + whos_watching_me->erase(user->nick); } } + + /* User's quitting, we're done with this. */ + delete wl; } } - virtual void OnGlobalConnect(userrec* user) + virtual void OnGarbageCollect() { - irc::string n2 = user->nick; - log(DEBUG,"*** WATCH: On global connect: user %s",user->nick); - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + watchentries* old_watch = whos_watching_me; + whos_watching_me = new watchentries(); + + for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++) + whos_watching_me->insert(*n); + + delete old_watch; + } + + virtual void OnCleanup(int target_type, void* item) + { + if (target_type == TYPE_USER) { - irc::string n1 = q->target.c_str(); - if (n1 == n2) + watchlist* wl; + userrec* user = (userrec*)item; + + if (user->GetExt("watchlist", wl)) { - log(DEBUG,"*** WATCH: On global connect: user %s is in notify of %s",user->nick,q->watcher->nick); - WriteServ(q->watcher->fd,"600 %s %s %s %s %lu :arrived online",q->watcher->nick,user->nick,user->ident,user->dhost,user->age); + user->Shrink("watchlist"); + delete wl; + } + } + } + + virtual void OnPostConnect(userrec* user) + { + watchentries::iterator x = whos_watching_me->find(user->nick); + if (x != whos_watching_me->end()) + { + for (std::deque::iterator n = x->second.begin(); n != x->second.end(); n++) + { + (*n)->WriteServ("600 %s %s %s %s %lu :arrived online", (*n)->nick, user->nick, user->ident, user->dhost, user->age); + watchlist* wl; + if ((*n)->GetExt("watchlist", wl)) + /* We were on somebody's notify list, set ourselves online */ + (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age)); } } } virtual void OnUserPostNick(userrec* user, const std::string &oldnick) { - irc::string n2 = oldnick.c_str(); - irc::string n3 = user->nick; - log(DEBUG,"*** WATCH: On global nickchange: old nick: %s new nick: %s",oldnick.c_str(),user->nick); - for (watchlist::iterator q = watches.begin(); q != watches.end(); q++) + watchentries::iterator new_online = whos_watching_me->find(user->nick); + watchentries::iterator new_offline = whos_watching_me->find(assign(oldnick)); + + if (new_online != whos_watching_me->end()) { - irc::string n1 = q->target.c_str(); - // changed from a nick on the watchlist to one that isnt - if (n1 == n2) + for (std::deque::iterator n = new_online->second.begin(); n != new_online->second.end(); n++) { - log(DEBUG,"*** WATCH: On global nickchange: old nick %s was on notify list of %s",oldnick.c_str(),q->watcher->nick); - WriteServ(q->watcher->fd,"601 %s %s %s %s %lu :went offline",q->watcher->nick,oldnick.c_str(),user->ident,user->dhost,time(NULL)); + watchlist* wl; + if ((*n)->GetExt("watchlist", wl)) + { + (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age)); + (*n)->WriteServ("600 %s %s %s :arrived online", (*n)->nick, user->nick, (*wl)[user->nick].c_str()); + } } - else if (n1 == n3) + } + + if (new_offline != whos_watching_me->end()) + { + for (std::deque::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++) { - // changed from a nick not on notify to one that is - log(DEBUG,"*** WATCH: On global nickchange: new nick %s is on notify list of %s",user->nick,q->watcher->nick); - WriteServ(q->watcher->fd,"600 %s %s %s %s %lu :arrived online",q->watcher->nick,user->nick,user->ident,user->dhost,user->age); + watchlist* wl; + if ((*n)->GetExt("watchlist", wl)) + { + (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick, oldnick.c_str(), user->ident, user->dhost, user->age); + (*wl)[user->nick] = ""; + } } } } @@ -274,16 +424,17 @@ class Modulewatch : public Module virtual void On005Numeric(std::string &output) { // we don't really have a limit... - output = output + " WATCH=999"; + output = output + " WATCH=32"; } virtual ~Modulewatch() { + delete whos_watching_me; } virtual Version GetVersion() { - return Version(1,0,0,1,VF_VENDOR); + return Version(1,1,0,1,VF_VENDOR,API_VERSION); } }; @@ -299,7 +450,7 @@ class ModulewatchFactory : public ModuleFactory { } - virtual Module * CreateModule(Server* Me) + virtual Module * CreateModule(InspIRCd* Me) { return new Modulewatch(Me); }