docs/man/man3/ConfigReader.3

   1 .TH "ConfigReader" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   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.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <modules.h>\fP
  12 .PP
  13 Inherits \fBclassbase\fP.
  14 .PP
  15 .SS "Public Member Functions"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "\fBConfigReader\fP ()"
  20 .br
  21 .RI "\fIDefault constructor. \fP"
  22 .ti -1c
  23 .RI "\fBConfigReader\fP (std::string filename)"
  24 .br
  25 .RI "\fIOverloaded constructor. \fP"
  26 .ti -1c
  27 .RI "\fB~ConfigReader\fP ()"
  28 .br
  29 .RI "\fIDefault destructor. \fP"
  30 .ti -1c
  31 .RI "std::string \fBReadValue\fP (std::string tag, std::string name, int index)"
  32 .br
  33 .RI "\fIRetrieves a value from the config file. \fP"
  34 .ti -1c
  35 .RI "bool \fBReadFlag\fP (std::string tag, std::string name, int index)"
  36 .br
  37 .RI "\fIRetrieves a boolean value from the config file. \fP"
  38 .ti -1c
  39 .RI "long \fBReadInteger\fP (std::string tag, std::string name, int index, bool needs_unsigned)"
  40 .br
  41 .RI "\fIRetrieves an integer value from the config file. \fP"
  42 .ti -1c
  43 .RI "long \fBGetError\fP ()"
  44 .br
  45 .RI "\fIReturns the last error to occur. \fP"
  46 .ti -1c
  47 .RI "int \fBEnumerate\fP (std::string tag)"
  48 .br
  49 .RI "\fICounts the number of times a given tag appears in the config file. \fP"
  50 .ti -1c
  51 .RI "bool \fBVerify\fP ()"
  52 .br
  53 .RI "\fIReturns true if a config file is valid. \fP"
  54 .ti -1c
  55 .RI "void \fBDumpErrors\fP (bool bail, \fBuserrec\fP *user)"
  56 .br
  57 .RI "\fIDumps the list of errors in a config file to an output location. \fP"
  58 .ti -1c
  59 .RI "int \fBEnumerateValues\fP (std::string tag, int index)"
  60 .br
  61 .RI "\fIReturns the number of items within a tag. \fP"
  62 .in -1c
  63 .SS "Protected Attributes"
  64
  65 .in +1c
  66 .ti -1c
  67 .RI "std::stringstream * \fBcache\fP"
  68 .br
  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"
  70 .ti -1c
  71 .RI "std::stringstream * \fBerrorlog\fP"
  72 .br
  73 .ti -1c
  74 .RI "bool \fBreaderror\fP"
  75 .br
  76 .RI "\fIUsed to store errors. \fP"
  77 .ti -1c
  78 .RI "long \fBerror\fP"
  79 .br
  80 .in -1c
  81 .SH "Detailed Description"
  82 .PP
  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.
  84
  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.
  86 .PP
  87 Definition at line 944 of file modules.h.
  88 .SH "Constructor & Destructor Documentation"
  89 .PP
  90 .SS "ConfigReader::ConfigReader ()"
  91 .PP
  92 Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 762 of file modules.cpp.
  93 .PP
  94 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
  95 .PP
  96 .nf
  97 763 {
  98 764         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
  99 765         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
 100 766         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
 101 767         if (!this->readerror)
 102 768                 this->error = CONF_FILE_NOT_FOUND;
 103 769 }
 104 .fi
 105 .SS "ConfigReader::ConfigReader (std::string filename)"
 106 .PP
 107 Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 781 of file modules.cpp.
 108 .PP
 109 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
 110 .PP
 111 .nf
 112 782 {
 113 783         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
 114 784         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
 115 785         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
 116 786         if (!this->readerror)
 117 787                 this->error = CONF_FILE_NOT_FOUND;
 118 788 };
 119 .fi
 120 .SS "ConfigReader::~\fBConfigReader\fP ()"
 121 .PP
 122 Default destructor. This method destroys the ConfigReader class.Definition at line 772 of file modules.cpp.
 123 .PP
 124 References cache, and errorlog.
 125 .PP
 126 .nf
 127 773 {
 128 774         if (this->cache)
 129 775                 delete this->cache;
 130 776         if (this->errorlog)
 131 777                 delete this->errorlog;
 132 778 }
 133 .fi
 134 .SH "Member Function Documentation"
 135 .PP
 136 .SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)"
 137 .PP
 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 859 of file modules.cpp.
 139 .PP
 140 References errorlog, connection::fd, and userrec::nick.
 141 .PP
 142 .nf
 143 860 {
 144 861         if (bail)
 145 862         {
 146 863                 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
 147 864                 exit(0);
 148 865         }
 149 866         else
 150 867         {
 151 868                 char dataline[1024];
 152 869                 if (user)
 153 870                 {
 154 871                         WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
 155 872                         while (!errorlog->eof())
 156 873                         {
 157 874                                 errorlog->getline(dataline,1024);
 158 875                                 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
 159 876                         }
 160 877                 }
 161 878                 else
 162 879                 {
 163 880                         WriteOpers('There were errors in the configuration file:',user->nick);
 164 881                         while (!errorlog->eof())
 165 882                         {
 166 883                                 errorlog->getline(dataline,1024);
 167 884                                 WriteOpers(dataline);
 168 885                         }
 169 886                 }
 170 887                 return;
 171 888         }
 172 889 }
 173 .fi
 174 .SS "int ConfigReader::Enumerate (std::string tag)"
 175 .PP
 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 892 of file modules.cpp.
 177 .PP
 178 References cache.
 179 .PP
 180 .nf
 181 893 {
 182 894         return EnumConf(cache,tag.c_str());
 183 895 }
 184 .fi
 185 .SS "int ConfigReader::EnumerateValues (std::string tag, int index)"
 186 .PP
 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 897 of file modules.cpp.
 188 .PP
 189 References cache.
 190 .PP
 191 .nf
 192 898 {
 193 899         return EnumValues(cache, tag.c_str(), index);
 194 900 }
 195 .fi
 196 .SS "long ConfigReader::GetError ()"
 197 .PP
 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 852 of file modules.cpp.
 199 .PP
 200 References error.
 201 .PP
 202 .nf
 203 853 {
 204 854         long olderr = this->error;
 205 855         this->error = 0;
 206 856         return olderr;
 207 857 }
 208 .fi
 209 .SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)"
 210 .PP
 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 806 of file modules.cpp.
 212 .PP
 213 References cache, CONF_VALUE_NOT_FOUND, and error.
 214 .PP
 215 .nf
 216 807 {
 217 808         char val[MAXBUF];
 218 809         char t[MAXBUF];
 219 810         char n[MAXBUF];
 220 811         strlcpy(t,tag.c_str(),MAXBUF);
 221 812         strlcpy(n,name.c_str(),MAXBUF);
 222 813         int res = ReadConf(cache,t,n,index,val);
 223 814         if (!res)
 224 815         {
 225 816                 this->error = CONF_VALUE_NOT_FOUND;
 226 817                 return false;
 227 818         }
 228 819         std::string s = val;
 229 820         return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
 230 821 }
 231 .fi
 232 .SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)"
 233 .PP
 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 823 of file modules.cpp.
 235 .PP
 236 References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
 237 .PP
 238 .nf
 239 824 {
 240 825         char val[MAXBUF];
 241 826         char t[MAXBUF];
 242 827         char n[MAXBUF];
 243 828         strlcpy(t,tag.c_str(),MAXBUF);
 244 829         strlcpy(n,name.c_str(),MAXBUF);
 245 830         int res = ReadConf(cache,t,n,index,val);
 246 831         if (!res)
 247 832         {
 248 833                 this->error = CONF_VALUE_NOT_FOUND;
 249 834                 return 0;
 250 835         }
 251 836         for (int i = 0; i < strlen(val); i++)
 252 837         {
 253 838                 if (!isdigit(val[i]))
 254 839                 {
 255 840                         this->error = CONF_NOT_A_NUMBER;
 256 841                         return 0;
 257 842                 }
 258 843         }
 259 844         if ((needs_unsigned) && (atoi(val)<0))
 260 845         {
 261 846                 this->error = CONF_NOT_UNSIGNED;
 262 847                 return 0;
 263 848         }
 264 849         return atoi(val);
 265 850 }
 266 .fi
 267 .SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)"
 268 .PP
 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 790 of file modules.cpp.
 270 .PP
 271 References cache, CONF_VALUE_NOT_FOUND, and error.
 272 .PP
 273 .nf
 274 791 {
 275 792         char val[MAXBUF];
 276 793         char t[MAXBUF];
 277 794         char n[MAXBUF];
 278 795         strlcpy(t,tag.c_str(),MAXBUF);
 279 796         strlcpy(n,name.c_str(),MAXBUF);
 280 797         int res = ReadConf(cache,t,n,index,val);
 281 798         if (!res)
 282 799         {
 283 800                 this->error = CONF_VALUE_NOT_FOUND;
 284 801                 return '';
 285 802         }
 286 803         return std::string(val);
 287 804 }
 288 .fi
 289 .SS "bool ConfigReader::Verify ()"
 290 .PP
 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 902 of file modules.cpp.
 292 .PP
 293 References readerror.
 294 .PP
 295 .nf
 296 903 {
 297 904         return this->readerror;
 298 905 }
 299 .fi
 300 .SH "Member Data Documentation"
 301 .PP
 302 .SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP"
 303 .PP
 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 952 of file modules.h.
 305 .PP
 306 Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
 307 .SS "long \fBConfigReader::error\fP\fC [protected]\fP"
 308 .PP
 309 Definition at line 957 of file modules.h.
 310 .PP
 311 Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
 312 .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP"
 313 .PP
 314 Definition at line 953 of file modules.h.
 315 .PP
 316 Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
 317 .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP"
 318 .PP
 319 Used to store errors. Definition at line 956 of file modules.h.
 320 .PP
 321 Referenced by ConfigReader(), and Verify().
 322
 323 .SH "Author"
 324 .PP
 325 Generated automatically by Doxygen for InspIRCd from the source code.