]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/inspircd.h
Remove more classbase
[user/henk/code/inspircd.git] / include / inspircd.h
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
6  * See: http://wiki.inspircd.org/Credits
7  *
8  * This program is free but copyrighted software; see
9  *          the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 #ifndef __INSPIRCD_H__
15 #define __INSPIRCD_H__
16
17 #define _FILE_OFFSET_BITS 64
18 #ifndef _LARGEFILE_SOURCE
19 #define _LARGEFILE_SOURCE
20 #endif
21
22 #ifndef WIN32
23 #define DllExport
24 #define CoreExport
25 #define printf_c printf
26 #else
27 #include "inspircd_win32wrapper.h"
28 /** Windows defines these already */
29 #undef DELETE
30 #undef ERROR
31 #endif
32
33 #ifdef __GNUC__
34 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
35 #else
36 #define CUSTOM_PRINTF(STRING, FIRST)
37 #endif
38
39 // Required system headers.
40 #include <ctime>
41 #include <cstdarg>
42 #include <algorithm>
43 #include <cmath>
44 #include <cstring>
45 #include <climits>
46 #include <cstdio>
47
48 #include <sstream>
49 #include <string>
50 #include <vector>
51 #include <list>
52 #include <deque>
53 #include <map>
54 #include <bitset>
55 #include <set>
56
57 /** A list of failed port bindings, used for informational purposes on startup */
58 typedef std::vector<std::pair<std::string, std::string> > FailedPortList;
59
60 class InspIRCd;
61 CoreExport extern InspIRCd* ServerInstance;
62
63 #include "inspircd_config.h"
64 #include "inspircd_version.h"
65 #include "caller.h"
66 #include "cull_list.h"
67 #include "extensible.h"
68 #include "numerics.h"
69 #include "uid.h"
70 #include "users.h"
71 #include "channels.h"
72 #include "timer.h"
73 #include "hashcomp.h"
74 #include "typedefs.h"
75 #include "logger.h"
76 #include "usermanager.h"
77 #include "socket.h"
78 #include "ctables.h"
79 #include "command_parse.h"
80 #include "mode.h"
81 #include "socketengine.h"
82 #include "snomasks.h"
83 #include "filelogger.h"
84 #include "caller.h"
85 #include "modules.h"
86 #include "configreader.h"
87 #include "inspstring.h"
88 #include "protocol.h"
89 #include "threadengine.h"
90 #include "fakeuser.h"
91
92 #ifndef PATH_MAX
93 #warning Potentially broken system, PATH_MAX undefined
94 #define PATH_MAX 4096
95 #endif
96
97 /**
98  * Used to define the maximum number of parameters a command may have.
99  */
100 #define MAXPARAMETERS 127
101
102 /** Returned by some functions to indicate failure.
103  */
104 #define ERROR -1
105
106 /** Support for librodent -
107  * see http://www.chatspike.net/index.php?z=64
108  */
109 #define ETIREDHAMSTERS EAGAIN
110
111 /** Template function to convert any input type to std::string
112  */
113 template<typename T> inline std::string ConvNumeric(const T &in)
114 {
115         if (in == 0) return "0";
116         char res[MAXBUF];
117         char* out = res;
118         T quotient = in;
119         while (quotient) {
120                 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
121                 ++out;
122                 quotient /= 10;
123         }
124         if (in < 0)
125                 *out++ = '-';
126         *out = 0;
127         std::reverse(res,out);
128         return res;
129 }
130
131 /** Template function to convert any input type to std::string
132  */
133 inline std::string ConvToStr(const int in)
134 {
135         return ConvNumeric(in);
136 }
137
138 /** Template function to convert any input type to std::string
139  */
140 inline std::string ConvToStr(const long in)
141 {
142         return ConvNumeric(in);
143 }
144
145 /** Template function to convert any input type to std::string
146  */
147 inline std::string ConvToStr(const char* in)
148 {
149         return in;
150 }
151
152 /** Template function to convert any input type to std::string
153  */
154 inline std::string ConvToStr(const bool in)
155 {
156         return (in ? "1" : "0");
157 }
158
159 /** Template function to convert any input type to std::string
160  */
161 inline std::string ConvToStr(char in)
162 {
163         return std::string(in,1);
164 }
165
166 /** Template function to convert any input type to std::string
167  */
168 template <class T> inline std::string ConvToStr(const T &in)
169 {
170         std::stringstream tmp;
171         if (!(tmp << in)) return std::string();
172         return tmp.str();
173 }
174
175 /** Template function to convert any input type to any other type
176  * (usually an integer or numeric type)
177  */
178 template<typename T> inline long ConvToInt(const T &in)
179 {
180         std::stringstream tmp;
181         if (!(tmp << in)) return 0;
182         return atoi(tmp.str().c_str());
183 }
184
185 /** Template function to convert integer to char, storing result in *res and
186  * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
187  * @param T input value
188  * @param V result value
189  * @param R base to convert to
190  */
191 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
192 {
193         if (base < 2 || base > 16) { *res = 0; return res; }
194         char* out = res;
195         int quotient = in;
196         while (quotient) {
197                 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
198                 ++out;
199                 quotient /= base;
200         }
201         if ( in < 0 && base == 10) *out++ = '-';
202         std::reverse( res, out );
203         *out = 0;
204         return res;
205 }
206
207 /** This class contains various STATS counters
208  * It is used by the InspIRCd class, which internally
209  * has an instance of it.
210  */
211 class serverstats
212 {
213   public:
214         /** Number of accepted connections
215          */
216         unsigned long statsAccept;
217         /** Number of failed accepts
218          */
219         unsigned long statsRefused;
220         /** Number of unknown commands seen
221          */
222         unsigned long statsUnknown;
223         /** Number of nickname collisions handled
224          */
225         unsigned long statsCollisions;
226         /** Number of DNS queries sent out
227          */
228         unsigned long statsDns;
229         /** Number of good DNS replies received
230          * NOTE: This may not tally to the number sent out,
231          * due to timeouts and other latency issues.
232          */
233         unsigned long statsDnsGood;
234         /** Number of bad (negative) DNS replies received
235          * NOTE: This may not tally to the number sent out,
236          * due to timeouts and other latency issues.
237          */
238         unsigned long statsDnsBad;
239         /** Number of inbound connections seen
240          */
241         unsigned long statsConnects;
242         /** Total bytes of data transmitted
243          */
244         double statsSent;
245         /** Total bytes of data received
246          */
247         double statsRecv;
248         /** Cpu usage at last sample
249          */
250         timeval LastCPU;
251         /** Time last sample was read
252          */
253         timeval LastSampled;
254         /** The constructor initializes all the counts to zero
255          */
256         serverstats()
257                 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
258                 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
259         {
260         }
261 };
262
263 class InspIRCd;
264
265 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
266 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
267 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
268 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
269 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
270 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
271
272 /* Forward declaration - required */
273 class XLineManager;
274 class BanCacheManager;
275
276 /** The background thread for config reading, so that reading from executable includes
277  * does not block.
278  */
279 class CoreExport ConfigReaderThread : public Thread
280 {
281         ServerConfig* Config;
282         bool done;
283  public:
284         std::string TheUserUID;
285         ConfigReaderThread(const std::string &useruid)
286                 : Thread(), done(false), TheUserUID(useruid)
287         {
288         }
289
290         virtual ~ConfigReaderThread()
291         {
292         }
293
294         void Run();
295         /** Run in the main thread to apply the configuration */
296         void Finish();
297         bool IsDone() { return done; }
298 };
299
300 /** The main class of the irc server.
301  * This class contains instances of all the other classes in this software.
302  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
303  * object, and a list of active Module objects, and facilities for Module
304  * objects to interact with the core system it implements.
305  */
306 class CoreExport InspIRCd
307 {
308  private:
309         /** Holds the current UID. Used to generate the next one.
310          */
311         char current_uid[UUID_LENGTH];
312
313         /** Set up the signal handlers
314          */
315         void SetSignals();
316
317         /** Daemonize the ircd and close standard input/output streams
318          * @return True if the program daemonized succesfully
319          */
320         bool DaemonSeed();
321
322         /** Iterate the list of BufferedSocket objects, removing ones which have timed out
323          * @param TIME the current time
324          */
325         void DoSocketTimeouts(time_t TIME);
326
327         /** Increments the current UID by one.
328          */
329         void IncrementUID(int pos);
330
331         /** Perform background user events such as PING checks
332          */
333         void DoBackgroundUserStuff();
334
335         /** Returns true when all modules have done pre-registration checks on a user
336          * @param user The user to verify
337          * @return True if all modules have finished checking this user
338          */
339         bool AllModulesReportReady(User* user);
340
341         /** Logfile pathname specified on the commandline, or empty string
342          */
343         char LogFileName[MAXBUF];
344
345         /** The current time, updated in the mainloop
346          */
347         time_t TIME;
348
349         /** The time that was recorded last time around the mainloop
350          */
351         time_t OLDTIME;
352
353         /** A 64k buffer used to read socket data into
354          * NOTE: update ValidateNetBufferSize if you change this
355          */
356         char ReadBuffer[65535];
357
358 #ifdef WIN32
359         IPC* WindowsIPC;
360 #endif
361
362  public:
363
364         /** Global cull list, will be processed on next iteration
365          */
366         CullList GlobalCulls;
367         /** Actions that must happen outside of the current call stack */
368         ActionList AtomicActions;
369
370         /**** Functors ****/
371
372         IsNickHandler HandleIsNick;
373         IsIdentHandler HandleIsIdent;
374         FloodQuitUserHandler HandleFloodQuitUser;
375         IsChannelHandler HandleIsChannel;
376         IsSIDHandler HandleIsSID;
377         RehashHandler HandleRehash;
378
379         /** Globally accessible fake user record. This is used to force mode changes etc across s2s, etc.. bit ugly, but.. better than how this was done in 1.1
380          * Reason for it:
381          * kludge alert!
382          * SendMode expects a User* to send the numeric replies
383          * back to, so we create it a fake user that isnt in the user
384          * hash and set its descriptor to FD_MAGIC_NUMBER so the data
385          * falls into the abyss :p
386          */
387         FakeUser* FakeClient;
388
389         /** Returns the next available UID for this server.
390          */
391         std::string GetUID();
392
393         /** Find a user in the UUID hash
394          * @param nick The nickname to find
395          * @return A pointer to the user, or NULL if the user does not exist
396          */
397         User* FindUUID(const std::string &);
398
399         /** Find a user in the UUID hash
400          * @param nick The nickname to find
401          * @return A pointer to the user, or NULL if the user does not exist
402          */
403         User* FindUUID(const char *);
404
405         /** Build the ISUPPORT string by triggering all modules On005Numeric events
406          */
407         void BuildISupport();
408
409         /** Time this ircd was booted
410          */
411         time_t startup_time;
412
413         /** Config file pathname specified on the commandline or via ./configure
414          */
415         std::string ConfigFileName;
416
417         ExtensionManager Extensions;
418
419         /** Mode handler, handles mode setting and removal
420          */
421         ModeParser* Modes;
422
423         /** Command parser, handles client to server commands
424          */
425         CommandParser* Parser;
426
427         /** Socket engine, handles socket activity events
428          */
429         SocketEngine* SE;
430
431         /** Thread engine, Handles threading where required
432          */
433         ThreadEngine* Threads;
434
435         /** The thread/class used to read config files in REHASH and on startup
436          */
437         ConfigReaderThread* ConfigThread;
438
439         /** LogManager handles logging.
440          */
441         LogManager *Logs;
442
443         /** ModuleManager contains everything related to loading/unloading
444          * modules.
445          */
446         ModuleManager* Modules;
447
448         /** BanCacheManager is used to speed up checking of restrictions on connection
449          * to the IRCd.
450          */
451         BanCacheManager *BanCache;
452
453         /** Stats class, holds miscellaneous stats counters
454          */
455         serverstats* stats;
456
457         /**  Server Config class, holds configuration file data
458          */
459         ServerConfig* Config;
460
461         /** Snomask manager - handles routing of snomask messages
462          * to opers.
463          */
464         SnomaskManager* SNO;
465
466         /** DNS class, provides resolver facilities to the core and modules
467          */
468         DNS* Res;
469
470         /** Timer manager class, triggers Timer timer events
471          */
472         TimerManager* Timers;
473
474         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
475          */
476         XLineManager* XLines;
477
478         /** User manager. Various methods and data associated with users.
479          */
480         UserManager *Users;
481
482         /** Channel list, a hash_map containing all channels XXX move to channel manager class
483          */
484         chan_hash* chanlist;
485
486         /** List of the open ports
487          */
488         std::vector<ListenSocketBase *> ports;
489
490         /** Set to the current signal recieved
491          */
492         int s_signal;
493
494         /** Protocol interface, overridden by server protocol modules
495          */
496         ProtocolInterface* PI;
497
498         /** Holds extensible for user nickforced
499          */
500         LocalIntExt NICKForced;
501
502         /** Holds extensible for user operquit
503          */
504         LocalStringExt OperQuit;
505
506         /** Get the current time
507          * Because this only calls time() once every time around the mainloop,
508          * it is much faster than calling time() directly.
509          * @return The current time as an epoch value (time_t)
510          */
511         time_t Time();
512
513         /** Bind all ports specified in the configuration file.
514          * @return The number of ports bound without error
515          */
516         int BindPorts(FailedPortList &failed_ports);
517
518         /** Binds a socket on an already open file descriptor
519          * @param sockfd A valid file descriptor of an open socket
520          * @param port The port number to bind to
521          * @param addr The address to bind to (IP only)
522          * @return True if the port was bound successfully
523          */
524         bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
525
526         /** Gets the GECOS (description) field of the given server.
527          * If the servername is not that of the local server, the name
528          * is passed to handling modules which will attempt to determine
529          * the GECOS that bleongs to the given servername.
530          * @param servername The servername to find the description of
531          * @return The description of this server, or of the local server
532          */
533         std::string GetServerDescription(const std::string& servername);
534
535         /** Find a user in the nick hash.
536          * If the user cant be found in the nick hash check the uuid hash
537          * @param nick The nickname to find
538          * @return A pointer to the user, or NULL if the user does not exist
539          */
540         User* FindNick(const std::string &nick);
541
542         /** Find a user in the nick hash.
543          * If the user cant be found in the nick hash check the uuid hash
544          * @param nick The nickname to find
545          * @return A pointer to the user, or NULL if the user does not exist
546          */
547         User* FindNick(const char* nick);
548
549         /** Find a user in the nick hash ONLY
550          */
551         User* FindNickOnly(const char* nick);
552
553         /** Find a user in the nick hash ONLY
554          */
555         User* FindNickOnly(const std::string &nick);
556
557         /** Find a channel in the channels hash
558          * @param chan The channel to find
559          * @return A pointer to the channel, or NULL if the channel does not exist
560          */
561         Channel* FindChan(const std::string &chan);
562
563         /** Find a channel in the channels hash
564          * @param chan The channel to find
565          * @return A pointer to the channel, or NULL if the channel does not exist
566          */
567         Channel* FindChan(const char* chan);
568
569         /** Check we aren't running as root, and exit if we are
570          * @return Depending on the configuration, this function may never return
571          */
572         void CheckRoot();
573
574         /** Determine the right path for, and open, the logfile
575          * @param argv The argv passed to main() initially, used to calculate program path
576          * @param argc The argc passed to main() initially, used to calculate program path
577          * @return True if the log could be opened, false if otherwise
578          */
579         bool OpenLog(char** argv, int argc);
580
581         /** Return true if a channel name is valid
582          * @param chname A channel name to verify
583          * @return True if the name is valid
584          */
585         caller2<bool, const char*, size_t> IsChannel;
586
587         /** Return true if str looks like a server ID
588          * @param string to check against
589          */
590         caller1<bool, const std::string&> IsSID;
591
592         /** Rehash the local server
593          */
594         caller1<void, const std::string&> Rehash;
595
596         /** Handles incoming signals after being set
597          * @param signal the signal recieved
598          */
599         void SignalHandler(int signal);
600
601         /** Sets the signal recieved
602          * @param signal the signal recieved
603          */
604         static void SetSignal(int signal);
605
606         /** Causes the server to exit after unloading modules and
607          * closing all open file descriptors.
608          *
609          * @param The exit code to give to the operating system
610          * (See the ExitStatus enum for valid values)
611          */
612         void Exit(int status);
613
614         /** Causes the server to exit immediately with exit code 0.
615          * The status code is required for signal handlers, and ignored.
616          */
617         static void QuickExit(int status);
618
619         /** Return a count of channels on the network
620          * @return The number of channels
621          */
622         long ChannelCount();
623
624         /** Send an error notice to all local users, opered and unopered
625          * @param s The error string to send
626          */
627         void SendError(const std::string &s);
628
629         /** Return true if a nickname is valid
630          * @param n A nickname to verify
631          * @return True if the nick is valid
632          */
633         caller2<bool, const char*, size_t> IsNick;
634
635         /** Return true if an ident is valid
636          * @param An ident to verify
637          * @return True if the ident is valid
638          */
639         caller1<bool, const char*> IsIdent;
640
641         /** Add a dns Resolver class to this server's active set
642          * @param r The resolver to add
643          * @param cached If this value is true, then the cache will
644          * be searched for the DNS result, immediately. If the value is
645          * false, then a request will be sent to the nameserver, and the
646          * result will not be immediately available. You should usually
647          * use the boolean value which you passed to the Resolver
648          * constructor, which Resolver will set appropriately depending
649          * on if cached results are available and haven't expired. It is
650          * however safe to force this value to false, forcing a remote DNS
651          * lookup, but not an update of the cache.
652          * @return True if the operation completed successfully. Note that
653          * if this method returns true, you should not attempt to access
654          * the resolver class you pass it after this call, as depending upon
655          * the request given, the object may be deleted!
656          */
657         bool AddResolver(Resolver* r, bool cached);
658
659         /** Add a command to this server's command parser
660          * @param f A Command command handler object to add
661          * @throw ModuleException Will throw ModuleExcption if the command already exists
662          */
663         void AddCommand(Command *f);
664
665         /** Send a modechange.
666          * The parameters provided are identical to that sent to the
667          * handler for class cmd_mode.
668          * @param parameters The mode parameters
669          * @param user The user to send error messages to
670          */
671         void SendMode(const std::vector<std::string>& parameters, User *user);
672
673         /** Match two strings using pattern matching, optionally, with a map
674          * to check case against (may be NULL). If map is null, match will be case insensitive.
675          * @param str The literal string to match against
676          * @param mask The glob pattern to match against.
677          */
678         static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
679         static bool Match(const  char *str, const char *mask, unsigned const char *map = NULL);
680
681         /** Match two strings using pattern matching, optionally, with a map
682          * to check case against (may be NULL). If map is null, match will be case insensitive.
683          * Supports CIDR patterns as well as globs.
684          * @param str The literal string to match against
685          * @param mask The glob or CIDR pattern to match against.
686          */
687         static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
688         static bool MatchCIDR(const  char *str, const char *mask, unsigned const char *map = NULL);
689
690         /** Call the handler for a given command.
691          * @param commandname The command whos handler you wish to call
692          * @param parameters The mode parameters
693          * @param pcnt The number of items you have given in the first parameter
694          * @param user The user to execute the command as
695          * @return True if the command handler was called successfully
696          */
697         CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
698
699         /** Return true if the command is a module-implemented command and the given parameters are valid for it
700          * @param parameters The mode parameters
701          * @param pcnt The number of items you have given in the first parameter
702          * @param user The user to test-execute the command as
703          * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
704          */
705         bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
706
707         /** Return true if the given parameter is a valid nick!user\@host mask
708          * @param mask A nick!user\@host masak to match against
709          * @return True i the mask is valid
710          */
711         bool IsValidMask(const std::string &mask);
712
713         /** Rehash the local server
714          */
715         void RehashServer();
716
717         /** Dump text to a user target, splitting it appropriately to fit
718          * @param User the user to dump the text to
719          * @param LinePrefix text to prefix each complete line with
720          * @param TextStream the text to send to the user
721          */
722         void DumpText(User* user, const std::string &LinePrefix, std::stringstream &TextStream);
723
724         /** Dump text to a user target (local or remote)
725          * @param user the user to dump the text to
726          * @param text the full line of text
727          */
728         void DumpText(User* user, const std::string &text);
729
730         /** Dump text to a user target (local or remote)
731          * @param user the user to dump the text to
732          * @param format the printf format string for the text to send
733          */
734         void DumpText(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
735
736         /** Check if the given nickmask matches too many users, send errors to the given user
737          * @param nick A nickmask to match against
738          * @param user A user to send error text to
739          * @return True if the nick matches too many users
740          */
741         bool NickMatchesEveryone(const std::string &nick, User* user);
742
743         /** Check if the given IP mask matches too many users, send errors to the given user
744          * @param ip An ipmask to match against
745          * @param user A user to send error text to
746          * @return True if the ip matches too many users
747          */
748         bool IPMatchesEveryone(const std::string &ip, User* user);
749
750         /** Check if the given hostmask matches too many users, send errors to the given user
751          * @param mask A hostmask to match against
752          * @param user A user to send error text to
753          * @return True if the host matches too many users
754          */
755         bool HostMatchesEveryone(const std::string &mask, User* user);
756
757         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
758          * @param str A string containing a time in the form 1y2w3d4h6m5s
759          * (one year, two weeks, three days, four hours, six minutes and five seconds)
760          * @return The total number of seconds
761          */
762         long Duration(const std::string &str);
763
764         /** Attempt to compare a password to a string from the config file.
765          * This will be passed to handling modules which will compare the data
766          * against possible hashed equivalents in the input string.
767          * @param ex The object (user, server, whatever) causing the comparison.
768          * @param data The data from the config file
769          * @param input The data input by the oper
770          * @param hashtype The hash from the config file
771          * @return 0 if the strings match, 1 or -1 if they do not
772          */
773         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
774
775         /** Check if a given server is a uline.
776          * An empty string returns true, this is by design.
777          * @param server The server to check for uline status
778          * @return True if the server is a uline OR the string is empty
779          */
780         bool ULine(const std::string& server);
781
782         /** Returns true if the uline is 'silent' (doesnt generate
783          * remote connect notices etc).
784          */
785         bool SilentULine(const std::string& server);
786
787         /** Returns the subversion revision ID of this ircd
788          * @return The revision ID or an empty string
789          */
790         std::string GetRevision();
791
792         /** Returns the full version string of this ircd
793          * @return The version string
794          */
795         std::string GetVersionString();
796
797         /** Attempt to write the process id to a given file
798          * @param filename The PID file to attempt to write to
799          * @return This function may bail if the file cannot be written
800          */
801         void WritePID(const std::string &filename);
802
803         /** This constructor initialises all the subsystems and reads the config file.
804          * @param argc The argument count passed to main()
805          * @param argv The argument list passed to main()
806          * @throw <anything> If anything is thrown from here and makes it to
807          * you, you should probably just give up and go home. Yes, really.
808          * It's that bad. Higher level classes should catch any non-fatal exceptions.
809          */
810         InspIRCd(int argc, char** argv);
811
812         /** Send a line of WHOIS data to a user.
813          * @param user user to send the line to
814          * @param dest user being WHOISed
815          * @param numeric Numeric to send
816          * @param text Text of the numeric
817          */
818         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
819
820         /** Send a line of WHOIS data to a user.
821          * @param user user to send the line to
822          * @param dest user being WHOISed
823          * @param numeric Numeric to send
824          * @param format Format string for the numeric
825          * @param ... Parameters for the format string
826          */
827         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
828
829         /** Handle /STATS
830          */
831         void DoStats(char statschar, User* user, string_list &results);
832
833         /** Handle /WHOIS
834          */
835         void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
836
837         /** Quit a user for excess flood, and if they are not
838          * fully registered yet, temporarily zline their IP.
839          * @param current user to quit
840          */
841         caller1<void, User*> FloodQuitUser;
842
843         /** Restart the server.
844          * This function will not return. If an error occurs,
845          * it will throw an instance of CoreException.
846          * @param reason The restart reason to show to all clients
847          * @throw CoreException An instance of CoreException indicating the error from execv().
848          */
849         void Restart(const std::string &reason);
850
851         /** Prepare the ircd for restart or shutdown.
852          * This function unloads all modules which can be unloaded,
853          * closes all open sockets, and closes the logfile.
854          */
855         void Cleanup();
856
857         /** This copies the user and channel hash_maps into new hash maps.
858          * This frees memory used by the hash_map allocator (which it neglects
859          * to free, most of the time, using tons of ram)
860          */
861         void RehashUsersAndChans();
862
863         /** Resets the cached max bans value on all channels.
864          * Called by rehash.
865          */
866         void ResetMaxBans();
867
868         /** Return a time_t as a human-readable string.
869          */
870         std::string TimeString(time_t curtime);
871
872         /** Begin execution of the server.
873          * NOTE: this function NEVER returns. Internally,
874          * it will repeatedly loop.
875          * @return The return value for this function is undefined.
876          */
877         int Run();
878
879         /** Adds an extban char to the 005 token.
880          */
881         void AddExtBanChar(char c);
882
883         char* GetReadBuffer()
884         {
885                 return this->ReadBuffer;
886         }
887 };
888
889 ENTRYPOINT;
890
891 template<class Cmd>
892 class CommandModule : public Module
893 {
894         Cmd cmd;
895  public:
896         CommandModule() : cmd(this)
897         {
898                 ServerInstance->AddCommand(&cmd);
899         }
900
901         Version GetVersion()
902         {
903                 return Version(cmd.command, VF_VENDOR|VF_CORE);
904         }
905 };
906
907 #endif