diff options
| -rw-r--r-- | src/modules/m_watch.cpp | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/src/modules/m_watch.cpp b/src/modules/m_watch.cpp new file mode 100644 index 000000000..bdd4b2b15 --- /dev/null +++ b/src/modules/m_watch.cpp @@ -0,0 +1,267 @@ +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2016 Attila Molnar <attilamolnar@hush.com> + * + * 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 <http://www.gnu.org/licenses/>. + */ + + +#include "inspircd.h" + +#define INSPIRCD_MONITOR_MANAGER_ONLY +#include "m_monitor.cpp" + +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 CommandWatch : public SplitCommand +{ + // Additional penalty for /WATCH commands that request a list from the server + static const unsigned int ListPenalty = 4000; + + IRCv3::Monitor::Manager& manager; + + static void SendOnlineOffline(LocalUser* user, const std::string& nick, bool show_offline = true) + { + User* target = IRCv3::Monitor::Manager::FindNick(nick); + if (target) + { + // 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, "%s %s %s %lu :is away", target->nick.c_str(), target->ident.c_str(), target->dhost.c_str(), (unsigned long)target->awaytime); + else + user->WriteNumeric(RPL_NOWON, "%s %s %s %lu :is online", target->nick.c_str(), target->ident.c_str(), target->dhost.c_str(), (unsigned long)target->age); + } + else if (show_offline) + user->WriteNumeric(RPL_NOWOFF, "%s * * 0 :is offline", nick.c_str()); + } + + 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) + { + // List is full, send error numeric + user->WriteNumeric(ERR_TOOMANYWATCH, "%s :Too many WATCH entries", nick.c_str()); + return; + } + else if (result == IRCv3::Monitor::Manager::WR_INVALIDNICK) + { + user->WriteNumeric(942, "%s :Invalid nickname", nick.c_str()); + return; + } + else if (result != IRCv3::Monitor::Manager::WR_OK) + return; + + SendOnlineOffline(user, nick); + } + + void HandleMinus(LocalUser* user, const std::string& nick) + { + if (!manager.Unwatch(user, nick)) + return; + + User* target = IRCv3::Monitor::Manager::FindNick(nick); + if (target) + user->WriteNumeric(RPL_WATCHOFF, "%s %s %s %lu :stopped watching", target->nick.c_str(), target->ident.c_str(), target->dhost.c_str(), (unsigned long)target->age); + else + user->WriteNumeric(RPL_WATCHOFF, "%s * * 0 :stopped watching", nick.c_str()); + } + + 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) + { + const IRCv3::Monitor::Entry* entry = *i; + SendOnlineOffline(user, entry->GetNick(), show_offline); + } + user->WriteNumeric(RPL_ENDOFWATCHLIST, ":End of WATCH list"); + } + + 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, ":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) + { + 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 = "[<C|L|S|l|+<nick1>|-<nick>>]"; + } + + CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user) + { + if (parameters.empty()) + { + HandleList(user, false); + return CMD_SUCCESS; + } + + bool watch_l_done = false; + bool watch_s_done = false; + + for (std::vector<std::string>::const_iterator i = parameters.begin(); i != parameters.end(); ++i) + { + const std::string& token = *i; + char subcmd = toupper(token[0]); + if (subcmd == '+') + { + HandlePlus(user, token.substr(1)); + } + else if (subcmd == '-') + { + HandleMinus(user, token.substr(1)); + } + else if (subcmd == 'C') + { + manager.UnwatchAll(user); + } + else if ((subcmd == 'L') && (!watch_l_done)) + { + 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_SUCCESS; + } +}; + +class ModuleWatch : public Module +{ + IRCv3::Monitor::Manager manager; + CommandWatch cmd; + + void SendAlert(User* user, const std::string& nick, unsigned int numeric, const char* numerictext, time_t shownts) + { + const IRCv3::Monitor::WatcherList* list = manager.GetWatcherList(nick); + if (!list) + return; + + std::string text = InspIRCd::Format("%s %s %s %lu :%s", nick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) shownts, numerictext); + for (IRCv3::Monitor::WatcherList::const_iterator i = list->begin(); i != list->end(); ++i) + { + LocalUser* curr = *i; + curr->WriteNumeric(numeric, text); + } + } + + void Online(User* user) + { + SendAlert(user, user->nick, RPL_LOGON, "arrived online", user->age); + } + + void Offline(User* user, const std::string& nick) + { + SendAlert(user, nick, RPL_LOGOFF, "went offline", user->age); + } + + public: + ModuleWatch() + : manager(this, "watch") + , cmd(this, manager) + { + } + + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE + { + ConfigTag* tag = ServerInstance->Config->ConfValue("watch"); + cmd.maxwatch = tag->getInt("maxwatch", 30, 1); + } + + void OnPostConnect(User* user) CXX11_OVERRIDE + { + Online(user); + } + + 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); + } + + void OnUserQuit(User* user, const std::string& message, const std::string& oper_message) CXX11_OVERRIDE + { + LocalUser* localuser = IS_LOCAL(user); + if (localuser) + manager.UnwatchAll(localuser); + Offline(user, user->nick); + } + + ModResult OnSetAway(User* user, const std::string& awaymsg) CXX11_OVERRIDE + { + 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; + } + + void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE + { + tokens["WATCH"] = ConvToStr(cmd.maxwatch); + } + + Version GetVersion() CXX11_OVERRIDE + { + return Version("Provides WATCH support", VF_VENDOR); + } +}; + +MODULE_INIT(ModuleWatch) |