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 typedef ValueContainer<size_t*> ValueContainerST;
154 /** A set of ValueItems used by multi-value validator functions
156 typedef std::deque<ValueItem> ValueList;
158 /** A callback for validating a single value
160 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
161 /** A callback for validating multiple value entries
163 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
164 /** A callback indicating the end of a group of entries
166 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
168 /** Holds a core configuration item and its callbacks
176 /** Default, if not defined */
177 const char* default_value;
178 /** Value containers */
179 ValueContainerBase* val;
182 /** Validation function */
183 Validator validation_function;
193 /** Holds a core configuration item and its callbacks
194 * where there may be more than one item
200 /** One or more items within tag */
201 const char* items[MAX_VALUES_PER_TAG];
202 /** One or more defaults for items within tags */
203 const char* items_default[MAX_VALUES_PER_TAG];
204 /** One or more data types */
205 int datatype[MAX_VALUES_PER_TAG];
206 /** Initialization function */
207 MultiNotify init_function;
208 /** Validation function */
209 MultiValidator validation_function;
210 /** Completion function */
211 MultiNotify finish_function;
214 /** A set of oper types
216 typedef std::map<irc::string,char*> opertype_t;
218 struct operclass_data : public Extensible
225 /** A Set of oper classes
227 typedef std::map<irc::string, operclass_data> operclass_t;
230 class ServerLimits : public Extensible
243 /* Creating the class initialises it to the defaults
244 * as in 1.1's ./configure script. Reading other values
245 * from the config will change these values.
247 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
264 /** This class holds the bulk of the runtime configuration for the ircd.
265 * It allows for reading new config values, accessing configuration files,
266 * and storage of the configuration data needed to run the ircd, such as
267 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
269 class CoreExport ServerConfig : public Extensible
272 /** Creator/owner pointer
274 InspIRCd* ServerInstance;
276 /** This variable holds the names of all
277 * files included from the main one. This
278 * is used to make sure that no files are
279 * recursively included.
281 std::vector<std::string> include_stack;
283 /** This private method processes one line of
284 * configutation, appending errors to errorstream
285 * and setting error if an error has occured.
287 bool ParseLine(ConfigDataHash &target, const std::string &filename, std::string &line, long &linenumber, std::ostringstream &errorstream);
289 /** Check that there is only one of each configuration item
291 bool CheckOnce(const char* tag, ConfigDataHash &newconf);
294 /** Process an include executable directive
296 bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
298 /** Process an include file directive
300 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
304 std::string RehashParameter;
306 std::ostringstream errstr;
308 ConfigDataHash newconfig;
310 std::map<std::string, std::istream*> IncludedFiles;
312 /** Used to indicate who we announce invites to on a channel */
313 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
315 /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
316 Validator DNSServerValidator;
318 InspIRCd* GetInstance();
322 /** This holds all the information in the config file,
323 * it's indexed by tag name to a vector of key/values.
325 ConfigDataHash config_data;
329 /** Clones CIDR range for ipv4 (0-32)
330 * Defaults to 32 (checks clones on all IPs seperately)
334 /** Clones CIDR range for ipv6 (0-128)
335 * Defaults to 128 (checks on all IPs seperately)
339 /** Max number of WhoWas entries per user.
343 /** Max number of cumulative user-entries in WhoWas.
344 * When max reached and added to, push out oldest entry FIFO style.
348 /** Max seconds a user is kept in WhoWas before being pruned.
352 /** Holds the server name of the local server
353 * as defined by the administrator.
355 char ServerName[MAXBUF];
357 /** Notice to give to users when they are Xlined
359 char MoronBanner[MAXBUF];
361 /* Holds the network name the local server
362 * belongs to. This is an arbitary field defined
363 * by the administrator.
365 char Network[MAXBUF];
367 /** Holds the description of the local server
368 * as defined by the administrator.
370 char ServerDesc[MAXBUF];
372 /** Holds the admin's name, for output in
373 * the /ADMIN command.
375 char AdminName[MAXBUF];
377 /** Holds the email address of the admin,
378 * for output in the /ADMIN command.
380 char AdminEmail[MAXBUF];
382 /** Holds the admin's nickname, for output
383 * in the /ADMIN command
385 char AdminNick[MAXBUF];
387 /** The admin-configured /DIE password
389 char diepass[MAXBUF];
391 /** The admin-configured /RESTART password
393 char restartpass[MAXBUF];
395 /** The hash method for *BOTH* the die and restart passwords.
397 char powerhash[MAXBUF];
399 /** The pathname and filename of the message of the
400 * day file, as defined by the administrator.
404 /** The pathname and filename of the rules file,
405 * as defined by the administrator.
409 /** The quit prefix in use, or an empty string
411 char PrefixQuit[MAXBUF];
413 /** The quit suffix in use, or an empty string
415 char SuffixQuit[MAXBUF];
417 /** The fixed quit message in use, or an empty string
419 char FixedQuit[MAXBUF];
421 /** The part prefix in use, or an empty string
423 char PrefixPart[MAXBUF];
425 /** The part suffix in use, or an empty string
427 char SuffixPart[MAXBUF];
429 /** The fixed part message in use, or an empty string
431 char FixedPart[MAXBUF];
433 /** The last string found within a <die> tag, or
436 char DieValue[MAXBUF];
438 /** The DNS server to use for DNS queries
440 char DNSServer[MAXBUF];
442 /** Pretend disabled commands don't exist.
444 bool DisabledDontExist;
446 /** This variable contains a space-seperated list
447 * of commands which are disabled by the
448 * administrator of the server for non-opers.
450 char DisabledCommands[MAXBUF];
452 /** This variable identifies which usermodes have been diabled.
455 char DisabledUModes[64];
457 /** This variable identifies which chanmodes have been disabled.
459 char DisabledCModes[64];
461 /** The full path to the modules directory.
462 * This is either set at compile time, or
463 * overridden in the configuration file via
468 /** The full pathname to the executable, as
469 * given in argv[0] when the program starts.
471 char MyExecutable[1024];
473 /** The file handle of the logfile. If this
474 * value is NULL, the log file is not open,
475 * probably due to a permissions error on
476 * startup (this should not happen in normal
481 /** If this value is true, the owner of the
482 * server specified -nofork on the command
483 * line, causing the daemon to stay in the
488 /** If this value if true then all log
489 * messages will be output, regardless of
490 * the level given in the config file.
491 * This is set with the -debug commandline
496 /** If this is true then log output will be
497 * written to the logfile. This is the default.
498 * If you put -nolog on the commandline then
499 * the logfile will not be written.
500 * This is meant to be used in conjunction with
501 * -debug for debugging without filling up the
506 /** If this value is true, halfops have been
507 * enabled in the configuration file.
511 /** If this is set to true, then mode lists (e.g
512 * MODE #chan b) are hidden from unprivileged
515 bool HideModeLists[256];
517 /** If this is set to true, then channel operators
518 * are exempt from this channel mode. Used for +Sc etc.
520 bool ExemptChanOps[256];
522 /** The number of seconds the DNS subsystem
523 * will wait before timing out any request.
527 /** The size of the read() buffer in the user
528 * handling code, used to read data into a user's
533 /** The value to be used for listen() backlogs
538 /** The soft limit value assigned to the irc server.
539 * The IRC server will not allow more than this
540 * number of local users.
542 unsigned int SoftLimit;
544 /** Maximum number of targets for a multi target command
545 * such as PRIVMSG or KICK
547 unsigned int MaxTargets;
549 /** The maximum number of /WHO results allowed
550 * in any single /WHO command.
554 /** True if the DEBUG loglevel is selected.
558 /** How many seconds to wait before exiting
559 * the program when /DIE is correctly issued.
563 /** True if we're going to hide netsplits as *.net *.split for non-opers
567 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
572 /** Announce invites to the channel with a server notice
574 InviteAnnounceState AnnounceInvites;
576 /** If this is enabled then operators will
577 * see invisible (+i) channels in /whois.
581 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
583 char HideWhoisServer[MAXBUF];
585 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
587 char HideKillsServer[MAXBUF];
589 /** The MOTD file, cached in a file_cache type.
593 /** The RULES file, cached in a file_cache type.
597 /** The full pathname and filename of the PID
598 * file as defined in the configuration.
602 /** The connect classes in use by the IRC server.
606 /** A list of the classes for listening client ports
608 std::vector<ListenSocket*> ports;
610 /** The 005 tokens of this server (ISUPPORT)
611 * populated/repopulated upon loading or unloading
618 std::vector<std::string> isupport;
620 /** STATS characters in this list are available
623 char UserStats[MAXBUF];
625 /** The path and filename of the ircd.log file
629 /** Default channel modes
631 char DefaultModes[MAXBUF];
633 /** Custom version string, which if defined can replace the system info in VERSION.
635 char CustomVersion[MAXBUF];
637 /** List of u-lined servers
639 std::map<irc::string, bool> ulines;
641 /** Max banlist sizes for channels (the std::string is a glob)
643 std::map<std::string, int> maxbans;
645 /** Directory where the inspircd binary resides
649 /** If set to true, no user DNS lookups are to be performed
653 /** If set to true, provide syntax hints for unknown commands
657 /** If set to true, users appear to quit then rejoin when their hosts change.
658 * This keeps clients synchronized properly.
662 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
663 * added to the outgoing text for undernet style msg prefixing.
665 bool UndernetMsgPrefix;
667 /** If set to true, the full nick!user@host will be shown in the TOPIC command
668 * for who set the topic last. If false, only the nick is shown.
670 bool FullHostInTopic;
672 /** All oper type definitions from the config file
674 opertype_t opertypes;
676 /** All oper class definitions from the config file
678 operclass_t operclass;
680 /** Saved argv from startup
684 /** Saved argc from startup
688 /** Max channels per user
690 unsigned int MaxChans;
692 /** Oper max channels per user
694 unsigned int OperMaxChans;
696 /** TS6-like server ID.
697 * NOTE: 000...999 are usable for InspIRCd servers. This
698 * makes code simpler. 0AA, 1BB etc with letters are reserved
703 /** True if we have been told to run the testsuite from the commandline,
704 * rather than entering the mainloop.
708 /** Construct a new ServerConfig
710 ServerConfig(InspIRCd* Instance);
712 /** Clears the include stack in preperation for a Read() call.
716 /** Get server ID as string with required leading zeroes
718 std::string GetSID();
720 /** Update the 005 vector
724 /** Send the 005 numerics (ISUPPORT) to a user
726 void Send005(User* user);
728 /** Read the entire configuration into memory
729 * and initialize this class. All other methods
730 * should be used only by the core.
732 void Read(bool bail, User* user);
734 /** Read a file into a file_cache object
736 bool ReadFile(file_cache &F, const char* fname);
738 /* Returns true if the given string starts with a windows drive letter
740 bool StartsWithWindowsDriveLetter(const std::string &path);
742 /** Report a configuration error given in errormessage.
743 * @param bail If this is set to true, the error is sent to the console, and the program exits
744 * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
745 * this user as SNOTICEs.
746 * If the parameter is NULL, the messages are spooled to all opers.
748 void ReportConfigError(const std::string &errormessage, bool bail, User* user);
750 /** Load 'filename' into 'target', with the new config parser everything is parsed into
751 * tag/key/value at load-time rather than at read-value time.
753 bool LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream);
755 /** Load 'filename' into 'target', with the new config parser everything is parsed into
756 * tag/key/value at load-time rather than at read-value time.
758 bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
760 /* Both these return true if the value existed or false otherwise */
762 /** Writes 'length' chars into 'result' as a string
764 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
765 /** Writes 'length' chars into 'result' as a string
767 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
769 /** Writes 'length' chars into 'result' as a string
771 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
772 /** Writes 'length' chars into 'result' as a string
774 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);
776 /** Tries to convert the value to an integer and write it to 'result'
778 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
779 /** Tries to convert the value to an integer and write it to 'result'
781 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
782 /** Tries to convert the value to an integer and write it to 'result'
784 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
785 /** Tries to convert the value to an integer and write it to 'result'
787 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
789 /** Returns true if the value exists and has a true value, false otherwise
791 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
792 /** Returns true if the value exists and has a true value, false otherwise
794 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
795 /** Returns true if the value exists and has a true value, false otherwise
797 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
798 /** Returns true if the value exists and has a true value, false otherwise
800 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
802 /** Returns the number of occurences of tag in the config file
804 int ConfValueEnum(ConfigDataHash &target, const char* tag);
805 /** Returns the number of occurences of tag in the config file
807 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
809 /** Returns the numbers of vars inside the index'th 'tag in the config file
811 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
812 /** Returns the numbers of vars inside the index'th 'tag in the config file
814 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
816 void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
818 void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
820 void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
822 /** Returns the fully qualified path to the inspircd directory
823 * @return The full program directory
825 std::string GetFullProgDir();
827 /** Returns true if a directory is valid (within the modules directory).
828 * @param dirandfile The directory and filename to check
829 * @return True if the directory is valid
831 static bool DirValid(const char* dirandfile);
833 /** Clean a filename, stripping the directories (and drives) from string.
834 * @param name Directory to tidy
835 * @return The cleaned filename
837 static char* CleanFilename(char* name);
839 /** Check if a file exists.
840 * @param file The full path to a file
841 * @return True if the file exists and is readable.
843 static bool FileExists(const char* file);
845 /** If this value is true, invites will bypass more than just +i
851 /** Initialize the disabled commands list
853 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
855 /** Initialize the oper types
857 bool InitTypes(ServerConfig* conf, const char* tag);
859 /** Initialize the oper classes
861 bool InitClasses(ServerConfig* conf, const char* tag);
863 /** Initialize an oper type
865 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
867 /** Initialize an oper class
869 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
871 /** Finish initializing the oper types and classes
873 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
877 /** Initialize x line
879 bool InitXLine(ServerConfig* conf, const char* tag);
881 /** Add a config-defined zline
883 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
885 /** Add a config-defined qline
887 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
889 /** Add a config-defined kline
891 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
893 /** Add a config-defined eline
895 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);