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_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 */
55 /** Holds a config value, either string, integer or boolean.
56 * Callback functions receive one or more of these, either on
57 * their own as a reference, or in a reference to a deque of them.
58 * The callback function can then alter the values of the ValueItem
59 * classes to validate the settings.
66 /** Initialize with an int */
68 /** Initialize with a bool */
69 ValueItem(bool value);
70 /** Initialize with a char pointer */
71 ValueItem(char* value);
72 /** Change value to a char pointer */
73 void Set(char* value);
74 /** Change value to a const char pointer */
75 void Set(const char* val);
76 /** Change value to an int */
78 /** Get value as an int */
80 /** Get value as a string */
82 /** Get value as a bool */
86 /** The base class of the container 'ValueContainer'
87 * used internally by the core to hold core values.
89 class ValueContainerBase
93 ValueContainerBase() { }
95 virtual ~ValueContainerBase() { }
98 /** ValueContainer is used to contain pointers to different
99 * core values such as the server name, maximum number of
101 * It is specialized to hold a data type, then pointed at
102 * a value in the ServerConfig class. When the value has been
103 * read and validated, the Set method is called to write the
104 * value safely in a type-safe manner.
106 template<typename T> class ValueContainer : public ValueContainerBase
108 /** Contained item */
112 /** Initialize with nothing */
118 /** Initialize with a value of type T */
119 ValueContainer(T Val)
124 /** Change value to type T of size s */
125 void Set(T newval, size_t s)
127 memcpy(val, newval, s);
131 /** A specialization of ValueContainer to hold a pointer to a bool
133 typedef ValueContainer<bool*> ValueContainerBool;
135 /** A specialization of ValueContainer to hold a pointer to
138 typedef ValueContainer<unsigned int*> ValueContainerUInt;
140 /** A specialization of ValueContainer to hold a pointer to
143 typedef ValueContainer<char*> ValueContainerChar;
145 /** A specialization of ValueContainer to hold a pointer to
148 typedef ValueContainer<int*> ValueContainerInt;
150 /** A set of ValueItems used by multi-value validator functions
152 typedef std::deque<ValueItem> ValueList;
154 /** A callback for validating a single value
156 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
157 /** A callback for validating multiple value entries
159 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
160 /** A callback indicating the end of a group of entries
162 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
164 /** Holds a core configuration item and its callbacks
172 /** Default, if not defined */
174 /** Value containers */
175 ValueContainerBase* val;
177 ConfigDataType datatype;
178 /** Validation function */
179 Validator validation_function;
182 /** Holds a core configuration item and its callbacks
183 * where there may be more than one item
189 /** One or more items within tag */
191 /** One or more defaults for items within tags */
192 char* items_default[17];
193 /** One or more data types */
195 /** Initialization function */
196 MultiNotify init_function;
197 /** Validation function */
198 MultiValidator validation_function;
199 /** Completion function */
200 MultiNotify finish_function;
203 /** A set of oper types
205 typedef std::map<irc::string,char*> opertype_t;
207 /** A Set of oper classes
209 typedef std::map<irc::string,char*> operclass_t;
212 /** This class holds the bulk of the runtime configuration for the ircd.
213 * It allows for reading new config values, accessing configuration files,
214 * and storage of the configuration data needed to run the ircd, such as
215 * the servername, connect classes, /ADMIN data, MOTDs and filenames etc.
217 class CoreExport ServerConfig : public Extensible
220 /** Creator/owner pointer
222 InspIRCd* ServerInstance;
224 /** This variable holds the names of all
225 * files included from the main one. This
226 * is used to make sure that no files are
227 * recursively included.
229 std::vector<std::string> include_stack;
231 /** This private method processes one line of
232 * configutation, appending errors to errorstream
233 * and setting error if an error has occured.
235 bool ParseLine(ConfigDataHash &target, std::string &line, long &linenumber, std::ostringstream &errorstream, int pass);
237 /** Process an include directive
239 bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream, int pass);
241 /** Check that there is only one of each configuration item
243 bool CheckOnce(char* tag);
245 std::map<std::string, std::stringstream*> IncludedFiles;
249 /** Used to indicate who we announce invites to on a channel */
250 enum InviteAnnounceState { INVITE_ANNOUNCE_NONE, INVITE_ANNOUNCE_ALL, INVITE_ANNOUNCE_OPS, INVITE_ANNOUNCE_DYNAMIC };
252 /** Pointer to function that validates dns server addresses (can be changed depending on platform) */
253 Validator DNSServerValidator;
255 InspIRCd* GetInstance();
259 void StartDownloads();
261 /** This holds all the information in the config file,
262 * it's indexed by tag name to a vector of key/values.
264 ConfigDataHash config_data;
266 /** Max number of WhoWas entries per user.
270 /** Max number of cumulative user-entries in WhoWas.
271 * When max reached and added to, push out oldest entry FIFO style.
275 /** Max seconds a user is kept in WhoWas before being pruned.
279 /** Holds the server name of the local server
280 * as defined by the administrator.
282 char ServerName[MAXBUF];
284 /** Notice to give to users when they are Xlined
286 char MoronBanner[MAXBUF];
288 /* Holds the network name the local server
289 * belongs to. This is an arbitary field defined
290 * by the administrator.
292 char Network[MAXBUF];
294 /** Holds the description of the local server
295 * as defined by the administrator.
297 char ServerDesc[MAXBUF];
299 /** Holds the admin's name, for output in
300 * the /ADMIN command.
302 char AdminName[MAXBUF];
304 /** Holds the email address of the admin,
305 * for output in the /ADMIN command.
307 char AdminEmail[MAXBUF];
309 /** Holds the admin's nickname, for output
310 * in the /ADMIN command
312 char AdminNick[MAXBUF];
314 /** The admin-configured /DIE password
316 char diepass[MAXBUF];
318 /** The admin-configured /RESTART password
320 char restartpass[MAXBUF];
322 /** The pathname and filename of the message of the
323 * day file, as defined by the administrator.
327 /** The pathname and filename of the rules file,
328 * as defined by the administrator.
332 /** The quit prefix in use, or an empty string
334 char PrefixQuit[MAXBUF];
336 /** The quit suffix in use, or an empty string
338 char SuffixQuit[MAXBUF];
340 /** The fixed quit message in use, or an empty string
342 char FixedQuit[MAXBUF];
344 /** The last string found within a <die> tag, or
347 char DieValue[MAXBUF];
349 /** The DNS server to use for DNS queries
351 char DNSServer[MAXBUF];
353 /** This variable contains a space-seperated list
354 * of commands which are disabled by the
355 * administrator of the server for non-opers.
357 char DisabledCommands[MAXBUF];
359 /** The full path to the modules directory.
360 * This is either set at compile time, or
361 * overridden in the configuration file via
366 /** The full pathname to the executable, as
367 * given in argv[0] when the program starts.
369 char MyExecutable[1024];
371 /** The file handle of the logfile. If this
372 * value is NULL, the log file is not open,
373 * probably due to a permissions error on
374 * startup (this should not happen in normal
379 /** If this value is true, the owner of the
380 * server specified -nofork on the command
381 * line, causing the daemon to stay in the
386 /** If this value if true then all log
387 * messages will be output, regardless of
388 * the level given in the config file.
389 * This is set with the -debug commandline
394 /** If this is true then log output will be
395 * written to the logfile. This is the default.
396 * If you put -nolog on the commandline then
397 * the logfile will not be written.
398 * This is meant to be used in conjunction with
399 * -debug for debugging without filling up the
404 /** If this value is true, halfops have been
405 * enabled in the configuration file.
409 /** If this is set to true, then mode lists (e.g
410 * MODE #chan b) are hidden from unprivileged
413 bool HideModeLists[256];
415 /** If this is set to true, then channel operators
416 * are exempt from this channel mode. Used for +Sc etc.
418 bool ExemptChanOps[256];
420 /** The number of seconds the DNS subsystem
421 * will wait before timing out any request.
425 /** The size of the read() buffer in the user
426 * handling code, used to read data into a user's
431 /** The value to be used for listen() backlogs
436 /** The soft limit value assigned to the irc server.
437 * The IRC server will not allow more than this
438 * number of local users.
440 unsigned int SoftLimit;
442 /** Maximum number of targets for a multi target command
443 * such as PRIVMSG or KICK
445 unsigned int MaxTargets;
447 /** The maximum number of /WHO results allowed
448 * in any single /WHO command.
452 /** True if the DEBUG loglevel is selected.
456 /** The loglevel in use by the IRC server
460 /** How many seconds to wait before exiting
461 * the program when /DIE is correctly issued.
465 /** True if we're going to hide netsplits as *.net *.split for non-opers
469 /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
474 /** Announce invites to the channel with a server notice
476 InviteAnnounceState AnnounceInvites;
478 /** If this is enabled then operators will
479 * see invisible (+i) channels in /whois.
483 /** Set to a non-empty string to obfuscate the server name of users in WHOIS
485 char HideWhoisServer[MAXBUF];
487 /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
489 char HideKillsServer[MAXBUF];
491 /** The MOTD file, cached in a file_cache type.
495 /** The RULES file, cached in a file_cache type.
499 /** The full pathname and filename of the PID
500 * file as defined in the configuration.
504 /** The connect classes in use by the IRC server.
508 /** A list of the classes for listening client ports
510 std::vector<ListenSocket*> ports;
512 /** A list of ports claimed by IO Modules
514 std::map<int,Module*> IOHookModule;
516 std::map<BufferedSocket*, Module*> SocketIOHookModule;
518 /** The 005 tokens of this server (ISUPPORT)
519 * populated/repopulated upon loading or unloading
526 std::vector<std::string> isupport;
528 /** STATS characters in this list are available
531 char UserStats[MAXBUF];
533 /** The path and filename of the ircd.log file
537 /** Default channel modes
539 char DefaultModes[MAXBUF];
541 /** Custom version string, which if defined can replace the system info in VERSION.
543 char CustomVersion[MAXBUF];
545 /** List of u-lined servers
547 std::map<irc::string, bool> ulines;
549 /** Max banlist sizes for channels (the std::string is a glob)
551 std::map<std::string, int> maxbans;
553 /** Directory where the inspircd binary resides
557 /** If set to true, no user DNS lookups are to be performed
561 /** If set to true, provide syntax hints for unknown commands
565 /** If set to true, users appear to quit then rejoin when their hosts change.
566 * This keeps clients synchronized properly.
570 /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
571 * added to the outgoing text for undernet style msg prefixing.
573 bool UndernetMsgPrefix;
575 /** If set to true, the full nick!user@host will be shown in the TOPIC command
576 * for who set the topic last. If false, only the nick is shown.
578 bool FullHostInTopic;
580 /** All oper type definitions from the config file
582 opertype_t opertypes;
584 /** All oper class definitions from the config file
586 operclass_t operclass;
588 /** Saved argv from startup
592 /** Saved argc from startup
596 /** Max channels per user
598 unsigned int MaxChans;
600 /** Oper max channels per user
602 unsigned int OperMaxChans;
604 /** TS6-like server ID.
605 * NOTE: 000...999 are usable for InspIRCd servers. This
606 * makes code simpler. 0AA, 1BB etc with letters are reserved
611 /** Construct a new ServerConfig
613 ServerConfig(InspIRCd* Instance);
615 /** Clears the include stack in preperation for a Read() call.
619 /** Get server ID as string with required leading zeroes
621 std::string GetSID();
623 /** Update the 005 vector
627 /** Send the 005 numerics (ISUPPORT) to a user
629 void Send005(User* user);
631 /** Read the entire configuration into memory
632 * and initialize this class. All other methods
633 * should be used only by the core.
635 void Read(bool bail, User* user, int pass);
637 /** Read a file into a file_cache object
639 bool ReadFile(file_cache &F, const char* fname);
641 /** Report a configuration error given in errormessage.
642 * @param bail If this is set to true, the error is sent to the console, and the program exits
643 * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
644 * this user as SNOTICEs.
645 * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
647 void ReportConfigError(const std::string &errormessage, bool bail, User* user);
649 /** Load 'filename' into 'target', with the new config parser everything is parsed into
650 * tag/key/value at load-time rather than at read-value time.
652 bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream, int pass);
654 /** Load 'filename' into 'target', with the new config parser everything is parsed into
655 * tag/key/value at load-time rather than at read-value time.
657 bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream, int pass);
659 /* Both these return true if the value existed or false otherwise */
661 /** Writes 'length' chars into 'result' as a string
663 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
664 /** Writes 'length' chars into 'result' as a string
666 bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
668 /** Writes 'length' chars into 'result' as a string
670 bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
671 /** Writes 'length' chars into 'result' as a string
673 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);
675 /** Tries to convert the value to an integer and write it to 'result'
677 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
678 /** Tries to convert the value to an integer and write it to 'result'
680 bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
681 /** Tries to convert the value to an integer and write it to 'result'
683 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
684 /** Tries to convert the value to an integer and write it to 'result'
686 bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
688 /** Returns true if the value exists and has a true value, false otherwise
690 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
691 /** Returns true if the value exists and has a true value, false otherwise
693 bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
694 /** Returns true if the value exists and has a true value, false otherwise
696 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
697 /** Returns true if the value exists and has a true value, false otherwise
699 bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
701 /** Returns the number of occurences of tag in the config file
703 int ConfValueEnum(ConfigDataHash &target, const char* tag);
704 /** Returns the number of occurences of tag in the config file
706 int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
708 /** Returns the numbers of vars inside the index'th 'tag in the config file
710 int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
711 /** Returns the numbers of vars inside the index'th 'tag in the config file
713 int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
715 void ValidateHostname(const char* p, const std::string &tag, const std::string &val);
717 void ValidateIP(const char* p, const std::string &tag, const std::string &val, bool wild);
719 void ValidateNoSpaces(const char* p, const std::string &tag, const std::string &val);
721 /** Get a pointer to the module which has hooked the given port.
722 * @parameter port Port number
723 * @return Returns a pointer to the hooking module, or NULL
725 Module* GetIOHook(int port);
727 /** Hook a module to a client port, so that it can receive notifications
728 * of low-level port activity.
729 * @param port The port number
730 * @param Module the module to hook to the port
731 * @return True if the hook was successful.
733 bool AddIOHook(int port, Module* iomod);
735 /** Delete a module hook from a client port.
736 * @param port The port to detatch from
737 * @return True if successful
739 bool DelIOHook(int port);
741 /** Get a pointer to the module which has hooked the given BufferedSocket class.
742 * @parameter port Port number
743 * @return Returns a pointer to the hooking module, or NULL
745 Module* GetIOHook(BufferedSocket* is);
747 /** Hook a module to an BufferedSocket class, so that it can receive notifications
748 * of low-level socket activity.
749 * @param iomod The module to hook to the socket
750 * @param is The BufferedSocket to attach to
751 * @return True if the hook was successful.
753 bool AddIOHook(Module* iomod, BufferedSocket* is);
755 /** Delete a module hook from an BufferedSocket.
756 * @param is The BufferedSocket to detatch from.
757 * @return True if the unhook was successful
759 bool DelIOHook(BufferedSocket* is);
761 /** Returns the fully qualified path to the inspircd directory
762 * @return The full program directory
764 std::string GetFullProgDir();
766 /** Returns true if a directory is valid (within the modules directory).
767 * @param dirandfile The directory and filename to check
768 * @return True if the directory is valid
770 static bool DirValid(const char* dirandfile);
772 /** Clean a filename, stripping the directories (and drives) from string.
773 * @param name Directory to tidy
774 * @return The cleaned filename
776 static char* CleanFilename(char* name);
778 /** Check if a file exists.
779 * @param file The full path to a file
780 * @return True if the file exists and is readable.
782 static bool FileExists(const char* file);
786 /** Initialize the disabled commands list
788 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
790 /** Initialize the oper types
792 bool InitTypes(ServerConfig* conf, const char* tag);
794 /** Initialize the oper classes
796 bool InitClasses(ServerConfig* conf, const char* tag);
798 /** Initialize an oper type
800 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
802 /** Initialize an oper class
804 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
806 /** Finish initializing the oper types and classes
808 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
812 /** Initialize x line
814 bool InitXLine(ServerConfig* conf, const char* tag);
816 /** Add a config-defined zline
818 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
820 /** Add a config-defined qline
822 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
824 /** Add a config-defined kline
826 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
828 /** Add a config-defined eline
830 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);