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

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

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

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 852 of file modules.cpp.

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

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

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 843 of file modules.cpp.

References cache, and errorlog. 

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

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

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

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

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

References cache. 

00964 {
00965         return EnumConf(cache,tag.c_str());
00966 }

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

References cache. 

00969 {
00970         return EnumValues(cache, tag.c_str(), index);
00971 }

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

References error. 

00924 {
00925         long olderr = this->error;
00926         this->error = 0;
00927         return olderr;
00928 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

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

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

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

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

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00862 {
00863         char val[MAXBUF];
00864         char t[MAXBUF];
00865         char n[MAXBUF];
00866         strlcpy(t,tag.c_str(),MAXBUF);
00867         strlcpy(n,name.c_str(),MAXBUF);
00868         int res = ReadConf(cache,t,n,index,val);
00869         if (!res)
00870         {
00871                 this->error = CONF_VALUE_NOT_FOUND;
00872                 return "";
00873         }
00874         return std::string(val);
00875 }

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

References readerror. 

00974 {
00975         return this->readerror;
00976 }

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

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

long ConfigReader::error [protected]
 

Definition at line 1085 of file modules.h.

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

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

Definition at line 1081 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 1084 of file modules.h.

Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files:
Generated on Wed Apr 20 15:47:01 2005 for InspIRCd by doxygen 1.3.3