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"
29 #include "socketengine.h"
30 #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);
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();
195 /** The main class of the irc server.
196 * This class contains instances of all the other classes
197 * in this software, with the exception of the base class,
198 * classbase. Amongst other things, it contains a ModeParser,
199 * a DNS object, a CommandParser object, and a list of active
200 * Module objects, and facilities for Module objects to
201 * interact with the core system it implements. You should
202 * NEVER attempt to instantiate a class of type InspIRCd
203 * yourself. If you do, this is equivalent to spawning a second
204 * IRC server, and could have catastrophic consequences for the
205 * program in terms of ram usage (basically, you could create
206 * an obese forkbomb built from recursively spawning irc servers!)
208 class InspIRCd : public classbase
211 /** Holds a string describing the last module error to occur
215 /** This is an internal flag used by the mainloop
219 /** List of server names we've seen.
221 servernamelist servernames;
223 /** Remove a ModuleFactory pointer
224 * @param j Index number of the ModuleFactory to remove
226 void EraseFactory(int j);
228 /** Remove a Module pointer
229 * @param j Index number of the Module to remove
231 void EraseModule(int j);
233 /** Build the ISUPPORT string by triggering all modules On005Numeric events
235 void BuildISupport();
237 /** Move a given module to a specific slot in the list
238 * @param modulename The module name to relocate
239 * @param slot The slot to move the module into
241 void MoveTo(std::string modulename,int slot);
243 /** Display the startup banner
247 /** Set up the signal handlers
248 * @param SEGVHandler create a handler for segfaults (deprecated)
250 void SetSignals(bool SEGVHandler);
252 /** Daemonize the ircd and close standard input/output streams
253 * @return True if the program daemonized succesfully
257 /** Moves the given module to the last slot in the list
258 * @param modulename The module name to relocate
260 void MoveToLast(std::string modulename);
262 /** Moves the given module to the first slot in the list
263 * @param modulename The module name to relocate
265 void MoveToFirst(std::string modulename);
267 /** Moves one module to be placed after another in the list
268 * @param modulename The module name to relocate
269 * @param after The module name to place the module after
271 void MoveAfter(std::string modulename, std::string after);
273 /** Moves one module to be placed before another in the list
274 * @param modulename The module name to relocate
275 * @param after The module name to place the module before
277 void MoveBefore(std::string modulename, std::string before);
279 /** Iterate the list of InspSocket objects, removing ones which have timed out
280 * @param TIME the current time
282 void DoSocketTimeouts(time_t TIME);
284 /** Perform background user events such as PING checks
285 * @param TIME the current time
287 void DoBackgroundUserStuff(time_t TIME);
289 /** Returns true when all modules have done pre-registration checks on a user
290 * @param user The user to verify
291 * @return True if all modules have finished checking this user
293 bool AllModulesReportReady(userrec* user);
295 /** Total number of modules loaded into the ircd, minus one
299 /** Logfile pathname specified on the commandline, or empty string
301 char LogFileName[MAXBUF];
303 /** The feature names published by various modules
305 featurelist Features;
307 /** The current time, updated in the mainloop
311 /** The time that was recorded last time around the mainloop
315 /** A 64k buffer used to read client lines into
317 char ReadBuffer[65535];
319 /** Number of seconds in a minute
321 const long duration_m;
323 /** Number of seconds in an hour
325 const long duration_h;
327 /** Number of seconds in a day
329 const long duration_d;
331 /** Number of seconds in a week
333 const long duration_w;
335 /** Number of seconds in a year
337 const long duration_y;
339 /** Used when connecting clients
341 insp_sockaddr client, server;
343 /** Used when connecting clients
347 /** Nonblocking file writer
352 /** Time this ircd was booted
356 /** Mode handler, handles mode setting and removal
360 /** Command parser, handles client to server commands
362 CommandParser* Parser;
364 /** Socket engine, handles socket activity events
368 /** Stats class, holds miscellaneous stats counters
372 /** Server Config class, holds configuration file data
374 ServerConfig* Config;
376 /** Client list, a hash_map containing all clients, local and remote
378 user_hash clientlist;
380 /** Channel list, a hash_map containing all channels
384 /** Local client list, a vector containing only local clients
386 std::vector<userrec*> local_users;
388 /** Oper list, a vector containing all local and remote opered users
390 std::vector<userrec*> all_opers;
392 /** Whowas container, contains a map of vectors of users tracked by WHOWAS
394 irc::whowas::whowas_users whowas;
396 /** DNS class, provides resolver facilities to the core and modules
400 /** Timer manager class, triggers InspTimer timer events
402 TimerManager* Timers;
404 /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
406 XLineManager* XLines;
408 /** A list of Module* module classes
409 * Note that this list is always exactly 255 in size.
410 * The actual number of loaded modules is available from GetModuleCount()
414 /** A list of ModuleFactory* module factories
415 * Note that this list is always exactly 255 in size.
416 * The actual number of loaded modules is available from GetModuleCount()
420 /** Get the current time
421 * Because this only calls time() once every time around the mainloop,
422 * it is much faster than calling time() directly.
423 * @return The current time as an epoch value (time_t)
427 /** Process a user whos socket has been flagged as active
428 * @param cu The user to process
429 * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
431 void ProcessUser(userrec* cu);
433 /** Get the total number of currently loaded modules
434 * @return The number of loaded modules
436 int GetModuleCount();
438 /** Find a module by name, and return a Module* to it.
439 * This is preferred over iterating the module lists yourself.
440 * @param name The module name to look up
441 * @return A pointer to the module, or NULL if the module cannot be found
443 Module* FindModule(const std::string &name);
445 /** Bind all ports specified in the configuration file.
446 * @param bail True if the function should bail back to the shell on failure
447 * @return The number of ports actually bound without error
449 int BindPorts(bool bail);
451 /** Returns true if this server has the given port bound to the given address
452 * @param port The port number
453 * @param addr The address
454 * @return True if we have a port listening on this address
456 bool HasPort(int port, char* addr);
458 /** Binds a socket on an already open file descriptor
459 * @param sockfd A valid file descriptor of an open socket
460 * @param client A sockaddr to use as temporary storage
461 * @param server A sockaddr to use as temporary storage
462 * @param port The port number to bind to
463 * @param addr The address to bind to (IP only)
464 * @return True if the port was bound successfully
466 bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr);
468 /** Adds a server name to the list of servers we've seen
469 * @param The servername to add
471 void AddServerName(const std::string &servername);
473 /** Finds a cached char* pointer of a server name,
474 * This is used to optimize userrec by storing only the pointer to the name
475 * @param The servername to find
476 * @return A pointer to this name, gauranteed to never become invalid
478 const char* FindServerNamePtr(const std::string &servername);
480 /** Returns true if we've seen the given server name before
481 * @param The servername to find
482 * @return True if we've seen this server name before
484 bool FindServerName(const std::string &servername);
486 /** Gets the GECOS (description) field of the given server.
487 * If the servername is not that of the local server, the name
488 * is passed to handling modules which will attempt to determine
489 * the GECOS that bleongs to the given servername.
490 * @param servername The servername to find the description of
491 * @return The description of this server, or of the local server
493 std::string GetServerDescription(const char* servername);
495 /** Write text to all opers connected to this server
496 * @param text The text format string
497 * @param ... Format args
499 void WriteOpers(const char* text, ...);
501 /** Write text to all opers connected to this server
502 * @param text The text to send
504 void WriteOpers(const std::string &text);
506 /** Find a nickname in the nick hash
507 * @param nick The nickname to find
508 * @return A pointer to the user, or NULL if the user does not exist
510 userrec* FindNick(const std::string &nick);
512 /** Find a nickname in the nick hash
513 * @param nick The nickname to find
514 * @return A pointer to the user, or NULL if the user does not exist
516 userrec* FindNick(const char* nick);
518 /** Find a channel in the channels hash
519 * @param chan The channel to find
520 * @return A pointer to the channel, or NULL if the channel does not exist
522 chanrec* FindChan(const std::string &chan);
524 /** Find a channel in the channels hash
525 * @param chan The channel to find
526 * @return A pointer to the channel, or NULL if the channel does not exist
528 chanrec* FindChan(const char* chan);
530 /** Called by the constructor to load all modules from the config file.
532 void LoadAllModules();
534 /** Check for a 'die' tag in the config file, and abort if found
535 * @return Depending on the configuration, this function may never return
539 /** Check we aren't running as root, and exit if we are
540 * @return Depending on the configuration, this function may never return
544 /** Determine the right path for, and open, the logfile
545 * @param argv The argv passed to main() initially, used to calculate program path
546 * @param argc The argc passed to main() initially, used to calculate program path
548 void OpenLog(char** argv, int argc);
550 /** Convert a user to a pseudoclient, disconnecting the real user
551 * @param user The user to convert
552 * @param message The quit message to display when exiting the user
553 * @return True if the operation succeeded
555 bool UserToPseudo(userrec* user, const std::string &message);
557 /** Convert a pseudoclient to a real user, discarding the pseudoclient
558 * @param alive A live client
559 * @param zombie A pseudoclient
560 * @param message The message to display when quitting the pseudoclient
561 * @return True if the operation succeeded
563 bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
565 /** Send a server notice to all local users
566 * @param text The text format string to send
567 * @param ... The format arguments
569 void ServerNoticeAll(char* text, ...);
571 /** Send a server message (PRIVMSG) to all local users
572 * @param text The text format string to send
573 * @param ... The format arguments
575 void ServerPrivmsgAll(char* text, ...);
577 /** Send text to all users with a specific set of modes
578 * @param modes The modes to check against, without a +, e.g. 'og'
579 * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
580 * mode characters in the first parameter causes receipt of the message, and
581 * if you specify WM_OR, all the modes must be present.
582 * @param text The text format string to send
583 * @param ... The format arguments
585 void WriteMode(const char* modes, int flags, const char* text, ...);
587 /** Return true if a channel name is valid
588 * @param chname A channel name to verify
589 * @return True if the name is valid
591 bool IsChannel(const char *chname);
593 /** Rehash the local server
594 * @param status This value is unused, and required for signal handler functions
596 static void Rehash(int status);
598 /** Causes the server to exit immediately
599 * @param The exit code to give to the operating system
601 static void Exit(int status);
603 /** Return a count of users, unknown and known connections
604 * @return The number of users
608 /** Return a count of fully registered connections only
609 * @return The number of registered users
611 int RegisteredUserCount();
613 /** Return a count of invisible (umode +i) users only
614 * @return The number of invisible users
616 int InvisibleUserCount();
618 /** Return a count of opered (umode +o) users only
619 * @return The number of opers
623 /** Return a count of unregistered (before NICK/USER) users only
624 * @return The number of unregistered (unknown) connections
626 int UnregisteredUserCount();
628 /** Return a count of channels on the network
629 * @return The number of channels
633 /** Return a count of local users on this server only
634 * @return The number of local users
636 long LocalUserCount();
638 /** Send an error notice to all local users, opered and unopered
639 * @param s The error string to send
641 void SendError(const char *s);
643 /** For use with Module::Prioritize().
644 * When the return value of this function is returned from
645 * Module::Prioritize(), this specifies that the module wishes
646 * to be ordered exactly BEFORE 'modulename'. For more information
647 * please see Module::Prioritize().
648 * @param modulename The module your module wants to be before in the call list
649 * @returns a priority ID which the core uses to relocate the module in the list
651 long PriorityBefore(const std::string &modulename);
653 /** For use with Module::Prioritize().
654 * When the return value of this function is returned from
655 * Module::Prioritize(), this specifies that the module wishes
656 * to be ordered exactly AFTER 'modulename'. For more information please
657 * see Module::Prioritize().
658 * @param modulename The module your module wants to be after in the call list
659 * @returns a priority ID which the core uses to relocate the module in the list
661 long PriorityAfter(const std::string &modulename);
663 /** Publish a 'feature'.
664 * There are two ways for a module to find another module it depends on.
665 * Either by name, using InspIRCd::FindModule, or by feature, using this
666 * function. A feature is an arbitary string which identifies something this
667 * module can do. For example, if your module provides SSL support, but other
668 * modules provide SSL support too, all the modules supporting SSL should
669 * publish an identical 'SSL' feature. This way, any module requiring use
670 * of SSL functions can just look up the 'SSL' feature using FindFeature,
671 * then use the module pointer they are given.
672 * @param FeatureName The case sensitive feature name to make available
673 * @param Mod a pointer to your module class
674 * @returns True on success, false if the feature is already published by
677 bool PublishFeature(const std::string &FeatureName, Module* Mod);
679 /** Unpublish a 'feature'.
680 * When your module exits, it must call this method for every feature it
681 * is providing so that the feature table is cleaned up.
682 * @param FeatureName the feature to remove
684 bool UnpublishFeature(const std::string &FeatureName);
686 /** Find a 'feature'.
687 * There are two ways for a module to find another module it depends on.
688 * Either by name, using InspIRCd::FindModule, or by feature, using the
689 * InspIRCd::PublishFeature method. A feature is an arbitary string which
690 * identifies something this module can do. For example, if your module
691 * provides SSL support, but other modules provide SSL support too, all
692 * the modules supporting SSL should publish an identical 'SSL' feature.
693 * To find a module capable of providing the feature you want, simply
694 * call this method with the feature name you are looking for.
695 * @param FeatureName The feature name you wish to obtain the module for
696 * @returns A pointer to a valid module class on success, NULL on failure.
698 Module* FindFeature(const std::string &FeatureName);
700 /** Given a pointer to a Module, return its filename
701 * @param m The module pointer to identify
702 * @return The module name or an empty string
704 const std::string& GetModuleName(Module* m);
706 /** Return true if a nickname is valid
707 * @param n A nickname to verify
708 * @return True if the nick is valid
710 bool IsNick(const char* n);
712 /** Return true if an ident is valid
713 * @param An ident to verify
714 * @return True if the ident is valid
716 bool IsIdent(const char* n);
718 /** Find a username by their file descriptor.
719 * It is preferred to use this over directly accessing the fd_ref_table array.
720 * @param socket The file descriptor of a user
721 * @return A pointer to the user if the user exists locally on this descriptor
723 userrec* FindDescriptor(int socket);
725 /** Add a new mode to this server's mode parser
726 * @param mh The modehandler to add
727 * @param modechar The mode character this modehandler handles
728 * @return True if the mode handler was added
730 bool AddMode(ModeHandler* mh, const unsigned char modechar);
732 /** Add a new mode watcher to this server's mode parser
733 * @param mw The modewatcher to add
734 * @return True if the modewatcher was added
736 bool AddModeWatcher(ModeWatcher* mw);
738 /** Delete a mode watcher from this server's mode parser
739 * @param mw The modewatcher to delete
740 * @return True if the modewatcher was deleted
742 bool DelModeWatcher(ModeWatcher* mw);
744 /** Add a dns Resolver class to this server's active set
745 * @param r The resolver to add
746 * @return True if the resolver was added
748 bool AddResolver(Resolver* r);
750 /** Add a command to this server's command parser
751 * @param f A command_t command handler object to add
752 * @throw ModuleException Will throw ModuleExcption if the command already exists
754 void AddCommand(command_t *f);
756 /** Send a modechange.
757 * The parameters provided are identical to that sent to the
758 * handler for class cmd_mode.
759 * @param parameters The mode parameters
760 * @param pcnt The number of items you have given in the first parameter
761 * @param user The user to send error messages to
763 void SendMode(const char **parameters, int pcnt, userrec *user);
765 /** Match two strings using pattern matching.
766 * This operates identically to the global function match(),
767 * except for that it takes std::string arguments rather than
769 * @param sliteral The literal string to match against
770 * @param spattern The pattern to match against. CIDR and globs are supported.
772 bool MatchText(const std::string &sliteral, const std::string &spattern);
774 /** Call the handler for a given command.
775 * @param commandname The command whos handler you wish to call
776 * @param parameters The mode parameters
777 * @param pcnt The number of items you have given in the first parameter
778 * @param user The user to execute the command as
779 * @return True if the command handler was called successfully
781 bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
783 /** Return true if the command is a module-implemented command and the given parameters are valid for it
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 test-execute the command as
787 * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
789 bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
791 /** Add a gline and apply it
792 * @param duration How long the line should last
793 * @param source Who set the line
794 * @param reason The reason for the line
795 * @param hostmask The hostmask to set the line against
797 void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
799 /** Add a qline and apply it
800 * @param duration How long the line should last
801 * @param source Who set the line
802 * @param reason The reason for the line
803 * @param nickname The nickmask to set the line against
805 void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
807 /** Add a zline and apply it
808 * @param duration How long the line should last
809 * @param source Who set the line
810 * @param reason The reason for the line
811 * @param ipaddr The ip-mask to set the line against
813 void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
815 /** Add a kline and apply it
816 * @param duration How long the line should last
817 * @param source Who set the line
818 * @param reason The reason for the line
819 * @param hostmask The hostmask to set the line against
821 void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
824 * @param duration How long the line should last
825 * @param source Who set the line
826 * @param reason The reason for the line
827 * @param hostmask The hostmask to set the line against
829 void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
832 * @param hostmask The gline to delete
833 * @return True if the item was removed
835 bool DelGLine(const std::string &hostmask);
838 * @param nickname The qline to delete
839 * @return True if the item was removed
841 bool DelQLine(const std::string &nickname);
844 * @param ipaddr The zline to delete
845 * @return True if the item was removed
847 bool DelZLine(const std::string &ipaddr);
850 * @param hostmask The kline to delete
851 * @return True if the item was removed
853 bool DelKLine(const std::string &hostmask);
856 * @param hostmask The kline to delete
857 * @return True if the item was removed
859 bool DelELine(const std::string &hostmask);
861 /** Return true if the given parameter is a valid nick!user\@host mask
862 * @param mask A nick!user\@host masak to match against
863 * @return True i the mask is valid
865 bool IsValidMask(const std::string &mask);
867 /** Rehash the local server
871 /** Return the channel whos index number matches that provided
872 * @param The index number of the channel to fetch
873 * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
875 chanrec* GetChannelIndex(long index);
877 /** Dump text to a user target, splitting it appropriately to fit
878 * @param User the user to dump the text to
879 * @param LinePrefix text to prefix each complete line with
880 * @param TextStream the text to send to the user
882 void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
884 /** Check if the given nickmask matches too many users, send errors to the given user
885 * @param nick A nickmask to match against
886 * @param user A user to send error text to
887 * @return True if the nick matches too many users
889 bool NickMatchesEveryone(const std::string &nick, userrec* user);
891 /** Check if the given IP mask matches too many users, send errors to the given user
892 * @param ip An ipmask to match against
893 * @param user A user to send error text to
894 * @return True if the ip matches too many users
896 bool IPMatchesEveryone(const std::string &ip, userrec* user);
898 /** Check if the given hostmask matches too many users, send errors to the given user
899 * @param mask A hostmask to match against
900 * @param user A user to send error text to
901 * @return True if the host matches too many users
903 bool HostMatchesEveryone(const std::string &mask, userrec* user);
905 /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
906 * @param str A string containing a time in the form 1y2w3d4h6m5s
907 * (one year, two weeks, three days, four hours, six minutes and five seconds)
908 * @return The total number of seconds
910 long Duration(const char* str);
912 /** Attempt to compare an oper password to a string from the config file.
913 * This will be passed to handling modules which will compare the data
914 * against possible hashed equivalents in the input string.
915 * @param data The data from the config file
916 * @param input The data input by the oper
917 * @return 0 if the strings match, 1 or -1 if they do not
919 int OperPassCompare(const char* data,const char* input);
921 /** Check if a given server is a uline.
922 * An empty string returns true, this is by design.
923 * @param server The server to check for uline status
924 * @return True if the server is a uline OR the string is empty
926 bool ULine(const char* server);
928 /** Returns the subversion revision ID of this ircd
929 * @return The revision ID or an empty string
931 std::string GetRevision();
933 /** Returns the full version string of this ircd
934 * @return The version string
936 std::string GetVersionString();
938 /** Attempt to write the process id to a given file
939 * @param filename The PID file to attempt to write to
940 * @return This function may bail if the file cannot be written
942 void WritePID(const std::string &filename);
944 /** Returns text describing the last module error
945 * @return The last error message to occur
949 /** Load a given module file
950 * @param filename The file to load
951 * @return True if the module was found and loaded
953 bool LoadModule(const char* filename);
955 /** Unload a given module file
956 * @param filename The file to unload
957 * @return True if the module was unloaded
959 bool UnloadModule(const char* filename);
961 /** This constructor initialises all the subsystems and reads the config file.
962 * @param argc The argument count passed to main()
963 * @param argv The argument list passed to main()
964 * @throw <anything> If anything is thrown from here and makes it to
965 * you, you should probably just give up and go home. Yes, really.
966 * It's that bad. Higher level classes should catch any non-fatal exceptions.
968 InspIRCd(int argc, char** argv);
970 /** Do one iteration of the mainloop
971 * @param process_module_sockets True if module sockets are to be processed
972 * this time around the event loop. The is the default.
974 void DoOneIteration(bool process_module_sockets = true);
976 /** Output a log message to the ircd.log file
977 * The text will only be output if the current loglevel
978 * is less than or equal to the level you provide
979 * @param level A log level from the DebugLevel enum
980 * @param text Format string of to write to the log
981 * @param ... Format arguments of text to write to the log
983 void Log(int level, const char* text, ...);
985 /** Output a log message to the ircd.log file
986 * The text will only be output if the current loglevel
987 * is less than or equal to the level you provide
988 * @param level A log level from the DebugLevel enum
989 * @param text Text to write to the log
991 void Log(int level, const std::string &text);
993 /** Begin execution of the server.
994 * NOTE: this function NEVER returns. Internally,
995 * after performing some initialisation routines,
996 * it will repeatedly call DoOneIteration in a loop.
997 * @return The return value for this function is undefined.