Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class 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 1510 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 807 of file modules.cpp.

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

00808 {
00809         include_stack.clear();
00810         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00811         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00812         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
00813         if (!this->readerror)
00814                 this->error = CONF_FILE_NOT_FOUND;
00815 }

ConfigReader::ConfigReader std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 827 of file modules.cpp.

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

00828 {
00829         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00830         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00831         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
00832         if (!this->readerror)
00833                 this->error = CONF_FILE_NOT_FOUND;
00834 };

ConfigReader::~ConfigReader  ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 818 of file modules.cpp.

References cache, and errorlog.

00819 {
00820         if (this->cache)
00821                 delete this->cache;
00822         if (this->errorlog)
00823                 delete this->errorlog;
00824 }


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

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

00906 {
00907         if (bail)
00908         {
00909                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
00910                 exit(0);
00911         }
00912         else
00913         {
00914                 char dataline[1024];
00915                 if (user)
00916                 {
00917                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
00918                         while (!errorlog->eof())
00919                         {
00920                                 errorlog->getline(dataline,1024);
00921                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
00922                         }
00923                 }
00924                 else
00925                 {
00926                         WriteOpers("There were errors in the configuration file:",user->nick);
00927                         while (!errorlog->eof())
00928                         {
00929                                 errorlog->getline(dataline,1024);
00930                                 WriteOpers(dataline);
00931                         }
00932                 }
00933                 return;
00934         }
00935 }

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

References cache.

00939 {
00940         return EnumConf(cache,tag.c_str());
00941 }

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

References cache.

00944 {
00945         return EnumValues(cache, tag.c_str(), index);
00946 }

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

References error.

00899 {
00900         long olderr = this->error;
00901         this->error = 0;
00902         return olderr;
00903 }

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

References cache, CONF_VALUE_NOT_FOUND, and error.

00853 {
00854         char val[MAXBUF];
00855         char t[MAXBUF];
00856         char n[MAXBUF];
00857         strlcpy(t,tag.c_str(),MAXBUF);
00858         strlcpy(n,name.c_str(),MAXBUF);
00859         int res = ReadConf(cache,t,n,index,val);
00860         if (!res)
00861         {
00862                 this->error = CONF_VALUE_NOT_FOUND;
00863                 return false;
00864         }
00865         std::string s = val;
00866         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
00867 }

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

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

00870 {
00871         char val[MAXBUF];
00872         char t[MAXBUF];
00873         char n[MAXBUF];
00874         strlcpy(t,tag.c_str(),MAXBUF);
00875         strlcpy(n,name.c_str(),MAXBUF);
00876         int res = ReadConf(cache,t,n,index,val);
00877         if (!res)
00878         {
00879                 this->error = CONF_VALUE_NOT_FOUND;
00880                 return 0;
00881         }
00882         for (unsigned int i = 0; i < strlen(val); i++)
00883         {
00884                 if (!isdigit(val[i]))
00885                 {
00886                         this->error = CONF_NOT_A_NUMBER;
00887                         return 0;
00888                 }
00889         }
00890         if ((needs_unsigned) && (atoi(val)<0))
00891         {
00892                 this->error = CONF_NOT_UNSIGNED;
00893                 return 0;
00894         }
00895         return atoi(val);
00896 }

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

References cache, CONF_VALUE_NOT_FOUND, and error.

00837 {
00838         char val[MAXBUF];
00839         char t[MAXBUF];
00840         char n[MAXBUF];
00841         strlcpy(t,tag.c_str(),MAXBUF);
00842         strlcpy(n,name.c_str(),MAXBUF);
00843         int res = ReadConf(cache,t,n,index,val);
00844         if (!res)
00845         {
00846                 this->error = CONF_VALUE_NOT_FOUND;
00847                 return "";
00848         }
00849         return val;
00850 }

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

References readerror.

00949 {
00950         return this->readerror;
00951 }


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

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

long ConfigReader::error [protected]
 

Definition at line 1523 of file modules.h.

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

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

Definition at line 1519 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 1522 of file modules.h.

Referenced by ConfigReader(), and Verify().


The documentation for this class was generated from the following files:
Generated on Mon Dec 12 13:31:11 2005 for InspIRCd by  doxygen 1.4.4-20050815