Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | 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>

Inherits classbase.

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

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

00836 {
00837         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00838         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00839         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
00840         if (!this->readerror)
00841                 this->error = CONF_FILE_NOT_FOUND;
00842 }

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 854 of file modules.cpp.

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

00855 {
00856         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00857         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00858         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
00859         if (!this->readerror)
00860                 this->error = CONF_FILE_NOT_FOUND;
00861 };

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 845 of file modules.cpp.

References cache, and errorlog. 

00846 {
00847         if (this->cache)
00848                 delete this->cache;
00849         if (this->errorlog)
00850                 delete this->errorlog;
00851 }

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

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

00933 {
00934         if (bail)
00935         {
00936                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
00937                 exit(0);
00938         }
00939         else
00940         {
00941                 char dataline[1024];
00942                 if (user)
00943                 {
00944                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
00945                         while (!errorlog->eof())
00946                         {
00947                                 errorlog->getline(dataline,1024);
00948                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
00949                         }
00950                 }
00951                 else
00952                 {
00953                         WriteOpers("There were errors in the configuration file:",user->nick);
00954                         while (!errorlog->eof())
00955                         {
00956                                 errorlog->getline(dataline,1024);
00957                                 WriteOpers(dataline);
00958                         }
00959                 }
00960                 return;
00961         }
00962 }

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

References cache. 

00966 {
00967         return EnumConf(cache,tag.c_str());
00968 }

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

References cache. 

00971 {
00972         return EnumValues(cache, tag.c_str(), index);
00973 }

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

References error. 

00926 {
00927         long olderr = this->error;
00928         this->error = 0;
00929         return olderr;
00930 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00880 {
00881         char val[MAXBUF];
00882         char t[MAXBUF];
00883         char n[MAXBUF];
00884         strlcpy(t,tag.c_str(),MAXBUF);
00885         strlcpy(n,name.c_str(),MAXBUF);
00886         int res = ReadConf(cache,t,n,index,val);
00887         if (!res)
00888         {
00889                 this->error = CONF_VALUE_NOT_FOUND;
00890                 return false;
00891         }
00892         std::string s = val;
00893         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
00894 }

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

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

00897 {
00898         char val[MAXBUF];
00899         char t[MAXBUF];
00900         char n[MAXBUF];
00901         strlcpy(t,tag.c_str(),MAXBUF);
00902         strlcpy(n,name.c_str(),MAXBUF);
00903         int res = ReadConf(cache,t,n,index,val);
00904         if (!res)
00905         {
00906                 this->error = CONF_VALUE_NOT_FOUND;
00907                 return 0;
00908         }
00909         for (int i = 0; i < strlen(val); i++)
00910         {
00911                 if (!isdigit(val[i]))
00912                 {
00913                         this->error = CONF_NOT_A_NUMBER;
00914                         return 0;
00915                 }
00916         }
00917         if ((needs_unsigned) && (atoi(val)<0))
00918         {
00919                 this->error = CONF_NOT_UNSIGNED;
00920                 return 0;
00921         }
00922         return atoi(val);
00923 }

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 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 "";
00875         }
00876         return std::string(val);
00877 }

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

References readerror. 

00976 {
00977         return this->readerror;
00978 }

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

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

long ConfigReader::error [protected]
 

Definition at line 1110 of file modules.h.

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

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

Definition at line 1106 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 1109 of file modules.h.

Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files:
Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by doxygen 1.3.3