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

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

00763 {
00764         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00765         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00766         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
00767         if (!this->readerror)
00768                 this->error = CONF_FILE_NOT_FOUND;
00769 }

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 781 of file modules.cpp.

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

00782 {
00783         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00784         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00785         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
00786         if (!this->readerror)
00787                 this->error = CONF_FILE_NOT_FOUND;
00788 };

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 772 of file modules.cpp.

References cache, and errorlog. 

00773 {
00774         if (this->cache)
00775                 delete this->cache;
00776         if (this->errorlog)
00777                 delete this->errorlog;
00778 }

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

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

00860 {
00861         if (bail)
00862         {
00863                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
00864                 exit(0);
00865         }
00866         else
00867         {
00868                 char dataline[1024];
00869                 if (user)
00870                 {
00871                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
00872                         while (!errorlog->eof())
00873                         {
00874                                 errorlog->getline(dataline,1024);
00875                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
00876                         }
00877                 }
00878                 else
00879                 {
00880                         WriteOpers("There were errors in the configuration file:",user->nick);
00881                         while (!errorlog->eof())
00882                         {
00883                                 errorlog->getline(dataline,1024);
00884                                 WriteOpers(dataline);
00885                         }
00886                 }
00887                 return;
00888         }
00889 }

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

References cache. 

00893 {
00894         return EnumConf(cache,tag.c_str());
00895 }

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

References cache. 

00898 {
00899         return EnumValues(cache, tag.c_str(), index);
00900 }

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

References error. 

00853 {
00854         long olderr = this->error;
00855         this->error = 0;
00856         return olderr;
00857 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00807 {
00808         char val[MAXBUF];
00809         char t[MAXBUF];
00810         char n[MAXBUF];
00811         strlcpy(t,tag.c_str(),MAXBUF);
00812         strlcpy(n,name.c_str(),MAXBUF);
00813         int res = ReadConf(cache,t,n,index,val);
00814         if (!res)
00815         {
00816                 this->error = CONF_VALUE_NOT_FOUND;
00817                 return false;
00818         }
00819         std::string s = val;
00820         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
00821 }

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

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

00824 {
00825         char val[MAXBUF];
00826         char t[MAXBUF];
00827         char n[MAXBUF];
00828         strlcpy(t,tag.c_str(),MAXBUF);
00829         strlcpy(n,name.c_str(),MAXBUF);
00830         int res = ReadConf(cache,t,n,index,val);
00831         if (!res)
00832         {
00833                 this->error = CONF_VALUE_NOT_FOUND;
00834                 return 0;
00835         }
00836         for (int i = 0; i < strlen(val); i++)
00837         {
00838                 if (!isdigit(val[i]))
00839                 {
00840                         this->error = CONF_NOT_A_NUMBER;
00841                         return 0;
00842                 }
00843         }
00844         if ((needs_unsigned) && (atoi(val)<0))
00845         {
00846                 this->error = CONF_NOT_UNSIGNED;
00847                 return 0;
00848         }
00849         return atoi(val);
00850 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00791 {
00792         char val[MAXBUF];
00793         char t[MAXBUF];
00794         char n[MAXBUF];
00795         strlcpy(t,tag.c_str(),MAXBUF);
00796         strlcpy(n,name.c_str(),MAXBUF);
00797         int res = ReadConf(cache,t,n,index,val);
00798         if (!res)
00799         {
00800                 this->error = CONF_VALUE_NOT_FOUND;
00801                 return "";
00802         }
00803         return std::string(val);
00804 }

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

References readerror. 

00903 {
00904         return this->readerror;
00905 }

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

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

long ConfigReader::error [protected]
 

Definition at line 957 of file modules.h.

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

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

Definition at line 953 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 956 of file modules.h.

Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files:
Generated on Sat Apr 16 18:57:16 2005 for InspIRCd by doxygen 1.3.3