X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_watch.cpp;h=803bd2c40f2f540470d771c130a5a2e9f9652734;hb=3151d60c1ecc9462e4c335282ee6c31672f45111;hp=58ceaf64527812104f62f40256f2f6b8e1ddb7b4;hpb=7b703512caffaf16015de787f83bc10c455b2326;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_watch.cpp b/src/modules/m_watch.cpp index 58ceaf645..803bd2c40 100644 --- a/src/modules/m_watch.cpp +++ b/src/modules/m_watch.cpp @@ -1,410 +1,275 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. - * This program is free but copyrighted software; see - * the file COPYING for details. + * Copyright (C) 2019 Robby + * Copyright (C) 2017-2018 Sadie Powell + * Copyright (C) 2016 Attila Molnar * - * --------------------------------------------------- + * 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 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 . */ -using namespace std; -#include -#include -#include -#include "users.h" -#include "channels.h" -#include "modules.h" -#include "hashcomp.h" #include "inspircd.h" +#include "modules/away.h" -/* $ModDesc: Provides support for the /watch command */ +#define INSPIRCD_MONITOR_MANAGER_ONLY +#include "m_monitor.cpp" -/* nickname list of users watching the nick */ -typedef std::map > watchentries; +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, + ERR_INVALIDWATCHNICK = 942 +}; -/* nickname 'ident host signon', or empty if not online */ -typedef std::map watchlist; +class CommandWatch : public SplitCommand +{ + // Additional penalty for /WATCH commands that request a list from the server + static const unsigned int ListPenalty = 4000; -/* Whos watching each nickname */ -watchentries whos_watching_me; + IRCv3::Monitor::Manager& manager; -/** Handle /WATCH - */ -class cmd_watch : public command_t -{ - unsigned int& MAX_WATCH; - public: - CmdResult remove_watch(userrec* user, const char* nick) + static void SendOnlineOffline(LocalUser* user, const std::string& nick, bool show_offline = true) { - // removing an item from the list - if (!ServerInstance->IsNick(nick)) + User* target = IRCv3::Monitor::Manager::FindNick(nick); + if (target) { - user->WriteServ("942 %s %s :Invalid nickname", user->nick, nick); - return CMD_FAILURE; + // 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->GetDisplayedHost(), (unsigned long)target->awaytime, "is away"); + else + user->WriteNumeric(RPL_NOWON, target->nick, target->ident, target->GetDisplayedHost(), (unsigned long)target->age, "is online"); } + else if (show_offline) + user->WriteNumeric(RPL_NOWOFF, nick, "*", "*", "0", "is offline"); + } - watchlist* wl; - if (user->GetExt("watchlist", wl)) + void HandlePlus(LocalUser* user, const std::string& nick) + { + IRCv3::Monitor::Manager::WatchResult result = manager.Watch(user, nick, maxwatch); + if (result == IRCv3::Monitor::Manager::WR_TOOMANY) { - /* 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); - } + // List is full, send error numeric + user->WriteNumeric(ERR_TOOMANYWATCH, nick, "Too many WATCH entries"); + return; + } + else if (result == IRCv3::Monitor::Manager::WR_INVALIDNICK) + { + user->WriteNumeric(ERR_INVALIDWATCHNICK, nick, "Invalid nickname"); + return; + } + else if (result != IRCv3::Monitor::Manager::WR_OK) + return; - if (!wl->size()) - { - user->Shrink("watchlist"); - delete wl; - } + SendOnlineOffline(user, nick); + } - 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); - } - } + void HandleMinus(LocalUser* user, const std::string& nick) + { + if (!manager.Unwatch(user, nick)) + 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; + User* target = IRCv3::Monitor::Manager::FindNick(nick); + if (target) + user->WriteNumeric(RPL_WATCHOFF, target->nick, target->ident, target->GetDisplayedHost(), (unsigned long)target->age, "stopped watching"); + else + user->WriteNumeric(RPL_WATCHOFF, nick, "*", "*", "0", "stopped watching"); } - CmdResult add_watch(userrec* user, const char* nick) + void HandleList(LocalUser* user, bool show_offline) { - if (!ServerInstance->IsNick(nick)) + 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) { - ServerInstance->Log(DEBUG,"Allocate new watchlist"); - 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; - if (wl->size() == MAX_WATCH) + CommandWatch(Module* mod, IRCv3::Monitor::Manager& managerref) + : SplitCommand(mod, "WATCH") + , manager(managerref) + { + allow_empty_last_param = false; + syntax = "C|L|l|S|(+|-) [(+|-)]+"; + } + + CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE + { + 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) { - 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()) + 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)); } - - userrec* target = ServerInstance->FindNick(nick); - if (target) + else if (subcmd == 'C') { - (*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 - { - 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) - { - this->source = "m_watch.so"; - syntax = "[C|L|S]|[+|-]"; - } - - CmdResult Handle (const char** parameters, int pcnt, userrec *user) - { - if (!pcnt) - { - watchlist* wl; - if (user->GetExt("watchlist", wl)) + else if ((subcmd == 'S') && (!watch_s_done)) { - 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()); - } + watch_s_done = true; + HandleStats(user); } - user->WriteServ("607 %s :End of WATCH list",user->nick); } - else if (pcnt > 0) - { - 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 - watchlist* wl; - if (user->GetExt("watchlist", 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()) - { - /* 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")) - { - 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 (!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++) - if (!q->second.empty()) - 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(); - - 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); - } - } - } - /* So that spanningtree doesnt pass the WATCH commands to the network! */ - return CMD_FAILURE; + return CMD_SUCCESS; } }; -class Modulewatch : public Module +class ModuleWatch + : public Module + , public Away::EventListener { - cmd_watch* mycommand; - unsigned int maxwatch; - public: + IRCv3::Monitor::Manager manager; + CommandWatch cmd; - Modulewatch(InspIRCd* Me) - : Module::Module(Me), maxwatch(32) + void SendAlert(User* user, const std::string& nick, unsigned int numeric, const char* numerictext, time_t shownts) { - mycommand = new cmd_watch(ServerInstance, maxwatch); - ServerInstance->AddCommand(mycommand); + const IRCv3::Monitor::WatcherList* list = manager.GetWatcherList(nick); + if (!list) + return; + + Numeric::Numeric num(numeric); + num.push(nick).push(user->ident).push(user->GetDisplayedHost()).push(ConvToStr(shownts)).push(numerictext); + for (IRCv3::Monitor::WatcherList::const_iterator i = list->begin(); i != list->end(); ++i) + { + LocalUser* curr = *i; + curr->WriteNumeric(num); + } } - void Implements(char* List) + void Online(User* user) { - List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1; + SendAlert(user, user->nick, RPL_LOGON, "arrived online", user->age); } - virtual void OnUserQuit(userrec* user, const std::string &reason) + void Offline(User* user, const std::string& nick) { - 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()) - { - 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()); - 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 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); - 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); - } - } - } + SendAlert(user, nick, RPL_LOGOFF, "went offline", user->age); } - virtual void OnPostConnect(userrec* user) + public: + ModuleWatch() + : Away::EventListener(this) + , manager(this, "watch") + , cmd(this, manager) { - 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()) - { - 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) + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { - 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)); - - 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)); - (*n)->WriteServ("600 %s %s %s %s %lu :arrived online", (*n)->nick, (*wl)[user->nick].c_str()); - } - } - } - - 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)) - { - (*n)->WriteServ("601 %s %s %s :went offline", (*n)->nick, (*wl)[user->nick].c_str()); - (*wl)[user->nick] = ""; - } - } - } - } + ConfigTag* tag = ServerInstance->Config->ConfValue("watch"); + cmd.maxwatch = tag->getUInt("maxwatch", 30, 1); + } - virtual void On005Numeric(std::string &output) + void OnPostConnect(User* user) CXX11_OVERRIDE { - // we don't really have a limit... - output = output + " WATCH=32"; + Online(user); } - - virtual ~Modulewatch() + + void OnUserPostNick(User* user, const std::string& oldnick) CXX11_OVERRIDE { + // Detect and ignore nickname case change + if (ServerInstance->FindNickOnly(oldnick) == user) + return; + + Offline(user, oldnick); + Online(user); } - - virtual Version GetVersion() + + void OnUserQuit(User* user, const std::string& message, const std::string& oper_message) CXX11_OVERRIDE { - return Version(1,1,0,1,VF_VENDOR,API_VERSION); + LocalUser* localuser = IS_LOCAL(user); + if (localuser) + manager.UnwatchAll(localuser); + Offline(user, user->nick); } -}; + void OnUserAway(User* user) CXX11_OVERRIDE + { + SendAlert(user, user->nick, RPL_GONEAWAY, user->awaymsg.c_str(), user->awaytime); + } -class ModulewatchFactory : public ModuleFactory -{ - public: - ModulewatchFactory() + void OnUserBack(User* user) CXX11_OVERRIDE { + SendAlert(user, user->nick, RPL_NOTAWAY, "is no longer away", ServerInstance->Time()); } - - ~ModulewatchFactory() + + void On005Numeric(std::map& tokens) CXX11_OVERRIDE { + tokens["WATCH"] = ConvToStr(cmd.maxwatch); } - - virtual Module * CreateModule(InspIRCd* Me) + + Version GetVersion() CXX11_OVERRIDE { - return new Modulewatch(Me); + return Version("Adds the /WATCH command which allows users to find out when their friends are connected to the server.", VF_VENDOR); } - }; - -extern "C" void * init_module( void ) -{ - return new ModulewatchFactory; -} - +MODULE_INIT(ModuleWatch)