1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
20 /** If you make a change which breaks the protocol, increment this.
21 * If you completely change the protocol, completely change the number.
23 * IMPORTANT: If you make changes, document your changes here, without fail:
24 * http://wiki.inspircd.org/List_of_protocol_changes_between_versions
26 * Failure to document your protocol changes will result in a painfully
27 * painful death by pain. You have been warned.
29 const long ProtocolVersion = 1202;
30 const long MinCompatProtocol = 1201;
32 /** Forward declarations
34 class CommandRConnect;
36 class SpanningTreeUtilities;
37 class CacheRefreshTimer;
42 /** This is the main class for the spanningtree module
44 class ModuleSpanningTree : public Module
46 unsigned int max_local;
47 unsigned int max_global;
48 CommandRConnect* command_rconnect;
49 CommandRSQuit* command_rsquit;
50 SpanningTreeUtilities* Utils;
52 void RedoConfig(Module* mod, const std::string &name);
55 CacheRefreshTimer *RefreshTimer;
56 /** Set to true if inside a spanningtree call, to prevent sending
57 * xlines and other things back to their source
67 void ShowLinks(TreeServer* Current, User* user, int hops);
69 /** Counts local servers
71 int CountLocalServs();
73 /** Counts local and remote servers
77 /** Handle LINKS command
79 void HandleLinks(const std::vector<std::string>& parameters, User* user);
81 /** Handle LUSERS command
83 void HandleLusers(const std::vector<std::string>& parameters, User* user);
85 /** Show MAP output to a user (recursive)
87 void ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats);
89 /** Handle remote MOTD
91 ModResult HandleMotd(const std::vector<std::string>& parameters, User* user);
93 /** Handle remote ADMIN
95 ModResult HandleAdmin(const std::vector<std::string>& parameters, User* user);
97 /** Handle remote STATS
99 ModResult HandleStats(const std::vector<std::string>& parameters, User* user);
101 /** Handle MAP command
103 bool HandleMap(const std::vector<std::string>& parameters, User* user);
107 ModResult HandleSquit(const std::vector<std::string>& parameters, User* user);
111 ModResult HandleTime(const std::vector<std::string>& parameters, User* user);
113 /** Handle remote WHOIS
115 ModResult HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
117 /** Handle remote MODULES
119 ModResult HandleModules(const std::vector<std::string>& parameters, User* user);
121 /** Ping all local servers
123 void DoPingChecks(time_t curtime);
125 /** Connect a server locally
127 void ConnectServer(Link* x, Autoconnect* y);
129 /** Check if any servers are due to be autoconnected
131 void AutoConnectServers(time_t curtime);
133 /** Check if any connecting servers should timeout
135 void DoConnectTimeout(time_t curtime);
137 /** Handle remote VERSON
139 ModResult HandleVersion(const std::vector<std::string>& parameters, User* user);
143 ModResult HandleConnect(const std::vector<std::string>& parameters, User* user);
145 /** Attempt to send a message to a user
147 void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
149 /** Returns oper-specific MAP information
151 const std::string MapOperInfo(TreeServer* Current);
153 /** Display a time as a human readable string
155 std::string TimeToStr(time_t secs);
158 ** *** MODULE EVENTS ***
161 ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
162 void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
163 void OnGetServerDescription(const std::string &servername,std::string &description);
164 void OnUserConnect(User* source);
165 void OnUserInvite(User* source,User* dest,Channel* channel, time_t);
166 void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
167 void OnWallops(User* user, const std::string &text);
168 void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
169 void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
170 void OnBackgroundTimer(time_t curtime);
171 void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts);
172 ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
173 void OnChangeName(User* user, const std::string &gecos);
174 void OnChangeIdent(User* user, const std::string &ident);
175 void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts);
176 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
177 void OnUserPostNick(User* user, const std::string &oldnick);
178 void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts);
179 void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
180 void OnPreRehash(User* user, const std::string ¶meter);
181 void OnRehash(User* user);
182 void OnOper(User* user, const std::string &opertype);
183 void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
184 void OnAddLine(User *u, XLine *x);
185 void OnDelLine(User *u, XLine *x);
186 void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
187 ModResult OnStats(char statschar, User* user, string_list &results);
188 ModResult OnSetAway(User* user, const std::string &awaymsg);
189 void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
190 void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
191 void OnEvent(Event* event);
192 void OnLoadModule(Module* mod,const std::string &name);
193 void OnUnloadModule(Module* mod,const std::string &name);
194 ~ModuleSpanningTree();
195 Version GetVersion();