]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/configreader.h
Add stuff for functors. Currently, as a test case only InspIRCd::IsNick has been...
[user/henk/code/inspircd.git] / include / configreader.h
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
6  * See: http://www.inspircd.org/wiki/index.php/Credits
7  *
8  * This program is free but copyrighted software; see
9  *            the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 #ifndef INSPIRCD_CONFIGREADER
15 #define INSPIRCD_CONFIGREADER
16
17 /* handy defines */
18
19 /** Determines if a channel op is exempt from given mode m,
20  * in config of server instance s. 
21  */
22 #define CHANOPS_EXEMPT(s, m) (s->Config->ExemptChanOps[(unsigned char)m])
23
24 #include <sstream>
25 #include <string>
26 #include <vector>
27 #include <map>
28 #include "inspircd.h"
29 #include "globals.h"
30 #include "modules.h"
31 #include "socketengine.h"
32 #include "socket.h"
33
34 /* Required forward definitions */
35 class ServerConfig;
36 class InspIRCd;
37 class InspSocket;
38
39 /** Types of data in the core config
40  */
41 enum ConfigDataType
42 {
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 */
48 };
49
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.
55  */
56 class ValueItem
57 {
58         /** Actual data */
59         std::string v;
60  public:
61         /** Initialize with an int */
62         ValueItem(int value);
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 */
72         void Set(int value);
73         /** Get value as an int */
74         int GetInteger();
75         /** Get value as a string */
76         char* GetString();
77         /** Get value as a bool */
78         bool GetBool();
79 };
80
81 /** The base class of the container 'ValueContainer'
82  * used internally by the core to hold core values.
83  */
84 class ValueContainerBase
85 {
86  public:
87         /** Constructor */
88         ValueContainerBase() { }
89         /** Destructor */
90         virtual ~ValueContainerBase() { }
91 };
92
93 /** ValueContainer is used to contain pointers to different
94  * core values such as the server name, maximum number of
95  * clients etc.
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.
100  */
101 template<typename T> class ValueContainer : public ValueContainerBase
102 {
103         /** Contained item */
104         T val;
105  public:
106
107         /** Initialize with nothing */
108         ValueContainer()
109         {
110                 val = NULL;
111         }
112
113         /** Initialize with a value of type T */
114         ValueContainer(T Val)
115         {
116                 val = Val;
117         }
118
119         /** Change value to type T of size s */
120         void Set(T newval, size_t s)
121         {
122                 memcpy(val, newval, s);
123         }
124 };
125
126 /** A specialization of ValueContainer to hold a pointer to a bool
127  */
128 typedef ValueContainer<bool*> ValueContainerBool;
129
130 /** A specialization of ValueContainer to hold a pointer to
131  * an unsigned int
132  */
133 typedef ValueContainer<unsigned int*> ValueContainerUInt;
134
135 /** A specialization of ValueContainer to hold a pointer to
136  * a char array.
137  */
138 typedef ValueContainer<char*> ValueContainerChar;
139
140 /** A specialization of ValueContainer to hold a pointer to
141  * an int
142  */
143 typedef ValueContainer<int*> ValueContainerInt;
144
145 /** A set of ValueItems used by multi-value validator functions
146  */
147 typedef std::deque<ValueItem> ValueList;
148
149 /** A callback for validating a single value
150  */
151 typedef bool (*Validator)(ServerConfig* conf, const char*, const char*, ValueItem&);
152 /** A callback for validating multiple value entries
153  */
154 typedef bool (*MultiValidator)(ServerConfig* conf, const char*, char**, ValueList&, int*);
155 /** A callback indicating the end of a group of entries
156  */
157 typedef bool (*MultiNotify)(ServerConfig* conf, const char*);
158
159 /** Holds a core configuration item and its callbacks
160  */
161 struct InitialConfig
162 {
163         /** Tag name */
164         char* tag;
165         /** Value name */
166         char* value;
167         /** Default, if not defined */
168         char* default_value;
169         /** Value containers */
170         ValueContainerBase* val;
171         /** Data types */
172         ConfigDataType datatype;
173         /** Validation function */
174         Validator validation_function;
175 };
176
177 /** Holds a core configuration item and its callbacks
178  * where there may be more than one item
179  */
180 struct MultiConfig
181 {
182         /** Tag name */
183         const char*     tag;
184         /** One or more items within tag */
185         char*           items[13];
186         /** One or more defaults for items within tags */
187         char*           items_default[13];
188         /** One or more data types */
189         int             datatype[13];
190         /** Initialization function */
191         MultiNotify     init_function;
192         /** Validation function */
193         MultiValidator  validation_function;
194         /** Completion function */
195         MultiNotify     finish_function;
196 };
197
198 /** A set of oper types
199  */
200 typedef std::map<irc::string,char*> opertype_t;
201
202 /** A Set of oper classes
203  */
204 typedef std::map<irc::string,char*> operclass_t;
205
206
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.
211  */
212 class CoreExport ServerConfig : public Extensible
213 {
214   private:
215         /** Creator/owner pointer
216          */
217         InspIRCd* ServerInstance;
218
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.
223          */
224         std::vector<std::string> include_stack;
225
226         /** This private method processes one line of
227          * configutation, appending errors to errorstream
228          * and setting error if an error has occured.
229          */
230         bool ParseLine(ConfigDataHash &target, std::string &line, long linenumber, std::ostringstream &errorstream);
231   
232         /** Process an include directive
233          */
234         bool DoInclude(ConfigDataHash &target, const std::string &file, std::ostringstream &errorstream);
235
236         /** Check that there is only one of each configuration item
237          */
238         bool CheckOnce(char* tag, bool bail, userrec* user);
239   
240   public:
241
242         InspIRCd* GetInstance();
243           
244         /** This holds all the information in the config file,
245          * it's indexed by tag name to a vector of key/values.
246          */
247         ConfigDataHash config_data;
248
249         /** Max number of WhoWas entries per user.
250          */
251         int WhoWasGroupSize;
252
253         /** Max number of cumulative user-entries in WhoWas.
254          *  When max reached and added to, push out oldest entry FIFO style.
255          */
256         int WhoWasMaxGroups;
257
258         /** Max seconds a user is kept in WhoWas before being pruned.
259          */
260         int WhoWasMaxKeep;
261
262         /** Holds the server name of the local server
263          * as defined by the administrator.
264          */
265         char ServerName[MAXBUF];
266
267         /** Notice to give to users when they are Xlined
268          */
269         char MoronBanner[MAXBUF];
270         
271         /* Holds the network name the local server
272          * belongs to. This is an arbitary field defined
273          * by the administrator.
274          */
275         char Network[MAXBUF];
276
277         /** Holds the description of the local server
278          * as defined by the administrator.
279          */
280         char ServerDesc[MAXBUF];
281
282         /** Holds the admin's name, for output in
283          * the /ADMIN command.
284          */
285         char AdminName[MAXBUF];
286
287         /** Holds the email address of the admin,
288          * for output in the /ADMIN command.
289          */
290         char AdminEmail[MAXBUF];
291
292         /** Holds the admin's nickname, for output
293          * in the /ADMIN command
294          */
295         char AdminNick[MAXBUF];
296
297         /** The admin-configured /DIE password
298          */
299         char diepass[MAXBUF];
300
301         /** The admin-configured /RESTART password
302          */
303         char restartpass[MAXBUF];
304
305         /** The pathname and filename of the message of the
306          * day file, as defined by the administrator.
307          */
308         char motd[MAXBUF];
309
310         /** The pathname and filename of the rules file,
311          * as defined by the administrator.
312          */
313         char rules[MAXBUF];
314
315         /** The quit prefix in use, or an empty string
316          */
317         char PrefixQuit[MAXBUF];
318
319         /** The quit suffix in use, or an empty string
320          */
321         char SuffixQuit[MAXBUF];
322
323         /** The fixed quit message in use, or an empty string
324          */
325         char FixedQuit[MAXBUF];
326
327         /** The last string found within a <die> tag, or
328          * an empty string.
329          */
330         char DieValue[MAXBUF];
331
332         /** The DNS server to use for DNS queries
333          */
334         char DNSServer[MAXBUF];
335
336         /** This variable contains a space-seperated list
337          * of commands which are disabled by the
338          * administrator of the server for non-opers.
339          */
340         char DisabledCommands[MAXBUF];
341
342         /** The full path to the modules directory.
343          * This is either set at compile time, or
344          * overridden in the configuration file via
345          * the <options> tag.
346          */
347         char ModPath[1024];
348
349         /** The full pathname to the executable, as
350          * given in argv[0] when the program starts.
351          */
352         char MyExecutable[1024];
353
354         /** The file handle of the logfile. If this
355          * value is NULL, the log file is not open,
356          * probably due to a permissions error on
357          * startup (this should not happen in normal
358          * operation!).
359          */
360         FILE *log_file;
361
362         /** If this value is true, the owner of the
363          * server specified -nofork on the command
364          * line, causing the daemon to stay in the
365          * foreground.
366          */
367         bool nofork;
368         
369         /** If this value if true then all log
370          * messages will be output, regardless of
371          * the level given in the config file.
372          * This is set with the -debug commandline
373          * option.
374          */
375         bool forcedebug;
376         
377         /** If this is true then log output will be
378          * written to the logfile. This is the default.
379          * If you put -nolog on the commandline then
380          * the logfile will not be written.
381          * This is meant to be used in conjunction with
382          * -debug for debugging without filling up the
383          * hard disk.
384          */
385         bool writelog;
386
387         /** If this value is true, halfops have been
388          * enabled in the configuration file.
389          */
390         bool AllowHalfop;
391
392         /** If this is set to true, then mode lists (e.g
393          * MODE #chan b) are hidden from unprivileged
394          * users.
395          */
396         bool HideModeLists[256];
397
398         /** If this is set to true, then channel operators
399          * are exempt from this channel mode. Used for +Sc etc.
400          */
401         bool ExemptChanOps[256];
402
403         /** The number of seconds the DNS subsystem
404          * will wait before timing out any request.
405          */
406         int dns_timeout;
407
408         /** The size of the read() buffer in the user
409          * handling code, used to read data into a user's
410          * recvQ.
411          */
412         int NetBufferSize;
413
414         /** The value to be used for listen() backlogs
415          * as default.
416          */
417         int MaxConn;
418
419         /** The soft limit value assigned to the irc server.
420          * The IRC server will not allow more than this
421          * number of local users.
422          */
423         unsigned int SoftLimit;
424
425         /** Maximum number of targets for a multi target command
426          * such as PRIVMSG or KICK
427          */
428         unsigned int MaxTargets;
429
430         /** The maximum number of /WHO results allowed
431          * in any single /WHO command.
432          */
433         int MaxWhoResults;
434
435         /** True if the DEBUG loglevel is selected.
436          */
437         int debugging;
438
439         /** The loglevel in use by the IRC server
440          */
441         int LogLevel;
442
443         /** How many seconds to wait before exiting
444          * the program when /DIE is correctly issued.
445          */
446         int DieDelay;
447
448         /** True if we're going to hide netsplits as *.net *.split for non-opers
449          */
450         bool HideSplits;
451
452         /** True if we're going to hide ban reasons for non-opers (e.g. G-Lines,
453          * K-Lines, Z-Lines)
454          */
455         bool HideBans;
456
457         /** Announce invites to the channel with a server notice
458          */
459         bool AnnounceInvites;
460
461         /** If this is enabled then operators will
462          * see invisible (+i) channels in /whois.
463          */
464         bool OperSpyWhois;
465
466         /** Set to a non-empty string to obfuscate the server name of users in WHOIS
467          */
468         char HideWhoisServer[MAXBUF];
469
470         /** Set to a non empty string to obfuscate nicknames prepended to a KILL.
471          */
472         char HideKillsServer[MAXBUF];
473
474         /** The MOTD file, cached in a file_cache type.
475          */
476         file_cache MOTD;
477
478         /** The RULES file, cached in a file_cache type.
479          */
480         file_cache RULES;
481
482         /** The full pathname and filename of the PID
483          * file as defined in the configuration.
484          */
485         char PID[1024];
486
487         /** The connect classes in use by the IRC server.
488          */
489         ClassVector Classes;
490
491         /** A list of module names (names only, no paths)
492          * which are currently loaded by the server.
493          */
494         std::vector<std::string> module_names;
495
496         /** A list of the classes for listening client ports
497          */
498         std::vector<ListenSocket*> ports;
499
500         /** Boolean sets of which modules implement which functions
501          */
502         char implement_lists[255][255];
503
504         /** Global implementation list
505          */
506         char global_implementation[255];
507
508         /** A list of ports claimed by IO Modules
509          */
510         std::map<int,Module*> IOHookModule;
511
512         std::map<InspSocket*, Module*> SocketIOHookModule;
513
514         /** The 005 tokens of this server (ISUPPORT)
515          * populated/repopulated upon loading or unloading
516          * modules.
517          */
518         std::string data005;
519
520         /** isupport strings
521          */
522         std::vector<std::string> isupport;
523
524         /** STATS characters in this list are available
525          * only to operators.
526          */
527         char UserStats[MAXBUF];
528         
529         /** The path and filename of the ircd.log file
530          */
531         std::string logpath;
532
533         /** Default channel modes
534          */
535         char DefaultModes[MAXBUF];
536
537         /** Custom version string, which if defined can replace the system info in VERSION.
538          */
539         char CustomVersion[MAXBUF];
540
541         /** List of u-lined servers
542          */
543         std::map<irc::string, bool> ulines;
544
545         /** Max banlist sizes for channels (the std::string is a glob)
546          */
547         std::map<std::string, int> maxbans;
548
549         /** Directory where the inspircd binary resides
550          */
551         std::string MyDir;
552
553         /** If set to true, no user DNS lookups are to be performed
554          */
555         bool NoUserDns;
556
557         /** If set to true, provide syntax hints for unknown commands
558          */
559         bool SyntaxHints;
560
561         /** If set to true, users appear to quit then rejoin when their hosts change.
562          * This keeps clients synchronized properly.
563          */
564         bool CycleHosts;
565
566         /** If set to true, prefixed channel NOTICEs and PRIVMSGs will have the prefix
567          *  added to the outgoing text for undernet style msg prefixing.
568          */
569         bool UndernetMsgPrefix;
570
571         /** If set to true, the full nick!user@host will be shown in the TOPIC command
572          * for who set the topic last. If false, only the nick is shown.
573          */
574         bool FullHostInTopic;
575
576         /** All oper type definitions from the config file
577          */
578         opertype_t opertypes;
579
580         /** All oper class definitions from the config file
581          */
582         operclass_t operclass;
583
584         /** Saved argv from startup
585          */
586         char** argv;
587
588         /** Saved argc from startup
589          */
590         int argc;
591
592         /** Max channels per user
593          */
594         unsigned int MaxChans;
595
596         /** Oper max channels per user
597          */
598         unsigned int OperMaxChans;
599
600         /** Construct a new ServerConfig
601          */
602         ServerConfig(InspIRCd* Instance);
603
604         /** Clears the include stack in preperation for a Read() call.
605          */
606         void ClearStack();
607
608         /** Update the 005 vector
609          */
610         void Update005();
611
612         /** Send the 005 numerics (ISUPPORT) to a user
613          */
614         void Send005(userrec* user);
615
616         /** Read the entire configuration into memory
617          * and initialize this class. All other methods
618          * should be used only by the core.
619          */
620         void Read(bool bail, userrec* user);
621
622         /** Read a file into a file_cache object
623          */
624         bool ReadFile(file_cache &F, const char* fname);
625
626         /** Report a configuration error given in errormessage.
627          * @param bail If this is set to true, the error is sent to the console, and the program exits
628          * @param user If this is set to a non-null value, and bail is false, the errors are spooled to
629          * this user as SNOTICEs.
630          * If the parameter is NULL, the messages are spooled to all users via WriteOpers as SNOTICEs.
631          */
632         void ReportConfigError(const std::string &errormessage, bool bail, userrec* user);
633
634         /** Load 'filename' into 'target', with the new config parser everything is parsed into
635          * tag/key/value at load-time rather than at read-value time.
636          */
637         bool LoadConf(ConfigDataHash &target, const char* filename, std::ostringstream &errorstream);
638
639         /** Load 'filename' into 'target', with the new config parser everything is parsed into
640          * tag/key/value at load-time rather than at read-value time.
641          */
642         bool LoadConf(ConfigDataHash &target, const std::string &filename, std::ostringstream &errorstream);
643         
644         /* Both these return true if the value existed or false otherwise */
645         
646         /** Writes 'length' chars into 'result' as a string
647          */
648         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, int index, char* result, int length, bool allow_linefeeds = false);
649         /** Writes 'length' chars into 'result' as a string
650          */
651         bool ConfValue(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, char* result, int length, bool allow_linefeeds = false);
652
653         /** Writes 'length' chars into 'result' as a string
654          */
655         bool ConfValue(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, std::string &result, bool allow_linefeeds = false);
656         /** Writes 'length' chars into 'result' as a string
657          */
658         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);
659         
660         /** Tries to convert the value to an integer and write it to 'result'
661          */
662         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, int index, int &result);
663         /** Tries to convert the value to an integer and write it to 'result'
664          */
665         bool ConfValueInteger(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index, int &result);
666         /** Tries to convert the value to an integer and write it to 'result'
667          */
668         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, int index, int &result);
669         /** Tries to convert the value to an integer and write it to 'result'
670          */
671         bool ConfValueInteger(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index, int &result);
672         
673         /** Returns true if the value exists and has a true value, false otherwise
674          */
675         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, int index);
676         /** Returns true if the value exists and has a true value, false otherwise
677          */
678         bool ConfValueBool(ConfigDataHash &target, const char* tag, const char* var, const char* default_value, int index);
679         /** Returns true if the value exists and has a true value, false otherwise
680          */
681         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, int index);
682         /** Returns true if the value exists and has a true value, false otherwise
683          */
684         bool ConfValueBool(ConfigDataHash &target, const std::string &tag, const std::string &var, const std::string &default_value, int index);
685         
686         /** Returns the number of occurences of tag in the config file
687          */
688         int ConfValueEnum(ConfigDataHash &target, const char* tag);
689         /** Returns the number of occurences of tag in the config file
690          */
691         int ConfValueEnum(ConfigDataHash &target, const std::string &tag);
692         
693         /** Returns the numbers of vars inside the index'th 'tag in the config file
694          */
695         int ConfVarEnum(ConfigDataHash &target, const char* tag, int index);
696         /** Returns the numbers of vars inside the index'th 'tag in the config file
697          */
698         int ConfVarEnum(ConfigDataHash &target, const std::string &tag, int index);
699         
700         /** Get a pointer to the module which has hooked the given port.
701          * @parameter port Port number
702          * @return Returns a pointer to the hooking module, or NULL
703          */
704         Module* GetIOHook(int port);
705
706         /** Hook a module to a client port, so that it can receive notifications
707          * of low-level port activity.
708          * @param port The port number
709          * @param Module the module to hook to the port
710          * @return True if the hook was successful.
711          */
712         bool AddIOHook(int port, Module* iomod);
713
714         /** Delete a module hook from a client port.
715          * @param port The port to detatch from
716          * @return True if successful
717          */
718         bool DelIOHook(int port);
719         
720         /** Get a pointer to the module which has hooked the given InspSocket class.
721          * @parameter port Port number
722          * @return Returns a pointer to the hooking module, or NULL
723          */
724         Module* GetIOHook(InspSocket* is);
725
726         /** Hook a module to an InspSocket class, so that it can receive notifications
727          * of low-level socket activity.
728          * @param iomod The module to hook to the socket
729          * @param is The InspSocket to attach to
730          * @return True if the hook was successful.
731          */
732         bool AddIOHook(Module* iomod, InspSocket* is);
733
734         /** Delete a module hook from an InspSocket.
735          * @param is The InspSocket to detatch from.
736          * @return True if the unhook was successful
737          */
738         bool DelIOHook(InspSocket* is);
739
740         /** Returns the fully qualified path to the inspircd directory
741          * @return The full program directory
742          */
743         std::string GetFullProgDir();
744
745         /** Returns true if a directory is valid (within the modules directory).
746          * @param dirandfile The directory and filename to check
747          * @return True if the directory is valid
748          */
749         static bool DirValid(const char* dirandfile);
750
751         /** Clean a filename, stripping the directories (and drives) from string.
752          * @param name Directory to tidy
753          * @return The cleaned filename
754          */
755         static char* CleanFilename(char* name);
756
757         /** Check if a file exists.
758          * @param file The full path to a file
759          * @return True if the file exists and is readable.
760          */
761         static bool FileExists(const char* file);
762         
763 };
764
765 /** Initialize the disabled commands list
766  */
767 CoreExport bool InitializeDisabledCommands(const char* data, InspIRCd* ServerInstance);
768
769 /** Initialize the oper types
770  */
771 bool InitTypes(ServerConfig* conf, const char* tag);
772
773 /** Initialize the oper classes
774  */
775 bool InitClasses(ServerConfig* conf, const char* tag);
776
777 /** Initialize an oper type 
778  */
779 bool DoType(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
780
781 /** Initialize an oper class
782  */
783 bool DoClass(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
784
785 /** Finish initializing the oper types and classes
786  */
787 bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
788
789 #endif
790