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 : public Module, public Stats::EventListener
  57 {
  58         /** Client to server commands, registered in the core
  59          */
  60         CommandRConnect rconnect;
  61         CommandRSQuit rsquit;
  62         CommandMap map;
  63
  64         /** Server to server only commands, not registered in the core
  65          */
  66         SpanningTreeCommands commands;
  67
  68         /** Next membership id assigned when a local user joins a channel
  69          */
  70         Membership::Id currmembid;
  71
  72         /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
  73          */
  74         SpanningTreeProtocolInterface protocolinterface;
  75
  76         /** Event provider for our events
  77          */
  78         Events::ModuleEventProvider eventprov;
  79
  80  public:
  81         dynamic_reference<DNS::Manager> DNS;
  82
  83         ServerCommandManager CmdManager;
  84
  85         /** Set to true if inside a spanningtree call, to prevent sending
  86          * xlines and other things back to their source
  87          */
  88         bool loopCall;
  89
  90         /** Constructor
  91          */
  92         ModuleSpanningTree();
  93         void init() CXX11_OVERRIDE;
  94
  95         /** Shows /LINKS
  96          */
  97         void ShowLinks(TreeServer* Current, User* user, int hops);
  98
  99         /** Handle LINKS command
 100          */
 101         void HandleLinks(const CommandBase::Params& parameters, User* user);
 102
 103         /** Handle SQUIT
 104          */
 105         ModResult HandleSquit(const CommandBase::Params& parameters, User* user);
 106
 107         /** Handle remote WHOIS
 108          */
 109         ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user);
 110
 111         /** Connect a server locally
 112          */
 113         void ConnectServer(Link* x, Autoconnect* y = NULL);
 114
 115         /** Connect the next autoconnect server
 116          */
 117         void ConnectServer(Autoconnect* y, bool on_timer);
 118
 119         /** Check if any servers are due to be autoconnected
 120          */
 121         void AutoConnectServers(time_t curtime);
 122
 123         /** Check if any connecting servers should timeout
 124          */
 125         void DoConnectTimeout(time_t curtime);
 126
 127         /** Handle remote VERSON
 128          */
 129         ModResult HandleVersion(const CommandBase::Params& parameters, User* user);
 130
 131         /** Handle CONNECT
 132          */
 133         ModResult HandleConnect(const CommandBase::Params& parameters, User* user);
 134
 135         /** Display a time as a human readable string
 136          */
 137         static std::string TimeToStr(time_t secs);
 138
 139         const Events::ModuleEventProvider& GetEventProvider() const { return eventprov; }
 140
 141         /**
 142          ** *** MODULE EVENTS ***
 143          **/
 144
 145         ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated, const std::string& original_line) CXX11_OVERRIDE;
 146         void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, const std::string& original_line) CXX11_OVERRIDE;
 147         void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
 148         void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts) CXX11_OVERRIDE;
 149         ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) CXX11_OVERRIDE;
 150         void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
 151         void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
 152         void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
 153         void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
 154         void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
 155         void OnChangeName(User* user, const std::string& real) CXX11_OVERRIDE;
 156         void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
 157         void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
 158         void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
 159         void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
 160         void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
 161         void OnPreRehash(User* user, const std::string &parameter) CXX11_OVERRIDE;
 162         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
 163         void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
 164         void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
 165         void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
 166         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
 167         ModResult OnSetAway(User* user, const std::string &awaymsg) CXX11_OVERRIDE;
 168         void OnLoadModule(Module* mod) CXX11_OVERRIDE;
 169         void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
 170         ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
 171         void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags, const std::string& output_mode) CXX11_OVERRIDE;
 172         CullResult cull() CXX11_OVERRIDE;
 173         ~ModuleSpanningTree();
 174         Version GetVersion() CXX11_OVERRIDE;
 175         void Prioritize() CXX11_OVERRIDE;
 176 };