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 /** Used to indicate who we announce invites to on a channel */
243 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
245 /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
246 Validator DNSServerValidator;
248 InspIRCd* GetInstance();
250 /** This holds all the information in the config file,
251 * it's indexed by tag name to a vector of key/values.
253 ConfigDataHash config_data;
255 /** Max number of WhoWas entries per user.
259 /** Max number of cumulative user-entries in WhoWas.
260 * When max reached and added to, push out oldest entry FIFO style.
264 /** Max seconds a user is kept in WhoWas before being pruned.
268 /** Holds the server name of the local server
269 * as defined by the administrator.
271 char ServerName[MAXBUF];
273 /** Notice to give to users when they are Xlined
275 char MoronBanner[MAXBUF];
277 /* Holds the network name the local server
278 * belongs to. This is an arbitary field defined
279 * by the administrator.
281 char Network[MAXBUF];
283 /** Holds the description of the local server
284 * as defined by the administrator.
286 char ServerDesc[MAXBUF];
288 /** Holds the admin's name, for output in
289 * the /ADMIN command.
291 char AdminName[MAXBUF];
293 /** Holds the email address of the admin,
294 * for output in the /ADMIN command.
296 char AdminEmail[MAXBUF];
298 /** Holds the admin's nickname, for output
299 * in the /ADMIN command
301 char AdminNick[MAXBUF];
303 /** The admin-configured /DIE password
305 char diepass[MAXBUF];
307 /** The admin-configured /RESTART password
309 char restartpass[MAXBUF];
311 /** The pathname and filename of the message of the
312 * day file, as defined by the administrator.
316 /** The pathname and filename of the rules file,
317 * as defined by the administrator.
321 /** The quit prefix in use, or an empty string
323 char PrefixQuit[MAXBUF];
325 /** The quit suffix in use, or an empty string
327 char SuffixQuit[MAXBUF];
329 /** The fixed quit message in use, or an empty string
331 char FixedQuit[MAXBUF];
333 /** The last string found within a <die> tag, or
336 char DieValue[MAXBUF];
338 /** The DNS server to use for DNS queries
340 char DNSServer[MAXBUF];
342 /** This variable contains a space-seperated list
343 * of commands which are disabled by the
344 * administrator of the server for non-opers.
346 char DisabledCommands[MAXBUF];
348 /** The full path to the modules directory.
349 * This is either set at compile time, or
350 * overridden in the configuration file via
355 /** The full pathname to the executable, as
356 * given in argv[0] when the program starts.
358 char MyExecutable[1024];
360 /** The file handle of the logfile. If this
361 * value is NULL, the log file is not open,
362 * probably due to a permissions error on
363 * startup (this should not happen in normal
368 /** If this value is true, the owner of the
369 * server specified -nofork on the command
370 * line, causing the daemon to stay in the
375 /** If this value if true then all log
376 * messages will be output, regardless of
377 * the level given in the config file.
378 * This is set with the -debug commandline
383 /** If this is true then log output will be
384 * written to the logfile. This is the default.
385 * If you put -nolog on the commandline then
386 * the logfile will not be written.
387 * This is meant to be used in conjunction with
388 * -debug for debugging without filling up the
393 /** If this value is true, halfops have been
394 * enabled in the configuration file.
398 /** If this is set to true, then mode lists (e.g
399 * MODE #chan b) are hidden from unprivileged
402 bool HideModeLists[256];
404 /** If this is set to true, then channel operators
405 * are exempt from this channel mode. Used for +Sc etc.
407 bool ExemptChanOps[256];
409 /** The number of seconds the DNS subsystem
410 * will wait before timing out any request.
414 /** The size of the read() buffer in the user
415 * handling code, used to read data into a user's
420 /** The value to be used for listen() backlogs
425 /** The soft limit value assigned to the irc server.
426 * The IRC server will not allow more than this
427 * number of local users.
429 unsigned int SoftLimit;
431 /** Maximum number of targets for a multi target command
432 * such as PRIVMSG or KICK
434 unsigned int MaxTargets;
436 /** The maximum number of /WHO results allowed
437 * in any single /WHO command.
441 /** True if the DEBUG loglevel is selected.
445 /** The loglevel in use by the IRC server
449 /** How many seconds to wait before exiting
450 * the program when /DIE is correctly issued.
454 /** True if we're going to hide netsplits as *.net *.split for non-opers
458 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
463 /** Announce invites to the channel with a server notice
465 InviteAnnounceState AnnounceInvites;
467 /** If this is enabled then operators will
468 * see invisible (+i) channels in /whois.
472 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
474 char HideWhoisServer[MAXBUF];
476 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
478 char HideKillsServer[MAXBUF];
480 /** The MOTD file, cached in a file_cache type.
484 /** The RULES file, cached in a file_cache type.
488 /** The full pathname and filename of the PID
489 * file as defined in the configuration.
493 /** The connect classes in use by the IRC server.
497 /** A list of module names (names only, no paths)
498 * which are currently loaded by the server.
500 std::vector<std::string> module_names;
502 /** A list of the classes for listening client ports
504 std::vector<ListenSocket*> ports;
506 /** Boolean sets of which modules implement which functions
508 char implement_lists[255][255];
510 /** Global implementation list
512 char global_implementation[255];
514 /** A list of ports claimed by IO Modules
516 std::map<int,Module*> IOHookModule;
518 std::map<InspSocket*, Module*> SocketIOHookModule;
520 /** The 005 tokens of this server (ISUPPORT)
521 * populated/repopulated upon loading or unloading
528 std::vector<std::string> isupport;
530 /** STATS characters in this list are available
533 char UserStats[MAXBUF];
535 /** The path and filename of the ircd.log file
539 /** Default channel modes
541 char DefaultModes[MAXBUF];
543 /** Custom version string, which if defined can replace the system info in VERSION.
545 char CustomVersion[MAXBUF];
547 /** List of u-lined servers
549 std::map<irc::string, bool> ulines;
551 /** Max banlist sizes for channels (the std::string is a glob)
553 std::map<std::string, int> maxbans;
555 /** Directory where the inspircd binary resides
559 /** If set to true, no user DNS lookups are to be performed
563 /** If set to true, provide syntax hints for unknown commands
567 /** If set to true, users appear to quit then rejoin when their hosts change.
568 * This keeps clients synchronized properly.
572 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
573 * added to the outgoing text for undernet style msg prefixing.
575 bool UndernetMsgPrefix;
577 /** If set to true, the full nick!user@host will be shown in the TOPIC command
578 * for who set the topic last. If false, only the nick is shown.
580 bool FullHostInTopic;
582 /** All oper type definitions from the config file
584 opertype_t opertypes;
586 /** All oper class definitions from the config file
588 operclass_t operclass;
590 /** Saved argv from startup
594 /** Saved argc from startup
598 /** Max channels per user
600 unsigned int MaxChans;
602 /** Oper max channels per user
604 unsigned int OperMaxChans;
606 /** TS6-like server ID.
607 * NOTE: 000...999 are usable for InspIRCd servers. This
608 * makes code simpler. 0AA, 1BB etc with letters are reserved
613 /** Construct a new ServerConfig
615 ServerConfig(InspIRCd* Instance);
617 /** Clears the include stack in preperation for a Read() call.
621 /** Get server ID as string with required leading zeroes
623 std::string GetSID();
625 /** Update the 005 vector
629 /** Send the 005 numerics (ISUPPORT) to a user
631 void Send005(userrec* user);
633 /** Read the entire configuration into memory
634 * and initialize this class. All other methods
635 * should be used only by the core.
637 void Read(bool bail, userrec* user);
639 /** Read a file into a file_cache object
641 bool ReadFile(file_cache &F, const char* fname);
643 /** Report a configuration error given in errormessage.
644 * @param bail If this is set to true, the error is sent to the console, and the program exits
645 * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
646 * this user as SNOTICEs.
647 * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
649 void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
651 /** Load 'filename' into 'target', with the new config parser everything is parsed into
652 * tag/key/value at load-time rather than at read-value time.
654 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
656 /** Load 'filename' into 'target', with the new config parser everything is parsed into
657 * tag/key/value at load-time rather than at read-value time.
659 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
661 /* Both these return true if the value existed or false otherwise */
663 /** Writes 'length' chars into 'result' as a string
665 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
666 /** Writes 'length' chars into 'result' as a string
668 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
670 /** Writes 'length' chars into 'result' as a string
672 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
673 /** Writes 'length' chars into 'result' as a string
675 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);
677 /** Tries to convert the value to an integer and write it to 'result'
679 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
680 /** Tries to convert the value to an integer and write it to 'result'
682 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
683 /** Tries to convert the value to an integer and write it to 'result'
685 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
686 /** Tries to convert the value to an integer and write it to 'result'
688 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
690 /** Returns true if the value exists and has a true value, false otherwise
692 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
693 /** Returns true if the value exists and has a true value, false otherwise
695 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
696 /** Returns true if the value exists and has a true value, false otherwise
698 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
699 /** Returns true if the value exists and has a true value, false otherwise
701 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
703 /** Returns the number of occurences of tag in the config file
705 int ConfValueEnum(ConfigDataHash &target, const char* tag);
706 /** Returns the number of occurences of tag in the config file
708 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
710 /** Returns the numbers of vars inside the index'th 'tag in the config file
712 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
713 /** Returns the numbers of vars inside the index'th 'tag in the config file
715 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
717 /** Get a pointer to the module which has hooked the given port.
718 * @parameter port Port number
719 * @return Returns a pointer to the hooking module, or NULL
721 Module* GetIOHook(int port);
723 /** Hook a module to a client port, so that it can receive notifications
724 * of low-level port activity.
725 * @param port The port number
726 * @param Module the module to hook to the port
727 * @return True if the hook was successful.
729 bool AddIOHook(int port, Module* iomod);
731 /** Delete a module hook from a client port.
732 * @param port The port to detatch from
733 * @return True if successful
735 bool DelIOHook(int port);
737 /** Get a pointer to the module which has hooked the given InspSocket class.
738 * @parameter port Port number
739 * @return Returns a pointer to the hooking module, or NULL
741 Module* GetIOHook(InspSocket* is);
743 /** Hook a module to an InspSocket class, so that it can receive notifications
744 * of low-level socket activity.
745 * @param iomod The module to hook to the socket
746 * @param is The InspSocket to attach to
747 * @return True if the hook was successful.
749 bool AddIOHook(Module* iomod, InspSocket* is);
751 /** Delete a module hook from an InspSocket.
752 * @param is The InspSocket to detatch from.
753 * @return True if the unhook was successful
755 bool DelIOHook(InspSocket* is);
757 /** Returns the fully qualified path to the inspircd directory
758 * @return The full program directory
760 std::string GetFullProgDir();
762 /** Returns true if a directory is valid (within the modules directory).
763 * @param dirandfile The directory and filename to check
764 * @return True if the directory is valid
766 static bool DirValid(const char* dirandfile);
768 /** Clean a filename, stripping the directories (and drives) from string.
769 * @param name Directory to tidy
770 * @return The cleaned filename
772 static char* CleanFilename(char* name);
774 /** Check if a file exists.
775 * @param file The full path to a file
776 * @return True if the file exists and is readable.
778 static bool FileExists(const char* file);
782 /** Initialize the disabled commands list
784 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
786 /** Initialize the oper types
788 bool InitTypes(ServerConfig* conf, const char* tag);
790 /** Initialize the oper classes
792 bool InitClasses(ServerConfig* conf, const char* tag);
794 /** Initialize an oper type
796 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
798 /** Initialize an oper class
800 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
802 /** Finish initializing the oper types and classes
804 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);