/* * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2020-2023 Sadie Powell * * 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 . */ #pragma once namespace ISupport { class API; class APIBase; class EventListener; class EventProvider; /* A mapping of ISUPPORT tokens to their values. */ typedef std::map TokenMap; } enum { // From draft-brocklesby-irc-isupport-03. RPL_ISUPPORT = 5, }; /** Defines the interface for the ISupport API. */ class ISupport::APIBase : public DataProvider { public: APIBase(Module* mod) : DataProvider(mod, "isupportapi") { } /** Sends a full ISupport numeric set to the specified user. * @param user The user to send to. */ virtual void SendTo(LocalUser* user) const = 0; }; /** Allows modules to send ISupport messages to users. */ class ISupport::API final : public dynamic_reference { public: API(Module* mod) : dynamic_reference(mod, "isupportapi") { } }; class ISupport::EventListener : public Events::ModuleEventListener { protected: EventListener(Module* mod, unsigned int eventprio = DefaultPriority) : ModuleEventListener(mod, "event/isupport", eventprio) { } public: virtual void OnBuildISupport(TokenMap& tokens) { } virtual void OnBuildClassISupport(const std::shared_ptr& klass, TokenMap& tokens) { } virtual ModResult OnSendISupportDiff(LocalUser* user, const TokenMap& tokens) { return MOD_RES_PASSTHRU; } }; class ISupport::EventProvider final : public Events::ModuleEventProvider { public: EventProvider(Module* mod) : Events::ModuleEventProvider(mod, "event/isupport") { } };