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"
31 /** If you make a change which breaks the protocol, increment this.
32 * If you completely change the protocol, completely change the number.
34 * IMPORTANT: If you make changes, document your changes here, without fail:
35 * http://wiki.inspircd.org/List_of_protocol_changes_between_versions
37 * Failure to document your protocol changes will result in a painfully
38 * painful death by pain. You have been warned.
40 const long ProtocolVersion = 1205;
41 const long MinCompatProtocol = 1202;
43 /** Forward declarations
45 class SpanningTreeCommands;
46 class SpanningTreeUtilities;
47 class CacheRefreshTimer;
52 /** This is the main class for the spanningtree module
54 class ModuleSpanningTree : public Module
56 /** Client to server commands, registered in the core
58 CommandRConnect rconnect;
62 /** Server to server only commands, not registered in the core
64 SpanningTreeCommands* commands;
67 dynamic_reference<DNS::Manager> DNS;
69 ServerCommandManager CmdManager;
71 /** Set to true if inside a spanningtree call, to prevent sending
72 * xlines and other things back to their source
79 void init() CXX11_OVERRIDE;
83 void ShowLinks(TreeServer* Current, User* user, int hops);
85 /** Handle LINKS command
87 void HandleLinks(const std::vector<std::string>& parameters, User* user);
91 ModResult HandleSquit(const std::vector<std::string>& parameters, User* user);
93 /** Handle remote WHOIS
95 ModResult HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
97 /** Ping all local servers
99 void DoPingChecks(time_t curtime);
101 /** Connect a server locally
103 void ConnectServer(Link* x, Autoconnect* y = NULL);
105 /** Connect the next autoconnect server
107 void ConnectServer(Autoconnect* y, bool on_timer);
109 /** Check if any servers are due to be autoconnected
111 void AutoConnectServers(time_t curtime);
113 /** Check if any connecting servers should timeout
115 void DoConnectTimeout(time_t curtime);
117 /** Handle remote VERSON
119 ModResult HandleVersion(const std::vector<std::string>& parameters, User* user);
123 ModResult HandleConnect(const std::vector<std::string>& parameters, User* user);
125 /** Attempt to send a message to a user
127 void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
129 /** Display a time as a human readable string
131 static std::string TimeToStr(time_t secs);
134 ** *** MODULE EVENTS ***
137 ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE;
138 void OnPostCommand(Command*, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line) CXX11_OVERRIDE;
139 void OnGetServerDescription(const std::string &servername,std::string &description) CXX11_OVERRIDE;
140 void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
141 void OnUserInvite(User* source,User* dest,Channel* channel, time_t) CXX11_OVERRIDE;
142 void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
143 void OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE;
144 void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
145 void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
146 void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
147 void OnChangeName(User* user, const std::string &gecos) CXX11_OVERRIDE;
148 void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
149 void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
150 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
151 void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
152 void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
153 void OnPreRehash(User* user, const std::string ¶meter) CXX11_OVERRIDE;
154 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
155 void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
156 void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
157 void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
158 void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
159 ModResult OnStats(char statschar, User* user, string_list &results) CXX11_OVERRIDE;
160 ModResult OnSetAway(User* user, const std::string &awaymsg) CXX11_OVERRIDE;
161 void OnLoadModule(Module* mod) CXX11_OVERRIDE;
162 void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
163 ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
164 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE;
166 ~ModuleSpanningTree();
167 Version GetVersion() CXX11_OVERRIDE;