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])
30 #include "socketengine.h"
33 /* Required forward definitions */
38 /** Types of data in the core config
42 DT_NOTHING = 0, /* No data */
43 DT_INTEGER = 1, /* Integer */
44 DT_CHARPTR = 2, /* Char pointer */
45 DT_BOOLEAN = 3, /* Boolean */
46 DT_HOSTNAME = 4, /* Hostname syntax */
47 DT_NOSPACES = 5, /* No spaces */
48 DT_IPADDRESS = 6, /* IP address (v4, v6) */
49 DT_CHANNEL = 7, /* Channel name */
50 DT_ALLOW_WILD = 64, /* Allow wildcards/CIDR in DT_IPADDRESS */
51 DT_ALLOW_NEWLINE = 128, /* New line characters allowed in DT_CHARPTR */
52 DT_BOOTONLY = 256 /* Can only be set on startup, not on rehash */
55 /** The maximum number of values in a core configuration tag. Can be increased if needed.
57 #define MAX_VALUES_PER_TAG 18
59 /** Holds a config value, either string, integer or boolean.
60 * Callback functions receive one or more of these, either on
61 * their own as a reference, or in a reference to a deque of them.
62 * The callback function can then alter the values of the ValueItem
63 * classes to validate the settings.
70 /** Initialize with an int */
72 /** Initialize with a bool */
73 ValueItem(bool value);
74 /** Initialize with a char pointer */
75 ValueItem(const char* value);
76 /** Change value to a char pointer */
77 void Set(const char* val);
78 /** Change value to an int */
80 /** Get value as an int */
82 /** Get value as a string */
84 /** Get value as a bool */
88 /** The base class of the container 'ValueContainer'
89 * used internally by the core to hold core values.
91 class ValueContainerBase
95 ValueContainerBase() { }
97 virtual ~ValueContainerBase() { }
100 /** ValueContainer is used to contain pointers to different
101 * core values such as the server name, maximum number of
103 * It is specialized to hold a data type, then pointed at
104 * a value in the ServerConfig class. When the value has been
105 * read and validated, the Set method is called to write the
106 * value safely in a type-safe manner.
108 template<typename T> class ValueContainer : public ValueContainerBase
110 /** Contained item */
114 /** Initialize with nothing */
120 /** Initialize with a value of type T */
121 ValueContainer(T Val)
126 /** Change value to type T of size s */
127 void Set(T newval, size_t s)
129 memcpy(val, newval, s);
133 /** A specialization of ValueContainer to hold a pointer to a bool
135 typedef ValueContainer<bool*> ValueContainerBool;
137 /** A specialization of ValueContainer to hold a pointer to
140 typedef ValueContainer<unsigned int*> ValueContainerUInt;
142 /** A specialization of ValueContainer to hold a pointer to
145 typedef ValueContainer<char*> ValueContainerChar;
147 /** A specialization of ValueContainer to hold a pointer to
150 typedef ValueContainer<int*> ValueContainerInt;
152 /** A specialization of ValueContainer to hold a pointer to
155 typedef ValueContainer<size_t*> ValueContainerST;
157 /** A set of ValueItems used by multi-value validator functions
159 typedef std::deque<ValueItem> ValueList;
161 /** A callback for validating a single value
163 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
164 /** A callback for validating multiple value entries
166 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
167 /** A callback indicating the end of a group of entries
169 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
171 /** Holds a core configuration item and its callbacks
179 /** Default, if not defined */
180 const char* default_value;
181 /** Value containers */
182 ValueContainerBase* val;
185 /** Validation function */
186 Validator validation_function;
189 /** Represents a deprecated configuration tag.
199 /** Reason for deprecation
204 /** Holds a core configuration item and its callbacks
205 * where there may be more than one item
211 /** One or more items within tag */
212 const char* items[MAX_VALUES_PER_TAG];
213 /** One or more defaults for items within tags */
214 const char* items_default[MAX_VALUES_PER_TAG];
215 /** One or more data types */
216 int datatype[MAX_VALUES_PER_TAG];
217 /** Initialization function */
218 MultiNotify init_function;
219 /** Validation function */
220 MultiValidator validation_function;
221 /** Completion function */
222 MultiNotify finish_function;
225 /** A set of oper types
227 typedef std::map<irc::string,char*> opertype_t;
229 /** Holds an oper class.
231 struct operclass_data : public Extensible
233 /** Command list for the class
237 /** Channel mode list for the class
241 /** User mode list for the class
245 /** Priviledges given by this class
250 /** A Set of oper classes
252 typedef std::map<irc::string, operclass_data> operclass_t;
254 /** Defines the server's length limits on various length-limited
255 * items such as topics, nicknames, channel names etc.
257 class ServerLimits : public Extensible
260 /** Maximum nickname length */
262 /** Maximum channel length */
264 /** Maximum number of modes per line */
266 /** Maximum length of ident, not including ~ etc */
268 /** Maximum length of a quit message */
270 /** Maximum topic length */
272 /** Maximum kick message length */
274 /** Maximum GECOS (real name) length */
276 /** Maximum away message length */
279 /** Creating the class initialises it to the defaults
280 * as in 1.1's ./configure script. Reading other values
281 * from the config will change these values.
283 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
287 /** Finalises the settings by adding one. This allows for them to be used as-is
288 * without a 'value+1' when using the std::string assignment methods etc.
303 /** This class holds the bulk of the runtime configuration for the ircd.
304 * It allows for reading new config values, accessing configuration files,
305 * and storage of the configuration data needed to run the ircd, such as
306 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
308 class CoreExport ServerConfig : public Extensible
311 /** Creator/owner pointer
313 InspIRCd* ServerInstance;
315 /** This variable holds the names of all
316 * files included from the main one. This
317 * is used to make sure that no files are
318 * recursively included.
320 std::vector<std::string> include_stack;
322 /** This private method processes one line of
323 * configutation, appending errors to errorstream
324 * and setting error if an error has occured.
326 bool ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream);
328 /** Check that there is only one of each configuration item
330 bool CheckOnce(const char* tag, ConfigDataHash &newconf);
333 /** Process an include executable directive
335 bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
337 /** Process an include file directive
339 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
341 /** User that is currently performing a rehash, needed because the
342 * rehash code is now threaded and needs to know who to give errors and feedback to.
344 std::string RehashUserUID;
346 /** Rehash parameter, as above
348 std::string RehashParameter;
350 /** Error stream, contains error output from any failed configuration parsing.
352 std::ostringstream* errstr;
354 /** Holds the new configuration when a rehash occurs so we dont overwrite the existing
355 * working config with a broken one without checking it first and swapping pointers.
357 ConfigDataHash newconfig;
359 /** Set of included files. Do we use this any more?
361 std::map<std::string, std::istream*> IncludedFiles;
363 /** Used to indicate who we announce invites to on a channel */
364 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
366 /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
367 Validator DNSServerValidator;
369 /** Returns the creator InspIRCd pointer
371 InspIRCd* GetInstance();
373 /** Not used any more as it is named, can probably be removed or renamed.
377 /** This holds all the information in the config file,
378 * it's indexed by tag name to a vector of key/values.
380 ConfigDataHash config_data;
382 /** Length limits, see definition of ServerLimits class
386 /** Clones CIDR range for ipv4 (0-32)
387 * Defaults to 32 (checks clones on all IPs seperately)
391 /** Clones CIDR range for ipv6 (0-128)
392 * Defaults to 128 (checks on all IPs seperately)
396 /** Max number of WhoWas entries per user.
400 /** Max number of cumulative user-entries in WhoWas.
401 * When max reached and added to, push out oldest entry FIFO style.
405 /** Max seconds a user is kept in WhoWas before being pruned.
409 /** Both for set(g|u)id.
411 char SetUser[MAXBUF];
412 char SetGroup[MAXBUF];
414 /** Holds the server name of the local server
415 * as defined by the administrator.
417 char ServerName[MAXBUF];
419 /** Notice to give to users when they are Xlined
421 char MoronBanner[MAXBUF];
423 /* Holds the network name the local server
424 * belongs to. This is an arbitary field defined
425 * by the administrator.
427 char Network[MAXBUF];
429 /** Holds the description of the local server
430 * as defined by the administrator.
432 char ServerDesc[MAXBUF];
434 /** Holds the admin's name, for output in
435 * the /ADMIN command.
437 char AdminName[MAXBUF];
439 /** Holds the email address of the admin,
440 * for output in the /ADMIN command.
442 char AdminEmail[MAXBUF];
444 /** Holds the admin's nickname, for output
445 * in the /ADMIN command
447 char AdminNick[MAXBUF];
449 /** The admin-configured /DIE password
451 char diepass[MAXBUF];
453 /** The admin-configured /RESTART password
455 char restartpass[MAXBUF];
457 /** The hash method for *BOTH* the die and restart passwords.
459 char powerhash[MAXBUF];
461 /** The pathname and filename of the message of the
462 * day file, as defined by the administrator.
466 /** The pathname and filename of the rules file,
467 * as defined by the administrator.
471 /** The quit prefix in use, or an empty string
473 char PrefixQuit[MAXBUF];
475 /** The quit suffix in use, or an empty string
477 char SuffixQuit[MAXBUF];
479 /** The fixed quit message in use, or an empty string
481 char FixedQuit[MAXBUF];
483 /** The part prefix in use, or an empty string
485 char PrefixPart[MAXBUF];
487 /** The part suffix in use, or an empty string
489 char SuffixPart[MAXBUF];
491 /** The fixed part message in use, or an empty string
493 char FixedPart[MAXBUF];
495 /** The last string found within a <die> tag, or
498 char DieValue[MAXBUF];
500 /** The DNS server to use for DNS queries
502 char DNSServer[MAXBUF];
504 /** Pretend disabled commands don't exist.
506 bool DisabledDontExist;
508 /** This variable contains a space-seperated list
509 * of commands which are disabled by the
510 * administrator of the server for non-opers.
512 char DisabledCommands[MAXBUF];
514 /** This variable identifies which usermodes have been diabled.
517 char DisabledUModes[64];
519 /** This variable identifies which chanmodes have been disabled.
521 char DisabledCModes[64];
523 /** The full path to the modules directory.
524 * This is either set at compile time, or
525 * overridden in the configuration file via
530 /** The full pathname to the executable, as
531 * given in argv[0] when the program starts.
533 char MyExecutable[1024];
535 /** The file handle of the logfile. If this
536 * value is NULL, the log file is not open,
537 * probably due to a permissions error on
538 * startup (this should not happen in normal
543 /** If this value is true, the owner of the
544 * server specified -nofork on the command
545 * line, causing the daemon to stay in the
550 /** If this value if true then all log
551 * messages will be output, regardless of
552 * the level given in the config file.
553 * This is set with the -debug commandline
558 /** If this is true then log output will be
559 * written to the logfile. This is the default.
560 * If you put -nolog on the commandline then
561 * the logfile will not be written.
562 * This is meant to be used in conjunction with
563 * -debug for debugging without filling up the
568 /** If this value is true, halfops have been
569 * enabled in the configuration file.
573 /** If this is set to true, then mode lists (e.g
574 * MODE #chan b) are hidden from unprivileged
577 bool HideModeLists[256];
579 /** If this is set to true, then channel operators
580 * are exempt from this channel mode. Used for +Sc etc.
582 bool ExemptChanOps[256];
584 /** The number of seconds the DNS subsystem
585 * will wait before timing out any request.
589 /** The size of the read() buffer in the user
590 * handling code, used to read data into a user's
595 /** The value to be used for listen() backlogs
600 /** The soft limit value assigned to the irc server.
601 * The IRC server will not allow more than this
602 * number of local users.
604 unsigned int SoftLimit;
606 /** Maximum number of targets for a multi target command
607 * such as PRIVMSG or KICK
609 unsigned int MaxTargets;
611 /** The maximum number of /WHO results allowed
612 * in any single /WHO command.
616 /** True if the DEBUG loglevel is selected.
620 /** How many seconds to wait before exiting
621 * the program when /DIE is correctly issued.
625 /** True if we're going to hide netsplits as *.net *.split for non-opers
629 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
634 /** Announce invites to the channel with a server notice
636 InviteAnnounceState AnnounceInvites;
638 /** If this is enabled then operators will
639 * see invisible (+i) channels in /whois.
643 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
645 char HideWhoisServer[MAXBUF];
647 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
649 char HideKillsServer[MAXBUF];
651 /** The MOTD file, cached in a file_cache type.
655 /** The RULES file, cached in a file_cache type.
659 /** The full pathname and filename of the PID
660 * file as defined in the configuration.
664 /** The connect classes in use by the IRC server.
668 /** A list of the classes for listening ports
670 std::vector<ListenSocketBase *> ports;
672 /** The 005 tokens of this server (ISUPPORT)
673 * populated/repopulated upon loading or unloading
680 std::vector<std::string> isupport;
682 /** STATS characters in this list are available
685 char UserStats[MAXBUF];
687 /** The path and filename of the ircd.log file
691 /** Default channel modes
693 char DefaultModes[MAXBUF];
695 /** Custom version string, which if defined can replace the system info in VERSION.
697 char CustomVersion[MAXBUF];
699 /** List of u-lined servers
701 std::map<irc::string, bool> ulines;
703 /** Max banlist sizes for channels (the std::string is a glob)
705 std::map<std::string, int> maxbans;
707 /** Directory where the inspircd binary resides
711 /** If set to true, no user DNS lookups are to be performed
715 /** If set to true, provide syntax hints for unknown commands
719 /** If set to true, users appear to quit then rejoin when their hosts change.
720 * This keeps clients synchronized properly.
724 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
725 * added to the outgoing text for undernet style msg prefixing.
727 bool UndernetMsgPrefix;
729 /** If set to true, the full nick!user@host will be shown in the TOPIC command
730 * for who set the topic last. If false, only the nick is shown.
732 bool FullHostInTopic;
734 /** All oper type definitions from the config file
736 opertype_t opertypes;
738 /** All oper class definitions from the config file
740 operclass_t operclass;
742 /** Saved argv from startup
746 /** Saved argc from startup
750 /** Max channels per user
752 unsigned int MaxChans;
754 /** Oper max channels per user
756 unsigned int OperMaxChans;
758 /** TS6-like server ID.
759 * NOTE: 000...999 are usable for InspIRCd servers. This
760 * makes code simpler. 0AA, 1BB etc with letters are reserved
765 /** True if we have been told to run the testsuite from the commandline,
766 * rather than entering the mainloop.
770 /** Construct a new ServerConfig
772 ServerConfig(InspIRCd* Instance);
774 /** Clears the include stack in preperation for a Read() call.
778 /** Get server ID as string with required leading zeroes
780 std::string GetSID();
782 /** Update the 005 vector
786 /** Send the 005 numerics (ISUPPORT) to a user
788 void Send005(User* user);
790 /** Read the entire configuration into memory
791 * and initialize this class. All other methods
792 * should be used only by the core.
794 void Read(bool bail, const std::string &useruid);
796 /** Read a file into a file_cache object
798 bool ReadFile(file_cache &F, const char* fname);
800 /* Returns true if the given string starts with a windows drive letter
802 bool StartsWithWindowsDriveLetter(const std::string &path);
804 /** Report a configuration error given in errormessage.
805 * @param bail If this is set to true, the error is sent to the console, and the program exits
806 * @param useruid If this is set to a non-empty value which is a valid UID, and bail is false,
807 * the errors are spooled to this user as SNOTICEs.
808 * If the parameter is not a valid UID, the messages are spooled to all opers.
810 void ReportConfigError(const std::string &errormessage, bool bail, const std::string &useruid);
812 /** Load 'filename' into 'target', with the new config parser everything is parsed into
813 * tag/key/value at load-time rather than at read-value time.
815 bool LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream);
817 /** Load 'filename' into 'target', with the new config parser everything is parsed into
818 * tag/key/value at load-time rather than at read-value time.
820 bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
822 /** Writes 'length' chars into 'result' as a string
824 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
826 /** Writes 'length' chars into 'result' as a string
828 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
830 /** Writes 'length' chars into 'result' as a string
832 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
834 /** Writes 'length' chars into 'result' as a string
836 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);
838 /** Tries to convert the value to an integer and write it to 'result'
840 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
842 /** Tries to convert the value to an integer and write it to 'result'
844 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
846 /** Tries to convert the value to an integer and write it to 'result'
848 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
850 /** Tries to convert the value to an integer and write it to 'result'
852 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
854 /** Returns true if the value exists and has a true value, false otherwise
856 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
858 /** Returns true if the value exists and has a true value, false otherwise
860 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
862 /** Returns true if the value exists and has a true value, false otherwise
864 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
866 /** Returns true if the value exists and has a true value, false otherwise
868 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
870 /** Returns the number of occurences of tag in the config file
872 int ConfValueEnum(ConfigDataHash &target, const char* tag);
873 /** Returns the number of occurences of tag in the config file
875 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
877 /** Returns the numbers of vars inside the index'th 'tag in the config file
879 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
880 /** Returns the numbers of vars inside the index'th 'tag in the config file
882 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
884 /** Validates a hostname value, throwing ConfigException if it is not valid
886 void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
888 /** Validates an IP address value, throwing ConfigException if it is not valid
890 void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
892 /** Validates a value that should not contain spaces, throwing ConfigException of it is not valid
894 void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
896 /** Returns the fully qualified path to the inspircd directory
897 * @return The full program directory
899 std::string GetFullProgDir();
901 /** Returns true if a directory is valid (within the modules directory).
902 * @param dirandfile The directory and filename to check
903 * @return True if the directory is valid
905 static bool DirValid(const char* dirandfile);
907 /** Clean a filename, stripping the directories (and drives) from string.
908 * @param name Directory to tidy
909 * @return The cleaned filename
911 static char* CleanFilename(char* name);
913 /** Check if a file exists.
914 * @param file The full path to a file
915 * @return True if the file exists and is readable.
917 static bool FileExists(const char* file);
919 /** If this value is true, invites will bypass more than just +i
925 /** Initialize the disabled commands list
927 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
929 /** Initialize the oper types
931 bool InitTypes(ServerConfig* conf, const char* tag);
933 /** Initialize the oper classes
935 bool InitClasses(ServerConfig* conf, const char* tag);
937 /** Initialize an oper type
939 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
941 /** Initialize an oper class
943 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
945 /** Finish initializing the oper types and classes
947 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
951 /** Initialize x line
953 bool InitXLine(ServerConfig* conf, const char* tag);
955 /** Add a config-defined zline
957 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
959 /** Add a config-defined qline
961 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
963 /** Add a config-defined kline
965 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
967 /** Add a config-defined eline
969 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);