/* * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2019 linuxdaemon * Copyright (C) 2013-2015 Attila Molnar * Copyright (C) 2013, 2018-2024 Sadie Powell * Copyright (C) 2013 Adam * Copyright (C) 2012 Robby * Copyright (C) 2009-2010 Daniel De Graaf * Copyright (C) 2009 Uli Schlachter * Copyright (C) 2007-2008 Dennis Friis * Copyright (C) 2007, 2009 Craig Edwards * Copyright (C) 2007 Robin Burchell * * 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 #include "inspircd.h" #include "event.h" #include "modules/dns.h" #include "modules/ssl.h" #include "modules/stats.h" #include "modules/ctctags.h" #include "modules/server.h" #include "servercommand.h" #include "commands.h" #include "protocolinterface.h" #include "tags.h" /** Forward declarations */ class SpanningTreeUtilities; class CacheRefreshTimer; class TreeServer; class Link; class Autoconnect; /** This is the main class for the spanningtree module */ class ModuleSpanningTree final : public Module , public Away::EventListener , public Stats::EventListener , public CTCTags::EventListener { /** Client to server commands, registered in the core */ CommandRConnect rconnect; CommandRSQuit rsquit; CommandMap map; /** Server to server only commands, not registered in the core */ SpanningTreeCommands commands; /** Next membership id assigned when a local user joins a channel */ Membership::Id currmembid = 1; public: /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load */ SpanningTreeProtocolInterface protocolinterface; /** Event provider for our routing event. */ Events::ModuleEventProvider routeeventprov; /** Event provider for our link events. */ Events::ModuleEventProvider linkeventprov; /** Event provider for our message events. */ Events::ModuleEventProvider messageeventprov; /** Event provider for our sync events. */ Events::ModuleEventProvider synceventprov; /** API for accessing user client certificates. */ UserCertificateAPI sslapi; /** Tags for server to server messages. */ ServerTags servertags; /** The DNS manager service provided by core_dns. */ DNS::ManagerRef DNS; /** Event provider for message tags. */ ClientProtocol::MessageTagEvent tagevprov; /** Manager for server commands. */ ServerCommandManager CmdManager; /** Set to true if inside a spanningtree call, to prevent sending * xlines and other things back to their source */ bool loopCall = false; /** Constructor */ ModuleSpanningTree(); void init() override; /** Shows /LINKS */ void ShowLinks(TreeServer* Current, User* user, int hops); /** Handle LINKS command */ void HandleLinks(const CommandBase::Params& parameters, User* user); /** Handle SQUIT */ static ModResult HandleSquit(const CommandBase::Params& parameters, User* user); /** Handle remote WHOIS */ static ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user); /** Connect a server locally */ void ConnectServer(const std::shared_ptr& x, const std::shared_ptr& y = nullptr); /** Connect the next autoconnect server */ void ConnectServer(const std::shared_ptr& y, bool on_timer); /** Check if any servers are due to be autoconnected */ void AutoConnectServers(time_t curtime); /** Check if any connecting servers should timeout */ static void DoConnectTimeout(time_t curtime); /** Handle remote VERSION */ static ModResult HandleVersion(const CommandBase::Params& parameters, User* user); /** Handle CONNECT */ ModResult HandleConnect(const CommandBase::Params& parameters, User* user); ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) override; void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop) override; void OnUserConnect(LocalUser* source) override; void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, ModeHandler::Rank notifyrank, CUList& notifyexcepts) override; ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) override; void OnPostTopicChange(User* user, Channel* chan, const std::string& topic) override; void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) override; void OnUserPostTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details) override; void OnBackgroundTimer(time_t curtime) override; void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) override; void OnChangeHost(User* user, const std::string& newhost) override; void OnChangeRealHost(User* user, const std::string& newhost) override; void OnChangeRealName(User* user, const std::string& real) override; void OnChangeUser(User* user, const std::string& newuser) override; void OnChangeRealUser(User* user, const std::string& newuser) override; void OnUserPart(Membership* memb, std::string& partmessage, CUList& excepts) override; void OnUserQuit(User* user, const std::string& reason, const std::string& oper_message) override; void OnUserPostNick(User* user, const std::string& oldnick) override; void OnUserKick(User* source, Membership* memb, const std::string& reason, CUList& excepts) override; void OnPreRehash(User* user, const std::string& parameter) override; void ReadConfig(ConfigStatus& status) override; void OnOperLogin(User* user, const std::shared_ptr& oper, bool automatic) override; void OnAddLine(User* u, XLine* x) override; void OnDelLine(User* u, XLine* x) override; ModResult OnStats(Stats::Context& stats) override; void OnUserAway(User* user, const std::optional& prevstate) override; void OnUserBack(User* user, const std::optional& prevstate) override; void OnLoadModule(Module* mod) override; void OnUnloadModule(Module* mod) override; ModResult OnAcceptConnection(int newsock, ListenSocket* from, const irc::sockets::sockaddrs& client, const irc::sockets::sockaddrs& server) override; void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags) override; void OnShutdown(const std::string& reason) override; void OnDecodeMetadata(Extensible* target, const std::string& extname, const std::string& extdata) override; Cullable::Result Cull() override; ~ModuleSpanningTree() override; void Prioritize() override; };