Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

ConfigReader Class Reference

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. More...

#include <modules.h>

Inheritance diagram for ConfigReader:

Inheritance graph
[legend]
Collaboration diagram for ConfigReader:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ConfigReader ()
 Default constructor.

 ConfigReader (std::string filename)
 Overloaded constructor.

 ~ConfigReader ()
 Default destructor.

std::string ReadValue (std::string tag, std::string name, int index)
 Retrieves a value from the config file.

bool ReadFlag (std::string tag, std::string name, int index)
 Retrieves a boolean value from the config file.

long ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)
 Retrieves an integer value from the config file.

long GetError ()
 Returns the last error to occur.

int Enumerate (std::string tag)
 Counts the number of times a given tag appears in the config file.

bool Verify ()
 Returns true if a config file is valid.

void DumpErrors (bool bail, userrec *user)
 Dumps the list of errors in a config file to an output location.

int EnumerateValues (std::string tag, int index)
 Returns the number of items within a tag.


Protected Attributes

std::stringstream * cache
 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).

std::stringstream * errorlog
bool readerror
 Used to store errors.

long error

Detailed Description

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.

Definition at line 1150 of file modules.h.

Constructor & Destructor Documentation

ConfigReader::ConfigReader (   ) 
 

Default constructor.

This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.

Definition at line 819 of file modules.cpp.

References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. 

00820 {
00821         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00822         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00823         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
00824         if (!this->readerror)
00825                 this->error = CONF_FILE_NOT_FOUND;
00826 }

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

This constructor initialises the ConfigReader class to read a user-specified config file

Definition at line 838 of file modules.cpp.

References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. 

00839 {
00840         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00841         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00842         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
00843         if (!this->readerror)
00844                 this->error = CONF_FILE_NOT_FOUND;
00845 };

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 829 of file modules.cpp.

References cache, and errorlog. 

00830 {
00831         if (this->cache)
00832                 delete this->cache;
00833         if (this->errorlog)
00834                 delete this->errorlog;
00835 }

Member Function Documentation

void ConfigReader::DumpErrors (  bool  bail,
userrec *  user
) 
 

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 916 of file modules.cpp.

References errorlog, connection::fd, and userrec::nick. 

00917 {
00918         if (bail)
00919         {
00920                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
00921                 exit(0);
00922         }
00923         else
00924         {
00925                 char dataline[1024];
00926                 if (user)
00927                 {
00928                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
00929                         while (!errorlog->eof())
00930                         {
00931                                 errorlog->getline(dataline,1024);
00932                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
00933                         }
00934                 }
00935                 else
00936                 {
00937                         WriteOpers("There were errors in the configuration file:",user->nick);
00938                         while (!errorlog->eof())
00939                         {
00940                                 errorlog->getline(dataline,1024);
00941                                 WriteOpers(dataline);
00942                         }
00943                 }
00944                 return;
00945         }
00946 }

int ConfigReader::Enumerate (  std::string  tag  ) 
 

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 ConfigReader::ReadValue to loop through all copies of a multiple instance tag.

Definition at line 949 of file modules.cpp.

References cache. 

00950 {
00951         return EnumConf(cache,tag.c_str());
00952 }

int ConfigReader::EnumerateValues (  std::string  tag,
int  index
) 
 

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 954 of file modules.cpp.

References cache. 

00955 {
00956         return EnumValues(cache, tag.c_str(), index);
00957 }

long ConfigReader::GetError (   ) 
 

Returns the last error to occur.

Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.

Definition at line 909 of file modules.cpp.

References error. 

00910 {
00911         long olderr = this->error;
00912         this->error = 0;
00913         return olderr;
00914 }

bool ConfigReader::ReadFlag (  std::string  tag,
std::string  name,
int  index
) 
 

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 863 of file modules.cpp.

References cache, CONF_VALUE_NOT_FOUND, and error. 

00864 {
00865         char val[MAXBUF];
00866         char t[MAXBUF];
00867         char n[MAXBUF];
00868         strlcpy(t,tag.c_str(),MAXBUF);
00869         strlcpy(n,name.c_str(),MAXBUF);
00870         int res = ReadConf(cache,t,n,index,val);
00871         if (!res)
00872         {
00873                 this->error = CONF_VALUE_NOT_FOUND;
00874                 return false;
00875         }
00876         std::string s = val;
00877         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
00878 }

long ConfigReader::ReadInteger (  std::string  tag,
std::string  name,
int  index,
bool  needs_unsigned
) 
 

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 GetError() 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 GetError() will return CONF_NOT_UNSIGNED

Definition at line 880 of file modules.cpp.

References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. 

00881 {
00882         char val[MAXBUF];
00883         char t[MAXBUF];
00884         char n[MAXBUF];
00885         strlcpy(t,tag.c_str(),MAXBUF);
00886         strlcpy(n,name.c_str(),MAXBUF);
00887         int res = ReadConf(cache,t,n,index,val);
00888         if (!res)
00889         {
00890                 this->error = CONF_VALUE_NOT_FOUND;
00891                 return 0;
00892         }
00893         for (int i = 0; i < strlen(val); i++)
00894         {
00895                 if (!isdigit(val[i]))
00896                 {
00897                         this->error = CONF_NOT_A_NUMBER;
00898                         return 0;
00899                 }
00900         }
00901         if ((needs_unsigned) && (atoi(val)<0))
00902         {
00903                 this->error = CONF_NOT_UNSIGNED;
00904                 return 0;
00905         }
00906         return atoi(val);
00907 }

std::string ConfigReader::ReadValue (  std::string  tag,
std::string  name,
int  index
) 
 

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 847 of file modules.cpp.

References cache, CONF_VALUE_NOT_FOUND, and error. 

00848 {
00849         char val[MAXBUF];
00850         char t[MAXBUF];
00851         char n[MAXBUF];
00852         strlcpy(t,tag.c_str(),MAXBUF);
00853         strlcpy(n,name.c_str(),MAXBUF);
00854         int res = ReadConf(cache,t,n,index,val);
00855         if (!res)
00856         {
00857                 this->error = CONF_VALUE_NOT_FOUND;
00858                 return "";
00859         }
00860         return val;
00861 }

bool ConfigReader::Verify (   ) 
 

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 959 of file modules.cpp.

References readerror. 

00960 {
00961         return this->readerror;
00962 }

Member Data Documentation

std::stringstream* ConfigReader::cache [protected]
 

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 1158 of file modules.h.

Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().

long ConfigReader::error [protected]
 

Definition at line 1163 of file modules.h.

Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().

std::stringstream* ConfigReader::errorlog [protected]
 

Definition at line 1159 of file modules.h.

Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 1162 of file modules.h.

Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files:
Generated on Wed May 25 22:02:53 2005 for InspIRCd by doxygen 1.3.3