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

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

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

ConfigReader::ConfigReader (  std::string  filename  ) 
 

Overloaded constructor.

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

Definition at line 598 of file modules.cpp.

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

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

ConfigReader::~ConfigReader (   ) 
 

Default destructor.

This method destroys the ConfigReader class.

Definition at line 589 of file modules.cpp.

References cache, and errorlog. 

00590 {
00591         if (this->cache)
00592                 delete this->cache;
00593         if (this->errorlog)
00594                 delete this->errorlog;
00595 }

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

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

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

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

References cache. 

00710 {
00711         return EnumConf(cache,tag.c_str());
00712 }

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

References cache. 

00715 {
00716         return EnumValues(cache, tag.c_str(), index);
00717 }

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

References error. 

00670 {
00671         long olderr = this->error;
00672         this->error = 0;
00673         return olderr;
00674 }

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

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

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

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

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

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

References cache, CONF_VALUE_NOT_FOUND, and error. 

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

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

References readerror. 

00720 {
00721         return this->readerror;
00722 }

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

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

long ConfigReader::error [protected]
 

Definition at line 696 of file modules.h.

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

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

Definition at line 692 of file modules.h.

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

bool ConfigReader::readerror [protected]
 

Used to store errors.

Definition at line 695 of file modules.h.

Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files:
Generated on Sat Apr 9 14:38:28 2005 for InspIRCd by doxygen 1.3.3