1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 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_CONFIGREADER
15 #define INSPIRCD_CONFIGREADER
19 /** Determines if a channel op is exempt from given mode m,
20 * in config of server instance s.
22 #define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m])
31 #include "socketengine.h"
34 /* Required forward definitions */
39 /** Types of data in the core config
43 DT_NOTHING = 0, /* No data */
44 DT_INTEGER = 1, /* Integer */
45 DT_CHARPTR = 2, /* Char pointer */
46 DT_BOOLEAN = 3, /* Boolean */
47 DT_HOSTNAME = 4, /* Hostname syntax */
48 DT_NOSPACES = 5, /* No spaces */
49 DT_IPADDRESS = 6, /* IP address (v4, v6) */
50 DT_CHANNEL = 7, /* Channel name */
51 DT_ALLOW_WILD = 64, /* Allow wildcards/CIDR in DT_IPADDRESS */
52 DT_ALLOW_NEWLINE = 128, /* New line characters allowed in DT_CHARPTR */
53 DT_BOOTONLY = 256 /* Can only be set on startup, not on rehash */
56 /** The maximum number of values in a core configuration tag. Can be increased if needed.
58 #define MAX_VALUES_PER_TAG 18
60 /** Holds a config value, either string, integer or boolean.
61 * Callback functions receive one or more of these, either on
62 * their own as a reference, or in a reference to a deque of them.
63 * The callback function can then alter the values of the ValueItem
64 * classes to validate the settings.
71 /** Initialize with an int */
73 /** Initialize with a bool */
74 ValueItem(bool value);
75 /** Initialize with a char pointer */
76 ValueItem(const char* value);
77 /** Change value to a char pointer */
78 void Set(const char* val);
79 /** Change value to an int */
81 /** Get value as an int */
83 /** Get value as a string */
85 /** Get value as a bool */
89 /** The base class of the container 'ValueContainer'
90 * used internally by the core to hold core values.
92 class ValueContainerBase
96 ValueContainerBase() { }
98 virtual ~ValueContainerBase() { }
101 /** ValueContainer is used to contain pointers to different
102 * core values such as the server name, maximum number of
104 * It is specialized to hold a data type, then pointed at
105 * a value in the ServerConfig class. When the value has been
106 * read and validated, the Set method is called to write the
107 * value safely in a type-safe manner.
109 template<typename T> class ValueContainer : public ValueContainerBase
111 /** Contained item */
115 /** Initialize with nothing */
121 /** Initialize with a value of type T */
122 ValueContainer(T Val)
127 /** Change value to type T of size s */
128 void Set(T newval, size_t s)
130 memcpy(val, newval, s);
134 /** A specialization of ValueContainer to hold a pointer to a bool
136 typedef ValueContainer<bool*> ValueContainerBool;
138 /** A specialization of ValueContainer to hold a pointer to
141 typedef ValueContainer<unsigned int*> ValueContainerUInt;
143 /** A specialization of ValueContainer to hold a pointer to
146 typedef ValueContainer<char*> ValueContainerChar;
148 /** A specialization of ValueContainer to hold a pointer to
151 typedef ValueContainer<int*> ValueContainerInt;
153 typedef ValueContainer<size_t*> ValueContainerST;
155 /** A set of ValueItems used by multi-value validator functions
157 typedef std::deque<ValueItem> ValueList;
159 /** A callback for validating a single value
161 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
162 /** A callback for validating multiple value entries
164 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
165 /** A callback indicating the end of a group of entries
167 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
169 /** Holds a core configuration item and its callbacks
177 /** Default, if not defined */
178 const char* default_value;
179 /** Value containers */
180 ValueContainerBase* val;
183 /** Validation function */
184 Validator validation_function;
194 /** Holds a core configuration item and its callbacks
195 * where there may be more than one item
201 /** One or more items within tag */
202 const char* items[MAX_VALUES_PER_TAG];
203 /** One or more defaults for items within tags */
204 const char* items_default[MAX_VALUES_PER_TAG];
205 /** One or more data types */
206 int datatype[MAX_VALUES_PER_TAG];
207 /** Initialization function */
208 MultiNotify init_function;
209 /** Validation function */
210 MultiValidator validation_function;
211 /** Completion function */
212 MultiNotify finish_function;
215 /** A set of oper types
217 typedef std::map<irc::string,char*> opertype_t;
219 struct operclass_data : public Extensible
226 /** A Set of oper classes
228 typedef std::map<irc::string, operclass_data> operclass_t;
231 class ServerLimits : public Extensible
244 /* Creating the class initialises it to the defaults
245 * as in 1.1's ./configure script. Reading other values
246 * from the config will change these values.
248 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
265 /** This class holds the bulk of the runtime configuration for the ircd.
266 * It allows for reading new config values, accessing configuration files,
267 * and storage of the configuration data needed to run the ircd, such as
268 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
270 class CoreExport ServerConfig : public Extensible
273 /** Creator/owner pointer
275 InspIRCd* ServerInstance;
277 /** This variable holds the names of all
278 * files included from the main one. This
279 * is used to make sure that no files are
280 * recursively included.
282 std::vector<std::string> include_stack;
284 /** This private method processes one line of
285 * configutation, appending errors to errorstream
286 * and setting error if an error has occured.
288 bool ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream);
290 /** Check that there is only one of each configuration item
292 bool CheckOnce(const char* tag, ConfigDataHash &newconf);
296 /** Process an include executable directive
298 bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
300 /** Process an include file directive
302 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
306 std::string RehashParameter;
308 std::ostringstream errstr;
310 ConfigDataHash newconfig;
312 std::map<std::string, std::istream*> IncludedFiles;
314 /** Used to indicate who we announce invites to on a channel */
315 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
317 /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
318 Validator DNSServerValidator;
320 InspIRCd* GetInstance();
324 /** This holds all the information in the config file,
325 * it's indexed by tag name to a vector of key/values.
327 ConfigDataHash config_data;
331 /** Max number of WhoWas entries per user.
335 /** Max number of cumulative user-entries in WhoWas.
336 * When max reached and added to, push out oldest entry FIFO style.
340 /** Max seconds a user is kept in WhoWas before being pruned.
344 /** Holds the server name of the local server
345 * as defined by the administrator.
347 char ServerName[MAXBUF];
349 /** Notice to give to users when they are Xlined
351 char MoronBanner[MAXBUF];
353 /* Holds the network name the local server
354 * belongs to. This is an arbitary field defined
355 * by the administrator.
357 char Network[MAXBUF];
359 /** Holds the description of the local server
360 * as defined by the administrator.
362 char ServerDesc[MAXBUF];
364 /** Holds the admin's name, for output in
365 * the /ADMIN command.
367 char AdminName[MAXBUF];
369 /** Holds the email address of the admin,
370 * for output in the /ADMIN command.
372 char AdminEmail[MAXBUF];
374 /** Holds the admin's nickname, for output
375 * in the /ADMIN command
377 char AdminNick[MAXBUF];
379 /** The admin-configured /DIE password
381 char diepass[MAXBUF];
383 /** The admin-configured /RESTART password
385 char restartpass[MAXBUF];
387 /** The hash method for *BOTH* the die and restart passwords.
389 char powerhash[MAXBUF];
391 /** The pathname and filename of the message of the
392 * day file, as defined by the administrator.
396 /** The pathname and filename of the rules file,
397 * as defined by the administrator.
401 /** The quit prefix in use, or an empty string
403 char PrefixQuit[MAXBUF];
405 /** The quit suffix in use, or an empty string
407 char SuffixQuit[MAXBUF];
409 /** The fixed quit message in use, or an empty string
411 char FixedQuit[MAXBUF];
413 /** The part prefix in use, or an empty string
415 char PrefixPart[MAXBUF];
417 /** The part suffix in use, or an empty string
419 char SuffixPart[MAXBUF];
421 /** The fixed part message in use, or an empty string
423 char FixedPart[MAXBUF];
425 /** The last string found within a <die> tag, or
428 char DieValue[MAXBUF];
430 /** The DNS server to use for DNS queries
432 char DNSServer[MAXBUF];
434 /** This variable contains a space-seperated list
435 * of commands which are disabled by the
436 * administrator of the server for non-opers.
438 char DisabledCommands[MAXBUF];
440 /** The full path to the modules directory.
441 * This is either set at compile time, or
442 * overridden in the configuration file via
447 /** The full pathname to the executable, as
448 * given in argv[0] when the program starts.
450 char MyExecutable[1024];
452 /** The file handle of the logfile. If this
453 * value is NULL, the log file is not open,
454 * probably due to a permissions error on
455 * startup (this should not happen in normal
460 /** If this value is true, the owner of the
461 * server specified -nofork on the command
462 * line, causing the daemon to stay in the
467 /** If this value if true then all log
468 * messages will be output, regardless of
469 * the level given in the config file.
470 * This is set with the -debug commandline
475 /** If this is true then log output will be
476 * written to the logfile. This is the default.
477 * If you put -nolog on the commandline then
478 * the logfile will not be written.
479 * This is meant to be used in conjunction with
480 * -debug for debugging without filling up the
485 /** If this value is true, halfops have been
486 * enabled in the configuration file.
490 /** If this is set to true, then mode lists (e.g
491 * MODE #chan b) are hidden from unprivileged
494 bool HideModeLists[256];
496 /** If this is set to true, then channel operators
497 * are exempt from this channel mode. Used for +Sc etc.
499 bool ExemptChanOps[256];
501 /** The number of seconds the DNS subsystem
502 * will wait before timing out any request.
506 /** The size of the read() buffer in the user
507 * handling code, used to read data into a user's
512 /** The value to be used for listen() backlogs
517 /** The soft limit value assigned to the irc server.
518 * The IRC server will not allow more than this
519 * number of local users.
521 unsigned int SoftLimit;
523 /** Maximum number of targets for a multi target command
524 * such as PRIVMSG or KICK
526 unsigned int MaxTargets;
528 /** The maximum number of /WHO results allowed
529 * in any single /WHO command.
533 /** True if the DEBUG loglevel is selected.
537 /** How many seconds to wait before exiting
538 * the program when /DIE is correctly issued.
542 /** True if we're going to hide netsplits as *.net *.split for non-opers
546 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
551 /** Announce invites to the channel with a server notice
553 InviteAnnounceState AnnounceInvites;
555 /** If this is enabled then operators will
556 * see invisible (+i) channels in /whois.
560 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
562 char HideWhoisServer[MAXBUF];
564 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
566 char HideKillsServer[MAXBUF];
568 /** The MOTD file, cached in a file_cache type.
572 /** The RULES file, cached in a file_cache type.
576 /** The full pathname and filename of the PID
577 * file as defined in the configuration.
581 /** The connect classes in use by the IRC server.
585 /** A list of the classes for listening client ports
587 std::vector<ListenSocket*> ports;
589 /** socket objects that are attached to by modules
591 std::map<BufferedSocket*, Module*> SocketIOHookModule;
593 /** The 005 tokens of this server (ISUPPORT)
594 * populated/repopulated upon loading or unloading
601 std::vector<std::string> isupport;
603 /** STATS characters in this list are available
606 char UserStats[MAXBUF];
608 /** The path and filename of the ircd.log file
612 /** Default channel modes
614 char DefaultModes[MAXBUF];
616 /** Custom version string, which if defined can replace the system info in VERSION.
618 char CustomVersion[MAXBUF];
620 /** List of u-lined servers
622 std::map<irc::string, bool> ulines;
624 /** Max banlist sizes for channels (the std::string is a glob)
626 std::map<std::string, int> maxbans;
628 /** Directory where the inspircd binary resides
632 /** If set to true, no user DNS lookups are to be performed
636 /** If set to true, provide syntax hints for unknown commands
640 /** If set to true, users appear to quit then rejoin when their hosts change.
641 * This keeps clients synchronized properly.
645 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
646 * added to the outgoing text for undernet style msg prefixing.
648 bool UndernetMsgPrefix;
650 /** If set to true, the full nick!user@host will be shown in the TOPIC command
651 * for who set the topic last. If false, only the nick is shown.
653 bool FullHostInTopic;
655 /** All oper type definitions from the config file
657 opertype_t opertypes;
659 /** All oper class definitions from the config file
661 operclass_t operclass;
663 /** Saved argv from startup
667 /** Saved argc from startup
671 /** Max channels per user
673 unsigned int MaxChans;
675 /** Oper max channels per user
677 unsigned int OperMaxChans;
679 /** TS6-like server ID.
680 * NOTE: 000...999 are usable for InspIRCd servers. This
681 * makes code simpler. 0AA, 1BB etc with letters are reserved
686 /** True if we have been told to run the testsuite from the commandline,
687 * rather than entering the mainloop.
691 /** Construct a new ServerConfig
693 ServerConfig(InspIRCd* Instance);
695 /** Clears the include stack in preperation for a Read() call.
699 /** Get server ID as string with required leading zeroes
701 std::string GetSID();
703 /** Update the 005 vector
707 /** Send the 005 numerics (ISUPPORT) to a user
709 void Send005(User* user);
711 /** Read the entire configuration into memory
712 * and initialize this class. All other methods
713 * should be used only by the core.
715 void Read(bool bail, User* user);
717 /** Read a file into a file_cache object
719 bool ReadFile(file_cache &F, const char* fname);
721 /* Returns true if the given string starts with a windows drive letter
723 bool StartsWithWindowsDriveLetter(const std::string &path);
725 /** Report a configuration error given in errormessage.
726 * @param bail If this is set to true, the error is sent to the console, and the program exits
727 * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
728 * this user as SNOTICEs.
729 * If the parameter is NULL, the messages are spooled to all opers.
731 void ReportConfigError(const std::string &errormessage, bool bail, User* user);
733 /** Load 'filename' into 'target', with the new config parser everything is parsed into
734 * tag/key/value at load-time rather than at read-value time.
736 bool LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream);
738 /** Load 'filename' into 'target', with the new config parser everything is parsed into
739 * tag/key/value at load-time rather than at read-value time.
741 bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
743 /* Both these return true if the value existed or false otherwise */
745 /** Writes 'length' chars into 'result' as a string
747 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
748 /** Writes 'length' chars into 'result' as a string
750 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
752 /** Writes 'length' chars into 'result' as a string
754 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
755 /** Writes 'length' chars into 'result' as a string
757 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, std::string &result, bool allow_linefeeds = false);
759 /** Tries to convert the value to an integer and write it to 'result'
761 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
762 /** Tries to convert the value to an integer and write it to 'result'
764 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
765 /** Tries to convert the value to an integer and write it to 'result'
767 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
768 /** Tries to convert the value to an integer and write it to 'result'
770 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
772 /** Returns true if the value exists and has a true value, false otherwise
774 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
775 /** Returns true if the value exists and has a true value, false otherwise
777 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
778 /** Returns true if the value exists and has a true value, false otherwise
780 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
781 /** Returns true if the value exists and has a true value, false otherwise
783 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
785 /** Returns the number of occurences of tag in the config file
787 int ConfValueEnum(ConfigDataHash &target, const char* tag);
788 /** Returns the number of occurences of tag in the config file
790 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
792 /** Returns the numbers of vars inside the index'th 'tag in the config file
794 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
795 /** Returns the numbers of vars inside the index'th 'tag in the config file
797 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
799 void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
801 void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
803 void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
805 /** Get a pointer to the module which has hooked the given BufferedSocket class.
806 * @parameter port Port number
807 * @return Returns a pointer to the hooking module, or NULL
809 Module* GetIOHook(BufferedSocket* is);
811 /** Hook a module to an BufferedSocket class, so that it can receive notifications
812 * of low-level socket activity.
813 * @param iomod The module to hook to the socket
814 * @param is The BufferedSocket to attach to
815 * @return True if the hook was successful.
817 bool AddIOHook(Module* iomod, BufferedSocket* is);
819 /** Delete a module hook from an BufferedSocket.
820 * @param is The BufferedSocket to detatch from.
821 * @return True if the unhook was successful
823 bool DelIOHook(BufferedSocket* is);
825 /** Returns the fully qualified path to the inspircd directory
826 * @return The full program directory
828 std::string GetFullProgDir();
830 /** Returns true if a directory is valid (within the modules directory).
831 * @param dirandfile The directory and filename to check
832 * @return True if the directory is valid
834 static bool DirValid(const char* dirandfile);
836 /** Clean a filename, stripping the directories (and drives) from string.
837 * @param name Directory to tidy
838 * @return The cleaned filename
840 static char* CleanFilename(char* name);
842 /** Check if a file exists.
843 * @param file The full path to a file
844 * @return True if the file exists and is readable.
846 static bool FileExists(const char* file);
850 /** Initialize the disabled commands list
852 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
854 /** Initialize the oper types
856 bool InitTypes(ServerConfig* conf, const char* tag);
858 /** Initialize the oper classes
860 bool InitClasses(ServerConfig* conf, const char* tag);
862 /** Initialize an oper type
864 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
866 /** Initialize an oper class
868 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
870 /** Finish initializing the oper types and classes
872 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
876 /** Initialize x line
878 bool InitXLine(ServerConfig* conf, const char* tag);
880 /** Add a config-defined zline
882 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
884 /** Add a config-defined qline
886 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
888 /** Add a config-defined kline
890 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
892 /** Add a config-defined eline
894 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);