X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_watch.cpp;h=24b4edc093994e10afa619e70e0746232000bde5;hb=6d03943426dcce76ba66567a9b18425a5ebb4c0c;hp=a8575dd98c8228d75f32b55c69a4f945141f2ad1;hpb=206e3b49c7bfe3e8a7ca972103fe9e30feb3a86a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_watch.cpp b/src/modules/m_watch.cpp index a8575dd98..24b4edc09 100644 --- a/src/modules/m_watch.cpp +++ b/src/modules/m_watch.cpp @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -11,14 +11,36 @@ * --------------------------------------------------- */ -#include "users.h" -#include "channels.h" -#include "modules.h" -#include "hashcomp.h" #include "inspircd.h" /* $ModDesc: Provides support for the /WATCH command */ + +/* + * Okay, it's nice that this was documented and all, but I at least understood very little + * of it, so I'm going to attempt to explain the data structures in here a bit more. + * + * For efficiency, many data structures are kept. + * + * The first is a global list `watchentries': + * hash_map > + * + * That is, if nick 'w00t' is being watched by user pointer 'Brain' and 'Om', + * will be in the watchentries list. + * + * The second is that each user has a per-user data structure attached to their user record via Extensible: + * std::map watchlist; + * So, in the above example with w00t watched by Brain and Om, we'd have: + * Brain- + * `- w00t + * Om- + * `- w00t + * + * Hopefully this helps any brave soul that ventures into this file other than me. :-) + * -- w00t (mar 30, 2008) + */ + + /* This module has been refactored to provide a very efficient (in terms of cpu time) * implementation of /WATCH. * @@ -27,14 +49,14 @@ * * 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 + * 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 @@ -61,12 +83,16 @@ * of users using WATCH. */ -#ifdef WINDOWS -typedef nspace::hash_map, nspace::hash_compare > > watchentries; +/* + * 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 + */ +#if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED) + typedef nspace::hash_map, nspace::hash_compare > > watchentries; #else -typedef nspace::hash_map, nspace::hash > watchentries; + typedef nspace::hash_map, nspace::hash > watchentries; #endif -typedef std::mapwatchlist; +typedef std::map watchlist; /* Who's watching each nickname. * NOTE: We do NOT iterate this to display a user's WATCH list! @@ -74,81 +100,114 @@ typedef std::mapwatchlist; */ watchentries* whos_watching_me; +class CommandSVSWatch : public Command +{ + public: + CommandSVSWatch(Module* Creator) : Command(Creator,"SVSWATCH", 2) + { + syntax = " [C|L|S]|[+|-]"; + TRANSLATE3(TR_NICK, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */ + } + + CmdResult Handle (const std::vector ¶meters, User *user) + { + if (!ServerInstance->ULine(user->server)) + return CMD_FAILURE; + + User *u = ServerInstance->FindNick(parameters[0]); + if (!u) + return CMD_FAILURE; + + if (IS_LOCAL(u)) + { + ServerInstance->Parser->CallHandler("WATCH", parameters, u); + } + + return CMD_SUCCESS; + } + + RouteDescriptor GetRouting(User* user, const std::vector& parameters) + { + return ROUTE_BROADCAST; + } +}; + /** 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) + SimpleExtItem ext; + CmdResult remove_watch(User* user, const char* nick) { // removing an item from the list - if (!ServerInstance->IsNick(nick)) + if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax)) { - user->WriteServ("942 %s %s :Invalid nickname", user->nick, nick); + user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick.c_str(), nick); return CMD_FAILURE; } - watchlist* wl; - if (user->GetExt("watchlist", wl)) + watchlist* wl = ext.get(user); + if (wl) { /* Yup, is on my list */ watchlist::iterator n = wl->find(nick); + + if (!wl) + return CMD_FAILURE; + 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()); + user->WriteNumeric(602, "%s %s %s :stopped watching", user->nick.c_str(), n->first.c_str(), n->second.c_str()); else - user->WriteServ("602 %s %s * * 0 :stopped watching", user->nick, nick); + user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick.c_str(), nick); wl->erase(n); } - if (!wl->size()) + if (wl->empty()) { - user->Shrink("watchlist"); - delete wl; + ext.unset(user); } 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()) + std::deque::iterator n2 = std::find(x->second.begin(), x->second.end(), user); + if (n2 != x->second.end()) /* I'm no longer watching you... */ - x->second.erase(n); + x->second.erase(n2); - if (!x->second.size()) + if (x->second.empty()) + /* nobody else is, either. */ 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; + return CMD_SUCCESS; } - CmdResult add_watch(userrec* user, const char* nick) + CmdResult add_watch(User* user, const char* nick) { - if (!ServerInstance->IsNick(nick)) + if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax)) { - user->WriteServ("942 %s %s :Invalid nickname",user->nick,nick); + user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick.c_str(),nick); return CMD_FAILURE; } - watchlist* wl; - if (!user->GetExt("watchlist", wl)) + watchlist* wl = ext.get(user); + if (!wl) { wl = new watchlist(); - user->Extend("watchlist", wl); + ext.set(user, wl); } if (wl->size() == MAX_WATCH) { - user->WriteServ("512 %s %s :Too many WATCH entries", user->nick, nick); + user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick.c_str(), nick); return CMD_FAILURE; } @@ -164,122 +223,126 @@ class cmd_watch : public command_t } else { - std::deque newlist; + std::deque newlist; newlist.push_back(user); (*(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] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age)); + user->WriteNumeric(604, "%s %s %s :is online",user->nick.c_str(), nick, (*wl)[nick].c_str()); + if (IS_AWAY(target)) { - (*wl)[nick] = ""; - user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick); - return CMD_FAILURE; + 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); } - - (*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); + user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick.c_str(), nick); } } - return CMD_FAILURE; + return CMD_SUCCESS; } - cmd_watch (InspIRCd* Instance, unsigned int &maxwatch) : command_t(Instance,"WATCH",0,0), MAX_WATCH(maxwatch) + CommandWatch(Module* parent, unsigned int &maxwatch) : Command(parent,"WATCH", 0), MAX_WATCH(maxwatch), ext("watchlist", parent) { - 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 std::vector ¶meters, User *user) { - if (!pcnt) + if (parameters.empty()) { - watchlist* wl; - if (user->GetExt("watchlist", wl)) + watchlist* wl = ext.get(user); + if (wl) { for (watchlist::iterator q = wl->begin(); q != wl->end(); q++) { if (!q->second.empty()) - user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str()); + user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str()); } } - user->WriteServ("607 %s :End of WATCH list",user->nick); + user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str()); } - else if (pcnt > 0) + else if (parameters.size() > 0) { - for (int x = 0; x < pcnt; x++) + for (int x = 0; x < (int)parameters.size(); x++) { - const char *nick = parameters[x]; + const char *nick = parameters[x].c_str(); if (!strcasecmp(nick,"C")) { // watch clear - watchlist* wl; - if (user->GetExt("watchlist", wl)) + watchlist* wl = ext.get(user); + if (wl) { 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 i2 = whos_watching_me->find(i->first); + if (i2 != 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()) + std::deque::iterator n = std::find(i2->second.begin(), i2->second.end(), user); + if (n != i2->second.end()) /* I'm no longer watching you... */ - x->second.erase(n); + i2->second.erase(n); - if (!x->second.size()) - whos_watching_me->erase(user->nick); + if (i2->second.empty()) + /* nobody else is, either. */ + whos_watching_me->erase(i2); } } - delete wl; - user->Shrink("watchlist"); + ext.unset(user); } } else if (!strcasecmp(nick,"L")) { - watchlist* wl; - if (user->GetExt("watchlist", wl)) + watchlist* wl = ext.get(user); + if (wl) { for (watchlist::iterator q = wl->begin(); q != wl->end(); q++) { if (!q->second.empty()) - user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str()); + { + user->WriteNumeric(604, "%s %s %s :is online", user->nick.c_str(), q->first.c_str(), q->second.c_str()); + User *targ = ServerInstance->FindNick(q->first.c_str()); + if (IS_AWAY(targ)) + { + 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); + } + } else - user->WriteServ("605 %s %s * * 0 :is offline", user->nick, q->first.c_str()); + user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick.c_str(), q->first.c_str()); } } - user->WriteServ("607 %s :End of WATCH list",user->nick); + user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str()); } else if (!strcasecmp(nick,"S")) { - watchlist* wl; + watchlist* wl = ext.get(user); int you_have = 0; int youre_on = 0; std::string list; - if (user->GetExt("watchlist", wl)) + if (wl) { for (watchlist::iterator q = wl->begin(); q != wl->end(); q++) list.append(q->first.c_str()).append(" "); you_have = wl->size(); } - watchentries::iterator x = whos_watching_me->find(user->nick); - if (x != whos_watching_me->end()) - youre_on = x->second.size(); + watchentries::iterator i2 = whos_watching_me->find(user->nick.c_str()); + if (i2 != whos_watching_me->end()) + youre_on = i2->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); + user->WriteNumeric(603, "%s :You have %d and are on %d WATCH entries", user->nick.c_str(), you_have, youre_on); + user->WriteNumeric(606, "%s :%s",user->nick.c_str(), list.c_str()); + user->WriteNumeric(607, "%s :End of WATCH S",user->nick.c_str()); } else if (nick[0] == '-') { @@ -293,79 +356,102 @@ class cmd_watch : public command_t } } } - /* So that spanningtree doesnt pass the WATCH commands to the network! */ - return CMD_FAILURE; + return CMD_SUCCESS; } }; class Modulewatch : public Module { - cmd_watch* mycommand; unsigned int maxwatch; - public: + CommandWatch cmdw; + CommandSVSWatch sw; - Modulewatch(InspIRCd* Me) - : Module(Me), maxwatch(32) + public: + Modulewatch() + : maxwatch(32), cmdw(this, maxwatch), sw(this) { - OnRehash(NULL, ""); + OnRehash(NULL); whos_watching_me = new watchentries(); - mycommand = new cmd_watch(ServerInstance, maxwatch); - ServerInstance->AddCommand(mycommand); + ServerInstance->AddCommand(&cmdw); + ServerInstance->AddCommand(&sw); + Extensible::Register(&cmdw.ext); + Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnCleanup, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric, I_OnSetAway }; + ServerInstance->Modules->Attach(eventlist, this, 8); } - virtual void OnRehash(userrec* user, const std::string ¶meter) + virtual void OnRehash(User* user) { - ConfigReader Conf(ServerInstance); + ConfigReader Conf; maxwatch = Conf.ReadInteger("watch", "maxentries", 0, true); if (!maxwatch) maxwatch = 32; } - void Implements(char* List) + virtual ModResult OnSetAway(User *user, const std::string &awaymsg) { - List[I_OnRehash] = List[I_OnGarbageCollect] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1; + std::string numeric; + int inum; + + if (awaymsg.empty()) + { + numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :is no longer away"; + inum = 599; + } + else + { + numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :" + awaymsg; + inum = 598; + } + + watchentries::iterator x = whos_watching_me->find(user->nick.c_str()); + if (x != whos_watching_me->end()) + { + for (std::deque::iterator n = x->second.begin(); n != x->second.end(); n++) + { + (*n)->WriteNumeric(inum, numeric); + } + } + + return MOD_RES_PASSTHRU; } - virtual void OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message) + virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) { - watchentries::iterator x = whos_watching_me->find(user->nick); + watchentries::iterator x = whos_watching_me->find(user->nick.c_str()); 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++) { - 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()); + (*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()); - watchlist* wl; - if ((*n)->GetExt("watchlist", wl)) + watchlist* wl = cmdw.ext.get(*n); + if (wl) /* We were on somebody's notify list, set ourselves offline */ - (*wl)[user->nick] = ""; + (*wl)[user->nick.c_str()] = ""; } } /* Now im quitting, if i have a notify list, im no longer watching anyone */ - watchlist* wl; - if (user->GetExt("watchlist", wl)) + watchlist* wl = cmdw.ext.get(user); + if (wl) { /* 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 i2 = whos_watching_me->find(i->first); + if (i2 != 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()) + std::deque::iterator n = std::find(i2->second.begin(), i2->second.end(), user); + if (n != i2->second.end()) /* I'm no longer watching you... */ - x->second.erase(n); - - if (!x->second.size()) - whos_watching_me->erase(user->nick); + i2->second.erase(n); + + if (i2->second.empty()) + /* and nobody else is, either. */ + whos_watching_me->erase(i2); } } - - /* User's quitting, we're done with this. */ - delete wl; } } @@ -380,112 +466,71 @@ class Modulewatch : public Module delete old_watch; } - virtual void OnCleanup(int target_type, void* item) - { - if (target_type == TYPE_USER) - { - watchlist* wl; - userrec* user = (userrec*)item; - - if (user->GetExt("watchlist", wl)) - { - user->Shrink("watchlist"); - delete wl; - } - } - } - - virtual void OnPostConnect(userrec* user) + virtual void OnPostConnect(User* user) { - watchentries::iterator x = whos_watching_me->find(user->nick); + watchentries::iterator x = whos_watching_me->find(user->nick.c_str()); 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++) { - 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); + (*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); - watchlist* wl; - if ((*n)->GetExt("watchlist", wl)) + watchlist* wl = cmdw.ext.get(*n); + if (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)); + (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age)); } } } - virtual void OnUserPostNick(userrec* user, const std::string &oldnick) + virtual void OnUserPostNick(User* user, const std::string &oldnick) { - 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(oldnick.c_str()); + watchentries::iterator new_online = whos_watching_me->find(user->nick.c_str()); - 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)) + watchlist* wl = cmdw.ext.get(*n); + if (wl) { - (*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()); + (*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); + (*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)) + watchlist* wl = cmdw.ext.get(*n); + if (wl) { - 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)[user->nick] = ""; + (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age)); + (*n)->WriteNumeric(600, "%s %s %s :arrived online", (*n)->nick.c_str(), user->nick.c_str(), (*wl)[user->nick.c_str()].c_str()); } } } - } + } virtual void On005Numeric(std::string &output) { // we don't really have a limit... output = output + " WATCH=" + ConvToStr(maxwatch); } - + virtual ~Modulewatch() { delete whos_watching_me; } - - virtual Version GetVersion() - { - return Version(1,1,0,1,VF_VENDOR,API_VERSION); - } -}; - -class ModulewatchFactory : public ModuleFactory -{ - public: - ModulewatchFactory() - { - } - - ~ModulewatchFactory() - { - } - - virtual Module * CreateModule(InspIRCd* Me) + virtual Version GetVersion() { - return new Modulewatch(Me); + return Version("Provides support for the /WATCH command", VF_COMMON | VF_VENDOR, API_VERSION); } - }; - -extern "C" DllExport void * init_module( void ) -{ - return new ModulewatchFactory; -} +MODULE_INIT(Modulewatch)