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

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

00718 {
00719         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00720         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00721         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
00722         if (!this->readerror)
00723                 this->error = CONF_FILE_NOT_FOUND;
00724 }

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 736 of file modules.cpp.

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

00737 {
00738         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00739         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00740         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
00741         if (!this->readerror)
00742                 this->error = CONF_FILE_NOT_FOUND;
00743 };

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 727 of file modules.cpp.

References cache, and errorlog. 

00728 {
00729         if (this->cache)
00730                 delete this->cache;
00731         if (this->errorlog)
00732                 delete this->errorlog;
00733 }

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

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

00815 {
00816         if (bail)
00817         {
00818                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
00819                 exit(0);
00820         }
00821         else
00822         {
00823                 char dataline[1024];
00824                 if (user)
00825                 {
00826                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
00827                         while (!errorlog->eof())
00828                         {
00829                                 errorlog->getline(dataline,1024);
00830                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
00831                         }
00832                 }
00833                 else
00834                 {
00835                         WriteOpers("There were errors in the configuration file:",user->nick);
00836                         while (!errorlog->eof())
00837                         {
00838                                 errorlog->getline(dataline,1024);
00839                                 WriteOpers(dataline);
00840                         }
00841                 }
00842                 return;
00843         }
00844 }

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

References cache. 

00848 {
00849         return EnumConf(cache,tag.c_str());
00850 }

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

References cache. 

00853 {
00854         return EnumValues(cache, tag.c_str(), index);
00855 }

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

References error. 

00808 {
00809         long olderr = this->error;
00810         this->error = 0;
00811         return olderr;
00812 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00762 {
00763         char val[MAXBUF];
00764         char t[MAXBUF];
00765         char n[MAXBUF];
00766         strlcpy(t,tag.c_str(),MAXBUF);
00767         strlcpy(n,name.c_str(),MAXBUF);
00768         int res = ReadConf(cache,t,n,index,val);
00769         if (!res)
00770         {
00771                 this->error = CONF_VALUE_NOT_FOUND;
00772                 return false;
00773         }
00774         std::string s = val;
00775         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
00776 }

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

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

00779 {
00780         char val[MAXBUF];
00781         char t[MAXBUF];
00782         char n[MAXBUF];
00783         strlcpy(t,tag.c_str(),MAXBUF);
00784         strlcpy(n,name.c_str(),MAXBUF);
00785         int res = ReadConf(cache,t,n,index,val);
00786         if (!res)
00787         {
00788                 this->error = CONF_VALUE_NOT_FOUND;
00789                 return 0;
00790         }
00791         for (int i = 0; i < strlen(val); i++)
00792         {
00793                 if (!isdigit(val[i]))
00794                 {
00795                         this->error = CONF_NOT_A_NUMBER;
00796                         return 0;
00797                 }
00798         }
00799         if ((needs_unsigned) && (atoi(val)<0))
00800         {
00801                 this->error = CONF_NOT_UNSIGNED;
00802                 return 0;
00803         }
00804         return atoi(val);
00805 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00746 {
00747         char val[MAXBUF];
00748         char t[MAXBUF];
00749         char n[MAXBUF];
00750         strlcpy(t,tag.c_str(),MAXBUF);
00751         strlcpy(n,name.c_str(),MAXBUF);
00752         int res = ReadConf(cache,t,n,index,val);
00753         if (!res)
00754         {
00755                 this->error = CONF_VALUE_NOT_FOUND;
00756                 return "";
00757         }
00758         return std::string(val);
00759 }

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

References readerror. 

00858 {
00859         return this->readerror;
00860 }

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

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

long ConfigReader::error [protected]
 

Definition at line 904 of file modules.h.

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

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

Definition at line 900 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 903 of file modules.h.

Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files:
Generated on Fri Apr 15 19:30:19 2005 for InspIRCd by doxygen 1.3.3