1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __INSPIRCD_H__
15 #define __INSPIRCD_H__
20 #define printf_c printf
22 #include "inspircd_win32wrapper.h"
23 /** Windows defines these already */
32 #include "inspircd_config.h"
38 #include "socketengine.h"
39 #include "command_parse.h"
41 #include "cull_list.h"
42 #include "filelogger.h"
46 * Used to define the maximum number of parameters a command may have.
48 #define MAXPARAMETERS 127
50 /** Returned by some functions to indicate failure.
54 /** Support for librodent -
55 * see http://www.chatspike.net/index.php?z=64
57 #define ETIREDHAMSTERS EAGAIN
59 /** Delete a pointer, and NULL its value
61 template<typename T> inline void DELETE(T* x)
67 /** Template function to convert any input type to std::string
69 template<typename T> inline std::string ConvNumeric(const T &in)
71 if (in == 0) return "0";
76 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
83 std::reverse(res,out);
87 /** Template function to convert any input type to std::string
89 inline std::string ConvToStr(const int in)
91 return ConvNumeric(in);
94 /** Template function to convert any input type to std::string
96 inline std::string ConvToStr(const long in)
98 return ConvNumeric(in);
101 /** Template function to convert any input type to std::string
103 inline std::string ConvToStr(const unsigned long in)
105 return ConvNumeric(in);
108 /** Template function to convert any input type to std::string
110 inline std::string ConvToStr(const char* in)
115 /** Template function to convert any input type to std::string
117 inline std::string ConvToStr(const bool in)
119 return (in ? "1" : "0");
122 /** Template function to convert any input type to std::string
124 inline std::string ConvToStr(char in)
126 return std::string(in,1);
129 /** Template function to convert any input type to std::string
131 template <class T> inline std::string ConvToStr(const T &in)
133 std::stringstream tmp;
134 if (!(tmp << in)) return std::string();
138 /** Template function to convert any input type to any other type
139 * (usually an integer or numeric type)
141 template<typename T> inline long ConvToInt(const T &in)
143 std::stringstream tmp;
144 if (!(tmp << in)) return 0;
145 return atoi(tmp.str().c_str());
148 /** Template function to convert integer to char, storing result in *res and
149 * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages.
150 * @param T input value
151 * @param V result value
152 * @param R base to convert to
154 template<typename T, typename V, typename R> inline char* itoa(const T &in, V *res, R base)
156 if (base < 2 || base > 16) { *res = 0; return res; }
160 *out = "0123456789abcdef"[ std::abs( quotient % base ) ];
164 if ( in < 0 && base == 10) *out++ = '-';
165 std::reverse( res, out );
170 /** This class contains various STATS counters
171 * It is used by the InspIRCd class, which internally
172 * has an instance of it.
174 class serverstats : public classbase
177 /** Number of accepted connections
179 unsigned long statsAccept;
180 /** Number of failed accepts
182 unsigned long statsRefused;
183 /** Number of unknown commands seen
185 unsigned long statsUnknown;
186 /** Number of nickname collisions handled
188 unsigned long statsCollisions;
189 /** Number of DNS queries sent out
191 unsigned long statsDns;
192 /** Number of good DNS replies received
193 * NOTE: This may not tally to the number sent out,
194 * due to timeouts and other latency issues.
196 unsigned long statsDnsGood;
197 /** Number of bad (negative) DNS replies received
198 * NOTE: This may not tally to the number sent out,
199 * due to timeouts and other latency issues.
201 unsigned long statsDnsBad;
202 /** Number of inbound connections seen
204 unsigned long statsConnects;
205 /** Total bytes of data transmitted
208 /** Total bytes of data received
211 /** Cpu usage at last sample
214 /** Time last sample was read
217 /** The constructor initializes all the counts to zero
220 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
221 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0)
226 /** A list of failed port bindings, used for informational purposes on startup */
227 typedef std::vector<std::pair<std::string, long> > FailedPortList;
229 /** A list of ip addresses cross referenced against clone counts */
230 typedef std::map<irc::string, unsigned int> clonemap;
234 DEFINE_HANDLER1(ProcessUserHandler, void, User*);
235 DEFINE_HANDLER1(IsNickHandler, bool, const char*);
236 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
237 DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
238 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
240 /* Forward declaration - required */
243 /** The main class of the irc server.
244 * This class contains instances of all the other classes
245 * in this software, with the exception of the base class,
246 * classbase. Amongst other things, it contains a ModeParser,
247 * a DNS object, a CommandParser object, and a list of active
248 * Module objects, and facilities for Module objects to
249 * interact with the core system it implements. You should
250 * NEVER attempt to instantiate a class of type InspIRCd
251 * yourself. If you do, this is equivalent to spawning a second
252 * IRC server, and could have catastrophic consequences for the
253 * program in terms of ram usage (basically, you could create
254 * an obese forkbomb built from recursively spawning irc servers!)
256 class CoreExport InspIRCd : public classbase
259 /** Holds the current UID. Used to generate the next one.
261 char current_uid[UUID_LENGTH];
263 /** Set up the signal handlers
267 /** Daemonize the ircd and close standard input/output streams
268 * @return True if the program daemonized succesfully
272 /** Iterate the list of BufferedSocket objects, removing ones which have timed out
273 * @param TIME the current time
275 void DoSocketTimeouts(time_t TIME);
277 /** Sets up UID subsystem
279 void InitialiseUID();
281 /** Perform background user events such as PING checks
282 * @param TIME the current time
284 void DoBackgroundUserStuff(time_t TIME);
286 /** Returns true when all modules have done pre-registration checks on a user
287 * @param user The user to verify
288 * @return True if all modules have finished checking this user
290 bool AllModulesReportReady(User* user);
292 /** Logfile pathname specified on the commandline, or empty string
294 char LogFileName[MAXBUF];
296 /** The current time, updated in the mainloop
300 /** The time that was recorded last time around the mainloop
304 /** A 64k buffer used to read client lines into
306 char ReadBuffer[65535];
308 /** Used when connecting clients
310 insp_sockaddr client, server;
312 /** Used when connecting clients
316 /** Nonblocking file writer
320 /** Time offset in seconds
321 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
331 /** Global cull list, will be processed on next iteration
333 CullList GlobalCulls;
337 ProcessUserHandler HandleProcessUser;
338 IsNickHandler HandleIsNick;
339 IsIdentHandler HandleIsIdent;
340 FindDescriptorHandler HandleFindDescriptor;
341 FloodQuitUserHandler HandleFloodQuitUser;
343 /** BufferedSocket classes pending deletion after being closed.
344 * We don't delete these immediately as this may cause a segmentation fault.
346 std::map<BufferedSocket*,BufferedSocket*> SocketCull;
348 /** 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
351 * SendMode expects a User* to send the numeric replies
352 * back to, so we create it a fake user that isnt in the user
353 * hash and set its descriptor to FD_MAGIC_NUMBER so the data
354 * falls into the abyss :p
358 /** Returns the next available UID for this server.
360 std::string GetUID();
362 /** Find a user in the UUID hash
363 * @param nick The nickname to find
364 * @return A pointer to the user, or NULL if the user does not exist
366 User *FindUUID(const std::string &);
368 /** Find a user in the UUID hash
369 * @param nick The nickname to find
370 * @return A pointer to the user, or NULL if the user does not exist
372 User *FindUUID(const char *);
374 /** Build the ISUPPORT string by triggering all modules On005Numeric events
376 void BuildISupport();
378 /** Number of unregistered users online right now.
379 * (Unregistered means before USER/NICK/dns)
381 int unregistered_count;
383 /** List of server names we've seen.
385 servernamelist servernames;
387 /** Time this ircd was booted
391 /** Config file pathname specified on the commandline or via ./configure
393 char ConfigFileName[MAXBUF];
395 /** Mode handler, handles mode setting and removal
399 /** Command parser, handles client to server commands
401 CommandParser* Parser;
403 /** Socket engine, handles socket activity events
407 /** ModuleManager contains everything related to loading/unloading
410 ModuleManager* Modules;
412 /** Stats class, holds miscellaneous stats counters
416 /** Server Config class, holds configuration file data
418 ServerConfig* Config;
420 /** Snomask manager - handles routing of snomask messages
425 /** Client list, a hash_map containing all clients, local and remote
427 user_hash* clientlist;
429 /** Client list stored by UUID. Contains all clients, and is updated
430 * automatically by the constructor and destructor of User.
434 /** Channel list, a hash_map containing all channels
438 /** Local client list, a vector containing only local clients
440 std::vector<User*> local_users;
442 /** Oper list, a vector containing all local and remote opered users
444 std::list<User*> all_opers;
446 /** Map of local ip addresses for clone counting
448 clonemap local_clones;
450 /** Map of global ip addresses for clone counting
452 clonemap global_clones;
454 /** DNS class, provides resolver facilities to the core and modules
458 /** Timer manager class, triggers Timer timer events
460 TimerManager* Timers;
462 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
464 XLineManager* XLines;
466 /** The time we next call our ping timeout and reg timeout checks
470 /** Set to the current signal recieved
474 /** Get the current time
475 * Because this only calls time() once every time around the mainloop,
476 * it is much faster than calling time() directly.
477 * @param delta True to use the delta as an offset, false otherwise
478 * @return The current time as an epoch value (time_t)
480 time_t Time(bool delta = false);
482 /** Set the time offset in seconds
483 * This offset is added to Time() to offset the system time by the specified
485 * @param delta The number of seconds to offset
486 * @return The old time delta
488 int SetTimeDelta(int delta);
490 /** Add a user to the local clone map
491 * @param user The user to add
493 void AddLocalClone(User* user);
495 /** Add a user to the global clone map
496 * @param user The user to add
498 void AddGlobalClone(User* user);
500 /** Number of users with a certain mode set on them
502 int ModeCount(const char mode);
504 /** Get the time offset in seconds
505 * @return The current time delta (in seconds)
509 /** Process a user whos socket has been flagged as active
510 * @param cu The user to process
511 * @return There is no actual return value, however upon exit, the user 'cu' may have been
512 * marked for deletion in the global CullList.
514 caller1<void, User*> ProcessUser;
516 /** Bind all ports specified in the configuration file.
517 * @param bail True if the function should bail back to the shell on failure
518 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
519 * @return The number of ports actually bound without error
521 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
523 /** Binds a socket on an already open file descriptor
524 * @param sockfd A valid file descriptor of an open socket
525 * @param port The port number to bind to
526 * @param addr The address to bind to (IP only)
527 * @return True if the port was bound successfully
529 bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
531 /** Adds a server name to the list of servers we've seen
532 * @param The servername to add
534 void AddServerName(const std::string &servername);
536 /** Finds a cached char* pointer of a server name,
537 * This is used to optimize User by storing only the pointer to the name
538 * @param The servername to find
539 * @return A pointer to this name, gauranteed to never become invalid
541 const char* FindServerNamePtr(const std::string &servername);
543 /** Returns true if we've seen the given server name before
544 * @param The servername to find
545 * @return True if we've seen this server name before
547 bool FindServerName(const std::string &servername);
549 /** Gets the GECOS (description) field of the given server.
550 * If the servername is not that of the local server, the name
551 * is passed to handling modules which will attempt to determine
552 * the GECOS that bleongs to the given servername.
553 * @param servername The servername to find the description of
554 * @return The description of this server, or of the local server
556 std::string GetServerDescription(const char* servername);
558 /** Write text to all opers connected to this server
559 * @param text The text format string
560 * @param ... Format args
562 void WriteOpers(const char* text, ...);
564 /** Write text to all opers connected to this server
565 * @param text The text to send
567 void WriteOpers(const std::string &text);
569 /** Find a user in the nick hash.
570 * If the user cant be found in the nick hash check the uuid hash
571 * @param nick The nickname to find
572 * @return A pointer to the user, or NULL if the user does not exist
574 User* FindNick(const std::string &nick);
576 /** Find a user in the nick hash.
577 * If the user cant be found in the nick hash check the uuid hash
578 * @param nick The nickname to find
579 * @return A pointer to the user, or NULL if the user does not exist
581 User* FindNick(const char* nick);
583 /** Find a user in the nick hash ONLY
585 User* FindNickOnly(const char* nick);
587 /** Find a user in the nick hash ONLY
589 User* FindNickOnly(const std::string &nick);
591 /** Find a channel in the channels hash
592 * @param chan The channel to find
593 * @return A pointer to the channel, or NULL if the channel does not exist
595 Channel* FindChan(const std::string &chan);
597 /** Find a channel in the channels hash
598 * @param chan The channel to find
599 * @return A pointer to the channel, or NULL if the channel does not exist
601 Channel* FindChan(const char* chan);
603 /** Check for a 'die' tag in the config file, and abort if found
604 * @return Depending on the configuration, this function may never return
608 /** Check we aren't running as root, and exit if we are
609 * @return Depending on the configuration, this function may never return
613 /** Determine the right path for, and open, the logfile
614 * @param argv The argv passed to main() initially, used to calculate program path
615 * @param argc The argc passed to main() initially, used to calculate program path
616 * @return True if the log could be opened, false if otherwise
618 bool OpenLog(char** argv, int argc);
620 /** Close the currently open log file
624 /** Send a server notice to all local users
625 * @param text The text format string to send
626 * @param ... The format arguments
628 void ServerNoticeAll(char* text, ...);
630 /** Send a server message (PRIVMSG) to all local users
631 * @param text The text format string to send
632 * @param ... The format arguments
634 void ServerPrivmsgAll(char* text, ...);
636 /** Send text to all users with a specific set of modes
637 * @param modes The modes to check against, without a +, e.g. 'og'
638 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
639 * mode characters in the first parameter causes receipt of the message, and
640 * if you specify WM_OR, all the modes must be present.
641 * @param text The text format string to send
642 * @param ... The format arguments
644 void WriteMode(const char* modes, int flags, const char* text, ...);
646 /** Return true if a channel name is valid
647 * @param chname A channel name to verify
648 * @return True if the name is valid
650 bool IsChannel(const char *chname);
652 /** Rehash the local server
656 /** Handles incoming signals after being set
657 * @param signal the signal recieved
659 void SignalHandler(int signal);
661 /** Sets the signal recieved
662 * @param signal the signal recieved
664 static void SetSignal(int signal);
666 /** Causes the server to exit after unloading modules and
667 * closing all open file descriptors.
669 * @param The exit code to give to the operating system
670 * (See the ExitStatus enum for valid values)
672 void Exit(int status);
674 /** Causes the server to exit immediately with exit code 0.
675 * The status code is required for signal handlers, and ignored.
677 static void QuickExit(int status);
679 /** Return a count of users, unknown and known connections
680 * @return The number of users
684 /** Return a count of fully registered connections only
685 * @return The number of registered users
687 int RegisteredUserCount();
689 /** Return a count of invisible (umode +i) users only
690 * @return The number of invisible users
692 int InvisibleUserCount();
694 /** Return a count of opered (umode +o) users only
695 * @return The number of opers
699 /** Return a count of unregistered (before NICK/USER) users only
700 * @return The number of unregistered (unknown) connections
702 int UnregisteredUserCount();
704 /** Return a count of channels on the network
705 * @return The number of channels
709 /** Return a count of local users on this server only
710 * @return The number of local users
712 long LocalUserCount();
714 /** Send an error notice to all local users, opered and unopered
715 * @param s The error string to send
717 void SendError(const std::string &s);
719 /** Return true if a nickname is valid
720 * @param n A nickname to verify
721 * @return True if the nick is valid
723 caller1<bool, const char*> IsNick;
725 /** Return true if an ident is valid
726 * @param An ident to verify
727 * @return True if the ident is valid
729 caller1<bool, const char*> IsIdent;
731 /** Find a username by their file descriptor.
732 * It is preferred to use this over directly accessing the fd_ref_table array.
733 * @param socket The file descriptor of a user
734 * @return A pointer to the user if the user exists locally on this descriptor
736 caller1<User*, int> FindDescriptor;
738 /** Add a new mode to this server's mode parser
739 * @param mh The modehandler to add
740 * @param modechar The mode character this modehandler handles
741 * @return True if the mode handler was added
743 bool AddMode(ModeHandler* mh, const unsigned char modechar);
745 /** Add a new mode watcher to this server's mode parser
746 * @param mw The modewatcher to add
747 * @return True if the modewatcher was added
749 bool AddModeWatcher(ModeWatcher* mw);
751 /** Delete a mode watcher from this server's mode parser
752 * @param mw The modewatcher to delete
753 * @return True if the modewatcher was deleted
755 bool DelModeWatcher(ModeWatcher* mw);
757 /** Add a dns Resolver class to this server's active set
758 * @param r The resolver to add
759 * @param cached If this value is true, then the cache will
760 * be searched for the DNS result, immediately. If the value is
761 * false, then a request will be sent to the nameserver, and the
762 * result will not be immediately available. You should usually
763 * use the boolean value which you passed to the Resolver
764 * constructor, which Resolver will set appropriately depending
765 * on if cached results are available and haven't expired. It is
766 * however safe to force this value to false, forcing a remote DNS
767 * lookup, but not an update of the cache.
768 * @return True if the operation completed successfully. Note that
769 * if this method returns true, you should not attempt to access
770 * the resolver class you pass it after this call, as depending upon
771 * the request given, the object may be deleted!
773 bool AddResolver(Resolver* r, bool cached);
775 /** Add a command to this server's command parser
776 * @param f A Command command handler object to add
777 * @throw ModuleException Will throw ModuleExcption if the command already exists
779 void AddCommand(Command *f);
781 /** Send a modechange.
782 * The parameters provided are identical to that sent to the
783 * handler for class cmd_mode.
784 * @param parameters The mode parameters
785 * @param pcnt The number of items you have given in the first parameter
786 * @param user The user to send error messages to
788 void SendMode(const char **parameters, int pcnt, User *user);
790 /** Match two strings using pattern matching.
791 * This operates identically to the global function match(),
792 * except for that it takes std::string arguments rather than
794 * @param sliteral The literal string to match against
795 * @param spattern The pattern to match against. CIDR and globs are supported.
797 bool MatchText(const std::string &sliteral, const std::string &spattern);
799 /** Call the handler for a given command.
800 * @param commandname The command whos handler you wish to call
801 * @param parameters The mode parameters
802 * @param pcnt The number of items you have given in the first parameter
803 * @param user The user to execute the command as
804 * @return True if the command handler was called successfully
806 CmdResult CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, User* user);
808 /** Return true if the command is a module-implemented command and the given parameters are valid for it
809 * @param parameters The mode parameters
810 * @param pcnt The number of items you have given in the first parameter
811 * @param user The user to test-execute the command as
812 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
814 bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
816 /** Add a gline and apply it
817 * @param duration How long the line should last
818 * @param source Who set the line
819 * @param reason The reason for the line
820 * @param hostmask The hostmask to set the line against
822 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
824 /** Add a qline and apply it
825 * @param duration How long the line should last
826 * @param source Who set the line
827 * @param reason The reason for the line
828 * @param nickname The nickmask to set the line against
830 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
832 /** Add a zline and apply it
833 * @param duration How long the line should last
834 * @param source Who set the line
835 * @param reason The reason for the line
836 * @param ipaddr The ip-mask to set the line against
838 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
840 /** Add a kline and apply it
841 * @param duration How long the line should last
842 * @param source Who set the line
843 * @param reason The reason for the line
844 * @param hostmask The hostmask to set the line against
846 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
849 * @param duration How long the line should last
850 * @param source Who set the line
851 * @param reason The reason for the line
852 * @param hostmask The hostmask to set the line against
854 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
857 * @param hostmask The gline to delete
858 * @return True if the item was removed
860 bool DelGLine(const std::string &hostmask);
863 * @param nickname The qline to delete
864 * @return True if the item was removed
866 bool DelQLine(const std::string &nickname);
869 * @param ipaddr The zline to delete
870 * @return True if the item was removed
872 bool DelZLine(const std::string &ipaddr);
875 * @param hostmask The kline to delete
876 * @return True if the item was removed
878 bool DelKLine(const std::string &hostmask);
881 * @param hostmask The kline to delete
882 * @return True if the item was removed
884 bool DelELine(const std::string &hostmask);
886 /** Return true if the given parameter is a valid nick!user\@host mask
887 * @param mask A nick!user\@host masak to match against
888 * @return True i the mask is valid
890 bool IsValidMask(const std::string &mask);
892 /** Rehash the local server
896 /** Return the channel whos index number matches that provided
897 * @param The index number of the channel to fetch
898 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
900 Channel* GetChannelIndex(long index);
902 /** Dump text to a user target, splitting it appropriately to fit
903 * @param User the user to dump the text to
904 * @param LinePrefix text to prefix each complete line with
905 * @param TextStream the text to send to the user
907 void DumpText(User* User, const std::string &LinePrefix, stringstream &TextStream);
909 /** Check if the given nickmask matches too many users, send errors to the given user
910 * @param nick A nickmask to match against
911 * @param user A user to send error text to
912 * @return True if the nick matches too many users
914 bool NickMatchesEveryone(const std::string &nick, User* user);
916 /** Check if the given IP mask matches too many users, send errors to the given user
917 * @param ip An ipmask to match against
918 * @param user A user to send error text to
919 * @return True if the ip matches too many users
921 bool IPMatchesEveryone(const std::string &ip, User* user);
923 /** Check if the given hostmask matches too many users, send errors to the given user
924 * @param mask A hostmask to match against
925 * @param user A user to send error text to
926 * @return True if the host matches too many users
928 bool HostMatchesEveryone(const std::string &mask, User* user);
930 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
931 * @param str A string containing a time in the form 1y2w3d4h6m5s
932 * (one year, two weeks, three days, four hours, six minutes and five seconds)
933 * @return The total number of seconds
935 long Duration(const std::string &str);
937 /** Attempt to compare an oper password to a string from the config file.
938 * This will be passed to handling modules which will compare the data
939 * against possible hashed equivalents in the input string.
940 * @param data The data from the config file
941 * @param input The data input by the oper
942 * @param tagnum the tag number of the oper's tag in the config file
943 * @return 0 if the strings match, 1 or -1 if they do not
945 int OperPassCompare(const char* data,const char* input, int tagnum);
947 /** Check if a given server is a uline.
948 * An empty string returns true, this is by design.
949 * @param server The server to check for uline status
950 * @return True if the server is a uline OR the string is empty
952 bool ULine(const char* server);
954 /** Returns true if the uline is 'silent' (doesnt generate
955 * remote connect notices etc).
957 bool SilentULine(const char* server);
959 /** Returns the subversion revision ID of this ircd
960 * @return The revision ID or an empty string
962 std::string GetRevision();
964 /** Returns the full version string of this ircd
965 * @return The version string
967 std::string GetVersionString();
969 /** Attempt to write the process id to a given file
970 * @param filename The PID file to attempt to write to
971 * @return This function may bail if the file cannot be written
973 void WritePID(const std::string &filename);
975 /** This constructor initialises all the subsystems and reads the config file.
976 * @param argc The argument count passed to main()
977 * @param argv The argument list passed to main()
978 * @throw <anything> If anything is thrown from here and makes it to
979 * you, you should probably just give up and go home. Yes, really.
980 * It's that bad. Higher level classes should catch any non-fatal exceptions.
982 InspIRCd(int argc, char** argv);
984 /** Output a log message to the ircd.log file
985 * The text will only be output if the current loglevel
986 * is less than or equal to the level you provide
987 * @param level A log level from the DebugLevel enum
988 * @param text Format string of to write to the log
989 * @param ... Format arguments of text to write to the log
991 void Log(int level, const char* text, ...);
993 /** Output a log message to the ircd.log file
994 * The text will only be output if the current loglevel
995 * is less than or equal to the level you provide
996 * @param level A log level from the DebugLevel enum
997 * @param text Text to write to the log
999 void Log(int level, const std::string &text);
1001 /** Send a line of WHOIS data to a user.
1002 * @param user user to send the line to
1003 * @param dest user being WHOISed
1004 * @param numeric Numeric to send
1005 * @param text Text of the numeric
1007 void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
1009 /** Send a line of WHOIS data to a user.
1010 * @param user user to send the line to
1011 * @param dest user being WHOISed
1012 * @param numeric Numeric to send
1013 * @param format Format string for the numeric
1014 * @param ... Parameters for the format string
1016 void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...);
1018 /** Quit a user for excess flood, and if they are not
1019 * fully registered yet, temporarily zline their IP.
1020 * @param current user to quit
1022 caller1<void, User*> FloodQuitUser;
1024 /** Restart the server.
1025 * This function will not return. If an error occurs,
1026 * it will throw an instance of CoreException.
1027 * @param reason The restart reason to show to all clients
1028 * @throw CoreException An instance of CoreException indicating the error from execv().
1030 void Restart(const std::string &reason);
1032 /** Prepare the ircd for restart or shutdown.
1033 * This function unloads all modules which can be unloaded,
1034 * closes all open sockets, and closes the logfile.
1038 /** This copies the user and channel hash_maps into new hash maps.
1039 * This frees memory used by the hash_map allocator (which it neglects
1040 * to free, most of the time, using tons of ram)
1042 void RehashUsersAndChans();
1044 /** Resets the cached max bans value on all channels.
1047 void ResetMaxBans();
1049 /** Return a time_t as a human-readable string.
1051 std::string TimeString(time_t curtime);
1053 /** Begin execution of the server.
1054 * NOTE: this function NEVER returns. Internally,
1055 * it will repeatedly loop.
1056 * @return The return value for this function is undefined.
1060 /** Force all BufferedSockets to be removed which are due to
1063 void BufferedSocketCull();
1065 char* GetReadBuffer()
1067 return this->ReadBuffer;