path: root/docs/man/man3/ConfigReader.3

.TH "ConfigReader" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ConfigReader \- 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.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <modules.h>\fP
.PP
Inherits \fBclassbase\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBConfigReader\fP ()"
.br
.RI "\fIDefault constructor. \fP"
.ti -1c
.RI "\fBConfigReader\fP (std::string filename)"
.br
.RI "\fIOverloaded constructor. \fP"
.ti -1c
.RI "\fB~ConfigReader\fP ()"
.br
.RI "\fIDefault destructor. \fP"
.ti -1c
.RI "std::string \fBReadValue\fP (std::string tag, std::string name, int index)"
.br
.RI "\fIRetrieves a value from the config file. \fP"
.ti -1c
.RI "bool \fBReadFlag\fP (std::string tag, std::string name, int index)"
.br
.RI "\fIRetrieves a boolean value from the config file. \fP"
.ti -1c
.RI "long \fBReadInteger\fP (std::string tag, std::string name, int index, bool needs_unsigned)"
.br
.RI "\fIRetrieves an integer value from the config file. \fP"
.ti -1c
.RI "long \fBGetError\fP ()"
.br
.RI "\fIReturns the last error to occur. \fP"
.ti -1c
.RI "int \fBEnumerate\fP (std::string tag)"
.br
.RI "\fICounts the number of times a given tag appears in the config file. \fP"
.ti -1c
.RI "bool \fBVerify\fP ()"
.br
.RI "\fIReturns true if a config file is valid. \fP"
.ti -1c
.RI "void \fBDumpErrors\fP (bool bail, \fBuserrec\fP *user)"
.br
.RI "\fIDumps the list of errors in a config file to an output location. \fP"
.ti -1c
.RI "int \fBEnumerateValues\fP (std::string tag, int index)"
.br
.RI "\fIReturns the number of items within a tag. \fP"
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "std::stringstream * \fBcache\fP"
.br
.RI "\fIThe contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). \fP"
.ti -1c
.RI "std::stringstream * \fBerrorlog\fP"
.br
.ti -1c
.RI "bool \fBreaderror\fP"
.br
.RI "\fIUsed to store errors. \fP"
.ti -1c
.RI "long \fBerror\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
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. 
.PP
Definition at line 1150 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "ConfigReader::ConfigReader ()"
.PP
Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 819 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
820 {
821         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
822         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
823         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
824         if (!this->readerror)
825                 this->error = CONF_FILE_NOT_FOUND;
826 }
.fi
.SS "ConfigReader::ConfigReader (std::string filename)"
.PP
Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 838 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
839 {
840         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
841         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
842         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
843         if (!this->readerror)
844                 this->error = CONF_FILE_NOT_FOUND;
845 };
.fi
.SS "ConfigReader::~\fBConfigReader\fP ()"
.PP
Default destructor. This method destroys the ConfigReader class.Definition at line 829 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
830 {
831         if (this->cache)
832                 delete this->cache;
833         if (this->errorlog)
834                 delete this->errorlog;
835 }
.fi
.SH "Member Function Documentation"
.PP 
.SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)"
.PP
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 916 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
917 {
918         if (bail)
919         {
920                 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
921                 exit(0);
922         }
923         else
924         {
925                 char dataline[1024];
926                 if (user)
927                 {
928                         WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
929                         while (!errorlog->eof())
930                         {
931                                 errorlog->getline(dataline,1024);
932                                 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
933                         }
934                 }
935                 else
936                 {
937                         WriteOpers('There were errors in the configuration file:',user->nick);
938                         while (!errorlog->eof())
939                         {
940                                 errorlog->getline(dataline,1024);
941                                 WriteOpers(dataline);
942                         }
943                 }
944                 return;
945         }
946 }
.fi
.SS "int ConfigReader::Enumerate (std::string tag)"
.PP
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 \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 949 of file modules.cpp.
.PP
References cache.
.PP
.nf
950 {
951         return EnumConf(cache,tag.c_str());
952 }
.fi
.SS "int ConfigReader::EnumerateValues (std::string tag, int index)"
.PP
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 954 of file modules.cpp.
.PP
References cache.
.PP
.nf
955 {
956         return EnumValues(cache, tag.c_str(), index);
957 }
.fi
.SS "long ConfigReader::GetError ()"
.PP
Returns the last error to occur. Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 909 of file modules.cpp.
.PP
References error.
.PP
.nf
910 {
911         long olderr = this->error;
912         this->error = 0;
913         return olderr;
914 }
.fi
.SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)"
.PP
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 863 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
864 {
865         char val[MAXBUF];
866         char t[MAXBUF];
867         char n[MAXBUF];
868         strlcpy(t,tag.c_str(),MAXBUF);
869         strlcpy(n,name.c_str(),MAXBUF);
870         int res = ReadConf(cache,t,n,index,val);
871         if (!res)
872         {
873                 this->error = CONF_VALUE_NOT_FOUND;
874                 return false;
875         }
876         std::string s = val;
877         return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
878 }
.fi
.SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)"
.PP
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 \fBGetError()\fP 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 \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 880 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
881 {
882         char val[MAXBUF];
883         char t[MAXBUF];
884         char n[MAXBUF];
885         strlcpy(t,tag.c_str(),MAXBUF);
886         strlcpy(n,name.c_str(),MAXBUF);
887         int res = ReadConf(cache,t,n,index,val);
888         if (!res)
889         {
890                 this->error = CONF_VALUE_NOT_FOUND;
891                 return 0;
892         }
893         for (int i = 0; i < strlen(val); i++)
894         {
895                 if (!isdigit(val[i]))
896                 {
897                         this->error = CONF_NOT_A_NUMBER;
898                         return 0;
899                 }
900         }
901         if ((needs_unsigned) && (atoi(val)<0))
902         {
903                 this->error = CONF_NOT_UNSIGNED;
904                 return 0;
905         }
906         return atoi(val);
907 }
.fi
.SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)"
.PP
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 847 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
848 {
849         char val[MAXBUF];
850         char t[MAXBUF];
851         char n[MAXBUF];
852         strlcpy(t,tag.c_str(),MAXBUF);
853         strlcpy(n,name.c_str(),MAXBUF);
854         int res = ReadConf(cache,t,n,index,val);
855         if (!res)
856         {
857                 this->error = CONF_VALUE_NOT_FOUND;
858                 return '';
859         }
860         return val;
861 }
.fi
.SS "bool ConfigReader::Verify ()"
.PP
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 959 of file modules.cpp.
.PP
References readerror.
.PP
.nf
960 {
961         return this->readerror;
962 }
.fi
.SH "Member Data Documentation"
.PP 
.SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP"
.PP
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 1158 of file modules.h.
.PP
Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
.SS "long \fBConfigReader::error\fP\fC [protected]\fP"
.PP
Definition at line 1163 of file modules.h.
.PP
Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
.SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP"
.PP
Definition at line 1159 of file modules.h.
.PP
Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
.SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP"
.PP
Used to store errors. Definition at line 1162 of file modules.h.
.PP
Referenced by ConfigReader(), and Verify().

.SH "Author"
.PP 
Generated automatically by Doxygen for InspIRCd from the source code.