1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #ifndef __INSPIRCD_H__
18 #define __INSPIRCD_H__
23 #include "inspircd_config.h"
28 #include "helperfuncs.h"
29 #include "socketengine.h"
30 #include "command_parse.h"
32 /* Some misc defines */
37 #define ETIREDGERBILS EAGAIN
39 /* This define is used in place of strcmp when we
40 * want to check if a char* string contains only one
41 * letter. Pretty fast, its just two compares and an
44 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
46 #define DELETE(x) { InspIRCd::Log(DEBUG,"%s:%d: delete()",__FILE__,__LINE__); if (x) { delete x; x = NULL; } else InspIRCd::Log(DEBUG,"Attempt to delete NULL pointer!"); }
48 template<typename T> inline std::string ConvToStr(const T &in)
50 std::stringstream tmp;
51 if (!(tmp << in)) return std::string();
55 class serverstats : public classbase
58 unsigned long statsAccept;
59 unsigned long statsRefused;
60 unsigned long statsUnknown;
61 unsigned long statsCollisions;
62 unsigned long statsDns;
63 unsigned long statsDnsGood;
64 unsigned long statsDnsBad;
65 unsigned long statsConnects;
68 unsigned long BoundPortCount;
72 statsAccept = statsRefused = statsUnknown = 0;
73 statsCollisions = statsDns = statsDnsGood = 0;
74 statsDnsBad = statsConnects = 0;
75 statsSent = statsRecv = 0.0;
81 class InspIRCd : public classbase
86 servernamelist servernames;
88 void EraseFactory(int j);
89 void EraseModule(int j);
91 void MoveTo(std::string modulename,int slot);
93 void SetSignals(bool SEGVHandler);
96 void MoveToLast(std::string modulename);
97 void MoveToFirst(std::string modulename);
98 void MoveAfter(std::string modulename, std::string after);
99 void MoveBefore(std::string modulename, std::string before);
101 void ProcessUser(userrec* cu);
102 void DoSocketTimeouts(time_t TIME);
103 void DoBackgroundUserStuff(time_t TIME);
105 bool AllModulesReportReady(userrec* user);
108 char LogFileName[MAXBUF];
110 featurelist Features;
114 ModeParser* ModeGrok;
115 CommandParser* Parser;
118 ServerConfig* Config;
119 std::vector<InspSocket*> module_sockets;
120 InspSocket* socket_ref[MAX_DESCRIPTORS]; /* XXX: This should probably be made private, with inline accessors */
121 userrec* fd_ref_table[MAX_DESCRIPTORS]; /* XXX: Ditto */
122 user_hash clientlist;
124 std::vector<userrec*> local_users;
125 std::vector<userrec*> all_opers;
127 TimerManager* Timers;
132 int GetModuleCount();
134 Module* FindModule(const std::string &name);
136 void AddServerName(const std::string &servername);
137 const char* FindServerNamePtr(const std::string &servername);
138 bool FindServerName(const std::string &servername);
140 std::string GetServerDescription(const char* servername);
142 void WriteOpers(const char* text, ...);
143 void WriteOpers(const std::string &text);
145 userrec* FindNick(const std::string &nick);
146 userrec* FindNick(const char* nick);
148 chanrec* FindChan(const std::string &chan);
149 chanrec* FindChan(const char* chan);
151 void LoadAllModules();
154 void OpenLog(char** argv, int argc);
156 bool UserToPseudo(userrec* user, const std::string &message);
157 bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
159 void ServerNoticeAll(char* text, ...);
160 void ServerPrivmsgAll(char* text, ...);
161 void WriteMode(const char* modes, int flags, const char* text, ...);
163 bool IsChannel(const char *chname);
165 static void Error(int status);
166 static void Rehash(int status);
167 static void Exit(int status);
170 int registered_usercount();
171 int usercount_invisible();
172 int usercount_opers();
173 int usercount_unknown();
177 void SendError(const char *s);
179 /** For use with Module::Prioritize().
180 * When the return value of this function is returned from
181 * Module::Prioritize(), this specifies that the module wishes
182 * to be ordered exactly BEFORE 'modulename'. For more information
183 * please see Module::Prioritize().
184 * @param modulename The module your module wants to be before in the call list
185 * @returns a priority ID which the core uses to relocate the module in the list
187 long PriorityBefore(const std::string &modulename);
189 /** For use with Module::Prioritize().
190 * When the return value of this function is returned from
191 * Module::Prioritize(), this specifies that the module wishes
192 * to be ordered exactly AFTER 'modulename'. For more information please
193 * see Module::Prioritize().
194 * @param modulename The module your module wants to be after in the call list
195 * @returns a priority ID which the core uses to relocate the module in the list
197 long PriorityAfter(const std::string &modulename);
199 /** Publish a 'feature'.
200 * There are two ways for a module to find another module it depends on.
201 * Either by name, using InspIRCd::FindModule, or by feature, using this
202 * function. A feature is an arbitary string which identifies something this
203 * module can do. For example, if your module provides SSL support, but other
204 * modules provide SSL support too, all the modules supporting SSL should
205 * publish an identical 'SSL' feature. This way, any module requiring use
206 * of SSL functions can just look up the 'SSL' feature using FindFeature,
207 * then use the module pointer they are given.
208 * @param FeatureName The case sensitive feature name to make available
209 * @param Mod a pointer to your module class
210 * @returns True on success, false if the feature is already published by
213 bool PublishFeature(const std::string &FeatureName, Module* Mod);
215 /** Unpublish a 'feature'.
216 * When your module exits, it must call this method for every feature it
217 * is providing so that the feature table is cleaned up.
218 * @param FeatureName the feature to remove
220 bool UnpublishFeature(const std::string &FeatureName);
222 /** Find a 'feature'.
223 * There are two ways for a module to find another module it depends on.
224 * Either by name, using InspIRCd::FindModule, or by feature, using the
225 * InspIRCd::PublishFeature method. A feature is an arbitary string which
226 * identifies something this module can do. For example, if your module
227 * provides SSL support, but other modules provide SSL support too, all
228 * the modules supporting SSL should publish an identical 'SSL' feature.
229 * To find a module capable of providing the feature you want, simply
230 * call this method with the feature name you are looking for.
231 * @param FeatureName The feature name you wish to obtain the module for
232 * @returns A pointer to a valid module class on success, NULL on failure.
234 Module* FindFeature(const std::string &FeatureName);
236 const std::string& GetModuleName(Module* m);
238 bool IsNick(const char* n);
239 bool IsIdent(const char* n);
241 std::string GetRevision();
242 std::string GetVersionString();
243 void WritePID(const std::string &filename);
245 bool LoadModule(const char* filename);
246 bool UnloadModule(const char* filename);
247 InspIRCd(int argc, char** argv);
248 void DoOneIteration(bool process_module_sockets);
249 static void Log(int level, const char* text, ...);
250 static void Log(int level, const std::string &text);