X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fmodule-doc%2FclassConfigReader.html;h=1e81811f5ea4ecfa5ee448e7a58d33bb7cb3b478;hb=654ff4ae2f06704de2beb1050021c8196f693cb5;hp=5ad5b9aedcfbdc2ab71009ea6567c7a2fd8f7ecd;hpb=0f2cf28d39404881b9719330ca86757c51b87bad;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 5ad5b9aed..1e81811f5 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -1,72 +1,83 @@ -ConfigReader class Reference +InspIRCd: ConfigReader class Reference - -
-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. + +
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>

-Inheritance diagram for ConfigReader:

Inheritance graph
- - - -
[legend]
Collaboration diagram for ConfigReader:

Collaboration graph
- - - -
[legend]
List of all members. +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.

int EnumerateValues (std::string tag, int index)
 Returns the number of items within a tag.

 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).

bool readerror
 Used to store errors.

long error
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. +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 617 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 790 of file modules.h.

Constructor & Destructor Documentation

- +
-
+ - - + + @@ -82,34 +93,35 @@ Definition at line 617 of
ConfigReader::ConfigReader (   )   ) 

-Default constructor. +Default constructor.

This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.

-Definition at line 553 of file modules.cpp. +Definition at line 675 of file modules.cpp.

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

-

00554 {
-00555         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00556         this->readerror = LoadConf(CONFIG_FILE,this->cache);
-00557         if (!this->readerror)
-00558                 this->error = CONF_FILE_NOT_FOUND;
-00559 }
+
00676 {
+00677         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00678         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00679         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00680         if (!this->readerror)
+00681                 this->error = CONF_FILE_NOT_FOUND;
+00682 }

- +
-
+ - - + + @@ -125,33 +137,34 @@ References cache,

-Overloaded constructor. +Overloaded constructor.

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

-Definition at line 569 of file modules.cpp. +Definition at line 694 of file modules.cpp.

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

-

00570 {
-00571         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00572         this->readerror = LoadConf(filename.c_str(),this->cache);
-00573         if (!this->readerror)
-00574                 this->error = CONF_FILE_NOT_FOUND;
-00575 };
+
00695 {
+00696         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00697         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00698         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00699         if (!this->readerror)
+00700                 this->error = CONF_FILE_NOT_FOUND;
+00701 };
ConfigReader::ConfigReader (  std::string   filename )  filename  ) 

- +
-
+ - + - - + + @@ -167,33 +180,111 @@ References cache,

-Default destructor. +Default destructor.

This method destroys the ConfigReader class.

-Definition at line 562 of file modules.cpp. +Definition at line 685 of file modules.cpp.

-References cache. +References cache, and errorlog.

-

00563 {
-00564         if (this->cache)
-00565                 delete this->cache;
-00566 }
+
00686 {
+00687         if (this->cache)
+00688                 delete this->cache;
+00689         if (this->errorlog)
+00690                 delete this->errorlog;
+00691 }
ConfigReader::~ConfigReader ConfigReader::~ConfigReader (   )   ) 

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

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

+

00773 {
+00774         if (bail)
+00775         {
+00776                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00777                 exit(0);
+00778         }
+00779         else
+00780         {
+00781                 char dataline[1024];
+00782                 if (user)
+00783                 {
+00784                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00785                         while (!errorlog->eof())
+00786                         {
+00787                                 errorlog->getline(dataline,1024);
+00788                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00789                         }
+00790                 }
+00791                 else
+00792                 {
+00793                         WriteOpers("There were errors in the configuration file:",user->nick);
+00794                         while (!errorlog->eof())
+00795                         {
+00796                                 errorlog->getline(dataline,1024);
+00797                                 WriteOpers(dataline);
+00798                         }
+00799                 }
+00800                 return;
+00801         }
+00802 }
+

- +
-
+ - - + + @@ -209,34 +300,36 @@ References cache.
int ConfigReader::Enumerate (  std::string   tag )  tag  ) 

-Counts the number of times a given tag appears in the config file. +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 647 of file modules.cpp. +Definition at line 805 of file modules.cpp. +

+References cache.

-

00648 {
-00649         return EnumConf(cache,tag.c_str());
-00650 }
+
00806 {
+00807         return EnumConf(cache,tag.c_str());
+00808 }
-

- +

+

-
+ - + - + @@ -256,28 +349,30 @@ Definition at line 647
int ConfigReader::EnumerateValues (  std::string   tag, tag,
int   index index

-Returns the number of items within a tag. +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 652 of file modules.cpp. +Definition at line 810 of file modules.cpp.

-

00653 {
-00654         return EnumValues(cache, tag.c_str(), index);
-00655 }
+References cache.
+

+
00811 {
+00812         return EnumValues(cache, tag.c_str(), index);
+00813 }

- +
-
+ - - + + @@ -293,44 +388,44 @@ Definition at line 652
long ConfigReader::GetError (   )   ) 

-Returns the last error to occur. +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 639 of file modules.cpp. +Definition at line 765 of file modules.cpp.

-References error. +References error.

-

00640 {
-00641         long olderr = this->error;
-00642         this->error = 0;
-00643         return olderr;
-00644 }
+
00766 {
+00767         long olderr = this->error;
+00768         this->error = 0;
+00769         return olderr;
+00770 }

- +
-
+ - + - + - + @@ -350,60 +445,60 @@ References error.
bool ConfigReader::ReadFlag (  std::string   tag, tag,
std::string   name, name,
int   index index

-Retrieves a boolean value from the config file. +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 593 of file modules.cpp. -

-References CONF_VALUE_NOT_FOUND, and error. -

-

00594 {
-00595         char val[MAXBUF];
-00596         char t[MAXBUF];
-00597         char n[MAXBUF];
-00598         strncpy(t,tag.c_str(),MAXBUF);
-00599         strncpy(n,name.c_str(),MAXBUF);
-00600         int res = ReadConf(cache,t,n,index,val);
-00601         if (!res)
-00602         {
-00603                 this->error = CONF_VALUE_NOT_FOUND;
-00604                 return false;
-00605         }
-00606         std::string s = val;
-00607         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00608 }
+Definition at line 719 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00720 {
+00721         char val[MAXBUF];
+00722         char t[MAXBUF];
+00723         char n[MAXBUF];
+00724         strlcpy(t,tag.c_str(),MAXBUF);
+00725         strlcpy(n,name.c_str(),MAXBUF);
+00726         int res = ReadConf(cache,t,n,index,val);
+00727         if (!res)
+00728         {
+00729                 this->error = CONF_VALUE_NOT_FOUND;
+00730                 return false;
+00731         }
+00732         std::string s = val;
+00733         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00734 }

- +
-
+ - + - + - + - + @@ -423,66 +518,66 @@ References CONF_VALUE_NOT_FOU
long ConfigReader::ReadInteger (  std::string   tag, tag,
std::string   name, name,
int   index, index,
bool   needs_unsigned needs_unsigned

-Retrieves an integer value from the config file. +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 610 of file modules.cpp. -

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

-

00611 {
-00612         char val[MAXBUF];
-00613         char t[MAXBUF];
-00614         char n[MAXBUF];
-00615         strncpy(t,tag.c_str(),MAXBUF);
-00616         strncpy(n,name.c_str(),MAXBUF);
-00617         int res = ReadConf(cache,t,n,index,val);
-00618         if (!res)
-00619         {
-00620                 this->error = CONF_VALUE_NOT_FOUND;
-00621                 return 0;
-00622         }
-00623         for (int i = 0; i < strlen(val); i++)
-00624         {
-00625                 if (!isdigit(val[i]))
-00626                 {
-00627                         this->error = CONF_NOT_A_NUMBER;
-00628                         return 0;
-00629                 }
-00630         }
-00631         if ((needs_unsigned) && (atoi(val)<0))
-00632         {
-00633                 this->error = CONF_NOT_UNSIGNED;
-00634                 return 0;
-00635         }
-00636         return atoi(val);
-00637 }
+Definition at line 736 of file modules.cpp.
+

+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, 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 0;
+00748         }
+00749         for (int i = 0; i < strlen(val); i++)
+00750         {
+00751                 if (!isdigit(val[i]))
+00752                 {
+00753                         this->error = CONF_NOT_A_NUMBER;
+00754                         return 0;
+00755                 }
+00756         }
+00757         if ((needs_unsigned) && (atoi(val)<0))
+00758         {
+00759                 this->error = CONF_NOT_UNSIGNED;
+00760                 return 0;
+00761         }
+00762         return atoi(val);
+00763 }

- +
-
+ - + - + - + @@ -502,41 +597,41 @@ References CONF_NOT_A_NUMBER<
std::string ConfigReader::ReadValue (  std::string   tag, tag,
std::string   name, name,
int   index index

-Retrieves a value from the config file. +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 577 of file modules.cpp. -

-References CONF_VALUE_NOT_FOUND, and error. -

-

00578 {
-00579         char val[MAXBUF];
-00580         char t[MAXBUF];
-00581         char n[MAXBUF];
-00582         strncpy(t,tag.c_str(),MAXBUF);
-00583         strncpy(n,name.c_str(),MAXBUF);
-00584         int res = ReadConf(cache,t,n,index,val);
-00585         if (!res)
-00586         {
-00587                 this->error = CONF_VALUE_NOT_FOUND;
-00588                 return "";
-00589         }
-00590         return std::string(val);
-00591 }
+Definition at line 703 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00704 {
+00705         char val[MAXBUF];
+00706         char t[MAXBUF];
+00707         char n[MAXBUF];
+00708         strlcpy(t,tag.c_str(),MAXBUF);
+00709         strlcpy(n,name.c_str(),MAXBUF);
+00710         int res = ReadConf(cache,t,n,index,val);
+00711         if (!res)
+00712         {
+00713                 this->error = CONF_VALUE_NOT_FOUND;
+00714                 return "";
+00715         }
+00716         return std::string(val);
+00717 }

- +
-
+ - - + + @@ -552,28 +647,28 @@ References CONF_VALUE_NOT_FOU
bool ConfigReader::Verify (   )   ) 

-Returns true if a config file is valid. +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 657 of file modules.cpp. +Definition at line 815 of file modules.cpp.

-References readerror. +References readerror.

-

00658 {
-00659         return this->readerror;
-00660 }
+
00816 {
+00817         return this->readerror;
+00818 }

Member Data Documentation

-

- +

+

- @@ -586,22 +681,48 @@ References readerror. + +
+ -
std::stringstream* ConfigReader::cache [protected] + 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). +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 625 of file modules.h. +Definition at line 798 of file modules.h. +

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

+

+ + + + +
+ + +
long ConfigReader::error [protected] +
+
+ + + + +Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
+   + + +

+ +

+Definition at line 803 of file modules.h.

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

-

- +

+

- @@ -616,18 +737,18 @@ Referenced by ConfigReader(

-Definition at line 629 of file modules.h. +Definition at line 799 of file modules.h.

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

+ -
long ConfigReader::error [protected] + std::stringstream* ConfigReader::errorlog [protected]
-

- +

+

- @@ -640,20 +761,20 @@ Referenced by ConfigReader( +Referenced by ConfigReader(), and Verify().
+ -
bool ConfigReader::readerror [protected] + bool ConfigReader::readerror [protected]

-Used to store errors. +Used to store errors.

-Definition at line 628 of file modules.h. +Definition at line 802 of file modules.h.

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

The documentation for this class was generated from the following files: -
Generated on Sat May 1 20:58:02 2004 for InspIRCd by +
Generated on Wed Apr 13 13:07:02 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3