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 /** Holds a config value, either string, integer or boolean.
57 * Callback functions receive one or more of these, either on
58 * their own as a reference, or in a reference to a deque of them.
59 * The callback function can then alter the values of the ValueItem
60 * classes to validate the settings.
67 /** Initialize with an int */
69 /** Initialize with a bool */
70 ValueItem(bool value);
71 /** Initialize with a char pointer */
72 ValueItem(const char* value);
73 /** Change value to a char pointer */
74 void Set(const char* val);
75 /** Change value to an int */
77 /** Get value as an int */
79 /** Get value as a string */
81 /** Get value as a bool */
85 /** The base class of the container 'ValueContainer'
86 * used internally by the core to hold core values.
88 class ValueContainerBase
92 ValueContainerBase() { }
94 virtual ~ValueContainerBase() { }
97 /** ValueContainer is used to contain pointers to different
98 * core values such as the server name, maximum number of
100 * It is specialized to hold a data type, then pointed at
101 * a value in the ServerConfig class. When the value has been
102 * read and validated, the Set method is called to write the
103 * value safely in a type-safe manner.
105 template<typename T> class ValueContainer : public ValueContainerBase
107 /** Contained item */
111 /** Initialize with nothing */
117 /** Initialize with a value of type T */
118 ValueContainer(T Val)
123 /** Change value to type T of size s */
124 void Set(T newval, size_t s)
126 memcpy(val, newval, s);
130 /** A specialization of ValueContainer to hold a pointer to a bool
132 typedef ValueContainer<bool*> ValueContainerBool;
134 /** A specialization of ValueContainer to hold a pointer to
137 typedef ValueContainer<unsigned int*> ValueContainerUInt;
139 /** A specialization of ValueContainer to hold a pointer to
142 typedef ValueContainer<char*> ValueContainerChar;
144 /** A specialization of ValueContainer to hold a pointer to
147 typedef ValueContainer<int*> ValueContainerInt;
149 /** A set of ValueItems used by multi-value validator functions
151 typedef std::deque<ValueItem> ValueList;
153 /** A callback for validating a single value
155 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
156 /** A callback for validating multiple value entries
158 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
159 /** A callback indicating the end of a group of entries
161 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
163 /** Holds a core configuration item and its callbacks
171 /** Default, if not defined */
172 const char* default_value;
173 /** Value containers */
174 ValueContainerBase* val;
177 /** Validation function */
178 Validator validation_function;
181 /** Holds a core configuration item and its callbacks
182 * where there may be more than one item
188 /** One or more items within tag */
189 const char* items[18];
190 /** One or more defaults for items within tags */
191 const char* items_default[18];
192 /** One or more data types */
194 /** Initialization function */
195 MultiNotify init_function;
196 /** Validation function */
197 MultiValidator validation_function;
198 /** Completion function */
199 MultiNotify finish_function;
202 /** A set of oper types
204 typedef std::map<irc::string,char*> opertype_t;
206 struct operclass_data : public Extensible
213 /** A Set of oper classes
215 typedef std::map<irc::string, operclass_data> operclass_t;
218 /** This class holds the bulk of the runtime configuration for the ircd.
219 * It allows for reading new config values, accessing configuration files,
220 * and storage of the configuration data needed to run the ircd, such as
221 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
223 class CoreExport ServerConfig : public Extensible
226 /** Creator/owner pointer
228 InspIRCd* ServerInstance;
230 /** This variable holds the names of all
231 * files included from the main one. This
232 * is used to make sure that no files are
233 * recursively included.
235 std::vector<std::string> include_stack;
237 /** This private method processes one line of
238 * configutation, appending errors to errorstream
239 * and setting error if an error has occured.
241 bool ParseLine(ConfigDataHash &target, std::string &line, long &linenumber, std::ostringstream &errorstream);
243 /** Check that there is only one of each configuration item
245 bool CheckOnce(const char* tag);
249 /** Process an include executable directive
251 bool DoPipe(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
253 /** Process an include file directive
255 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
259 std::string RehashParameter;
261 std::ostringstream errstr;
263 ConfigDataHash newconfig;
265 std::map<std::string, std::istream*> IncludedFiles;
267 std::map<std::string, bool> CompletedFiles;
269 size_t TotalDownloaded;
272 /** Used to indicate who we announce invites to on a channel */
273 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
275 /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
276 Validator DNSServerValidator;
278 InspIRCd* GetInstance();
282 /** This holds all the information in the config file,
283 * it's indexed by tag name to a vector of key/values.
285 ConfigDataHash config_data;
287 /** Max number of WhoWas entries per user.
291 /** Max number of cumulative user-entries in WhoWas.
292 * When max reached and added to, push out oldest entry FIFO style.
296 /** Max seconds a user is kept in WhoWas before being pruned.
300 /** Holds the server name of the local server
301 * as defined by the administrator.
303 char ServerName[MAXBUF];
305 /** Notice to give to users when they are Xlined
307 char MoronBanner[MAXBUF];
309 /* Holds the network name the local server
310 * belongs to. This is an arbitary field defined
311 * by the administrator.
313 char Network[MAXBUF];
315 /** Holds the description of the local server
316 * as defined by the administrator.
318 char ServerDesc[MAXBUF];
320 /** Holds the admin's name, for output in
321 * the /ADMIN command.
323 char AdminName[MAXBUF];
325 /** Holds the email address of the admin,
326 * for output in the /ADMIN command.
328 char AdminEmail[MAXBUF];
330 /** Holds the admin's nickname, for output
331 * in the /ADMIN command
333 char AdminNick[MAXBUF];
335 /** The admin-configured /DIE password
337 char diepass[MAXBUF];
339 /** The admin-configured /RESTART password
341 char restartpass[MAXBUF];
343 /** The hash method for *BOTH* the die and restart passwords.
345 char powerhash[MAXBUF];
347 /** The pathname and filename of the message of the
348 * day file, as defined by the administrator.
352 /** The pathname and filename of the rules file,
353 * as defined by the administrator.
357 /** The quit prefix in use, or an empty string
359 char PrefixQuit[MAXBUF];
361 /** The quit suffix in use, or an empty string
363 char SuffixQuit[MAXBUF];
365 /** The fixed quit message in use, or an empty string
367 char FixedQuit[MAXBUF];
369 /** The part prefix in use, or an empty string
371 char PrefixPart[MAXBUF];
373 /** The part suffix in use, or an empty string
375 char SuffixPart[MAXBUF];
377 /** The fixed part message in use, or an empty string
379 char FixedPart[MAXBUF];
381 /** The last string found within a <die> tag, or
384 char DieValue[MAXBUF];
386 /** The DNS server to use for DNS queries
388 char DNSServer[MAXBUF];
390 /** This variable contains a space-seperated list
391 * of commands which are disabled by the
392 * administrator of the server for non-opers.
394 char DisabledCommands[MAXBUF];
396 /** The full path to the modules directory.
397 * This is either set at compile time, or
398 * overridden in the configuration file via
403 /** The full pathname to the executable, as
404 * given in argv[0] when the program starts.
406 char MyExecutable[1024];
408 /** The file handle of the logfile. If this
409 * value is NULL, the log file is not open,
410 * probably due to a permissions error on
411 * startup (this should not happen in normal
416 /** If this value is true, the owner of the
417 * server specified -nofork on the command
418 * line, causing the daemon to stay in the
423 /** If this value if true then all log
424 * messages will be output, regardless of
425 * the level given in the config file.
426 * This is set with the -debug commandline
431 /** If this is true then log output will be
432 * written to the logfile. This is the default.
433 * If you put -nolog on the commandline then
434 * the logfile will not be written.
435 * This is meant to be used in conjunction with
436 * -debug for debugging without filling up the
441 /** If this value is true, halfops have been
442 * enabled in the configuration file.
446 /** If this is set to true, then mode lists (e.g
447 * MODE #chan b) are hidden from unprivileged
450 bool HideModeLists[256];
452 /** If this is set to true, then channel operators
453 * are exempt from this channel mode. Used for +Sc etc.
455 bool ExemptChanOps[256];
457 /** The number of seconds the DNS subsystem
458 * will wait before timing out any request.
462 /** The size of the read() buffer in the user
463 * handling code, used to read data into a user's
468 /** The value to be used for listen() backlogs
473 /** The soft limit value assigned to the irc server.
474 * The IRC server will not allow more than this
475 * number of local users.
477 unsigned int SoftLimit;
479 /** Maximum number of targets for a multi target command
480 * such as PRIVMSG or KICK
482 unsigned int MaxTargets;
484 /** The maximum number of /WHO results allowed
485 * in any single /WHO command.
489 /** True if the DEBUG loglevel is selected.
493 /** The loglevel in use by the IRC server
497 /** How many seconds to wait before exiting
498 * the program when /DIE is correctly issued.
502 /** True if we're going to hide netsplits as *.net *.split for non-opers
506 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
511 /** Announce invites to the channel with a server notice
513 InviteAnnounceState AnnounceInvites;
515 /** If this is enabled then operators will
516 * see invisible (+i) channels in /whois.
520 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
522 char HideWhoisServer[MAXBUF];
524 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
526 char HideKillsServer[MAXBUF];
528 /** The MOTD file, cached in a file_cache type.
532 /** The RULES file, cached in a file_cache type.
536 /** The full pathname and filename of the PID
537 * file as defined in the configuration.
541 /** The connect classes in use by the IRC server.
545 /** A list of the classes for listening client ports
547 std::vector<ListenSocket*> ports;
549 /** socket objects that are attached to by modules
551 std::map<BufferedSocket*, Module*> SocketIOHookModule;
553 /** The 005 tokens of this server (ISUPPORT)
554 * populated/repopulated upon loading or unloading
561 std::vector<std::string> isupport;
563 /** STATS characters in this list are available
566 char UserStats[MAXBUF];
568 /** The path and filename of the ircd.log file
572 /** Default channel modes
574 char DefaultModes[MAXBUF];
576 /** Custom version string, which if defined can replace the system info in VERSION.
578 char CustomVersion[MAXBUF];
580 /** List of u-lined servers
582 std::map<irc::string, bool> ulines;
584 /** Max banlist sizes for channels (the std::string is a glob)
586 std::map<std::string, int> maxbans;
588 /** Directory where the inspircd binary resides
592 /** If set to true, no user DNS lookups are to be performed
596 /** If set to true, provide syntax hints for unknown commands
600 /** If set to true, users appear to quit then rejoin when their hosts change.
601 * This keeps clients synchronized properly.
605 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
606 * added to the outgoing text for undernet style msg prefixing.
608 bool UndernetMsgPrefix;
610 /** If set to true, the full nick!user@host will be shown in the TOPIC command
611 * for who set the topic last. If false, only the nick is shown.
613 bool FullHostInTopic;
615 /** All oper type definitions from the config file
617 opertype_t opertypes;
619 /** All oper class definitions from the config file
621 operclass_t operclass;
623 /** Saved argv from startup
627 /** Saved argc from startup
631 /** Max channels per user
633 unsigned int MaxChans;
635 /** Oper max channels per user
637 unsigned int OperMaxChans;
639 /** TS6-like server ID.
640 * NOTE: 000...999 are usable for InspIRCd servers. This
641 * makes code simpler. 0AA, 1BB etc with letters are reserved
646 /** True if we have been told to run the testsuite from the commandline,
647 * rather than entering the mainloop.
651 /** Construct a new ServerConfig
653 ServerConfig(InspIRCd* Instance);
655 /** Clears the include stack in preperation for a Read() call.
659 /** Get server ID as string with required leading zeroes
661 std::string GetSID();
663 /** Update the 005 vector
667 /** Send the 005 numerics (ISUPPORT) to a user
669 void Send005(User* user);
671 /** Read the entire configuration into memory
672 * and initialize this class. All other methods
673 * should be used only by the core.
675 void Read(bool bail, User* user);
677 /** Read a file into a file_cache object
679 bool ReadFile(file_cache &F, const char* fname);
681 /** Report a configuration error given in errormessage.
682 * @param bail If this is set to true, the error is sent to the console, and the program exits
683 * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
684 * this user as SNOTICEs.
685 * If the parameter is NULL, the messages are spooled to all opers.
687 void ReportConfigError(const std::string &errormessage, bool bail, User* user);
689 /** Load 'filename' into 'target', with the new config parser everything is parsed into
690 * tag/key/value at load-time rather than at read-value time.
692 bool LoadConf(ConfigDataHash &target, FILE* &conf, const char* filename, std::ostringstream &errorstream);
694 /** Load 'filename' into 'target', with the new config parser everything is parsed into
695 * tag/key/value at load-time rather than at read-value time.
697 bool LoadConf(ConfigDataHash &target, FILE* &conf, const std::string &filename, std::ostringstream &errorstream);
699 /* Both these return true if the value existed or false otherwise */
701 /** Writes 'length' chars into 'result' as a string
703 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
704 /** Writes 'length' chars into 'result' as a string
706 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
708 /** Writes 'length' chars into 'result' as a string
710 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
711 /** Writes 'length' chars into 'result' as a string
713 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);
715 /** Tries to convert the value to an integer and write it to 'result'
717 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
718 /** Tries to convert the value to an integer and write it to 'result'
720 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
721 /** Tries to convert the value to an integer and write it to 'result'
723 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
724 /** Tries to convert the value to an integer and write it to 'result'
726 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
728 /** Returns true if the value exists and has a true value, false otherwise
730 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
731 /** Returns true if the value exists and has a true value, false otherwise
733 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
734 /** Returns true if the value exists and has a true value, false otherwise
736 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
737 /** Returns true if the value exists and has a true value, false otherwise
739 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
741 /** Returns the number of occurences of tag in the config file
743 int ConfValueEnum(ConfigDataHash &target, const char* tag);
744 /** Returns the number of occurences of tag in the config file
746 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
748 /** Returns the numbers of vars inside the index'th 'tag in the config file
750 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
751 /** Returns the numbers of vars inside the index'th 'tag in the config file
753 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
755 void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
757 void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
759 void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
761 /** Get a pointer to the module which has hooked the given BufferedSocket class.
762 * @parameter port Port number
763 * @return Returns a pointer to the hooking module, or NULL
765 Module* GetIOHook(BufferedSocket* is);
767 /** Hook a module to an BufferedSocket class, so that it can receive notifications
768 * of low-level socket activity.
769 * @param iomod The module to hook to the socket
770 * @param is The BufferedSocket to attach to
771 * @return True if the hook was successful.
773 bool AddIOHook(Module* iomod, BufferedSocket* is);
775 /** Delete a module hook from an BufferedSocket.
776 * @param is The BufferedSocket to detatch from.
777 * @return True if the unhook was successful
779 bool DelIOHook(BufferedSocket* is);
781 /** Returns the fully qualified path to the inspircd directory
782 * @return The full program directory
784 std::string GetFullProgDir();
786 /** Returns true if a directory is valid (within the modules directory).
787 * @param dirandfile The directory and filename to check
788 * @return True if the directory is valid
790 static bool DirValid(const char* dirandfile);
792 /** Clean a filename, stripping the directories (and drives) from string.
793 * @param name Directory to tidy
794 * @return The cleaned filename
796 static char* CleanFilename(char* name);
798 /** Check if a file exists.
799 * @param file The full path to a file
800 * @return True if the file exists and is readable.
802 static bool FileExists(const char* file);
806 /** Initialize the disabled commands list
808 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
810 /** Initialize the oper types
812 bool InitTypes(ServerConfig* conf, const char* tag);
814 /** Initialize the oper classes
816 bool InitClasses(ServerConfig* conf, const char* tag);
818 /** Initialize an oper type
820 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
822 /** Initialize an oper class
824 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
826 /** Finish initializing the oper types and classes
828 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
832 /** Initialize x line
834 bool InitXLine(ServerConfig* conf, const char* tag);
836 /** Add a config-defined zline
838 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
840 /** Add a config-defined qline
842 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
844 /** Add a config-defined kline
846 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
848 /** Add a config-defined eline
850 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);