X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_watch.cpp;h=6e9a6f9ed716be97ee34dcf1953e8214bccce1f1;hb=da29af8cba49d51e53d6e68237ccbf6370b6dd1f;hp=dff282633a4d299e4c4791f4bbf5c0ba1f2a0c77;hpb=1ea31c8ecfc02b77c8ac89be88f760da9fa9d6eb;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_watch.cpp b/src/modules/m_watch.cpp index dff282633..6e9a6f9ed 100644 --- a/src/modules/m_watch.cpp +++ b/src/modules/m_watch.cpp @@ -1,503 +1,268 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2016 Attila Molnar * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. * - * --------------------------------------------------- + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ + #include "inspircd.h" -/* $ModDesc: Provides support for the /WATCH command */ +#define INSPIRCD_MONITOR_MANAGER_ONLY +#include "m_monitor.cpp" -/* 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. - */ - -/* - * 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; +enum +{ + RPL_GONEAWAY = 598, + RPL_NOTAWAY = 599, + RPL_LOGON = 600, + RPL_LOGOFF = 601, + RPL_WATCHOFF = 602, + RPL_WATCHSTAT = 603, + RPL_NOWON = 604, + RPL_NOWOFF = 605, + RPL_WATCHLIST = 606, + RPL_ENDOFWATCHLIST = 607, + // RPL_CLEARWATCH = 608, // unused + RPL_NOWISAWAY = 609, + ERR_TOOMANYWATCH = 512 +}; -class CommandSVSWatch : public Command +class CommandWatch : public SplitCommand { - public: - CommandSVSWatch (InspIRCd* Instance) : Command(Instance,"WATCH", 0, 2) - { - this->source = "m_watch.so"; - syntax = " [C|L|S]|[+|-]"; - TRANSLATE3(TR_NICK, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */ - } + // Additional penalty for /WATCH commands that request a list from the server + static const unsigned int ListPenalty = 4000; + + IRCv3::Monitor::Manager& manager; - CmdResult Handle (const char** parameters, int pcnt, User *user) + static void SendOnlineOffline(LocalUser* user, const std::string& nick, bool show_offline = true) { - if (!ServerInstance->ULine(user->server)) - return CMD_FAILURE; - - User *u = ServerInstance->FindNick(parameters[0]); - if (!u) - return CMD_FAILURE; - - if (IS_LOCAL(u)) + User* target = IRCv3::Monitor::Manager::FindNick(nick); + if (target) { - ServerInstance->Parser->CallHandler("WATCH", ¶meters[1], 1, u); + // The away state should only be sent if the client requests away notifications for a nick but 2.0 always sends them so we do that too + if (target->IsAway()) + user->WriteNumeric(RPL_NOWISAWAY, target->nick, target->ident, target->dhost, (unsigned long)target->awaytime, "is away"); + else + user->WriteNumeric(RPL_NOWON, target->nick, target->ident, target->dhost, (unsigned long)target->age, "is online"); } - - return CMD_SUCCESS; + else if (show_offline) + user->WriteNumeric(RPL_NOWOFF, nick, "*", "*", "0", "is offline"); } -}; -/** Handle /WATCH - */ -class CommandWatch : public Command -{ - unsigned int& MAX_WATCH; - public: - CmdResult remove_watch(User* user, const char* nick) + void HandlePlus(LocalUser* user, const std::string& nick) { - // removing an item from the list - if (!ServerInstance->IsNick(nick)) + IRCv3::Monitor::Manager::WatchResult result = manager.Watch(user, nick, maxwatch); + if (result == IRCv3::Monitor::Manager::WR_TOOMANY) { - user->WriteServ("942 %s %s :Invalid nickname", user->nick, nick); - return CMD_FAILURE; + // List is full, send error numeric + user->WriteNumeric(ERR_TOOMANYWATCH, nick, "Too many WATCH entries"); + return; } - - watchlist* wl; - if (user->GetExt("watchlist", wl)) + else if (result == IRCv3::Monitor::Manager::WR_INVALIDNICK) { - /* 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()); - 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 n2 = std::find(x->second.begin(), x->second.end(), user); - if (n2 != x->second.end()) - /* I'm no longer watching you... */ - x->second.erase(n2); - - if (!x->second.size()) - whos_watching_me->erase(nick); - } + user->WriteNumeric(942, nick, "Invalid nickname"); + return; } + else if (result != IRCv3::Monitor::Manager::WR_OK) + return; - /* 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; + SendOnlineOffline(user, nick); } - CmdResult add_watch(User* user, const char* nick) + void HandleMinus(LocalUser* user, const std::string& nick) { - if (!ServerInstance->IsNick(nick)) + if (!manager.Unwatch(user, nick)) + return; + + User* target = IRCv3::Monitor::Manager::FindNick(nick); + if (target) + user->WriteNumeric(RPL_WATCHOFF, target->nick, target->ident, target->dhost, (unsigned long)target->age, "stopped watching"); + else + user->WriteNumeric(RPL_WATCHOFF, nick, "*", "*", "0", "stopped watching"); + } + + void HandleList(LocalUser* user, bool show_offline) + { + user->CommandFloodPenalty += ListPenalty; + const IRCv3::Monitor::WatchedList& list = manager.GetWatched(user); + for (IRCv3::Monitor::WatchedList::const_iterator i = list.begin(); i != list.end(); ++i) { - user->WriteServ("942 %s %s :Invalid nickname",user->nick,nick); - return CMD_FAILURE; + const IRCv3::Monitor::Entry* entry = *i; + SendOnlineOffline(user, entry->GetNick(), show_offline); } + user->WriteNumeric(RPL_ENDOFWATCHLIST, "End of WATCH list"); + } - watchlist* wl; - if (!user->GetExt("watchlist", wl)) + void HandleStats(LocalUser* user) + { + user->CommandFloodPenalty += ListPenalty; + + // Do not show how many clients are watching this nick, it's pointless + const IRCv3::Monitor::WatchedList& list = manager.GetWatched(user); + user->WriteNumeric(RPL_WATCHSTAT, InspIRCd::Format("You have %lu and are on 0 WATCH entries", (unsigned long)list.size())); + + Numeric::Builder<' '> out(user, RPL_WATCHLIST); + for (IRCv3::Monitor::WatchedList::const_iterator i = list.begin(); i != list.end(); ++i) { - wl = new watchlist(); - user->Extend("watchlist", wl); + const IRCv3::Monitor::Entry* entry = *i; + out.Add(entry->GetNick()); } + out.Flush(); + user->WriteNumeric(RPL_ENDOFWATCHLIST, "End of WATCH S"); + } + + public: + unsigned int maxwatch; + + CommandWatch(Module* mod, IRCv3::Monitor::Manager& managerref) + : SplitCommand(mod, "WATCH") + , manager(managerref) + { + allow_empty_last_param = false; + syntax = "[|->]"; + } - if (wl->size() == MAX_WATCH) + CmdResult HandleLocal(const std::vector& parameters, LocalUser* user) + { + if (parameters.empty()) { - user->WriteServ("512 %s %s :Too many WATCH entries", user->nick, nick); - return CMD_FAILURE; + HandleList(user, false); + return CMD_SUCCESS; } - watchlist::iterator n = wl->find(nick); - if (n == wl->end()) + bool watch_l_done = false; + bool watch_s_done = false; + + for (std::vector::const_iterator i = parameters.begin(); i != parameters.end(); ++i) { - /* 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()) + const std::string& token = *i; + char subcmd = toupper(token[0]); + if (subcmd == '+') { - /* People are watching this user, add myself */ - x->second.push_back(user); + HandlePlus(user, token.substr(1)); } - else + else if (subcmd == '-') { - std::deque newlist; - newlist.push_back(user); - (*(whos_watching_me))[nick] = newlist; + HandleMinus(user, token.substr(1)); } - - User* target = ServerInstance->FindNick(nick); - if (target) + else if (subcmd == 'C') { - 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()); + manager.UnwatchAll(user); } - else + else if ((subcmd == 'L') && (!watch_l_done)) { - (*wl)[nick] = ""; - user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick); + watch_l_done = true; + // WATCH L requests a full list with online and offline nicks + // WATCH l requests a list with only online nicks + HandleList(user, (token[0] == 'L')); + } + else if ((subcmd == 'S') && (!watch_s_done)) + { + watch_s_done = true; + HandleStats(user); } } - - return CMD_FAILURE; + return CMD_SUCCESS; } +}; - 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. */ - } +class ModuleWatch : public Module +{ + IRCv3::Monitor::Manager manager; + CommandWatch cmd; - CmdResult Handle (const char** parameters, int pcnt, User *user) + void SendAlert(User* user, const std::string& nick, unsigned int numeric, const char* numerictext, time_t shownts) { - if (!pcnt) - { - watchlist* wl; - if (user->GetExt("watchlist", 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->WriteServ("607 %s :End of WATCH list",user->nick); - } - else if (pcnt > 0) + const IRCv3::Monitor::WatcherList* list = manager.GetWatcherList(nick); + if (!list) + return; + + Numeric::Numeric num(numeric); + num.push(nick).push(user->ident).push(user->dhost).push(ConvToStr(shownts)).push(numerictext); + for (IRCv3::Monitor::WatcherList::const_iterator i = list->begin(); i != list->end(); ++i) { - for (int x = 0; x < pcnt; x++) - { - const char *nick = parameters[x]; - if (!strcasecmp(nick,"C")) - { - // watch clear - watchlist* wl; - if (user->GetExt("watchlist", wl)) - { - for (watchlist::iterator i = wl->begin(); i != wl->end(); i++) - { - 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(i2->second.begin(), i2->second.end(), user); - if (n != i2->second.end()) - /* I'm no longer watching you... */ - i2->second.erase(n); - - if (!i2->second.size()) - whos_watching_me->erase(user->nick); - } - } - - delete wl; - user->Shrink("watchlist"); - } - } - else if (!strcasecmp(nick,"L")) - { - watchlist* wl; - if (user->GetExt("watchlist", 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()); - else - user->WriteServ("605 %s %s * * 0 :is offline", user->nick, q->first.c_str()); - } - } - user->WriteServ("607 %s :End of WATCH list",user->nick); - } - else if (!strcasecmp(nick,"S")) - { - watchlist* wl; - int you_have = 0; - int youre_on = 0; - std::string list; - - if (user->GetExt("watchlist", wl)) - { - for (watchlist::iterator q = wl->begin(); q != wl->end(); q++) - list.append(q->first.c_str()).append(" "); - you_have = wl->size(); - } - - watchentries::iterator i2 = whos_watching_me->find(user->nick); - 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); - } - else if (nick[0] == '-') - { - nick++; - remove_watch(user, nick); - } - else if (nick[0] == '+') - { - nick++; - add_watch(user, nick); - } - } + LocalUser* curr = *i; + curr->WriteNumeric(num); } - /* So that spanningtree doesnt pass the WATCH commands to the network! */ - return CMD_FAILURE; } -}; -class Modulewatch : public Module -{ - CommandWatch* mycommand; - CommandSVSWatch *sw; - unsigned int maxwatch; - - public: - Modulewatch(InspIRCd* Me) - : Module(Me), maxwatch(32) + void Online(User* user) { - OnRehash(NULL, ""); - whos_watching_me = new watchentries(); - mycommand = new CommandWatch(ServerInstance, maxwatch); - ServerInstance->AddCommand(mycommand); - sw = new CommandSVSWatch(ServerInstance); - ServerInstance->AddCommand(sw); - Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnCleanup, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric }; - ServerInstance->Modules->Attach(eventlist, this, 7); + SendAlert(user, user->nick, RPL_LOGON, "arrived online", user->age); } - virtual void OnRehash(User* user, const std::string ¶meter) + void Offline(User* user, const std::string& nick) { - ConfigReader Conf(ServerInstance); - maxwatch = Conf.ReadInteger("watch", "maxentries", 0, true); - if (!maxwatch) - maxwatch = 32; + SendAlert(user, nick, RPL_LOGOFF, "went offline", user->age); } - - virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) + public: + ModuleWatch() + : manager(this, "watch") + , cmd(this, manager) { - 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("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] = ""; - } - } - - /* Now im quitting, if i have a notify list, im no longer watching anyone */ - watchlist* wl; - if (user->GetExt("watchlist", 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 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(i2->second.begin(), i2->second.end(), user); - if (n != i2->second.end()) - /* I'm no longer watching you... */ - i2->second.erase(n); - - if (!i2->second.size()) - whos_watching_me->erase(user->nick); - } - } - - /* User's quitting, we're done with this. */ - delete wl; - user->Shrink("watchlist"); - } } - virtual void OnGarbageCollect() + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { - 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; + ConfigTag* tag = ServerInstance->Config->ConfValue("watch"); + cmd.maxwatch = tag->getInt("maxwatch", 30, 1); } - virtual void OnCleanup(int target_type, void* item) + void OnPostConnect(User* user) CXX11_OVERRIDE { - if (target_type == TYPE_USER) - { - watchlist* wl; - User* user = (User*)item; - - if (user->GetExt("watchlist", wl)) - { - user->Shrink("watchlist"); - delete wl; - } - } + Online(user); } - virtual void OnPostConnect(User* user) + void OnUserPostNick(User* user, const std::string& oldnick) CXX11_OVERRIDE { - 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); + // Detect and ignore nickname case change + if (ServerInstance->FindNickOnly(oldnick) == user) + return; - 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)); - } - } + Offline(user, oldnick); + Online(user); } - virtual void OnUserPostNick(User* user, const std::string &oldnick) + void OnUserQuit(User* user, const std::string& message, const std::string& oper_message) CXX11_OVERRIDE { - watchentries::iterator new_offline = whos_watching_me->find(assign(oldnick)); - watchentries::iterator new_online = whos_watching_me->find(user->nick); - - if (new_offline != whos_watching_me->end()) - { - for (std::deque::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++) - { - watchlist* wl; - if ((*n)->GetExt("watchlist", 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)[oldnick.c_str()] = ""; - } - } - } - - if (new_online != whos_watching_me->end()) - { - for (std::deque::iterator n = new_online->second.begin(); n != new_online->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)); - if (!user->Visibility || user->Visibility->VisibleTo(user)) - (*n)->WriteServ("600 %s %s %s :arrived online", (*n)->nick, user->nick, (*wl)[user->nick].c_str()); - } - } - } - } + LocalUser* localuser = IS_LOCAL(user); + if (localuser) + manager.UnwatchAll(localuser); + Offline(user, user->nick); + } - virtual void On005Numeric(std::string &output) + ModResult OnSetAway(User* user, const std::string& awaymsg) CXX11_OVERRIDE { - // we don't really have a limit... - output = output + " WATCH=" + ConvToStr(maxwatch); + if (awaymsg.empty()) + SendAlert(user, user->nick, RPL_NOTAWAY, "is no longer away", ServerInstance->Time()); + else + SendAlert(user, user->nick, RPL_GONEAWAY, awaymsg.c_str(), user->awaytime); + + return MOD_RES_PASSTHRU; } - - virtual ~Modulewatch() + + void On005Numeric(std::map& tokens) CXX11_OVERRIDE { - delete whos_watching_me; + tokens["WATCH"] = ConvToStr(cmd.maxwatch); } - - virtual Version GetVersion() + + Version GetVersion() CXX11_OVERRIDE { - return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION); + return Version("Provides WATCH support", VF_VENDOR); } }; -MODULE_INIT(Modulewatch) - +MODULE_INIT(ModuleWatch)