1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/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(m) (ServerInstance->Config->ExemptChanOps[(unsigned char)m])
30 #include "socketengine.h"
33 /* Required forward definitions */
39 /** A set of oper types
41 typedef std::map<irc::string,std::string> opertype_t;
43 /** Holds an oper class.
45 struct operclass_data : public classbase
47 /** Command list for the class
49 std::string commandlist;
51 /** Channel mode list for the class
53 std::string cmodelist;
55 /** User mode list for the class
57 std::string umodelist;
59 /** Priviledges given by this class
64 /** A Set of oper classes
66 typedef std::map<irc::string, operclass_data> operclass_t;
68 /** Defines the server's length limits on various length-limited
69 * items such as topics, nicknames, channel names etc.
74 /** Maximum nickname length */
76 /** Maximum channel length */
78 /** Maximum number of modes per line */
80 /** Maximum length of ident, not including ~ etc */
82 /** Maximum length of a quit message */
84 /** Maximum topic length */
86 /** Maximum kick message length */
88 /** Maximum GECOS (real name) length */
90 /** Maximum away message length */
93 /** Creating the class initialises it to the defaults
94 * as in 1.1's ./configure script. Reading other values
95 * from the config will change these values.
97 ServerLimits() : NickMax(31), ChanMax(64), MaxModes(20), IdentMax(12), MaxQuit(255), MaxTopic(307), MaxKick(255), MaxGecos(128), MaxAway(200)
101 /** Finalises the settings by adding one. This allows for them to be used as-is
102 * without a 'value+1' when using the std::string assignment methods etc.
117 /** This class holds the bulk of the runtime configuration for the ircd.
118 * It allows for reading new config values, accessing configuration files,
119 * and storage of the configuration data needed to run the ircd, such as
120 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
122 class CoreExport ServerConfig : public classbase
125 /** This variable holds the names of all
126 * files included from the main one. This
127 * is used to make sure that no files are
128 * recursively included.
130 std::vector<std::string> include_stack;
132 /* classes removed by this rehash */
133 std::vector<ConnectClass*> removed_classes;
135 /** This private method processes one line of
136 * configutation, appending errors to errorstream
137 * and setting error if an error has occured.
139 bool ParseLine(const std::string &filename, std::string &line, long &linenumber, bool allowexeinc);
141 /** Check that there is only one of each configuration item
143 bool CheckOnce(const char* tag);
145 void CrossCheckOperClassType();
146 void CrossCheckConnectBlocks(ServerConfig* current);
149 /** Process an include executable directive
151 bool DoPipe(const std::string &file);
153 /** Process an include file directive
155 bool DoInclude(const std::string &file, bool allowexeinc);
157 /** Error stream, contains error output from any failed configuration parsing.
159 std::stringstream errstr;
161 /** True if this configuration is valid enough to run with */
164 /** Set of included files. Do we use this any more?
166 std::map<std::string, std::istream*> IncludedFiles;
168 /** Used to indicate who we announce invites to on a channel */
169 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
171 /** Not used any more as it is named, can probably be removed or renamed.
175 /** This holds all the information in the config file,
176 * it's indexed by tag name to a vector of key/values.
178 ConfigDataHash config_data;
180 /** Length limits, see definition of ServerLimits class
184 /** Clones CIDR range for ipv4 (0-32)
185 * Defaults to 32 (checks clones on all IPs seperately)
189 /** Clones CIDR range for ipv6 (0-128)
190 * Defaults to 128 (checks on all IPs seperately)
194 /** Max number of WhoWas entries per user.
198 /** Max number of cumulative user-entries in WhoWas.
199 * When max reached and added to, push out oldest entry FIFO style.
203 /** Max seconds a user is kept in WhoWas before being pruned.
207 /** Both for set(g|u)id.
210 std::string SetGroup;
212 /** Holds the server name of the local server
213 * as defined by the administrator.
215 std::string ServerName;
217 /** Notice to give to users when they are Xlined
219 std::string MoronBanner;
221 /* Holds the network name the local server
222 * belongs to. This is an arbitary field defined
223 * by the administrator.
227 /** Holds the description of the local server
228 * as defined by the administrator.
230 std::string ServerDesc;
232 /** Holds the admin's name, for output in
233 * the /ADMIN command.
235 std::string AdminName;
237 /** Holds the email address of the admin,
238 * for output in the /ADMIN command.
240 std::string AdminEmail;
242 /** Holds the admin's nickname, for output
243 * in the /ADMIN command
245 std::string AdminNick;
247 /** The admin-configured /DIE password
251 /** The admin-configured /RESTART password
253 std::string restartpass;
255 /** The hash method for *BOTH* the die and restart passwords.
257 std::string powerhash;
259 /** The pathname and filename of the message of the
260 * day file, as defined by the administrator.
264 /** The pathname and filename of the rules file,
265 * as defined by the administrator.
269 /** The quit prefix in use, or an empty string
271 std::string PrefixQuit;
273 /** The quit suffix in use, or an empty string
275 std::string SuffixQuit;
277 /** The fixed quit message in use, or an empty string
279 std::string FixedQuit;
281 /** The part prefix in use, or an empty string
283 std::string PrefixPart;
285 /** The part suffix in use, or an empty string
287 std::string SuffixPart;
289 /** The fixed part message in use, or an empty string
291 std::string FixedPart;
293 /** The last string found within a <die> tag, or
296 std::string DieValue;
298 /** The DNS server to use for DNS queries
300 std::string DNSServer;
302 /** Pretend disabled commands don't exist.
304 bool DisabledDontExist;
306 /** This variable contains a space-seperated list
307 * of commands which are disabled by the
308 * administrator of the server for non-opers.
310 std::string DisabledCommands;
312 /** This variable identifies which usermodes have been diabled.
315 char DisabledUModes[64];
317 /** This variable identifies which chanmodes have been disabled.
319 char DisabledCModes[64];
321 /** The full path to the modules directory.
322 * This is either set at compile time, or
323 * overridden in the configuration file via
328 /** The full pathname to the executable, as
329 * given in argv[0] when the program starts.
331 std::string MyExecutable;
333 /** The file handle of the logfile. If this
334 * value is NULL, the log file is not open,
335 * probably due to a permissions error on
336 * startup (this should not happen in normal
341 /** If this value is true, the owner of the
342 * server specified -nofork on the command
343 * line, causing the daemon to stay in the
348 /** If this value if true then all log
349 * messages will be output, regardless of
350 * the level given in the config file.
351 * This is set with the -debug commandline
356 /** If this is true then log output will be
357 * written to the logfile. This is the default.
358 * If you put -nolog on the commandline then
359 * the logfile will not be written.
360 * This is meant to be used in conjunction with
361 * -debug for debugging without filling up the
366 /** If set to true, then all opers on this server are
367 * shown with a generic 'is an IRC operator' line rather
368 * than the oper type. Oper types are still used internally.
372 /** If this value is true, banned users (+b, not extbans) will not be able to change nick
373 * if banned on any channel, nor to message them.
375 bool RestrictBannedUsers;
377 /** If this value is true, halfops have been
378 * enabled in the configuration file.
382 /** If this is set to true, then mode lists (e.g
383 * MODE #chan b) are hidden from unprivileged
386 bool HideModeLists[256];
388 /** If this is set to true, then channel operators
389 * are exempt from this channel mode. Used for +Sc etc.
391 bool ExemptChanOps[256];
393 /** The number of seconds the DNS subsystem
394 * will wait before timing out any request.
398 /** The size of the read() buffer in the user
399 * handling code, used to read data into a user's
404 /** The value to be used for listen() backlogs
409 /** The soft limit value assigned to the irc server.
410 * The IRC server will not allow more than this
411 * number of local users.
413 unsigned int SoftLimit;
415 /** Maximum number of targets for a multi target command
416 * such as PRIVMSG or KICK
418 unsigned int MaxTargets;
420 /** The maximum number of /WHO results allowed
421 * in any single /WHO command.
425 /** True if the DEBUG loglevel is selected.
429 /** How many seconds to wait before exiting
430 * the program when /DIE is correctly issued.
434 /** True if we're going to hide netsplits as *.net *.split for non-opers
438 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
443 /** Announce invites to the channel with a server notice
445 InviteAnnounceState AnnounceInvites;
447 /** If this is enabled then operators will
448 * see invisible (+i) channels in /whois.
452 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
454 std::string HideWhoisServer;
456 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
458 std::string HideKillsServer;
460 /** The MOTD file, cached in a file_cache type.
464 /** The RULES file, cached in a file_cache type.
468 /** The full pathname and filename of the PID
469 * file as defined in the configuration.
473 /** The connect classes in use by the IRC server.
477 /** The 005 tokens of this server (ISUPPORT)
478 * populated/repopulated upon loading or unloading
485 std::vector<std::string> isupport;
487 /** STATS characters in this list are available
490 std::string UserStats;
492 /** The path and filename of the ircd.log file
496 /** Default channel modes
498 std::string DefaultModes;
500 /** Custom version string, which if defined can replace the system info in VERSION.
502 std::string CustomVersion;
504 /** List of u-lined servers
506 std::map<irc::string, bool> ulines;
508 /** Max banlist sizes for channels (the std::string is a glob)
510 std::map<std::string, int> maxbans;
512 /** Directory where the inspircd binary resides
516 /** If set to true, no user DNS lookups are to be performed
520 /** If set to true, provide syntax hints for unknown commands
524 /** If set to true, users appear to quit then rejoin when their hosts change.
525 * This keeps clients synchronized properly.
529 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
530 * added to the outgoing text for undernet style msg prefixing.
532 bool UndernetMsgPrefix;
534 /** If set to true, the full nick!user@host will be shown in the TOPIC command
535 * for who set the topic last. If false, only the nick is shown.
537 bool FullHostInTopic;
539 /** All oper type definitions from the config file
541 opertype_t opertypes;
543 /** All oper class definitions from the config file
545 operclass_t operclass;
547 /** Saved argv from startup
551 /** Saved argc from startup
555 /** Max channels per user
557 unsigned int MaxChans;
559 /** Oper max channels per user
561 unsigned int OperMaxChans;
563 /** TS6-like server ID.
564 * NOTE: 000...999 are usable for InspIRCd servers. This
565 * makes code simpler. 0AA, 1BB etc with letters are reserved
570 /** True if we have been told to run the testsuite from the commandline,
571 * rather than entering the mainloop.
575 /** Construct a new ServerConfig
579 /** Get server ID as string with required leading zeroes
581 std::string GetSID();
583 /** Update the 005 vector
587 /** Send the 005 numerics (ISUPPORT) to a user
589 void Send005(User* user);
591 /** Read the entire configuration into memory
592 * and initialize this class. All other methods
593 * should be used only by the core.
597 /** Apply configuration changes from the old configuration.
599 void Apply(ServerConfig* old, const std::string &useruid);
600 void ApplyModules(User* user);
602 /** Read a file into a file_cache object
604 bool ReadFile(file_cache &F, const char* fname);
606 /* Returns true if the given string starts with a windows drive letter
608 bool StartsWithWindowsDriveLetter(const std::string &path);
610 /** Load 'filename' into 'target', with the new config parser everything is parsed into
611 * tag/key/value at load-time rather than at read-value time.
613 bool LoadConf(FILE* &conf, const char* filename, bool allowexeinc);
615 /** Load 'filename' into 'target', with the new config parser everything is parsed into
616 * tag/key/value at load-time rather than at read-value time.
618 bool LoadConf(FILE* &conf, const std::string &filename, bool allowexeinc);
620 /** Writes 'length' chars into 'result' as a string
622 bool ConfValue(const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
624 /** Writes 'length' chars into 'result' as a string
626 bool ConfValue(const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
628 /** Writes 'length' chars into 'result' as a string
630 bool ConfValue(const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
632 /** Writes 'length' chars into 'result' as a string
634 bool ConfValue(const std::string &tag, const std::string &var, const std::string &default_value, int index, std::string &result, bool allow_linefeeds = false);
636 /** Tries to convert the value to an integer and write it to 'result'
638 bool ConfValueInteger(const char* tag, const char* var, int index, int &result);
640 /** Tries to convert the value to an integer and write it to 'result'
642 bool ConfValueInteger(const char* tag, const char* var, const char* default_value, int index, int &result);
644 /** Tries to convert the value to an integer and write it to 'result'
646 bool ConfValueInteger(const std::string &tag, const std::string &var, int index, int &result);
648 /** Tries to convert the value to an integer and write it to 'result'
650 bool ConfValueInteger(const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
652 /** Returns true if the value exists and has a true value, false otherwise
654 bool ConfValueBool(const char* tag, const char* var, int index);
656 /** Returns true if the value exists and has a true value, false otherwise
658 bool ConfValueBool(const char* tag, const char* var, const char* default_value, int index);
660 /** Returns true if the value exists and has a true value, false otherwise
662 bool ConfValueBool(const std::string &tag, const std::string &var, int index);
664 /** Returns true if the value exists and has a true value, false otherwise
666 bool ConfValueBool(const std::string &tag, const std::string &var, const std::string &default_value, int index);
668 /** Returns the number of occurences of tag in the config file
670 int ConfValueEnum(const char* tag);
671 /** Returns the number of occurences of tag in the config file
673 int ConfValueEnum(const std::string &tag);
675 /** Returns the numbers of vars inside the index'th 'tag in the config file
677 int ConfVarEnum(const char* tag, int index);
678 /** Returns the numbers of vars inside the index'th 'tag in the config file
680 int ConfVarEnum(const std::string &tag, int index);
682 bool ApplyDisabledCommands(const std::string& data);
684 /** Returns the fully qualified path to the inspircd directory
685 * @return The full program directory
687 std::string GetFullProgDir();
689 /** Clean a filename, stripping the directories (and drives) from string.
690 * @param name Directory to tidy
691 * @return The cleaned filename
693 static const char* CleanFilename(const char* name);
695 /** Check if a file exists.
696 * @param file The full path to a file
697 * @return True if the file exists and is readable.
699 static bool FileExists(const char* file);
701 /** If this value is true, invites will bypass more than just +i
708 /** Types of data in the core config
712 DT_NOTHING = 0, /* No data */
713 DT_INTEGER = 1, /* Integer */
714 DT_CHARPTR = 2, /* Char pointer */
715 DT_BOOLEAN = 3, /* Boolean */
716 DT_HOSTNAME = 4, /* Hostname syntax */
717 DT_NOSPACES = 5, /* No spaces */
718 DT_IPADDRESS = 6, /* IP address (v4, v6) */
719 DT_CHANNEL = 7, /* Channel name */
720 DT_LIMIT = 8, /* size_t */
721 DT_ALLOW_WILD = 64, /* Allow wildcards/CIDR in DT_IPADDRESS */
722 DT_ALLOW_NEWLINE = 128 /* New line characters allowed in DT_CHARPTR */
725 /** The maximum number of values in a core configuration tag. Can be increased if needed.
727 #define MAX_VALUES_PER_TAG 18
729 /** Holds a config value, either string, integer or boolean.
730 * Callback functions receive one or more of these, either on
731 * their own as a reference, or in a reference to a deque of them.
732 * The callback function can then alter the values of the ValueItem
733 * classes to validate the settings.
740 /** Initialize with an int */
741 ValueItem(int value);
742 /** Initialize with a bool */
743 ValueItem(bool value);
744 /** Initialize with a string */
745 ValueItem(const char* value) : v(value) { }
746 /** Change value to a string */
747 void Set(const std::string &val);
748 /** Change value to an int */
750 /** Get value as an int */
752 /** Get value as a string */
753 const char* GetString() const;
754 /** Get value as a string */
755 inline const std::string& GetValue() const { return v; }
756 /** Get value as a bool */
760 /** The base class of the container 'ValueContainer'
761 * used internally by the core to hold core values.
763 class ValueContainerBase
767 ValueContainerBase() { }
769 virtual ~ValueContainerBase() { }
772 /** ValueContainer is used to contain pointers to different
773 * core values such as the server name, maximum number of
775 * It is specialized to hold a data type, then pointed at
776 * a value in the ServerConfig class. When the value has been
777 * read and validated, the Set method is called to write the
778 * value safely in a type-safe manner.
780 template<typename T> class ValueContainer : public ValueContainerBase
782 T ServerConfig::* const vptr;
784 /** Initialize with a value of type T */
785 ValueContainer(T ServerConfig::* const offset) : vptr(offset)
789 /** Change value to type T of size s */
790 void Set(ServerConfig* conf, const T& value)
795 void Set(ServerConfig* conf, const ValueItem& item);
798 class ValueContainerLimit : public ValueContainerBase
800 size_t ServerLimits::* const vptr;
802 /** Initialize with a value of type T */
803 ValueContainerLimit(size_t ServerLimits::* const offset) : vptr(offset)
807 /** Change value to type T of size s */
808 void Set(ServerConfig* conf, const size_t& value)
810 conf->Limits.*vptr = value;
814 /** A specialization of ValueContainer to hold a pointer to a bool
816 typedef ValueContainer<bool> ValueContainerBool;
818 /** A specialization of ValueContainer to hold a pointer to
821 typedef ValueContainer<unsigned int> ValueContainerUInt;
823 /** A specialization of ValueContainer to hold a pointer to
826 typedef ValueContainer<std::string> ValueContainerString;
828 /** A specialization of ValueContainer to hold a pointer to
831 typedef ValueContainer<int> ValueContainerInt;
833 /** A set of ValueItems used by multi-value validator functions
835 typedef std::deque<ValueItem> ValueList;
837 /** A callback for validating a single value
839 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
840 /** A callback for validating multiple value entries
842 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, const char**, ValueList&, int*);
843 /** A callback indicating the end of a group of entries
845 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
847 /** Holds a core configuration item and its callbacks
855 /** Default, if not defined */
856 const char* default_value;
857 /** Value containers */
858 ValueContainerBase* val;
861 /** Validation function */
862 Validator validation_function;
865 /** Represents a deprecated configuration tag.
875 /** Reason for deprecation
880 /** Holds a core configuration item and its callbacks
881 * where there may be more than one item
887 /** One or more items within tag */
888 const char* items[MAX_VALUES_PER_TAG];
889 /** One or more defaults for items within tags */
890 const char* items_default[MAX_VALUES_PER_TAG];
891 /** One or more data types */
892 int datatype[MAX_VALUES_PER_TAG];
893 /** Validation function */
894 MultiValidator validation_function;