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

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

00577 {
00578         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00579         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00580         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
00581         if (!this->readerror)
00582                 this->error = CONF_FILE_NOT_FOUND;
00583 }

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 595 of file modules.cpp.

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

00596 {
00597         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
00598         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
00599         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
00600         if (!this->readerror)
00601                 this->error = CONF_FILE_NOT_FOUND;
00602 };

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 586 of file modules.cpp.

References cache, and errorlog. 

00587 {
00588         if (this->cache)
00589                 delete this->cache;
00590         if (this->errorlog)
00591                 delete this->errorlog;
00592 }

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

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

00674 {
00675         if (bail)
00676         {
00677                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
00678                 exit(0);
00679         }
00680         else
00681         {
00682                 char dataline[1024];
00683                 if (user)
00684                 {
00685                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
00686                         while (!errorlog->eof())
00687                         {
00688                                 errorlog->getline(dataline,1024);
00689                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
00690                         }
00691                 }
00692                 else
00693                 {
00694                         WriteOpers("There were errors in the configuration file:",user->nick);
00695                         while (!errorlog->eof())
00696                         {
00697                                 errorlog->getline(dataline,1024);
00698                                 WriteOpers(dataline);
00699                         }
00700                 }
00701                 return;
00702         }
00703 }

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

References cache. 

00707 {
00708         return EnumConf(cache,tag.c_str());
00709 }

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

References cache. 

00712 {
00713         return EnumValues(cache, tag.c_str(), index);
00714 }

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

References error. 

00667 {
00668         long olderr = this->error;
00669         this->error = 0;
00670         return olderr;
00671 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00621 {
00622         char val[MAXBUF];
00623         char t[MAXBUF];
00624         char n[MAXBUF];
00625         strlcpy(t,tag.c_str(),MAXBUF);
00626         strlcpy(n,name.c_str(),MAXBUF);
00627         int res = ReadConf(cache,t,n,index,val);
00628         if (!res)
00629         {
00630                 this->error = CONF_VALUE_NOT_FOUND;
00631                 return false;
00632         }
00633         std::string s = val;
00634         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
00635 }

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

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

00638 {
00639         char val[MAXBUF];
00640         char t[MAXBUF];
00641         char n[MAXBUF];
00642         strlcpy(t,tag.c_str(),MAXBUF);
00643         strlcpy(n,name.c_str(),MAXBUF);
00644         int res = ReadConf(cache,t,n,index,val);
00645         if (!res)
00646         {
00647                 this->error = CONF_VALUE_NOT_FOUND;
00648                 return 0;
00649         }
00650         for (int i = 0; i < strlen(val); i++)
00651         {
00652                 if (!isdigit(val[i]))
00653                 {
00654                         this->error = CONF_NOT_A_NUMBER;
00655                         return 0;
00656                 }
00657         }
00658         if ((needs_unsigned) && (atoi(val)<0))
00659         {
00660                 this->error = CONF_NOT_UNSIGNED;
00661                 return 0;
00662         }
00663         return atoi(val);
00664 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

00605 {
00606         char val[MAXBUF];
00607         char t[MAXBUF];
00608         char n[MAXBUF];
00609         strlcpy(t,tag.c_str(),MAXBUF);
00610         strlcpy(n,name.c_str(),MAXBUF);
00611         int res = ReadConf(cache,t,n,index,val);
00612         if (!res)
00613         {
00614                 this->error = CONF_VALUE_NOT_FOUND;
00615                 return "";
00616         }
00617         return std::string(val);
00618 }

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

References readerror. 

00717 {
00718         return this->readerror;
00719 }

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

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

long ConfigReader::error [protected]
 

Definition at line 682 of file modules.h.

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

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

Definition at line 678 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 681 of file modules.h.

Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files:
Generated on Mon Mar 28 21:09:31 2005 for InspIRCd by doxygen 1.3.3