2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
27 #include "modules/dns.h"
28 #include "servercommand.h"
30 #include "protocolinterface.h"
32 /** If you make a change which breaks the protocol, increment this.
33 * If you completely change the protocol, completely change the number.
35 * IMPORTANT: If you make changes, document your changes here, without fail:
36 * http://wiki.inspircd.org/List_of_protocol_changes_between_versions
38 * Failure to document your protocol changes will result in a painfully
39 * painful death by pain. You have been warned.
41 const long ProtocolVersion = 1205;
42 const long MinCompatProtocol = 1202;
44 /** Forward declarations
46 class SpanningTreeCommands;
47 class SpanningTreeUtilities;
48 class CacheRefreshTimer;
53 /** This is the main class for the spanningtree module
55 class ModuleSpanningTree : public Module
57 /** Client to server commands, registered in the core
59 CommandRConnect rconnect;
63 /** Server to server only commands, not registered in the core
65 SpanningTreeCommands* commands;
67 /** Next membership id assigned when a local user joins a channel
69 Membership::Id currmembid;
71 /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
73 SpanningTreeProtocolInterface protocolinterface;
76 dynamic_reference<DNS::Manager> DNS;
78 ServerCommandManager CmdManager;
80 /** Set to true if inside a spanningtree call, to prevent sending
81 * xlines and other things back to their source
85 /** True if users are quitting due to a netsplit
92 void init() CXX11_OVERRIDE;
96 void ShowLinks(TreeServer* Current, User* user, int hops);
98 /** Handle LINKS command
100 void HandleLinks(const std::vector<std::string>& parameters, User* user);
104 ModResult HandleSquit(const std::vector<std::string>& parameters, User* user);
106 /** Handle remote WHOIS
108 ModResult HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
110 /** Ping all local servers
112 void DoPingChecks(time_t curtime);
114 /** Connect a server locally
116 void ConnectServer(Link* x, Autoconnect* y = NULL);
118 /** Connect the next autoconnect server
120 void ConnectServer(Autoconnect* y, bool on_timer);
122 /** Check if any servers are due to be autoconnected
124 void AutoConnectServers(time_t curtime);
126 /** Check if any connecting servers should timeout
128 void DoConnectTimeout(time_t curtime);
130 /** Handle remote VERSON
132 ModResult HandleVersion(const std::vector<std::string>& parameters, User* user);
136 ModResult HandleConnect(const std::vector<std::string>& parameters, User* user);
138 /** Attempt to send a message to a user
140 void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
142 /** Display a time as a human readable string
144 static std::string TimeToStr(time_t secs);
147 ** *** MODULE EVENTS ***
150 ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE;
151 void OnPostCommand(Command*, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line) CXX11_OVERRIDE;
152 void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
153 void OnUserInvite(User* source,User* dest,Channel* channel, time_t) CXX11_OVERRIDE;
154 void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
155 void OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE;
156 void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
157 void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
158 void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
159 void OnChangeName(User* user, const std::string &gecos) CXX11_OVERRIDE;
160 void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
161 void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
162 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
163 void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
164 void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
165 void OnPreRehash(User* user, const std::string ¶meter) CXX11_OVERRIDE;
166 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
167 void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
168 void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
169 void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
170 ModResult OnStats(char statschar, User* user, string_list &results) CXX11_OVERRIDE;
171 ModResult OnSetAway(User* user, const std::string &awaymsg) 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 On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE;
177 ~ModuleSpanningTree();
178 Version GetVersion() CXX11_OVERRIDE;