X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_cap.cpp;h=f035944baf87c24b7d9a13383fb270b8b5e97a6d;hb=6cfabb0064cab52bbbab59974e53dc0fa1954da7;hp=8ba28001e410ac0224bd95cd4269168625ef78f7;hpb=a58f0c00f1153f90701db07b033cf0576e9999e9;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_cap.cpp b/src/modules/m_cap.cpp index 8ba28001e..f035944ba 100644 --- a/src/modules/m_cap.cpp +++ b/src/modules/m_cap.cpp @@ -1,7 +1,8 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2015 Attila Molnar + * Copyright (C) 2018-2020 Sadie Powell + * Copyright (C) 2015-2016, 2018 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 @@ -18,23 +19,51 @@ #include "inspircd.h" +#include "modules/reload.h" #include "modules/cap.h" +enum +{ + // From IRCv3 capability-negotiation-3.1. + ERR_INVALIDCAPCMD = 410 +}; + namespace Cap { class ManagerImpl; } -class Cap::ManagerImpl : public Cap::Manager +static Cap::ManagerImpl* managerimpl; + +class Cap::ManagerImpl : public Cap::Manager, public ReloadModule::EventListener { + /** Stores the cap state of a module being reloaded + */ + struct CapModData + { + struct Data + { + std::string name; + std::vector users; + + Data(Capability* cap) + : name(cap->GetName()) + { + } + }; + std::vector caps; + }; + typedef insp::flat_map CapMap; ExtItem capext; CapMap caps; + Events::ModuleEventProvider& evprov; static bool CanRequest(LocalUser* user, Ext usercaps, Capability* cap, bool adding) { - if ((usercaps & cap->GetMask()) == adding) + const bool hascap = ((usercaps & cap->GetMask()) != 0); + if (hascap == adding) return true; return cap->OnRequest(user, adding); @@ -49,20 +78,84 @@ class Cap::ManagerImpl : public Cap::Manager used |= cap->GetMask(); } - for (unsigned int i = 0; i < MAX_CAPS; i++) + for (size_t i = 0; i < MAX_CAPS; i++) { - Capability::Bit bit = (1 << i); + Capability::Bit bit = (static_cast(1) << i); if (!(used & bit)) return bit; } throw ModuleException("Too many caps"); } + void OnReloadModuleSave(Module* mod, ReloadModule::CustomData& cd) CXX11_OVERRIDE + { + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnReloadModuleSave()"); + if (mod == creator) + return; + + CapModData* capmoddata = new CapModData; + cd.add(this, capmoddata); + + for (CapMap::iterator i = caps.begin(); i != caps.end(); ++i) + { + Capability* cap = i->second; + // Only save users of caps that belong to the module being reloaded + if (cap->creator != mod) + continue; + + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Module being reloaded implements cap %s, saving cap users", cap->GetName().c_str()); + capmoddata->caps.push_back(CapModData::Data(cap)); + CapModData::Data& capdata = capmoddata->caps.back(); + + // Populate list with uuids of users who are using the cap + const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers(); + for (UserManager::LocalList::const_iterator j = list.begin(); j != list.end(); ++j) + { + LocalUser* user = *j; + if (cap->get(user)) + capdata.users.push_back(user->uuid); + } + } + } + + void OnReloadModuleRestore(Module* mod, void* data) CXX11_OVERRIDE + { + CapModData* capmoddata = static_cast(data); + for (std::vector::const_iterator i = capmoddata->caps.begin(); i != capmoddata->caps.end(); ++i) + { + const CapModData::Data& capdata = *i; + Capability* cap = ManagerImpl::Find(capdata.name); + if (!cap) + { + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Cap %s is no longer available after reload", capdata.name.c_str()); + continue; + } + + // Set back the cap for all users who were using it before the reload + for (std::vector::const_iterator j = capdata.users.begin(); j != capdata.users.end(); ++j) + { + const std::string& uuid = *j; + User* user = ServerInstance->FindUUID(uuid); + if (!user) + { + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "User %s is gone when trying to restore cap %s", uuid.c_str(), capdata.name.c_str()); + continue; + } + + cap->set(user, true); + } + } + delete capmoddata; + } + public: - ManagerImpl(Module* mod) + ManagerImpl(Module* mod, Events::ModuleEventProvider& evprovref) : Cap::Manager(mod) - , capext("caps", ExtensionItem::EXT_USER, mod) + , ReloadModule::EventListener(mod) + , capext(mod) + , evprov(evprovref) { + managerimpl = this; } ~ManagerImpl() @@ -85,6 +178,9 @@ class Cap::ManagerImpl : public Cap::Manager cap->bit = AllocateBit(); cap->extitem = &capext; caps.insert(std::make_pair(cap->GetName(), cap)); + ServerInstance->Modules.AddReferent("cap/" + cap->GetName(), cap); + + FOREACH_MOD_CUSTOM(evprov, Cap::EventListener, OnCapAddDel, (cap, true)); } void DelCap(Cap::Capability* cap) CXX11_OVERRIDE @@ -95,6 +191,9 @@ class Cap::ManagerImpl : public Cap::Manager ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Unregistering cap %s", cap->GetName().c_str()); + // Fire the event first so modules can still see who is using the cap which is being unregistered + FOREACH_MOD_CUSTOM(evprov, Cap::EventListener, OnCapAddDel, (cap, false)); + // Turn off the cap for all users const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers(); for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i) @@ -103,6 +202,7 @@ class Cap::ManagerImpl : public Cap::Manager cap->set(user, false); } + ServerInstance->Modules.DelReferent(cap); cap->Unregister(); caps.erase(cap->GetName()); } @@ -115,6 +215,12 @@ class Cap::ManagerImpl : public Cap::Manager return NULL; } + void NotifyValueChange(Capability* cap) CXX11_OVERRIDE + { + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Cap %s changed value", cap->GetName().c_str()); + FOREACH_MOD_CUSTOM(evprov, Cap::EventListener, OnCapValueChange, (cap)); + } + Protocol GetProtocol(LocalUser* user) const { return ((capext.get(user) & CAP_302_BIT) ? CAP_302 : CAP_LEGACY); @@ -149,7 +255,7 @@ class Cap::ManagerImpl : public Cap::Manager return true; } - void HandleList(std::string& out, LocalUser* user, bool show_all, bool minus_prefix = false) const + void HandleList(std::vector& out, LocalUser* user, bool show_all, bool show_values, bool minus_prefix = false) const { Ext show_caps = (show_all ? ~0 : capext.get(user)); @@ -162,28 +268,140 @@ class Cap::ManagerImpl : public Cap::Manager if ((show_all) && (!cap->OnList(user))) continue; + std::string token; if (minus_prefix) - out.push_back('-'); - out.append(cap->GetName()).push_back(' '); + token.push_back('-'); + token.append(cap->GetName()); + + if (show_values) + { + const std::string* capvalue = cap->GetValue(user); + if ((capvalue) && (!capvalue->empty()) && (capvalue->find(' ') == std::string::npos)) + { + token.push_back('='); + token.append(*capvalue, 0, MAX_VALUE_LENGTH); + } + } + out.push_back(token); } } - void HandleClear(LocalUser* user, std::string& result) + void HandleClear(LocalUser* user, std::vector& result) { - HandleList(result, user, false, true); + HandleList(result, user, false, false, true); capext.unset(user); } }; +namespace +{ + std::string SerializeCaps(const Extensible* container, void* item, bool human) + { + // XXX: Cast away the const because IS_LOCAL() doesn't handle it + LocalUser* user = IS_LOCAL(const_cast(static_cast(container))); + if (!user) + return std::string(); + + // List requested caps + std::vector result; + managerimpl->HandleList(result, user, false, false); + + // Serialize cap protocol version. If building a human-readable string append a + // new token, otherwise append only a single character indicating the version. + std::string version; + if (human) + version.append("capversion=3."); + switch (managerimpl->GetProtocol(user)) + { + case Cap::CAP_302: + version.push_back('2'); + break; + default: + version.push_back('1'); + break; + } + result.push_back(version); + + return stdalgo::string::join(result, ' '); + } +} + +Cap::ExtItem::ExtItem(Module* mod) + : LocalIntExt("caps", ExtensionItem::EXT_USER, mod) +{ +} + +std::string Cap::ExtItem::ToHuman(const Extensible* container, void* item) const +{ + return SerializeCaps(container, item, true); +} + +std::string Cap::ExtItem::ToInternal(const Extensible* container, void* item) const +{ + return SerializeCaps(container, item, false); +} + +void Cap::ExtItem::FromInternal(Extensible* container, const std::string& value) +{ + LocalUser* user = IS_LOCAL(static_cast(container)); + if (!user) + return; // Can't happen + + // Process the cap protocol version which is a single character at the end of the serialized string + const char verchar = *value.rbegin(); + if (verchar == '2') + managerimpl->Set302Protocol(user); + + // Remove the version indicator from the string passed to HandleReq + std::string caplist(value, 0, value.size()-1); + managerimpl->HandleReq(user, caplist); +} + +class CapMessage : public Cap::MessageBase +{ + public: + CapMessage(LocalUser* user, const std::string& subcmd, const std::string& result, bool asterisk) + : Cap::MessageBase(subcmd) + { + SetUser(user); + if (asterisk) + PushParam("*"); + PushParamRef(result); + } +}; + class CommandCap : public SplitCommand { + private: + Events::ModuleEventProvider evprov; Cap::ManagerImpl manager; + ClientProtocol::EventProvider protoevprov; - static void DisplayResult(LocalUser* user, std::string& result) + void DisplayResult(LocalUser* user, const std::string& subcmd, std::vector result, bool asterisk) { - if (result.size() > 5) - result.erase(result.end()-1); - user->WriteCommand("CAP", result); + size_t maxline = ServerInstance->Config->Limits.MaxLine - ServerInstance->Config->ServerName.size() - user->nick.length() - subcmd.length() - 11; + std::string line; + for (std::vector::const_iterator iter = result.begin(); iter != result.end(); ++iter) + { + if (line.length() + iter->length() < maxline) + { + line.append(*iter); + line.push_back(' '); + } + else + { + DisplaySingleResult(user, subcmd, line, asterisk); + line.clear(); + } + } + DisplaySingleResult(user, subcmd, line, false); + } + + void DisplaySingleResult(LocalUser* user, const std::string& subcmd, const std::string& result, bool asterisk) + { + CapMessage msg(user, subcmd, result, asterisk); + ClientProtocol::Event ev(protoevprov, msg); + user->Send(ev); } public: @@ -191,52 +409,60 @@ class CommandCap : public SplitCommand CommandCap(Module* mod) : SplitCommand(mod, "CAP", 1) - , manager(mod) + , evprov(mod, "event/cap") + , manager(mod, evprov) + , protoevprov(mod, name) , holdext("cap_hold", ExtensionItem::EXT_USER, mod) { works_before_reg = true; } - CmdResult HandleLocal(const std::vector& parameters, LocalUser* user) CXX11_OVERRIDE + CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE { if (user->registered != REG_ALL) holdext.set(user, 1); - std::string subcommand(parameters[0].length(), ' '); - std::transform(parameters[0].begin(), parameters[0].end(), subcommand.begin(), ::toupper); - - if (subcommand == "REQ") + const std::string& subcommand = parameters[0]; + if (irc::equals(subcommand, "REQ")) { if (parameters.size() < 2) return CMD_FAILURE; - std::string result = (manager.HandleReq(user, parameters[1]) ? "ACK :" : "NAK :"); - result.append(parameters[1]); - user->WriteCommand("CAP", result); + const std::string replysubcmd = (manager.HandleReq(user, parameters[1]) ? "ACK" : "NAK"); + DisplaySingleResult(user, replysubcmd, parameters[1], false); } - else if (subcommand == "END") + else if (irc::equals(subcommand, "END")) { holdext.unset(user); } - else if ((subcommand == "LS") || (subcommand == "LIST")) + else if (irc::equals(subcommand, "LS") || irc::equals(subcommand, "LIST")) { + Cap::Protocol capversion = Cap::CAP_LEGACY; const bool is_ls = (subcommand.length() == 2); - if ((is_ls) && (parameters.size() > 1) && (parameters[1] == "302")) - manager.Set302Protocol(user); - - std::string result = subcommand + " :"; - manager.HandleList(result, user, is_ls); - DisplayResult(user, result); + if ((is_ls) && (parameters.size() > 1)) + { + unsigned int version = ConvToNum(parameters[1]); + if (version >= 302) + { + capversion = Cap::CAP_302; + manager.Set302Protocol(user); + } + } + + std::vector result; + // Show values only if supports v3.2 and doing LS + manager.HandleList(result, user, is_ls, ((is_ls) && (capversion != Cap::CAP_LEGACY))); + DisplayResult(user, subcommand, result, (capversion != Cap::CAP_LEGACY)); } - else if ((subcommand == "CLEAR") && (manager.GetProtocol(user) == Cap::CAP_LEGACY)) + else if (irc::equals(subcommand, "CLEAR") && (manager.GetProtocol(user) == Cap::CAP_LEGACY)) { - std::string result = "ACK :"; + std::vector result; manager.HandleClear(user, result); - DisplayResult(user, result); + DisplayResult(user, "ACK", result, false); } else { - user->WriteNumeric(ERR_INVALIDCAPSUBCOMMAND, "%s :Invalid CAP subcommand", subcommand.c_str()); + user->WriteNumeric(ERR_INVALIDCAPCMD, subcommand.empty() ? "*" : subcommand, "Invalid CAP subcommand"); return CMD_FAILURE; } @@ -244,13 +470,33 @@ class CommandCap : public SplitCommand } }; +class PoisonCap : public Cap::Capability +{ + public: + PoisonCap(Module* mod) + : Cap::Capability(mod, "inspircd.org/poison") + { + } + + bool OnRequest(LocalUser* user, bool adding) CXX11_OVERRIDE + { + // Reject the attempt to enable this capability. + return false; + } +}; + class ModuleCap : public Module { + private: CommandCap cmd; + PoisonCap poisoncap; + Cap::Capability stdrplcap; public: ModuleCap() : cmd(this) + , poisoncap(this) + , stdrplcap(this, "inspircd.org/standard-replies") { } @@ -261,7 +507,7 @@ class ModuleCap : public Module Version GetVersion() CXX11_OVERRIDE { - return Version("Provides support for CAP capability negotiation", VF_VENDOR); + return Version("Implements support for the IRCv3 Client Capability Negotiation extension.", VF_VENDOR); } };