src/modules/m_spanningtree/main.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   6  *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   8  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #pragma once
  25
  26 #include "inspircd.h"
  27 #include "event.h"
  28 #include "modules/dns.h"
  29 #include "modules/ssl.h"
  30 #include "modules/stats.h"
  31 #include "modules/ctctags.h"
  32 #include "servercommand.h"
  33 #include "commands.h"
  34 #include "protocolinterface.h"
  35
  36 /** An enumeration of all known protocol versions.
  37  *
  38  * If you introduce new protocol versions please document them here:
  39  * https://docs.inspircd.org/spanningtree/changes
  40  */
  41 enum ProtocolVersion
  42 {
  43         /** The linking protocol version introduced in InspIRCd v2.0. */
  44         PROTO_INSPIRCD_20 = 1202,
  45
  46         /** The linking protocol version introduced in InspIRCd v2.1 alpha 0. */
  47         PROTO_INSPIRCD_21_A0 = 1203,
  48
  49         /** The linking protocol version introduced in InspIRCd v2.1 beta 2. */
  50         PROTO_INSPIRCD_21_B2 = 1204,
  51
  52         /** The linking protocol version introduced in InspIRCd v3.0. */
  53         PROTO_INSPIRCD_30 = 1205,
  54
  55         /** The oldest version of the protocol that we support. */
  56         PROTO_OLDEST = PROTO_INSPIRCD_20,
  57
  58         /** The newest version of the protocol that we support. */
  59         PROTO_NEWEST = PROTO_INSPIRCD_30
  60 };
  61
  62 /** Forward declarations
  63  */
  64 class SpanningTreeUtilities;
  65 class CacheRefreshTimer;
  66 class TreeServer;
  67 class Link;
  68 class Autoconnect;
  69
  70 /** This is the main class for the spanningtree module
  71  */
  72 class ModuleSpanningTree
  73         : public Module
  74         , public Away::EventListener
  75         , public Stats::EventListener
  76         , public CTCTags::EventListener
  77 {
  78         /** Client to server commands, registered in the core
  79          */
  80         CommandRConnect rconnect;
  81         CommandRSQuit rsquit;
  82         CommandMap map;
  83
  84         /** Server to server only commands, not registered in the core
  85          */
  86         SpanningTreeCommands commands;
  87
  88         /** Next membership id assigned when a local user joins a channel
  89          */
  90         Membership::Id currmembid;
  91
  92         /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
  93          */
  94         SpanningTreeProtocolInterface protocolinterface;
  95
  96         /** Event provider for our events
  97          */
  98         Events::ModuleEventProvider eventprov;
  99
 100         /** API for accessing user SSL certificates. */
 101         UserCertificateAPI sslapi;
 102
 103  public:
 104         dynamic_reference<DNS::Manager> DNS;
 105
 106         /** Event provider for message tags. */
 107         Events::ModuleEventProvider tagevprov;
 108
 109         ServerCommandManager CmdManager;
 110
 111         /** Set to true if inside a spanningtree call, to prevent sending
 112          * xlines and other things back to their source
 113          */
 114         bool loopCall;
 115
 116         /** Constructor
 117          */
 118         ModuleSpanningTree();
 119         void init() CXX11_OVERRIDE;
 120
 121         /** Shows /LINKS
 122          */
 123         void ShowLinks(TreeServer* Current, User* user, int hops);
 124
 125         /** Handle LINKS command
 126          */
 127         void HandleLinks(const CommandBase::Params& parameters, User* user);
 128
 129         /** Handle SQUIT
 130          */
 131         ModResult HandleSquit(const CommandBase::Params& parameters, User* user);
 132
 133         /** Handle remote WHOIS
 134          */
 135         ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user);
 136
 137         /** Connect a server locally
 138          */
 139         void ConnectServer(Link* x, Autoconnect* y = NULL);
 140
 141         /** Connect the next autoconnect server
 142          */
 143         void ConnectServer(Autoconnect* y, bool on_timer);
 144
 145         /** Check if any servers are due to be autoconnected
 146          */
 147         void AutoConnectServers(time_t curtime);
 148
 149         /** Check if any connecting servers should timeout
 150          */
 151         void DoConnectTimeout(time_t curtime);
 152
 153         /** Handle remote VERSON
 154          */
 155         ModResult HandleVersion(const CommandBase::Params& parameters, User* user);
 156
 157         /** Handle CONNECT
 158          */
 159         ModResult HandleConnect(const CommandBase::Params& parameters, User* user);
 160
 161         const Events::ModuleEventProvider& GetEventProvider() const { return eventprov; }
 162
 163         /**
 164          ** *** MODULE EVENTS ***
 165          **/
 166
 167         ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE;
 168         void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop) CXX11_OVERRIDE;
 169         void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
 170         void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts) CXX11_OVERRIDE;
 171         ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) CXX11_OVERRIDE;
 172         void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
 173         void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
 174         void OnUserPostTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details) CXX11_OVERRIDE;
 175         void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
 176         void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
 177         void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
 178         void OnChangeRealName(User* user, const std::string& real) CXX11_OVERRIDE;
 179         void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
 180         void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
 181         void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
 182         void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
 183         void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
 184         void OnPreRehash(User* user, const std::string &parameter) CXX11_OVERRIDE;
 185         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
 186         void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
 187         void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
 188         void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
 189         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
 190         void OnUserAway(User* user) CXX11_OVERRIDE;
 191         void OnUserBack(User* user) CXX11_OVERRIDE;
 192         void OnLoadModule(Module* mod) CXX11_OVERRIDE;
 193         void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
 194         ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
 195         void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags) CXX11_OVERRIDE;
 196         CullResult cull() CXX11_OVERRIDE;
 197         ~ModuleSpanningTree();
 198         Version GetVersion() CXX11_OVERRIDE;
 199         void Prioritize() CXX11_OVERRIDE;
 200 };