X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_watch.cpp;h=4ce4d0340bfbb7a345413c8e002bb6d6a92f7057;hb=53afaa7cadcdf222dcf761441727305f79b4c557;hp=fcae80cf634ff6ca5d3fe91f900070dacbd1dc7a;hpb=336c9691a599801cf87e4a5e91b516b0534c7821;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_watch.cpp b/src/modules/m_watch.cpp index fcae80cf6..4ce4d0340 100644 --- a/src/modules/m_watch.cpp +++ b/src/modules/m_watch.cpp @@ -2,47 +2,85 @@ * | 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. + * the file COPYING for details. * * --------------------------------------------------- */ -using namespace std; - -#include -#include -#include -#include "users.h" -#include "channels.h" -#include "modules.h" -#include "hashcomp.h" #include "inspircd.h" -/* $ModDesc: Provides support for the /watch command */ +/* $ModDesc: Provides support for the /WATCH command */ -/* nickname list of users watching the nick */ -typedef std::map > watchentries; - -/* nickname 'ident host signon', or empty if not online */ -typedef std::map watchlist; +/* 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 User 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. + */ -/* Whos watching each nickname */ -watchentries whos_watching_me; +/* + * Before you start screaming, this definition is only used here, so moving it to a header is pointless. + * Yes, it's horrid. Blame cl for being different. -- w00t + */ +#ifdef WINDOWS +typedef nspace::hash_map, nspace::hash_compare > > watchentries; +#else +typedef nspace::hash_map, nspace::hash > watchentries; +#endif +typedef std::map watchlist; + +/* 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 +class CommandWatch : public Command { unsigned int& MAX_WATCH; public: - CmdResult remove_watch(userrec* user, const char* nick) + CmdResult remove_watch(User* user, const char* nick) { // removing an item from the list if (!ServerInstance->IsNick(nick)) @@ -72,17 +110,17 @@ class cmd_watch : public command_t delete wl; } - watchentries::iterator x = whos_watching_me.find(nick); - if (x != whos_watching_me.end()) + 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); + 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); + whos_watching_me->erase(nick); } } @@ -93,7 +131,7 @@ class cmd_watch : public command_t return CMD_FAILURE; } - CmdResult add_watch(userrec* user, const char* nick) + CmdResult add_watch(User* user, const char* nick) { if (!ServerInstance->IsNick(nick)) { @@ -104,7 +142,6 @@ class cmd_watch : public command_t watchlist* wl; if (!user->GetExt("watchlist", wl)) { - ServerInstance->Log(DEBUG,"Allocate new watchlist"); wl = new watchlist(); user->Extend("watchlist", wl); } @@ -118,24 +155,30 @@ class cmd_watch : public command_t watchlist::iterator n = wl->find(nick); if (n == wl->end()) { - ServerInstance->Log(DEBUG,"*** Add to WATCH: '%s'", nick); /* 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()) + 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; + std::deque newlist; newlist.push_back(user); - whos_watching_me[nick] = newlist; + (*(whos_watching_me))[nick] = newlist; } - userrec* target = ServerInstance->FindNick(nick); + User* target = ServerInstance->FindNick(nick); if (target) { + if (target->Visibility && !target->Visibility->VisibleTo(user)) + { + (*wl)[nick] = ""; + user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick); + return CMD_FAILURE; + } + (*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()); } @@ -145,21 +188,18 @@ class cmd_watch : public command_t user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick); } } - else - { - ServerInstance->Log(DEBUG,"*** WATCH entry '%s' already exists!", nick); - } return CMD_FAILURE; } - cmd_watch (InspIRCd* Instance, unsigned int &maxwatch) : command_t(Instance,"WATCH",0,0), MAX_WATCH(maxwatch) + CommandWatch (InspIRCd* Instance, unsigned int &maxwatch) : Command(Instance,"WATCH",0,0), MAX_WATCH(maxwatch) { this->source = "m_watch.so"; syntax = "[C|L|S]|[+|-]"; + TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */ } - CmdResult Handle (const char** parameters, int pcnt, userrec *user) + CmdResult Handle (const char** parameters, int pcnt, User *user) { if (!pcnt) { @@ -179,7 +219,6 @@ class cmd_watch : public command_t for (int x = 0; x < pcnt; x++) { const char *nick = parameters[x]; - ServerInstance->Log(DEBUG,"WATCH iterate item '%s'", nick); if (!strcasecmp(nick,"C")) { // watch clear @@ -188,17 +227,17 @@ class cmd_watch : public command_t { for (watchlist::iterator i = wl->begin(); i != wl->end(); i++) { - watchentries::iterator x = whos_watching_me.find(i->first); - if (x != whos_watching_me.end()) + watchentries::iterator x = whos_watching_me->find(i->first); + 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); + 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); + whos_watching_me->erase(user->nick); } } @@ -235,8 +274,8 @@ class cmd_watch : public command_t you_have = wl->size(); } - watchentries::iterator x = whos_watching_me.find(user->nick); - if (x != whos_watching_me.end()) + 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); @@ -262,31 +301,40 @@ class cmd_watch : public command_t class Modulewatch : public Module { - cmd_watch* mycommand; + CommandWatch* mycommand; unsigned int maxwatch; public: Modulewatch(InspIRCd* Me) - : Module::Module(Me), maxwatch(32) + : Module(Me), maxwatch(32) { - mycommand = new cmd_watch(ServerInstance, maxwatch); + OnRehash(NULL, ""); + whos_watching_me = new watchentries(); + mycommand = new CommandWatch(ServerInstance, maxwatch); ServerInstance->AddCommand(mycommand); + Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnCleanup, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric }; + ServerInstance->Modules->Attach(eventlist, this, 7); } - void Implements(char* List) + virtual void OnRehash(User* user, const std::string ¶meter) { - List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1; + ConfigReader Conf(ServerInstance); + maxwatch = Conf.ReadInteger("watch", "maxentries", 0, true); + if (!maxwatch) + maxwatch = 32; } - virtual void OnUserQuit(userrec* user, const std::string &reason) + + virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) { - ServerInstance->Log(DEBUG,"*** WATCH: On global quit: user %s",user->nick); - watchentries::iterator x = whos_watching_me.find(user->nick); - if (x != whos_watching_me.end()) + 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++) + for (std::deque::iterator n = x->second.begin(); n != x->second.end(); n++) { - (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick ,user->nick, user->ident, user->dhost, ServerInstance->Time()); + if (!user->Visibility || user->Visibility->VisibleTo(user)) + (*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 */ @@ -301,31 +349,61 @@ class Modulewatch : public Module /* 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++) { - watchentries::iterator x = whos_watching_me.find(i->first); - if (x != whos_watching_me.end()) + watchentries::iterator x = whos_watching_me->find(i->first); + 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); + 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); + whos_watching_me->erase(user->nick); } } + + /* User's quitting, we're done with this. */ + delete wl; } } - virtual void OnPostConnect(userrec* user) + virtual void OnGarbageCollect() { - ServerInstance->Log(DEBUG,"*** WATCH: On global connect: user %s",user->nick); - watchentries::iterator x = whos_watching_me.find(user->nick); - if (x != whos_watching_me.end()) + 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) { - for (std::deque::iterator n = x->second.begin(); n != x->second.end(); n++) + watchlist* wl; + User* user = (User*)item; + + if (user->GetExt("watchlist", wl)) { - (*n)->WriteServ("600 %s %s %s %s %lu :arrived online", (*n)->nick, user->nick, user->ident, user->dhost, user->age); + user->Shrink("watchlist"); + delete wl; + } + } + } + + virtual void OnPostConnect(User* 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++) + { + if (!user->Visibility || user->Visibility->VisibleTo(user)) + (*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 */ @@ -334,35 +412,35 @@ class Modulewatch : public Module } } - virtual void OnUserPostNick(userrec* user, const std::string &oldnick) + virtual void OnUserPostNick(User* user, const std::string &oldnick) { - ServerInstance->Log(DEBUG,"*** WATCH: On global nickchange: old nick: %s new nick: %s",oldnick.c_str(),user->nick); - - watchentries::iterator new_online = whos_watching_me.find(user->nick); - watchentries::iterator new_offline = whos_watching_me.find(assign(oldnick)); + watchentries::iterator new_offline = whos_watching_me->find(assign(oldnick)); + watchentries::iterator new_online = whos_watching_me->find(user->nick); - if (new_online != whos_watching_me.end()) + if (new_offline != whos_watching_me->end()) { - for (std::deque::iterator n = new_online->second.begin(); n != new_online->second.end(); n++) + for (std::deque::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++) { 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()); + if (!user->Visibility || user->Visibility->VisibleTo(user)) + (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick, oldnick.c_str(), user->ident, user->dhost, user->age); + (*wl)[oldnick.c_str()] = ""; } } } - if (new_offline != whos_watching_me.end()) + if (new_online != whos_watching_me->end()) { - for (std::deque::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++) + for (std::deque::iterator n = new_online->second.begin(); n != new_online->second.end(); n++) { watchlist* wl; if ((*n)->GetExt("watchlist", wl)) { - (*n)->WriteServ("601 %s %s %s :went offline", (*n)->nick, user->nick, (*wl)[user->nick].c_str()); - (*wl)[user->nick] = ""; + (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age)); + if (!user->Visibility || user->Visibility->VisibleTo(user)) + (*n)->WriteServ("600 %s %s %s :arrived online", (*n)->nick, user->nick, (*wl)[user->nick].c_str()); } } } @@ -371,41 +449,19 @@ class Modulewatch : public Module virtual void On005Numeric(std::string &output) { // we don't really have a limit... - output = output + " WATCH=32"; + output = output + " WATCH=" + ConvToStr(maxwatch); } virtual ~Modulewatch() { + delete whos_watching_me; } virtual Version GetVersion() { - return Version(1,1,0,1,VF_VENDOR,API_VERSION); + return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION); } }; - -class ModulewatchFactory : public ModuleFactory -{ - public: - ModulewatchFactory() - { - } - - ~ModulewatchFactory() - { - } - - virtual Module * CreateModule(InspIRCd* Me) - { - return new Modulewatch(Me); - } - -}; - - -extern "C" void * init_module( void ) -{ - return new ModulewatchFactory; -} +MODULE_INIT(Modulewatch)