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
|
.TH "ConfigReader" 3 "13 Apr 2005" "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 (std::string filename)"
.br
.RI "\fIOverloaded constructor. \fP"
.ti -1c
.RI "\fB~ConfigReader\fP ()"
.br
.RI "\fIDefault destructor. \fP"
.ti -1c
.RI "std::string \fBReadValue\fP (std::string tag, std::string name, int index)"
.br
.RI "\fIRetrieves a value from the config file. \fP"
.ti -1c
.RI "bool \fBReadFlag\fP (std::string tag, std::string name, int index)"
.br
.RI "\fIRetrieves a boolean value from the config file. \fP"
.ti -1c
.RI "long \fBReadInteger\fP (std::string tag, std::string 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 (std::string 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 (std::string 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 790 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "ConfigReader::ConfigReader ()"
.PP
Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 675 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
676 {
677 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
678 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
679 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
680 if (!this->readerror)
681 this->error = CONF_FILE_NOT_FOUND;
682 }
.fi
.SS "ConfigReader::ConfigReader (std::string filename)"
.PP
Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 694 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
695 {
696 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
697 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
698 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
699 if (!this->readerror)
700 this->error = CONF_FILE_NOT_FOUND;
701 };
.fi
.SS "ConfigReader::~\fBConfigReader\fP ()"
.PP
Default destructor. This method destroys the ConfigReader class.Definition at line 685 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
686 {
687 if (this->cache)
688 delete this->cache;
689 if (this->errorlog)
690 delete this->errorlog;
691 }
.fi
.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. 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.Definition at line 772 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
773 {
774 if (bail)
775 {
776 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
777 exit(0);
778 }
779 else
780 {
781 char dataline[1024];
782 if (user)
783 {
784 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
785 while (!errorlog->eof())
786 {
787 errorlog->getline(dataline,1024);
788 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
789 }
790 }
791 else
792 {
793 WriteOpers('There were errors in the configuration file:',user->nick);
794 while (!errorlog->eof())
795 {
796 errorlog->getline(dataline,1024);
797 WriteOpers(dataline);
798 }
799 }
800 return;
801 }
802 }
.fi
.SS "int ConfigReader::Enumerate (std::string tag)"
.PP
Counts the number of times a given tag appears in the config file. 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.Definition at line 805 of file modules.cpp.
.PP
References cache.
.PP
.nf
806 {
807 return EnumConf(cache,tag.c_str());
808 }
.fi
.SS "int ConfigReader::EnumerateValues (std::string tag, int index)"
.PP
Returns the number of items within a tag. 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.Definition at line 810 of file modules.cpp.
.PP
References cache.
.PP
.nf
811 {
812 return EnumValues(cache, tag.c_str(), index);
813 }
.fi
.SS "long ConfigReader::GetError ()"
.PP
Returns the last error to occur. 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.Definition at line 765 of file modules.cpp.
.PP
References error.
.PP
.nf
766 {
767 long olderr = this->error;
768 this->error = 0;
769 return olderr;
770 }
.fi
.SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)"
.PP
Retrieves a boolean value from the config file. 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.Definition at line 719 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
720 {
721 char val[MAXBUF];
722 char t[MAXBUF];
723 char n[MAXBUF];
724 strlcpy(t,tag.c_str(),MAXBUF);
725 strlcpy(n,name.c_str(),MAXBUF);
726 int res = ReadConf(cache,t,n,index,val);
727 if (!res)
728 {
729 this->error = CONF_VALUE_NOT_FOUND;
730 return false;
731 }
732 std::string s = val;
733 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
734 }
.fi
.SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)"
.PP
Retrieves an integer value from the config file. 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_UNSIGNEDDefinition at line 736 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
737 {
738 char val[MAXBUF];
739 char t[MAXBUF];
740 char n[MAXBUF];
741 strlcpy(t,tag.c_str(),MAXBUF);
742 strlcpy(n,name.c_str(),MAXBUF);
743 int res = ReadConf(cache,t,n,index,val);
744 if (!res)
745 {
746 this->error = CONF_VALUE_NOT_FOUND;
747 return 0;
748 }
749 for (int i = 0; i < strlen(val); i++)
750 {
751 if (!isdigit(val[i]))
752 {
753 this->error = CONF_NOT_A_NUMBER;
754 return 0;
755 }
756 }
757 if ((needs_unsigned) && (atoi(val)<0))
758 {
759 this->error = CONF_NOT_UNSIGNED;
760 return 0;
761 }
762 return atoi(val);
763 }
.fi
.SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)"
.PP
Retrieves a value from the config file. 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.Definition at line 703 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
704 {
705 char val[MAXBUF];
706 char t[MAXBUF];
707 char n[MAXBUF];
708 strlcpy(t,tag.c_str(),MAXBUF);
709 strlcpy(n,name.c_str(),MAXBUF);
710 int res = ReadConf(cache,t,n,index,val);
711 if (!res)
712 {
713 this->error = CONF_VALUE_NOT_FOUND;
714 return '';
715 }
716 return std::string(val);
717 }
.fi
.SS "bool ConfigReader::Verify ()"
.PP
Returns true if a config file is valid. This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 815 of file modules.cpp.
.PP
References readerror.
.PP
.nf
816 {
817 return this->readerror;
818 }
.fi
.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). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 798 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 803 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 799 of file modules.h.
.PP
Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
.SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP"
.PP
Used to store errors. Definition at line 802 of file modules.h.
.PP
Referenced by ConfigReader(), and Verify().
.SH "Author"
.PP
Generated automatically by Doxygen for InspIRCd from the source code.
|
