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

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

00709 {
00710         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00711         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00712         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
00713         if (!this->readerror)
00714                 this->error = CONF_FILE_NOT_FOUND;
00715 }

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 727 of file modules.cpp.

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

00728 {
00729         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00730         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00731         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
00732         if (!this->readerror)
00733                 this->error = CONF_FILE_NOT_FOUND;
00734 };

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 718 of file modules.cpp.

References cache, and errorlog. 

00719 {
00720         if (this->cache)
00721                 delete this->cache;
00722         if (this->errorlog)
00723                 delete this->errorlog;
00724 }

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

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

00806 {
00807         if (bail)
00808         {
00809                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
00810                 exit(0);
00811         }
00812         else
00813         {
00814                 char dataline[1024];
00815                 if (user)
00816                 {
00817                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
00818                         while (!errorlog->eof())
00819                         {
00820                                 errorlog->getline(dataline,1024);
00821                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
00822                         }
00823                 }
00824                 else
00825                 {
00826                         WriteOpers("There were errors in the configuration file:",user->nick);
00827                         while (!errorlog->eof())
00828                         {
00829                                 errorlog->getline(dataline,1024);
00830                                 WriteOpers(dataline);
00831                         }
00832                 }
00833                 return;
00834         }
00835 }

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

References cache. 

00839 {
00840         return EnumConf(cache,tag.c_str());
00841 }

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

References cache. 

00844 {
00845         return EnumValues(cache, tag.c_str(), index);
00846 }

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

References error. 

00799 {
00800         long olderr = this->error;
00801         this->error = 0;
00802         return olderr;
00803 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00753 {
00754         char val[MAXBUF];
00755         char t[MAXBUF];
00756         char n[MAXBUF];
00757         strlcpy(t,tag.c_str(),MAXBUF);
00758         strlcpy(n,name.c_str(),MAXBUF);
00759         int res = ReadConf(cache,t,n,index,val);
00760         if (!res)
00761         {
00762                 this->error = CONF_VALUE_NOT_FOUND;
00763                 return false;
00764         }
00765         std::string s = val;
00766         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
00767 }

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

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

00770 {
00771         char val[MAXBUF];
00772         char t[MAXBUF];
00773         char n[MAXBUF];
00774         strlcpy(t,tag.c_str(),MAXBUF);
00775         strlcpy(n,name.c_str(),MAXBUF);
00776         int res = ReadConf(cache,t,n,index,val);
00777         if (!res)
00778         {
00779                 this->error = CONF_VALUE_NOT_FOUND;
00780                 return 0;
00781         }
00782         for (int i = 0; i < strlen(val); i++)
00783         {
00784                 if (!isdigit(val[i]))
00785                 {
00786                         this->error = CONF_NOT_A_NUMBER;
00787                         return 0;
00788                 }
00789         }
00790         if ((needs_unsigned) && (atoi(val)<0))
00791         {
00792                 this->error = CONF_NOT_UNSIGNED;
00793                 return 0;
00794         }
00795         return atoi(val);
00796 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00737 {
00738         char val[MAXBUF];
00739         char t[MAXBUF];
00740         char n[MAXBUF];
00741         strlcpy(t,tag.c_str(),MAXBUF);
00742         strlcpy(n,name.c_str(),MAXBUF);
00743         int res = ReadConf(cache,t,n,index,val);
00744         if (!res)
00745         {
00746                 this->error = CONF_VALUE_NOT_FOUND;
00747                 return "";
00748         }
00749         return std::string(val);
00750 }

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

References readerror. 

00849 {
00850         return this->readerror;
00851 }

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

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

long ConfigReader::error [protected]
 

Definition at line 848 of file modules.h.

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

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

Definition at line 844 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 847 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 14:50:49 2005 for InspIRCd by doxygen 1.3.3