]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/inspircd.h
Move IsNick, IsIdent into class InspIRCd, update modules that use it.
[user/henk/code/inspircd.git] / include / inspircd.h
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
6  *                     E-mail:
7  *              <brain@chatspike.net>
8  *                <Craig@chatspike.net>
9  *     
10  * Written by Craig Edwards, Craig McLure, and others.
11  * This program is free but copyrighted software; see
12  *          the file COPYING for details.
13  *
14  * ---------------------------------------------------
15  */
16
17 #ifndef __INSPIRCD_H__
18 #define __INSPIRCD_H__
19
20 #include <time.h>
21 #include <string>
22 #include <sstream>
23 #include "inspircd_config.h"
24 #include "users.h"
25 #include "channels.h"
26 #include "socket.h"
27 #include "mode.h"
28 #include "helperfuncs.h"
29 #include "socketengine.h"
30 #include "command_parse.h"
31
32 /* Some misc defines */
33 #define ERROR -1
34 #define MAXCOMMAND 32
35
36 /* Crucial defines */
37 #define ETIREDGERBILS EAGAIN
38
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
42  * addition.
43  */
44 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
45
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!"); }
47
48 template<typename T> inline std::string ConvToStr(const T &in)
49 {
50         std::stringstream tmp;
51         if (!(tmp << in)) return std::string();
52         return tmp.str();
53 }
54
55 class serverstats : public classbase
56 {
57   public:
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;
66         double statsSent;
67         double statsRecv;
68         unsigned long BoundPortCount;
69
70         serverstats()
71         {
72                 statsAccept = statsRefused = statsUnknown = 0;
73                 statsCollisions = statsDns = statsDnsGood = 0;
74                 statsDnsBad = statsConnects = 0;
75                 statsSent = statsRecv = 0.0;
76                 BoundPortCount = 0;
77         }
78 };
79
80
81 class InspIRCd : public classbase
82 {
83  private:
84         char MODERR[MAXBUF];
85         bool expire_run;
86         servernamelist servernames;
87  
88         void EraseFactory(int j);
89         void EraseModule(int j);
90         void BuildISupport();
91         void MoveTo(std::string modulename,int slot);
92         void Start();
93         void SetSignals(bool SEGVHandler);
94         bool DaemonSeed();
95         void MakeLowerMap();
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);
100
101         void ProcessUser(userrec* cu);
102         void DoSocketTimeouts(time_t TIME);
103         void DoBackgroundUserStuff(time_t TIME);
104
105  public:
106         time_t startup_time;
107         ModeParser* ModeGrok;
108         CommandParser* Parser;
109         SocketEngine* SE;
110         serverstats* stats;
111         ServerConfig* Config;
112         std::vector<InspSocket*> module_sockets;
113         InspSocket* socket_ref[MAX_DESCRIPTORS];        /* XXX: This should probably be made private, with inline accessors */
114         userrec* fd_ref_table[MAX_DESCRIPTORS];         /* XXX: Ditto */
115         user_hash clientlist;
116         chan_hash chanlist;
117         std::vector<userrec*> local_users;
118         DNS* Res;
119         TimerManager* Timers;
120
121         void AddServerName(const std::string &servername);
122         const char* FindServerNamePtr(const std::string &servername);
123         bool FindServerName(const std::string &servername);
124
125         std::string GetServerDescription(const char* servername);
126
127         void WriteOpers(const char* text, ...);
128         void WriteOpers(const std::string &text);
129         
130         userrec* FindNick(const std::string &nick);
131         userrec* FindNick(const char* nick);
132
133         chanrec* FindChan(const std::string &chan);
134         chanrec* FindChan(const char* chan);
135
136         bool UserToPseudo(userrec* user, const std::string &message);
137         bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
138
139         void ServerNoticeAll(char* text, ...);
140         void ServerPrivmsgAll(char* text, ...);
141         void WriteMode(const char* modes, int flags, const char* text, ...);
142
143         int usercnt();
144         int registered_usercount();
145         int usercount_invisible();
146         int usercount_opers();
147         int usercount_unknown();
148         long chancount();
149         long local_count();
150
151         void SendError(const char *s);
152
153         /** For use with Module::Prioritize().
154          * When the return value of this function is returned from
155          * Module::Prioritize(), this specifies that the module wishes
156          * to be ordered exactly BEFORE 'modulename'. For more information
157          * please see Module::Prioritize().
158          * @param modulename The module your module wants to be before in the call list
159          * @returns a priority ID which the core uses to relocate the module in the list
160          */
161         long PriorityBefore(const std::string &modulename);
162
163         /** For use with Module::Prioritize().
164          * When the return value of this function is returned from
165          * Module::Prioritize(), this specifies that the module wishes
166          * to be ordered exactly AFTER 'modulename'. For more information please
167          * see Module::Prioritize().
168          * @param modulename The module your module wants to be after in the call list
169          * @returns a priority ID which the core uses to relocate the module in the list
170          */
171         long PriorityAfter(const std::string &modulename);
172
173         /** Publish a 'feature'.
174          * There are two ways for a module to find another module it depends on.
175          * Either by name, using InspIRCd::FindModule, or by feature, using this
176          * function. A feature is an arbitary string which identifies something this
177          * module can do. For example, if your module provides SSL support, but other
178          * modules provide SSL support too, all the modules supporting SSL should
179          * publish an identical 'SSL' feature. This way, any module requiring use
180          * of SSL functions can just look up the 'SSL' feature using FindFeature,
181          * then use the module pointer they are given.
182          * @param FeatureName The case sensitive feature name to make available
183          * @param Mod a pointer to your module class
184          * @returns True on success, false if the feature is already published by
185          * another module.
186          */
187         bool PublishFeature(const std::string &FeatureName, Module* Mod);
188
189         /** Unpublish a 'feature'.
190          * When your module exits, it must call this method for every feature it
191          * is providing so that the feature table is cleaned up.
192          * @param FeatureName the feature to remove
193          */
194         bool UnpublishFeature(const std::string &FeatureName);
195
196         /** Find a 'feature'.
197          * There are two ways for a module to find another module it depends on.
198          * Either by name, using InspIRCd::FindModule, or by feature, using the
199          * InspIRCd::PublishFeature method. A feature is an arbitary string which
200          * identifies something this module can do. For example, if your module
201          * provides SSL support, but other modules provide SSL support too, all
202          * the modules supporting SSL should publish an identical 'SSL' feature.
203          * To find a module capable of providing the feature you want, simply
204          * call this method with the feature name you are looking for.
205          * @param FeatureName The feature name you wish to obtain the module for
206          * @returns A pointer to a valid module class on success, NULL on failure.
207          */
208         Module* FindFeature(const std::string &FeatureName);
209
210         const std::string& GetModuleName(Module* m);
211
212         bool IsNick(const char* n);
213         bool IsIdent(const char* n);
214
215         std::string GetRevision();
216         std::string GetVersionString();
217         void WritePID(const std::string &filename);
218         char* ModuleError();
219         bool LoadModule(const char* filename);
220         bool UnloadModule(const char* filename);
221         InspIRCd(int argc, char** argv);
222         void DoOneIteration(bool process_module_sockets);
223         static void Log(int level, const char* text, ...);
224         static void Log(int level, const std::string &text);
225         int Run();
226 };
227
228 /* Miscellaneous stuff here, moved from inspircd_io.h */
229 void Exit(int status);
230
231 #endif