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/stats.h"
  30 #include "servercommand.h"
  31 #include "commands.h"
  32 #include "protocolinterface.h"
  33
  34 /** If you make a change which breaks the protocol, increment this.
  35  * If you  completely change the protocol, completely change the number.
  36  *
  37  * IMPORTANT: If you make changes, document your changes here, without fail:
  38  * https://wiki.inspircd.org/List_of_protocol_changes_between_versions
  39  *
  40  * Failure to document your protocol changes will result in a painfully
  41  * painful death by pain. You have been warned.
  42  */
  43 const long ProtocolVersion = 1205;
  44 const long MinCompatProtocol = 1202;
  45
  46 /** Forward declarations
  47  */
  48 class SpanningTreeUtilities;
  49 class CacheRefreshTimer;
  50 class TreeServer;
  51 class Link;
  52 class Autoconnect;
  53
  54 /** This is the main class for the spanningtree module
  55  */
  56 class ModuleSpanningTree
  57         : public Module
  58         , public Away::EventListener
  59         , public Stats::EventListener
  60 {
  61         /** Client to server commands, registered in the core
  62          */
  63         CommandRConnect rconnect;
  64         CommandRSQuit rsquit;
  65         CommandMap map;
  66
  67         /** Server to server only commands, not registered in the core
  68          */
  69         SpanningTreeCommands commands;
  70
  71         /** Next membership id assigned when a local user joins a channel
  72          */
  73         Membership::Id currmembid;
  74
  75         /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
  76          */
  77         SpanningTreeProtocolInterface protocolinterface;
  78
  79         /** Event provider for our events
  80          */
  81         Events::ModuleEventProvider eventprov;
  82
  83  public:
  84         dynamic_reference<DNS::Manager> DNS;
  85
  86         ServerCommandManager CmdManager;
  87
  88         /** Set to true if inside a spanningtree call, to prevent sending
  89          * xlines and other things back to their source
  90          */
  91         bool loopCall;
  92
  93         /** Constructor
  94          */
  95         ModuleSpanningTree();
  96         void init() CXX11_OVERRIDE;
  97
  98         /** Shows /LINKS
  99          */
 100         void ShowLinks(TreeServer* Current, User* user, int hops);
 101
 102         /** Handle LINKS command
 103          */
 104         void HandleLinks(const CommandBase::Params& parameters, User* user);
 105
 106         /** Handle SQUIT
 107          */
 108         ModResult HandleSquit(const CommandBase::Params& parameters, User* user);
 109
 110         /** Handle remote WHOIS
 111          */
 112         ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user);
 113
 114         /** Connect a server locally
 115          */
 116         void ConnectServer(Link* x, Autoconnect* y = NULL);
 117
 118         /** Connect the next autoconnect server
 119          */
 120         void ConnectServer(Autoconnect* y, bool on_timer);
 121
 122         /** Check if any servers are due to be autoconnected
 123          */
 124         void AutoConnectServers(time_t curtime);
 125
 126         /** Check if any connecting servers should timeout
 127          */
 128         void DoConnectTimeout(time_t curtime);
 129
 130         /** Handle remote VERSON
 131          */
 132         ModResult HandleVersion(const CommandBase::Params& parameters, User* user);
 133
 134         /** Handle CONNECT
 135          */
 136         ModResult HandleConnect(const CommandBase::Params& parameters, User* user);
 137
 138         /** Display a time as a human readable string
 139          */
 140         static std::string TimeToStr(time_t secs);
 141
 142         const Events::ModuleEventProvider& GetEventProvider() const { return eventprov; }
 143
 144         /**
 145          ** *** MODULE EVENTS ***
 146          **/
 147
 148         ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE;
 149         void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result) CXX11_OVERRIDE;
 150         void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
 151         void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts) CXX11_OVERRIDE;
 152         ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) CXX11_OVERRIDE;
 153         void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
 154         void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
 155         void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
 156         void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
 157         void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
 158         void OnChangeRealName(User* user, const std::string& real) CXX11_OVERRIDE;
 159         void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
 160         void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
 161         void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
 162         void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
 163         void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
 164         void OnPreRehash(User* user, const std::string &parameter) CXX11_OVERRIDE;
 165         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
 166         void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
 167         void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
 168         void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
 169         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
 170         void OnUserAway(User* user) CXX11_OVERRIDE;
 171         void OnUserBack(User* user) CXX11_OVERRIDE;
 172         void OnLoadModule(Module* mod) CXX11_OVERRIDE;
 173         void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
 174         ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
 175         void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags, const std::string& output_mode) CXX11_OVERRIDE;
 176         CullResult cull() CXX11_OVERRIDE;
 177         ~ModuleSpanningTree();
 178         Version GetVersion() CXX11_OVERRIDE;
 179         void Prioritize() CXX11_OVERRIDE;
 180 };