1 .TH "ConfigReader" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*-
5 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.
11 \fC#include <modules.h>\fP
13 Inherits \fBclassbase\fP.
15 .SS "Public Member Functions"
19 .RI "\fBConfigReader\fP ()"
21 .RI "\fIDefault constructor. \fP"
23 .RI "\fBConfigReader\fP (std::string filename)"
25 .RI "\fIOverloaded constructor. \fP"
27 .RI "\fB~ConfigReader\fP ()"
29 .RI "\fIDefault destructor. \fP"
31 .RI "std::string \fBReadValue\fP (std::string tag, std::string name, int index)"
33 .RI "\fIRetrieves a value from the config file. \fP"
35 .RI "bool \fBReadFlag\fP (std::string tag, std::string name, int index)"
37 .RI "\fIRetrieves a boolean value from the config file. \fP"
39 .RI "long \fBReadInteger\fP (std::string tag, std::string name, int index, bool needs_unsigned)"
41 .RI "\fIRetrieves an integer value from the config file. \fP"
43 .RI "long \fBGetError\fP ()"
45 .RI "\fIReturns the last error to occur. \fP"
47 .RI "int \fBEnumerate\fP (std::string tag)"
49 .RI "\fICounts the number of times a given tag appears in the config file. \fP"
51 .RI "bool \fBVerify\fP ()"
53 .RI "\fIReturns true if a config file is valid. \fP"
55 .RI "void \fBDumpErrors\fP (bool bail, \fBuserrec\fP *user)"
57 .RI "\fIDumps the list of errors in a config file to an output location. \fP"
59 .RI "int \fBEnumerateValues\fP (std::string tag, int index)"
61 .RI "\fIReturns the number of items within a tag. \fP"
63 .SS "Protected Attributes"
67 .RI "std::stringstream * \fBcache\fP"
69 .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"
71 .RI "std::stringstream * \fBerrorlog\fP"
74 .RI "bool \fBreaderror\fP"
76 .RI "\fIUsed to store errors. \fP"
78 .RI "long \fBerror\fP"
81 .SH "Detailed Description"
83 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.
85 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.
87 Definition at line 1097 of file modules.h.
88 .SH "Constructor & Destructor Documentation"
90 .SS "ConfigReader::ConfigReader ()"
92 Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 835 of file modules.cpp.
94 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
98 837 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
99 838 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
100 839 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
101 840 if (!this->readerror)
102 841 this->error = CONF_FILE_NOT_FOUND;
105 .SS "ConfigReader::ConfigReader (std::string filename)"
107 Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 854 of file modules.cpp.
109 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
113 856 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
114 857 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
115 858 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
116 859 if (!this->readerror)
117 860 this->error = CONF_FILE_NOT_FOUND;
120 .SS "ConfigReader::~\fBConfigReader\fP ()"
122 Default destructor. This method destroys the ConfigReader class.Definition at line 845 of file modules.cpp.
124 References cache, and errorlog.
129 848 delete this->cache;
130 849 if (this->errorlog)
131 850 delete this->errorlog;
134 .SH "Member Function Documentation"
136 .SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)"
138 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 932 of file modules.cpp.
140 References errorlog, connection::fd, and userrec::nick.
146 936 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
151 941 char dataline[1024];
154 944 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
155 945 while (!errorlog->eof())
157 947 errorlog->getline(dataline,1024);
158 948 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
163 953 WriteOpers('There were errors in the configuration file:',user->nick);
164 954 while (!errorlog->eof())
166 956 errorlog->getline(dataline,1024);
167 957 WriteOpers(dataline);
174 .SS "int ConfigReader::Enumerate (std::string tag)"
176 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 965 of file modules.cpp.
182 967 return EnumConf(cache,tag.c_str());
185 .SS "int ConfigReader::EnumerateValues (std::string tag, int index)"
187 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 970 of file modules.cpp.
193 972 return EnumValues(cache, tag.c_str(), index);
196 .SS "long ConfigReader::GetError ()"
198 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 925 of file modules.cpp.
204 927 long olderr = this->error;
209 .SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)"
211 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 879 of file modules.cpp.
213 References cache, CONF_VALUE_NOT_FOUND, and error.
217 881 char val[MAXBUF];
220 884 strlcpy(t,tag.c_str(),MAXBUF);
221 885 strlcpy(n,name.c_str(),MAXBUF);
222 886 int res = ReadConf(cache,t,n,index,val);
225 889 this->error = CONF_VALUE_NOT_FOUND;
228 892 std::string s = val;
229 893 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
232 .SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)"
234 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 896 of file modules.cpp.
236 References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
240 898 char val[MAXBUF];
243 901 strlcpy(t,tag.c_str(),MAXBUF);
244 902 strlcpy(n,name.c_str(),MAXBUF);
245 903 int res = ReadConf(cache,t,n,index,val);
248 906 this->error = CONF_VALUE_NOT_FOUND;
251 909 for (int i = 0; i < strlen(val); i++)
253 911 if (!isdigit(val[i]))
255 913 this->error = CONF_NOT_A_NUMBER;
259 917 if ((needs_unsigned) && (atoi(val)<0))
261 919 this->error = CONF_NOT_UNSIGNED;
264 922 return atoi(val);
267 .SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)"
269 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 863 of file modules.cpp.
271 References cache, CONF_VALUE_NOT_FOUND, and error.
275 865 char val[MAXBUF];
278 868 strlcpy(t,tag.c_str(),MAXBUF);
279 869 strlcpy(n,name.c_str(),MAXBUF);
280 870 int res = ReadConf(cache,t,n,index,val);
283 873 this->error = CONF_VALUE_NOT_FOUND;
286 876 return std::string(val);
289 .SS "bool ConfigReader::Verify ()"
291 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 975 of file modules.cpp.
293 References readerror.
297 977 return this->readerror;
300 .SH "Member Data Documentation"
302 .SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP"
304 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 1105 of file modules.h.
306 Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
307 .SS "long \fBConfigReader::error\fP\fC [protected]\fP"
309 Definition at line 1110 of file modules.h.
311 Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
312 .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP"
314 Definition at line 1106 of file modules.h.
316 Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
317 .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP"
319 Used to store errors. Definition at line 1109 of file modules.h.
321 Referenced by ConfigReader(), and Verify().
325 Generated automatically by Doxygen for InspIRCd from the source code.