1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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_ALLOW_NEWLINE = 128 /* New line characters allowed */
50 /** Holds a config value, either string, integer or boolean.
51 * Callback functions receive one or more of these, either on
52 * their own as a reference, or in a reference to a deque of them.
53 * The callback function can then alter the values of the ValueItem
54 * classes to validate the settings.
61 /** Initialize with an int */
63 /** Initialize with a bool */
64 ValueItem(bool value);
65 /** Initialize with a char pointer */
66 ValueItem(char* value);
67 /** Change value to a char pointer */
68 void Set(char* value);
69 /** Change value to a const char pointer */
70 void Set(const char* val);
71 /** Change value to an int */
73 /** Get value as an int */
75 /** Get value as a string */
77 /** Get value as a bool */
81 /** The base class of the container 'ValueContainer'
82 * used internally by the core to hold core values.
84 class ValueContainerBase
88 ValueContainerBase() { }
90 virtual ~ValueContainerBase() { }
93 /** ValueContainer is used to contain pointers to different
94 * core values such as the server name, maximum number of
96 * It is specialized to hold a data type, then pointed at
97 * a value in the ServerConfig class. When the value has been
98 * read and validated, the Set method is called to write the
99 * value safely in a type-safe manner.
101 template<typename T> class ValueContainer : public ValueContainerBase
103 /** Contained item */
107 /** Initialize with nothing */
113 /** Initialize with a value of type T */
114 ValueContainer(T Val)
119 /** Change value to type T of size s */
120 void Set(T newval, size_t s)
122 memcpy(val, newval, s);
126 /** A specialization of ValueContainer to hold a pointer to a bool
128 typedef ValueContainer<bool*> ValueContainerBool;
130 /** A specialization of ValueContainer to hold a pointer to
133 typedef ValueContainer<unsigned int*> ValueContainerUInt;
135 /** A specialization of ValueContainer to hold a pointer to
138 typedef ValueContainer<char*> ValueContainerChar;
140 /** A specialization of ValueContainer to hold a pointer to
143 typedef ValueContainer<int*> ValueContainerInt;
145 /** A set of ValueItems used by multi-value validator functions
147 typedef std::deque<ValueItem> ValueList;
149 /** A callback for validating a single value
151 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
152 /** A callback for validating multiple value entries
154 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
155 /** A callback indicating the end of a group of entries
157 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
159 /** Holds a core configuration item and its callbacks
167 /** Default, if not defined */
169 /** Value containers */
170 ValueContainerBase* val;
172 ConfigDataType datatype;
173 /** Validation function */
174 Validator validation_function;
177 /** Holds a core configuration item and its callbacks
178 * where there may be more than one item
184 /** One or more items within tag */
186 /** One or more defaults for items within tags */
187 char* items_default[17];
188 /** One or more data types */
190 /** Initialization function */
191 MultiNotify init_function;
192 /** Validation function */
193 MultiValidator validation_function;
194 /** Completion function */
195 MultiNotify finish_function;
198 /** A set of oper types
200 typedef std::map<irc::string,char*> opertype_t;
202 /** A Set of oper classes
204 typedef std::map<irc::string,char*> operclass_t;
207 /** This class holds the bulk of the runtime configuration for the ircd.
208 * It allows for reading new config values, accessing configuration files,
209 * and storage of the configuration data needed to run the ircd, such as
210 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
212 class CoreExport ServerConfig : public Extensible
215 /** Creator/owner pointer
217 InspIRCd* ServerInstance;
219 /** This variable holds the names of all
220 * files included from the main one. This
221 * is used to make sure that no files are
222 * recursively included.
224 std::vector<std::string> include_stack;
226 /** This private method processes one line of
227 * configutation, appending errors to errorstream
228 * and setting error if an error has occured.
230 bool ParseLine(ConfigDataHash &target, std::string &line, long &linenumber, std::ostringstream &errorstream);
232 /** Process an include directive
234 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
236 /** Check that there is only one of each configuration item
238 bool CheckOnce(char* tag, bool bail, userrec* user);
242 /* Pointer to function that validates dns server addresses (can be changed depending on platform) */
243 Validator DNSServerValidator;
245 InspIRCd* GetInstance();
247 /** This holds all the information in the config file,
248 * it's indexed by tag name to a vector of key/values.
250 ConfigDataHash config_data;
252 /** Max number of WhoWas entries per user.
256 /** Max number of cumulative user-entries in WhoWas.
257 * When max reached and added to, push out oldest entry FIFO style.
261 /** Max seconds a user is kept in WhoWas before being pruned.
265 /** Holds the server name of the local server
266 * as defined by the administrator.
268 char ServerName[MAXBUF];
270 /** Notice to give to users when they are Xlined
272 char MoronBanner[MAXBUF];
274 /* Holds the network name the local server
275 * belongs to. This is an arbitary field defined
276 * by the administrator.
278 char Network[MAXBUF];
280 /** Holds the description of the local server
281 * as defined by the administrator.
283 char ServerDesc[MAXBUF];
285 /** Holds the admin's name, for output in
286 * the /ADMIN command.
288 char AdminName[MAXBUF];
290 /** Holds the email address of the admin,
291 * for output in the /ADMIN command.
293 char AdminEmail[MAXBUF];
295 /** Holds the admin's nickname, for output
296 * in the /ADMIN command
298 char AdminNick[MAXBUF];
300 /** The admin-configured /DIE password
302 char diepass[MAXBUF];
304 /** The admin-configured /RESTART password
306 char restartpass[MAXBUF];
308 /** The pathname and filename of the message of the
309 * day file, as defined by the administrator.
313 /** The pathname and filename of the rules file,
314 * as defined by the administrator.
318 /** The quit prefix in use, or an empty string
320 char PrefixQuit[MAXBUF];
322 /** The quit suffix in use, or an empty string
324 char SuffixQuit[MAXBUF];
326 /** The fixed quit message in use, or an empty string
328 char FixedQuit[MAXBUF];
330 /** The last string found within a <die> tag, or
333 char DieValue[MAXBUF];
335 /** The DNS server to use for DNS queries
337 char DNSServer[MAXBUF];
339 /** This variable contains a space-seperated list
340 * of commands which are disabled by the
341 * administrator of the server for non-opers.
343 char DisabledCommands[MAXBUF];
345 /** The full path to the modules directory.
346 * This is either set at compile time, or
347 * overridden in the configuration file via
352 /** The full pathname to the executable, as
353 * given in argv[0] when the program starts.
355 char MyExecutable[1024];
357 /** The file handle of the logfile. If this
358 * value is NULL, the log file is not open,
359 * probably due to a permissions error on
360 * startup (this should not happen in normal
365 /** If this value is true, the owner of the
366 * server specified -nofork on the command
367 * line, causing the daemon to stay in the
372 /** If this value if true then all log
373 * messages will be output, regardless of
374 * the level given in the config file.
375 * This is set with the -debug commandline
380 /** If this is true then log output will be
381 * written to the logfile. This is the default.
382 * If you put -nolog on the commandline then
383 * the logfile will not be written.
384 * This is meant to be used in conjunction with
385 * -debug for debugging without filling up the
390 /** If this value is true, halfops have been
391 * enabled in the configuration file.
395 /** If this is set to true, then mode lists (e.g
396 * MODE #chan b) are hidden from unprivileged
399 bool HideModeLists[256];
401 /** If this is set to true, then channel operators
402 * are exempt from this channel mode. Used for +Sc etc.
404 bool ExemptChanOps[256];
406 /** The number of seconds the DNS subsystem
407 * will wait before timing out any request.
411 /** The size of the read() buffer in the user
412 * handling code, used to read data into a user's
417 /** The value to be used for listen() backlogs
422 /** The soft limit value assigned to the irc server.
423 * The IRC server will not allow more than this
424 * number of local users.
426 unsigned int SoftLimit;
428 /** Maximum number of targets for a multi target command
429 * such as PRIVMSG or KICK
431 unsigned int MaxTargets;
433 /** The maximum number of /WHO results allowed
434 * in any single /WHO command.
438 /** True if the DEBUG loglevel is selected.
442 /** The loglevel in use by the IRC server
446 /** How many seconds to wait before exiting
447 * the program when /DIE is correctly issued.
451 /** True if we're going to hide netsplits as *.net *.split for non-opers
455 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
460 /** Announce invites to the channel with a server notice
462 bool AnnounceInvites;
464 /** If this is enabled then operators will
465 * see invisible (+i) channels in /whois.
469 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
471 char HideWhoisServer[MAXBUF];
473 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
475 char HideKillsServer[MAXBUF];
477 /** The MOTD file, cached in a file_cache type.
481 /** The RULES file, cached in a file_cache type.
485 /** The full pathname and filename of the PID
486 * file as defined in the configuration.
490 /** The connect classes in use by the IRC server.
494 /** A list of module names (names only, no paths)
495 * which are currently loaded by the server.
497 std::vector<std::string> module_names;
499 /** A list of the classes for listening client ports
501 std::vector<ListenSocket*> ports;
503 /** Boolean sets of which modules implement which functions
505 char implement_lists[255][255];
507 /** Global implementation list
509 char global_implementation[255];
511 /** A list of ports claimed by IO Modules
513 std::map<int,Module*> IOHookModule;
515 std::map<InspSocket*, Module*> SocketIOHookModule;
517 /** The 005 tokens of this server (ISUPPORT)
518 * populated/repopulated upon loading or unloading
525 std::vector<std::string> isupport;
527 /** STATS characters in this list are available
530 char UserStats[MAXBUF];
532 /** The path and filename of the ircd.log file
536 /** Default channel modes
538 char DefaultModes[MAXBUF];
540 /** Custom version string, which if defined can replace the system info in VERSION.
542 char CustomVersion[MAXBUF];
544 /** List of u-lined servers
546 std::map<irc::string, bool> ulines;
548 /** Max banlist sizes for channels (the std::string is a glob)
550 std::map<std::string, int> maxbans;
552 /** Directory where the inspircd binary resides
556 /** If set to true, no user DNS lookups are to be performed
560 /** If set to true, provide syntax hints for unknown commands
564 /** If set to true, users appear to quit then rejoin when their hosts change.
565 * This keeps clients synchronized properly.
569 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
570 * added to the outgoing text for undernet style msg prefixing.
572 bool UndernetMsgPrefix;
574 /** If set to true, the full nick!user@host will be shown in the TOPIC command
575 * for who set the topic last. If false, only the nick is shown.
577 bool FullHostInTopic;
579 /** All oper type definitions from the config file
581 opertype_t opertypes;
583 /** All oper class definitions from the config file
585 operclass_t operclass;
587 /** Saved argv from startup
591 /** Saved argc from startup
595 /** Max channels per user
597 unsigned int MaxChans;
599 /** Oper max channels per user
601 unsigned int OperMaxChans;
603 /** Construct a new ServerConfig
605 ServerConfig(InspIRCd* Instance);
607 /** Clears the include stack in preperation for a Read() call.
611 /** Update the 005 vector
615 /** Send the 005 numerics (ISUPPORT) to a user
617 void Send005(userrec* user);
619 /** Read the entire configuration into memory
620 * and initialize this class. All other methods
621 * should be used only by the core.
623 void Read(bool bail, userrec* user);
625 /** Read a file into a file_cache object
627 bool ReadFile(file_cache &F, const char* fname);
629 /** Report a configuration error given in errormessage.
630 * @param bail If this is set to true, the error is sent to the console, and the program exits
631 * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
632 * this user as SNOTICEs.
633 * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
635 void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
637 /** Load 'filename' into 'target', with the new config parser everything is parsed into
638 * tag/key/value at load-time rather than at read-value time.
640 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
642 /** Load 'filename' into 'target', with the new config parser everything is parsed into
643 * tag/key/value at load-time rather than at read-value time.
645 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
647 /* Both these return true if the value existed or false otherwise */
649 /** Writes 'length' chars into 'result' as a string
651 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
652 /** Writes 'length' chars into 'result' as a string
654 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
656 /** Writes 'length' chars into 'result' as a string
658 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
659 /** Writes 'length' chars into 'result' as a string
661 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);
663 /** Tries to convert the value to an integer and write it to 'result'
665 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
666 /** Tries to convert the value to an integer and write it to 'result'
668 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
669 /** Tries to convert the value to an integer and write it to 'result'
671 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
672 /** Tries to convert the value to an integer and write it to 'result'
674 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
676 /** Returns true if the value exists and has a true value, false otherwise
678 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
679 /** Returns true if the value exists and has a true value, false otherwise
681 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
682 /** Returns true if the value exists and has a true value, false otherwise
684 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
685 /** Returns true if the value exists and has a true value, false otherwise
687 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
689 /** Returns the number of occurences of tag in the config file
691 int ConfValueEnum(ConfigDataHash &target, const char* tag);
692 /** Returns the number of occurences of tag in the config file
694 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
696 /** Returns the numbers of vars inside the index'th 'tag in the config file
698 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
699 /** Returns the numbers of vars inside the index'th 'tag in the config file
701 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
703 /** Get a pointer to the module which has hooked the given port.
704 * @parameter port Port number
705 * @return Returns a pointer to the hooking module, or NULL
707 Module* GetIOHook(int port);
709 /** Hook a module to a client port, so that it can receive notifications
710 * of low-level port activity.
711 * @param port The port number
712 * @param Module the module to hook to the port
713 * @return True if the hook was successful.
715 bool AddIOHook(int port, Module* iomod);
717 /** Delete a module hook from a client port.
718 * @param port The port to detatch from
719 * @return True if successful
721 bool DelIOHook(int port);
723 /** Get a pointer to the module which has hooked the given InspSocket class.
724 * @parameter port Port number
725 * @return Returns a pointer to the hooking module, or NULL
727 Module* GetIOHook(InspSocket* is);
729 /** Hook a module to an InspSocket class, so that it can receive notifications
730 * of low-level socket activity.
731 * @param iomod The module to hook to the socket
732 * @param is The InspSocket to attach to
733 * @return True if the hook was successful.
735 bool AddIOHook(Module* iomod, InspSocket* is);
737 /** Delete a module hook from an InspSocket.
738 * @param is The InspSocket to detatch from.
739 * @return True if the unhook was successful
741 bool DelIOHook(InspSocket* is);
743 /** Returns the fully qualified path to the inspircd directory
744 * @return The full program directory
746 std::string GetFullProgDir();
748 /** Returns true if a directory is valid (within the modules directory).
749 * @param dirandfile The directory and filename to check
750 * @return True if the directory is valid
752 static bool DirValid(const char* dirandfile);
754 /** Clean a filename, stripping the directories (and drives) from string.
755 * @param name Directory to tidy
756 * @return The cleaned filename
758 static char* CleanFilename(char* name);
760 /** Check if a file exists.
761 * @param file The full path to a file
762 * @return True if the file exists and is readable.
764 static bool FileExists(const char* file);
768 /** Initialize the disabled commands list
770 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
772 /** Initialize the oper types
774 bool InitTypes(ServerConfig* conf, const char* tag);
776 /** Initialize the oper classes
778 bool InitClasses(ServerConfig* conf, const char* tag);
780 /** Initialize an oper type
782 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
784 /** Initialize an oper class
786 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
788 /** Finish initializing the oper types and classes
790 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);