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