1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #ifndef __INSPIRCD_H__
18 #define __INSPIRCD_H__
23 #include "inspircd_config.h"
28 #include "socketengine.h"
29 #include "command_parse.h"
32 /** Returned by some functions to indicate failure,
33 * and the exit code of the program if it terminates.
39 #define ETIREDGERBILS EAGAIN
41 /** Debug levels for use with InspIRCd::Log()
53 * This define is used in place of strcmp when we
54 * want to check if a char* string contains only one
55 * letter. Pretty fast, its just two compares and an
58 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
60 /** Delete a pointer, and NULL its value
62 template<typename T> inline void DELETE(T* x)
68 /** Template function to convert any input type to std::string
70 template<typename T> inline std::string ConvToStr(const T &in)
72 std::stringstream tmp;
73 if (!(tmp << in)) return std::string();
77 /** This class contains various STATS counters
78 * It is used by the InspIRCd class, which internally
79 * has an instance of it.
81 class serverstats : public classbase
84 /** Number of accepted connections
86 unsigned long statsAccept;
87 /** Number of failed accepts
89 unsigned long statsRefused;
90 /** Number of unknown commands seen
92 unsigned long statsUnknown;
93 /** Number of nickname collisions handled
95 unsigned long statsCollisions;
96 /** Number of DNS queries sent out
98 unsigned long statsDns;
99 /** Number of good DNS replies received
100 * NOTE: This may not tally to the number sent out,
101 * due to timeouts and other latency issues.
103 unsigned long statsDnsGood;
104 /** Number of bad (negative) DNS replies received
105 * NOTE: This may not tally to the number sent out,
106 * due to timeouts and other latency issues.
108 unsigned long statsDnsBad;
109 /** Number of inbound connections seen
111 unsigned long statsConnects;
112 /** Total bytes of data transmitted
115 /** Total bytes of data received
118 /** Number of bound listening ports
120 unsigned long BoundPortCount;
122 /** The constructor initializes all the counts to zero
125 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
126 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0),
134 /** This class implements a nonblocking log-writer.
135 * Most people writing an ircd give little thought to their disk
136 * i/o. On a congested system, disk writes can block for long
137 * periods of time (e.g. if the system is busy and/or swapping
138 * a lot). If we just use a blocking fprintf() call, this could
139 * block for undesirable amounts of time (half of a second through
140 * to whole seconds). We DO NOT want this, so we make our logfile
141 * nonblocking and hook it into the SocketEngine.
142 * NB: If the operating system does not support nonblocking file
143 * I/O (linux seems to, as does freebsd) this will default to
144 * blocking behaviour.
146 class FileLogger : public EventHandler
149 /** The creator/owner of this object
151 InspIRCd* ServerInstance;
152 /** The log file (fd is inside this somewhere,
153 * we get it out with fileno())
156 /** Buffer of pending log lines to be written
159 /** Number of write operations that have occured
163 /** The constructor takes an already opened logfile.
165 FileLogger(InspIRCd* Instance, FILE* logfile);
166 /** This returns false, logfiles are writeable.
168 virtual bool Readable();
169 /** Handle pending write events.
170 * This will flush any waiting data to disk.
171 * If any data remains after the fprintf call,
172 * another write event is scheduled to write
173 * the rest of the data when possible.
175 virtual void HandleEvent(EventType et, int errornum = 0);
176 /** Write one or more preformatted log lines.
177 * If the data cannot be written immediately,
178 * this class will insert itself into the
179 * SocketEngine, and register a write event,
180 * and when the write event occurs it will
181 * attempt again to write the data.
183 void WriteLogLine(const std::string &line);
184 /** Close the log file and cancel any events.
186 virtual void Close();
187 /** Close the log file and cancel any events.
188 * (indirectly call Close()
190 virtual ~FileLogger();
193 /** A list of failed port bindings, used for informational purposes on startup */
194 typedef std::vector<std::pair<std::string, long> > FailedPortList;
198 /** The main class of the irc server.
199 * This class contains instances of all the other classes
200 * in this software, with the exception of the base class,
201 * classbase. Amongst other things, it contains a ModeParser,
202 * a DNS object, a CommandParser object, and a list of active
203 * Module objects, and facilities for Module objects to
204 * interact with the core system it implements. You should
205 * NEVER attempt to instantiate a class of type InspIRCd
206 * yourself. If you do, this is equivalent to spawning a second
207 * IRC server, and could have catastrophic consequences for the
208 * program in terms of ram usage (basically, you could create
209 * an obese forkbomb built from recursively spawning irc servers!)
211 class InspIRCd : public classbase
214 /** Holds a string describing the last module error to occur
218 /** Remove a ModuleFactory pointer
219 * @param j Index number of the ModuleFactory to remove
221 void EraseFactory(int j);
223 /** Remove a Module pointer
224 * @param j Index number of the Module to remove
226 void EraseModule(int j);
228 /** Build the ISUPPORT string by triggering all modules On005Numeric events
230 void BuildISupport();
232 /** Move a given module to a specific slot in the list
233 * @param modulename The module name to relocate
234 * @param slot The slot to move the module into
236 void MoveTo(std::string modulename,int slot);
238 /** Display the startup banner
242 /** Set up the signal handlers
246 /** Daemonize the ircd and close standard input/output streams
247 * @return True if the program daemonized succesfully
251 /** Moves the given module to the last slot in the list
252 * @param modulename The module name to relocate
254 void MoveToLast(std::string modulename);
256 /** Moves the given module to the first slot in the list
257 * @param modulename The module name to relocate
259 void MoveToFirst(std::string modulename);
261 /** Moves one module to be placed after another in the list
262 * @param modulename The module name to relocate
263 * @param after The module name to place the module after
265 void MoveAfter(std::string modulename, std::string after);
267 /** Moves one module to be placed before another in the list
268 * @param modulename The module name to relocate
269 * @param after The module name to place the module before
271 void MoveBefore(std::string modulename, std::string before);
273 /** Iterate the list of InspSocket objects, removing ones which have timed out
274 * @param TIME the current time
276 void DoSocketTimeouts(time_t TIME);
278 /** Perform background user events such as PING checks
279 * @param TIME the current time
281 void DoBackgroundUserStuff(time_t TIME);
283 /** Returns true when all modules have done pre-registration checks on a user
284 * @param user The user to verify
285 * @return True if all modules have finished checking this user
287 bool AllModulesReportReady(userrec* user);
289 /** Total number of modules loaded into the ircd, minus one
293 /** Logfile pathname specified on the commandline, or empty string
295 char LogFileName[MAXBUF];
297 /** The feature names published by various modules
299 featurelist Features;
301 /** The current time, updated in the mainloop
305 /** The time that was recorded last time around the mainloop
309 /** A 64k buffer used to read client lines into
311 char ReadBuffer[65535];
313 /** Number of seconds in a minute
315 const long duration_m;
317 /** Number of seconds in an hour
319 const long duration_h;
321 /** Number of seconds in a day
323 const long duration_d;
325 /** Number of seconds in a week
327 const long duration_w;
329 /** Number of seconds in a year
331 const long duration_y;
333 /** Used when connecting clients
335 insp_sockaddr client, server;
337 /** Used when connecting clients
341 /** Nonblocking file writer
345 /** Time offset in seconds
346 * This offset is added to all calls to Time(). Use SetTimeDelta() to update
351 /** List of server names we've seen.
353 servernamelist servernames;
355 /** Time this ircd was booted
359 /** Mode handler, handles mode setting and removal
363 /** Command parser, handles client to server commands
365 CommandParser* Parser;
367 /** Socket engine, handles socket activity events
371 /** Stats class, holds miscellaneous stats counters
375 /** Server Config class, holds configuration file data
377 ServerConfig* Config;
379 /** Snomask manager - handles routing of snomask messages
384 /** Client list, a hash_map containing all clients, local and remote
386 user_hash clientlist;
388 /** Channel list, a hash_map containing all channels
392 /** Local client list, a vector containing only local clients
394 std::vector<userrec*> local_users;
396 /** Oper list, a vector containing all local and remote opered users
398 std::vector<userrec*> all_opers;
400 /** Whowas container, contains a map of vectors of users tracked by WHOWAS
402 irc::whowas::whowas_users whowas;
404 /** Whowas container, contains a map of time_t to users tracked by WHOWAS
406 irc::whowas::whowas_users_fifo whowas_fifo;
408 /** DNS class, provides resolver facilities to the core and modules
412 /** Timer manager class, triggers InspTimer timer events
414 TimerManager* Timers;
416 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
418 XLineManager* XLines;
420 /** A list of Module* module classes
421 * Note that this list is always exactly 255 in size.
422 * The actual number of loaded modules is available from GetModuleCount()
426 /** A list of ModuleFactory* module factories
427 * Note that this list is always exactly 255 in size.
428 * The actual number of loaded modules is available from GetModuleCount()
432 /** The time we next call our ping timeout and reg timeout checks
436 /** Get the current time
437 * Because this only calls time() once every time around the mainloop,
438 * it is much faster than calling time() directly.
439 * @param delta True to use the delta as an offset, false otherwise
440 * @return The current time as an epoch value (time_t)
442 time_t Time(bool delta = false);
444 /** Set the time offset in seconds
445 * This offset is added to Time() to offset the system time by the specified
447 * @param delta The number of seconds to offset
448 * @return The old time delta
450 int SetTimeDelta(int delta);
452 /** Process a user whos socket has been flagged as active
453 * @param cu The user to process
454 * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
456 void ProcessUser(userrec* cu);
458 /** Get the total number of currently loaded modules
459 * @return The number of loaded modules
461 int GetModuleCount();
463 /** Find a module by name, and return a Module* to it.
464 * This is preferred over iterating the module lists yourself.
465 * @param name The module name to look up
466 * @return A pointer to the module, or NULL if the module cannot be found
468 Module* FindModule(const std::string &name);
470 /** Bind all ports specified in the configuration file.
471 * @param bail True if the function should bail back to the shell on failure
472 * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
473 * @return The number of ports actually bound without error
475 int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
477 /** Returns true if this server has the given port bound to the given address
478 * @param port The port number
479 * @param addr The address
480 * @return True if we have a port listening on this address
482 bool HasPort(int port, char* addr);
484 /** Binds a socket on an already open file descriptor
485 * @param sockfd A valid file descriptor of an open socket
486 * @param client A sockaddr to use as temporary storage
487 * @param server A sockaddr to use as temporary storage
488 * @param port The port number to bind to
489 * @param addr The address to bind to (IP only)
490 * @return True if the port was bound successfully
492 bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr);
494 /** Adds a server name to the list of servers we've seen
495 * @param The servername to add
497 void AddServerName(const std::string &servername);
499 /** Finds a cached char* pointer of a server name,
500 * This is used to optimize userrec by storing only the pointer to the name
501 * @param The servername to find
502 * @return A pointer to this name, gauranteed to never become invalid
504 const char* FindServerNamePtr(const std::string &servername);
506 /** Returns true if we've seen the given server name before
507 * @param The servername to find
508 * @return True if we've seen this server name before
510 bool FindServerName(const std::string &servername);
512 /** Gets the GECOS (description) field of the given server.
513 * If the servername is not that of the local server, the name
514 * is passed to handling modules which will attempt to determine
515 * the GECOS that bleongs to the given servername.
516 * @param servername The servername to find the description of
517 * @return The description of this server, or of the local server
519 std::string GetServerDescription(const char* servername);
521 /** Write text to all opers connected to this server
522 * @param text The text format string
523 * @param ... Format args
525 void WriteOpers(const char* text, ...);
527 /** Write text to all opers connected to this server
528 * @param text The text to send
530 void WriteOpers(const std::string &text);
532 /** Find a nickname in the nick hash
533 * @param nick The nickname to find
534 * @return A pointer to the user, or NULL if the user does not exist
536 userrec* FindNick(const std::string &nick);
538 /** Find a nickname in the nick hash
539 * @param nick The nickname to find
540 * @return A pointer to the user, or NULL if the user does not exist
542 userrec* FindNick(const char* nick);
544 /** Find a channel in the channels hash
545 * @param chan The channel to find
546 * @return A pointer to the channel, or NULL if the channel does not exist
548 chanrec* FindChan(const std::string &chan);
550 /** Find a channel in the channels hash
551 * @param chan The channel to find
552 * @return A pointer to the channel, or NULL if the channel does not exist
554 chanrec* FindChan(const char* chan);
556 /** Called by the constructor to load all modules from the config file.
558 void LoadAllModules();
560 /** Check for a 'die' tag in the config file, and abort if found
561 * @return Depending on the configuration, this function may never return
565 /** Check we aren't running as root, and exit if we are
566 * @return Depending on the configuration, this function may never return
570 /** Determine the right path for, and open, the logfile
571 * @param argv The argv passed to main() initially, used to calculate program path
572 * @param argc The argc passed to main() initially, used to calculate program path
574 void OpenLog(char** argv, int argc);
576 /** Convert a user to a pseudoclient, disconnecting the real user
577 * @param user The user to convert
578 * @param message The quit message to display when exiting the user
579 * @return True if the operation succeeded
581 bool UserToPseudo(userrec* user, const std::string &message);
583 /** Convert a pseudoclient to a real user, discarding the pseudoclient
584 * @param alive A live client
585 * @param zombie A pseudoclient
586 * @param message The message to display when quitting the pseudoclient
587 * @return True if the operation succeeded
589 bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
591 /** Send a server notice to all local users
592 * @param text The text format string to send
593 * @param ... The format arguments
595 void ServerNoticeAll(char* text, ...);
597 /** Send a server message (PRIVMSG) to all local users
598 * @param text The text format string to send
599 * @param ... The format arguments
601 void ServerPrivmsgAll(char* text, ...);
603 /** Send text to all users with a specific set of modes
604 * @param modes The modes to check against, without a +, e.g. 'og'
605 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
606 * mode characters in the first parameter causes receipt of the message, and
607 * if you specify WM_OR, all the modes must be present.
608 * @param text The text format string to send
609 * @param ... The format arguments
611 void WriteMode(const char* modes, int flags, const char* text, ...);
613 /** Return true if a channel name is valid
614 * @param chname A channel name to verify
615 * @return True if the name is valid
617 bool IsChannel(const char *chname);
619 /** Rehash the local server
620 * @param status This value is unused, and required for signal handler functions
622 static void Rehash(int status);
624 /** Causes the server to exit immediately
625 * @param The exit code to give to the operating system
627 static void Exit(int status);
629 /** Return a count of users, unknown and known connections
630 * @return The number of users
634 /** Return a count of fully registered connections only
635 * @return The number of registered users
637 int RegisteredUserCount();
639 /** Return a count of invisible (umode +i) users only
640 * @return The number of invisible users
642 int InvisibleUserCount();
644 /** Return a count of opered (umode +o) users only
645 * @return The number of opers
649 /** Return a count of unregistered (before NICK/USER) users only
650 * @return The number of unregistered (unknown) connections
652 int UnregisteredUserCount();
654 /** Return a count of channels on the network
655 * @return The number of channels
659 /** Return a count of local users on this server only
660 * @return The number of local users
662 long LocalUserCount();
664 /** Send an error notice to all local users, opered and unopered
665 * @param s The error string to send
667 void SendError(const char *s);
669 /** For use with Module::Prioritize().
670 * When the return value of this function is returned from
671 * Module::Prioritize(), this specifies that the module wishes
672 * to be ordered exactly BEFORE 'modulename'. For more information
673 * please see Module::Prioritize().
674 * @param modulename The module your module wants to be before in the call list
675 * @returns a priority ID which the core uses to relocate the module in the list
677 long PriorityBefore(const std::string &modulename);
679 /** For use with Module::Prioritize().
680 * When the return value of this function is returned from
681 * Module::Prioritize(), this specifies that the module wishes
682 * to be ordered exactly AFTER 'modulename'. For more information please
683 * see Module::Prioritize().
684 * @param modulename The module your module wants to be after in the call list
685 * @returns a priority ID which the core uses to relocate the module in the list
687 long PriorityAfter(const std::string &modulename);
689 /** Publish a 'feature'.
690 * There are two ways for a module to find another module it depends on.
691 * Either by name, using InspIRCd::FindModule, or by feature, using this
692 * function. A feature is an arbitary string which identifies something this
693 * module can do. For example, if your module provides SSL support, but other
694 * modules provide SSL support too, all the modules supporting SSL should
695 * publish an identical 'SSL' feature. This way, any module requiring use
696 * of SSL functions can just look up the 'SSL' feature using FindFeature,
697 * then use the module pointer they are given.
698 * @param FeatureName The case sensitive feature name to make available
699 * @param Mod a pointer to your module class
700 * @returns True on success, false if the feature is already published by
703 bool PublishFeature(const std::string &FeatureName, Module* Mod);
705 /** Unpublish a 'feature'.
706 * When your module exits, it must call this method for every feature it
707 * is providing so that the feature table is cleaned up.
708 * @param FeatureName the feature to remove
710 bool UnpublishFeature(const std::string &FeatureName);
712 /** Find a 'feature'.
713 * There are two ways for a module to find another module it depends on.
714 * Either by name, using InspIRCd::FindModule, or by feature, using the
715 * InspIRCd::PublishFeature method. A feature is an arbitary string which
716 * identifies something this module can do. For example, if your module
717 * provides SSL support, but other modules provide SSL support too, all
718 * the modules supporting SSL should publish an identical 'SSL' feature.
719 * To find a module capable of providing the feature you want, simply
720 * call this method with the feature name you are looking for.
721 * @param FeatureName The feature name you wish to obtain the module for
722 * @returns A pointer to a valid module class on success, NULL on failure.
724 Module* FindFeature(const std::string &FeatureName);
726 /** Given a pointer to a Module, return its filename
727 * @param m The module pointer to identify
728 * @return The module name or an empty string
730 const std::string& GetModuleName(Module* m);
732 /** Return true if a nickname is valid
733 * @param n A nickname to verify
734 * @return True if the nick is valid
736 bool IsNick(const char* n);
738 /** Return true if an ident is valid
739 * @param An ident to verify
740 * @return True if the ident is valid
742 bool IsIdent(const char* n);
744 /** Find a username by their file descriptor.
745 * It is preferred to use this over directly accessing the fd_ref_table array.
746 * @param socket The file descriptor of a user
747 * @return A pointer to the user if the user exists locally on this descriptor
749 userrec* FindDescriptor(int socket);
751 /** Add a new mode to this server's mode parser
752 * @param mh The modehandler to add
753 * @param modechar The mode character this modehandler handles
754 * @return True if the mode handler was added
756 bool AddMode(ModeHandler* mh, const unsigned char modechar);
758 /** Add a new mode watcher to this server's mode parser
759 * @param mw The modewatcher to add
760 * @return True if the modewatcher was added
762 bool AddModeWatcher(ModeWatcher* mw);
764 /** Delete a mode watcher from this server's mode parser
765 * @param mw The modewatcher to delete
766 * @return True if the modewatcher was deleted
768 bool DelModeWatcher(ModeWatcher* mw);
770 /** Add a dns Resolver class to this server's active set
771 * @param r The resolver to add
772 * @return True if the resolver was added
774 bool AddResolver(Resolver* r);
776 /** Add a command to this server's command parser
777 * @param f A command_t command handler object to add
778 * @throw ModuleException Will throw ModuleExcption if the command already exists
780 void AddCommand(command_t *f);
782 /** Send a modechange.
783 * The parameters provided are identical to that sent to the
784 * handler for class cmd_mode.
785 * @param parameters The mode parameters
786 * @param pcnt The number of items you have given in the first parameter
787 * @param user The user to send error messages to
789 void SendMode(const char **parameters, int pcnt, userrec *user);
791 /** Match two strings using pattern matching.
792 * This operates identically to the global function match(),
793 * except for that it takes std::string arguments rather than
795 * @param sliteral The literal string to match against
796 * @param spattern The pattern to match against. CIDR and globs are supported.
798 bool MatchText(const std::string &sliteral, const std::string &spattern);
800 /** Call the handler for a given command.
801 * @param commandname The command whos handler you wish to call
802 * @param parameters The mode parameters
803 * @param pcnt The number of items you have given in the first parameter
804 * @param user The user to execute the command as
805 * @return True if the command handler was called successfully
807 bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
809 /** Return true if the command is a module-implemented command and the given parameters are valid for it
810 * @param parameters The mode parameters
811 * @param pcnt The number of items you have given in the first parameter
812 * @param user The user to test-execute the command as
813 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
815 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
817 /** Add a gline and apply it
818 * @param duration How long the line should last
819 * @param source Who set the line
820 * @param reason The reason for the line
821 * @param hostmask The hostmask to set the line against
823 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
825 /** Add a qline and apply it
826 * @param duration How long the line should last
827 * @param source Who set the line
828 * @param reason The reason for the line
829 * @param nickname The nickmask to set the line against
831 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
833 /** Add a zline and apply it
834 * @param duration How long the line should last
835 * @param source Who set the line
836 * @param reason The reason for the line
837 * @param ipaddr The ip-mask to set the line against
839 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
841 /** Add a kline and apply it
842 * @param duration How long the line should last
843 * @param source Who set the line
844 * @param reason The reason for the line
845 * @param hostmask The hostmask to set the line against
847 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
850 * @param duration How long the line should last
851 * @param source Who set the line
852 * @param reason The reason for the line
853 * @param hostmask The hostmask to set the line against
855 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
858 * @param hostmask The gline to delete
859 * @return True if the item was removed
861 bool DelGLine(const std::string &hostmask);
864 * @param nickname The qline to delete
865 * @return True if the item was removed
867 bool DelQLine(const std::string &nickname);
870 * @param ipaddr The zline to delete
871 * @return True if the item was removed
873 bool DelZLine(const std::string &ipaddr);
876 * @param hostmask The kline to delete
877 * @return True if the item was removed
879 bool DelKLine(const std::string &hostmask);
882 * @param hostmask The kline to delete
883 * @return True if the item was removed
885 bool DelELine(const std::string &hostmask);
887 /** Return true if the given parameter is a valid nick!user\@host mask
888 * @param mask A nick!user\@host masak to match against
889 * @return True i the mask is valid
891 bool IsValidMask(const std::string &mask);
893 /** Rehash the local server
897 /** Return the channel whos index number matches that provided
898 * @param The index number of the channel to fetch
899 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
901 chanrec* GetChannelIndex(long index);
903 /** Dump text to a user target, splitting it appropriately to fit
904 * @param User the user to dump the text to
905 * @param LinePrefix text to prefix each complete line with
906 * @param TextStream the text to send to the user
908 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
910 /** Check if the given nickmask matches too many users, send errors to the given user
911 * @param nick A nickmask to match against
912 * @param user A user to send error text to
913 * @return True if the nick matches too many users
915 bool NickMatchesEveryone(const std::string &nick, userrec* user);
917 /** Check if the given IP mask matches too many users, send errors to the given user
918 * @param ip An ipmask to match against
919 * @param user A user to send error text to
920 * @return True if the ip matches too many users
922 bool IPMatchesEveryone(const std::string &ip, userrec* user);
924 /** Check if the given hostmask matches too many users, send errors to the given user
925 * @param mask A hostmask to match against
926 * @param user A user to send error text to
927 * @return True if the host matches too many users
929 bool HostMatchesEveryone(const std::string &mask, userrec* user);
931 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
932 * @param str A string containing a time in the form 1y2w3d4h6m5s
933 * (one year, two weeks, three days, four hours, six minutes and five seconds)
934 * @return The total number of seconds
936 long Duration(const char* str);
938 /** Attempt to compare an oper password to a string from the config file.
939 * This will be passed to handling modules which will compare the data
940 * against possible hashed equivalents in the input string.
941 * @param data The data from the config file
942 * @param input The data input by the oper
943 * @return 0 if the strings match, 1 or -1 if they do not
945 int OperPassCompare(const char* data,const char* input);
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 the subversion revision ID of this ircd
955 * @return The revision ID or an empty string
957 std::string GetRevision();
959 /** Returns the full version string of this ircd
960 * @return The version string
962 std::string GetVersionString();
964 /** Attempt to write the process id to a given file
965 * @param filename The PID file to attempt to write to
966 * @return This function may bail if the file cannot be written
968 void WritePID(const std::string &filename);
970 /** Returns text describing the last module error
971 * @return The last error message to occur
975 /** Load a given module file
976 * @param filename The file to load
977 * @return True if the module was found and loaded
979 bool LoadModule(const char* filename);
981 /** Unload a given module file
982 * @param filename The file to unload
983 * @return True if the module was unloaded
985 bool UnloadModule(const char* filename);
987 /** This constructor initialises all the subsystems and reads the config file.
988 * @param argc The argument count passed to main()
989 * @param argv The argument list passed to main()
990 * @throw <anything> If anything is thrown from here and makes it to
991 * you, you should probably just give up and go home. Yes, really.
992 * It's that bad. Higher level classes should catch any non-fatal exceptions.
994 InspIRCd(int argc, char** argv);
996 /** Do one iteration of the mainloop
997 * @param process_module_sockets True if module sockets are to be processed
998 * this time around the event loop. The is the default.
1000 void DoOneIteration(bool process_module_sockets = true);
1002 /** Output a log message to the ircd.log file
1003 * The text will only be output if the current loglevel
1004 * is less than or equal to the level you provide
1005 * @param level A log level from the DebugLevel enum
1006 * @param text Format string of to write to the log
1007 * @param ... Format arguments of text to write to the log
1009 void Log(int level, const char* text, ...);
1011 /** Output a log message to the ircd.log file
1012 * The text will only be output if the current loglevel
1013 * is less than or equal to the level you provide
1014 * @param level A log level from the DebugLevel enum
1015 * @param text Text to write to the log
1017 void Log(int level, const std::string &text);
1019 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const std::string &text);
1021 void SendWhoisLine(userrec* user, userrec* dest, int numeric, const char* format, ...);
1023 /** Begin execution of the server.
1024 * NOTE: this function NEVER returns. Internally,
1025 * after performing some initialisation routines,
1026 * it will repeatedly call DoOneIteration in a loop.
1027 * @return The return value for this function is undefined.