From f62de63955ff77e800360eb140f108b5d2c6c075 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Dec 2005 18:32:09 +0000 Subject: Design flaw my ass. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2580 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 780 --------------------------------- 1 file changed, 780 deletions(-) delete mode 100644 docs/module-doc/classConfigReader.html (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html deleted file mode 100644 index e084841af..000000000 --- a/docs/module-doc/classConfigReader.html +++ /dev/null @@ -1,780 +0,0 @@ - - -InspIRCd: ConfigReader Class Reference - - - -
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 1550 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 735 of file modules.cpp. -

-References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.

00736 {
-00737         Config->ClearStack();
-00738         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00739         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00740         this->readerror = Config->LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00741         if (!this->readerror)
-00742                 this->error = CONF_FILE_NOT_FOUND;
-00743 }
-
-

-

-

- - - - -
- - - - - - - - - -
ConfigReader::ConfigReader ( std::string  filename  ) 
-
- - - - - -
-   - - -

-Overloaded constructor. -

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

-Definition at line 755 of file modules.cpp. -

-References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.

00756 {
-00757         Config->ClearStack();
-00758         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00759         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00760         this->readerror = Config->LoadConf(filename.c_str(),this->cache,this->errorlog);
-00761         if (!this->readerror)
-00762                 this->error = CONF_FILE_NOT_FOUND;
-00763 };
-
-

-

-

- - - - -
- - - - - - - - -
ConfigReader::~ConfigReader (   ) 
-
- - - - - -
-   - - -

-Default destructor. -

-This method destroys the ConfigReader class. -

-Definition at line 746 of file modules.cpp. -

-References cache, and errorlog.

00747 {
-00748         if (this->cache)
-00749                 delete this->cache;
-00750         if (this->errorlog)
-00751                 delete this->errorlog;
-00752 }
-
-

-

-

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

-References errorlog, connection::fd, userrec::nick, WriteOpers(), and WriteServ().

00835 {
-00836         if (bail)
-00837         {
-00838                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00839                 exit(0);
-00840         }
-00841         else
-00842         {
-00843                 char dataline[1024];
-00844                 if (user)
-00845                 {
-00846                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00847                         while (!errorlog->eof())
-00848                         {
-00849                                 errorlog->getline(dataline,1024);
-00850                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00851                         }
-00852                 }
-00853                 else
-00854                 {
-00855                         WriteOpers("There were errors in the configuration file:",user->nick);
-00856                         while (!errorlog->eof())
-00857                         {
-00858                                 errorlog->getline(dataline,1024);
-00859                                 WriteOpers(dataline);
-00860                         }
-00861                 }
-00862                 return;
-00863         }
-00864 }
-
-

-

-

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

-References cache, and ServerConfig::EnumConf().

00868 {
-00869         return Config->EnumConf(cache,tag.c_str());
-00870 }
-
-

-

-

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

-References cache, and ServerConfig::EnumValues().

00873 {
-00874         return Config->EnumValues(cache, tag.c_str(), index);
-00875 }
-
-

-

-

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

-References error.

00828 {
-00829         long olderr = this->error;
-00830         this->error = 0;
-00831         return olderr;
-00832 }
-
-

-

-

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

-References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().

00782 {
-00783         char val[MAXBUF];
-00784         char t[MAXBUF];
-00785         char n[MAXBUF];
-00786         strlcpy(t,tag.c_str(),MAXBUF);
-00787         strlcpy(n,name.c_str(),MAXBUF);
-00788         int res = Config->ReadConf(cache,t,n,index,val);
-00789         if (!res)
-00790         {
-00791                 this->error = CONF_VALUE_NOT_FOUND;
-00792                 return false;
-00793         }
-00794         std::string s = val;
-00795         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00796 }
-
-

-

-

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

-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().

00799 {
-00800         char val[MAXBUF];
-00801         char t[MAXBUF];
-00802         char n[MAXBUF];
-00803         strlcpy(t,tag.c_str(),MAXBUF);
-00804         strlcpy(n,name.c_str(),MAXBUF);
-00805         int res = Config->ReadConf(cache,t,n,index,val);
-00806         if (!res)
-00807         {
-00808                 this->error = CONF_VALUE_NOT_FOUND;
-00809                 return 0;
-00810         }
-00811         for (unsigned int i = 0; i < strlen(val); i++)
-00812         {
-00813                 if (!isdigit(val[i]))
-00814                 {
-00815                         this->error = CONF_NOT_A_NUMBER;
-00816                         return 0;
-00817                 }
-00818         }
-00819         if ((needs_unsigned) && (atoi(val)<0))
-00820         {
-00821                 this->error = CONF_NOT_UNSIGNED;
-00822                 return 0;
-00823         }
-00824         return atoi(val);
-00825 }
-
-

-

-

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

-References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().

00766 {
-00767         char val[MAXBUF];
-00768         char t[MAXBUF];
-00769         char n[MAXBUF];
-00770         strlcpy(t,tag.c_str(),MAXBUF);
-00771         strlcpy(n,name.c_str(),MAXBUF);
-00772         int res = Config->ReadConf(cache,t,n,index,val);
-00773         if (!res)
-00774         {
-00775                 this->error = CONF_VALUE_NOT_FOUND;
-00776                 return "";
-00777         }
-00778         return val;
-00779 }
-
-

-

-

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

-References readerror.

00878 {
-00879         return this->readerror;
-00880 }
-
-

-

-

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

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

-

- - - - -
- - - - -
long ConfigReader::error [protected]
-
- - - - - -
-   - - -

- -

-Definition at line 1563 of file modules.h. -

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

-

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

- -

-Definition at line 1559 of file modules.h. -

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

-

- - - - -
- - - - -
bool ConfigReader::readerror [protected]
-
- - - - - -
-   - - -

-Used to store errors. -

- -

-Definition at line 1562 of file modules.h. -

-Referenced by ConfigReader(), and Verify().

-

The documentation for this class was generated from the following files: -
Generated on Mon Dec 19 18:05:21 2005 for InspIRCd by  - -doxygen 1.4.4-20050815
- - -- cgit v1.2.3