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;
41 /** This is the main class for the spanningtree module
43 class ModuleSpanningTree : public Module
45 unsigned int max_local;
46 unsigned int max_global;
47 CommandRConnect* command_rconnect;
48 CommandRSQuit* command_rsquit;
49 SpanningTreeUtilities* Utils;
51 void RedoConfig(Module* mod, const std::string &name);
54 CacheRefreshTimer *RefreshTimer;
55 /** Set to true if inside a spanningtree call, to prevent sending
56 * xlines and other things back to their source
62 ModuleSpanningTree(InspIRCd* Me);
66 void ShowLinks(TreeServer* Current, User* user, int hops);
68 /** Counts local servers
70 int CountLocalServs();
72 /** Counts local and remote servers
76 /** Handle LINKS command
78 void HandleLinks(const std::vector<std::string>& parameters, User* user);
80 /** Handle LUSERS command
82 void HandleLusers(const std::vector<std::string>& parameters, User* user);
84 /** Show MAP output to a user (recursive)
86 void ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats);
88 /** Handle remote MOTD
90 ModResult HandleMotd(const std::vector<std::string>& parameters, User* user);
92 /** Handle remote ADMIN
94 ModResult HandleAdmin(const std::vector<std::string>& parameters, User* user);
96 /** Handle remote STATS
98 ModResult HandleStats(const std::vector<std::string>& parameters, User* user);
100 /** Handle MAP command
102 bool HandleMap(const std::vector<std::string>& parameters, User* user);
106 ModResult HandleSquit(const std::vector<std::string>& parameters, User* user);
110 ModResult HandleTime(const std::vector<std::string>& parameters, User* user);
112 /** Handle remote WHOIS
114 ModResult HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
116 /** Handle remote MODULES
118 ModResult HandleModules(const std::vector<std::string>& parameters, User* user);
120 /** Ping all local servers
122 void DoPingChecks(time_t curtime);
124 /** Connect a server locally
126 void ConnectServer(Link* x);
128 /** Check if any servers are due to be autoconnected
130 void AutoConnectServers(time_t curtime);
132 /** Check if any connecting servers should timeout
134 void DoConnectTimeout(time_t curtime);
136 /** Handle remote VERSON
138 ModResult HandleVersion(const std::vector<std::string>& parameters, User* user);
142 ModResult HandleConnect(const std::vector<std::string>& parameters, User* user);
144 /** Attempt to send a message to a user
146 void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
148 /** Returns oper-specific MAP information
150 const std::string MapOperInfo(TreeServer* Current);
152 /** Display a time as a human readable string
154 std::string TimeToStr(time_t secs);
157 ** *** MODULE EVENTS ***
160 ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
161 void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
162 void OnGetServerDescription(const std::string &servername,std::string &description);
163 void OnUserConnect(User* source);
164 void OnUserInvite(User* source,User* dest,Channel* channel, time_t);
165 void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
166 void OnWallops(User* user, const std::string &text);
167 void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
168 void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
169 void OnBackgroundTimer(time_t curtime);
170 void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts);
171 ModResult OnChangeLocalUserHost(User* user, const std::string &newhost);
172 void OnChangeName(User* user, const std::string &gecos);
173 void OnChangeIdent(User* user, const std::string &ident);
174 void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts);
175 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
176 void OnUserPostNick(User* user, const std::string &oldnick);
177 void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts);
178 void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
179 void OnPreRehash(User* user, const std::string ¶meter);
180 void OnRehash(User* user);
181 void OnOper(User* user, const std::string &opertype);
182 void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
183 void OnAddLine(User *u, XLine *x);
184 void OnDelLine(User *u, XLine *x);
185 void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
186 ModResult OnStats(char statschar, User* user, string_list &results);
187 ModResult OnSetAway(User* user, const std::string &awaymsg);
188 void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
189 void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
190 std::string ProtoTranslate(Extensible* item);
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();