docs/man/man3/ConfigReader.3

   1 .TH "ConfigReader" 3 "2 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 669 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 576 of file modules.cpp.
  93 .PP
  94 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
  95 .PP
  96 .nf
  97 577 {
  98 578         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
  99 579         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
 100 580         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
 101 581         if (!this->readerror)
 102 582                 this->error = CONF_FILE_NOT_FOUND;
 103 583 }
 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 595 of file modules.cpp.
 108 .PP
 109 References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
 110 .PP
 111 .nf
 112 596 {
 113 597         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
 114 598         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
 115 599         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
 116 600         if (!this->readerror)
 117 601                 this->error = CONF_FILE_NOT_FOUND;
 118 602 };
 119 .fi
 120 .SS "ConfigReader::~\fBConfigReader\fP ()"
 121 .PP
 122 Default destructor. This method destroys the ConfigReader class.Definition at line 586 of file modules.cpp.
 123 .PP
 124 References cache, and errorlog.
 125 .PP
 126 .nf
 127 587 {
 128 588         if (this->cache)
 129 589                 delete this->cache;
 130 590         if (this->errorlog)
 131 591                 delete this->errorlog;
 132 592 }
 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 673 of file modules.cpp.
 139 .PP
 140 References errorlog, connection::fd, and userrec::nick.
 141 .PP
 142 .nf
 143 674 {
 144 675         if (bail)
 145 676         {
 146 677                 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
 147 678                 exit(0);
 148 679         }
 149 680         else
 150 681         {
 151 682                 char dataline[1024];
 152 683                 if (user)
 153 684                 {
 154 685                         WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
 155 686                         while (!errorlog->eof())
 156 687                         {
 157 688                                 errorlog->getline(dataline,1024);
 158 689                                 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
 159 690                         }
 160 691                 }
 161 692                 else
 162 693                 {
 163 694                         WriteOpers('There were errors in the configuration file:',user->nick);
 164 695                         while (!errorlog->eof())
 165 696                         {
 166 697                                 errorlog->getline(dataline,1024);
 167 698                                 WriteOpers(dataline);
 168 699                         }
 169 700                 }
 170 701                 return;
 171 702         }
 172 703 }
 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 706 of file modules.cpp.
 177 .PP
 178 References cache.
 179 .PP
 180 .nf
 181 707 {
 182 708         return EnumConf(cache,tag.c_str());
 183 709 }
 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 711 of file modules.cpp.
 188 .PP
 189 References cache.
 190 .PP
 191 .nf
 192 712 {
 193 713         return EnumValues(cache, tag.c_str(), index);
 194 714 }
 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 666 of file modules.cpp.
 199 .PP
 200 References error.
 201 .PP
 202 .nf
 203 667 {
 204 668         long olderr = this->error;
 205 669         this->error = 0;
 206 670         return olderr;
 207 671 }
 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 620 of file modules.cpp.
 212 .PP
 213 References cache, CONF_VALUE_NOT_FOUND, and error.
 214 .PP
 215 .nf
 216 621 {
 217 622         char val[MAXBUF];
 218 623         char t[MAXBUF];
 219 624         char n[MAXBUF];
 220 625         strlcpy(t,tag.c_str(),MAXBUF);
 221 626         strlcpy(n,name.c_str(),MAXBUF);
 222 627         int res = ReadConf(cache,t,n,index,val);
 223 628         if (!res)
 224 629         {
 225 630                 this->error = CONF_VALUE_NOT_FOUND;
 226 631                 return false;
 227 632         }
 228 633         std::string s = val;
 229 634         return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
 230 635 }
 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 637 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 638 {
 240 639         char val[MAXBUF];
 241 640         char t[MAXBUF];
 242 641         char n[MAXBUF];
 243 642         strlcpy(t,tag.c_str(),MAXBUF);
 244 643         strlcpy(n,name.c_str(),MAXBUF);
 245 644         int res = ReadConf(cache,t,n,index,val);
 246 645         if (!res)
 247 646         {
 248 647                 this->error = CONF_VALUE_NOT_FOUND;
 249 648                 return 0;
 250 649         }
 251 650         for (int i = 0; i < strlen(val); i++)
 252 651         {
 253 652                 if (!isdigit(val[i]))
 254 653                 {
 255 654                         this->error = CONF_NOT_A_NUMBER;
 256 655                         return 0;
 257 656                 }
 258 657         }
 259 658         if ((needs_unsigned) && (atoi(val)<0))
 260 659         {
 261 660                 this->error = CONF_NOT_UNSIGNED;
 262 661                 return 0;
 263 662         }
 264 663         return atoi(val);
 265 664 }
 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 604 of file modules.cpp.
 270 .PP
 271 References cache, CONF_VALUE_NOT_FOUND, and error.
 272 .PP
 273 .nf
 274 605 {
 275 606         char val[MAXBUF];
 276 607         char t[MAXBUF];
 277 608         char n[MAXBUF];
 278 609         strlcpy(t,tag.c_str(),MAXBUF);
 279 610         strlcpy(n,name.c_str(),MAXBUF);
 280 611         int res = ReadConf(cache,t,n,index,val);
 281 612         if (!res)
 282 613         {
 283 614                 this->error = CONF_VALUE_NOT_FOUND;
 284 615                 return '';
 285 616         }
 286 617         return std::string(val);
 287 618 }
 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 716 of file modules.cpp.
 292 .PP
 293 References readerror.
 294 .PP
 295 .nf
 296 717 {
 297 718         return this->readerror;
 298 719 }
 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 677 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 682 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 678 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 681 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.