1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
.TH "ConfigReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ConfigReader \- Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <modules.h>\fP
.PP
Inherits \fBclassbase\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBConfigReader\fP ()"
.br
.RI "\fIDefault constructor. \fP"
.ti -1c
.RI "\fBConfigReader\fP (\fBstd::string\fP filename)"
.br
.RI "\fIOverloaded constructor. \fP"
.ti -1c
.RI "\fB~ConfigReader\fP ()"
.br
.RI "\fIDefault destructor. \fP"
.ti -1c
.RI "\fBstd::string\fP \fBReadValue\fP (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
.br
.RI "\fIRetrieves a value from the config file. \fP"
.ti -1c
.RI "bool \fBReadFlag\fP (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
.br
.RI "\fIRetrieves a boolean value from the config file. \fP"
.ti -1c
.RI "long \fBReadInteger\fP (\fBstd::string\fP tag, \fBstd::string\fP name, int index, bool needs_unsigned)"
.br
.RI "\fIRetrieves an integer value from the config file. \fP"
.ti -1c
.RI "long \fBGetError\fP ()"
.br
.RI "\fIReturns the last error to occur. \fP"
.ti -1c
.RI "int \fBEnumerate\fP (\fBstd::string\fP tag)"
.br
.RI "\fICounts the number of times a given tag appears in the config file. \fP"
.ti -1c
.RI "bool \fBVerify\fP ()"
.br
.RI "\fIReturns true if a config file is valid. \fP"
.ti -1c
.RI "void \fBDumpErrors\fP (bool bail, \fBuserrec\fP *user)"
.br
.RI "\fIDumps the list of errors in a config file to an output location. \fP"
.ti -1c
.RI "int \fBEnumerateValues\fP (\fBstd::string\fP tag, int index)"
.br
.RI "\fIReturns the number of items within a tag. \fP"
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "std::stringstream * \fBcache\fP"
.br
.RI "\fIThe contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). \fP"
.ti -1c
.RI "std::stringstream * \fBerrorlog\fP"
.br
.ti -1c
.RI "bool \fBreaderror\fP"
.br
.RI "\fIUsed to store errors. \fP"
.ti -1c
.RI "long \fBerror\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.
It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read.
.PP
Definition at line 1510 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "ConfigReader::ConfigReader ()"
.PP
Default constructor.
.PP
This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
.PP
Definition at line 834 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
.PP
.nf
835 {
836 include_stack.clear();
837 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
838 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
839 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
840 if (!this->readerror)
841 this->error = CONF_FILE_NOT_FOUND;
842 }
.fi
.PP
.SS "ConfigReader::ConfigReader (\fBstd::string\fP filename)"
.PP
Overloaded constructor.
.PP
This constructor initialises the ConfigReader class to read a user-specified config file
.PP
Definition at line 854 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
855 {
856 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
857 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
858 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
859 if (!this->readerror)
860 this->error = CONF_FILE_NOT_FOUND;
861 };
.fi
.PP
.SS "ConfigReader::~ConfigReader ()"
.PP
Default destructor.
.PP
This method destroys the ConfigReader class.
.PP
Definition at line 845 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
846 {
847 if (this->cache)
848 delete this->cache;
849 if (this->errorlog)
850 delete this->errorlog;
851 }
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)"
.PP
Dumps the list of errors in a config file to an output location.
.PP
If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.
.PP
Definition at line 932 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
933 {
934 if (bail)
935 {
936 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
937 exit(0);
938 }
939 else
940 {
941 char dataline[1024];
942 if (user)
943 {
944 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
945 while (!errorlog->eof())
946 {
947 errorlog->getline(dataline,1024);
948 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
949 }
950 }
951 else
952 {
953 WriteOpers('There were errors in the configuration file:',user->nick);
954 while (!errorlog->eof())
955 {
956 errorlog->getline(dataline,1024);
957 WriteOpers(dataline);
958 }
959 }
960 return;
961 }
962 }
.fi
.PP
.SS "int ConfigReader::Enumerate (\fBstd::string\fP tag)"
.PP
Counts the number of times a given tag appears in the config file.
.PP
This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.
.PP
Definition at line 965 of file modules.cpp.
.PP
References cache.
.PP
.nf
966 {
967 return EnumConf(cache,tag.c_str());
968 }
.fi
.PP
.SS "int ConfigReader::EnumerateValues (\fBstd::string\fP tag, int index)"
.PP
Returns the number of items within a tag.
.PP
For example if the tag was <test tag='blah' data='foo'> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.
.PP
Definition at line 970 of file modules.cpp.
.PP
References cache.
.PP
.nf
971 {
972 return EnumValues(cache, tag.c_str(), index);
973 }
.fi
.PP
.SS "long ConfigReader::GetError ()"
.PP
Returns the last error to occur.
.PP
Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.
.PP
Definition at line 925 of file modules.cpp.
.PP
References error.
.PP
.nf
926 {
927 long olderr = this->error;
928 this->error = 0;
929 return olderr;
930 }
.fi
.PP
.SS "bool ConfigReader::ReadFlag (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
.PP
Retrieves a boolean value from the config file.
.PP
This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.
.PP
Definition at line 879 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
880 {
881 char val[MAXBUF];
882 char t[MAXBUF];
883 char n[MAXBUF];
884 strlcpy(t,tag.c_str(),MAXBUF);
885 strlcpy(n,name.c_str(),MAXBUF);
886 int res = ReadConf(cache,t,n,index,val);
887 if (!res)
888 {
889 this->error = CONF_VALUE_NOT_FOUND;
890 return false;
891 }
892 std::string s = val;
893 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
894 }
.fi
.PP
.SS "long ConfigReader::ReadInteger (\fBstd::string\fP tag, \fBstd::string\fP name, int index, bool needs_unsigned)"
.PP
Retrieves an integer value from the config file.
.PP
This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNED
.PP
Definition at line 896 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
897 {
898 char val[MAXBUF];
899 char t[MAXBUF];
900 char n[MAXBUF];
901 strlcpy(t,tag.c_str(),MAXBUF);
902 strlcpy(n,name.c_str(),MAXBUF);
903 int res = ReadConf(cache,t,n,index,val);
904 if (!res)
905 {
906 this->error = CONF_VALUE_NOT_FOUND;
907 return 0;
908 }
909 for (unsigned int i = 0; i < strlen(val); i++)
910 {
911 if (!isdigit(val[i]))
912 {
913 this->error = CONF_NOT_A_NUMBER;
914 return 0;
915 }
916 }
917 if ((needs_unsigned) && (atoi(val)<0))
918 {
919 this->error = CONF_NOT_UNSIGNED;
920 return 0;
921 }
922 return atoi(val);
923 }
.fi
.PP
.SS "\fBstd::string\fP ConfigReader::ReadValue (\fBstd::string\fP tag, \fBstd::string\fP name, int index)"
.PP
Retrieves a value from the config file.
.PP
This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.
.PP
Definition at line 863 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
864 {
865 char val[MAXBUF];
866 char t[MAXBUF];
867 char n[MAXBUF];
868 strlcpy(t,tag.c_str(),MAXBUF);
869 strlcpy(n,name.c_str(),MAXBUF);
870 int res = ReadConf(cache,t,n,index,val);
871 if (!res)
872 {
873 this->error = CONF_VALUE_NOT_FOUND;
874 return '';
875 }
876 return val;
877 }
.fi
.PP
.SS "bool ConfigReader::Verify ()"
.PP
Returns true if a config file is valid.
.PP
This method is partially implemented and will only return false if the config file does not exist or could not be opened.
.PP
Definition at line 975 of file modules.cpp.
.PP
References readerror.
.PP
.nf
976 {
977 return this->readerror;
978 }
.fi
.PP
.SH "Member Data Documentation"
.PP
.SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP"
.PP
The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).
.PP
It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.
.PP
Definition at line 1518 of file modules.h.
.PP
Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
.SS "long \fBConfigReader::error\fP\fC [protected]\fP"
.PP
Definition at line 1523 of file modules.h.
.PP
Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
.SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP"
.PP
Definition at line 1519 of file modules.h.
.PP
Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
.SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP"
.PP
Used to store errors.
.PP
Definition at line 1522 of file modules.h.
.PP
Referenced by ConfigReader(), and Verify().
.SH "Author"
.PP
Generated automatically by Doxygen for InspIRCd from the source code.
|
