- |
+ |
| ConfigReader::ConfigReader |
( |
- |
- ) |
+ |
+ ) |
|
@@ -71,31 +93,35 @@ Definition at line 252 of
-Default constructor.
+Default constructor.
This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.
-Definition at line 152 of file modules.cpp.
+Definition at line 675 of file modules.cpp.
-References fname.
+References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
- 00153 {
-00154 fname = CONFIG_FILE;
-00155 }
+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 }
|
-
+
- |
+ |
| ConfigReader::ConfigReader |
( |
- string |
- filename |
- ) |
+ std::string |
+ filename |
+ ) |
|
@@ -111,26 +137,34 @@ References fname.
-Overloaded constructor.
+Overloaded constructor.
This constructor initialises the ConfigReader class to read a user-specified config file
-Definition at line 163 of file modules.cpp.
+Definition at line 694 of file modules.cpp.
- |
-
+
- |
+ |
- | ConfigReader::~ConfigReader |
+ ConfigReader::~ConfigReader |
( |
- |
- ) |
+ |
+ ) |
|
@@ -146,29 +180,111 @@ Definition at line 163
-Default destructor.
+Default destructor.
This method destroys the ConfigReader class.
-Definition at line 158 of file modules.cpp.
+Definition at line 685 of file modules.cpp.
+
+References cache, and errorlog.
- |
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 }
+ |
+
+
+
+
+
+
| int ConfigReader::Enumerate |
( |
- string |
- tag |
- ) |
+ std::string |
+ tag |
+ ) |
|
@@ -184,42 +300,132 @@ Definition at line 158
-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 174 of file modules.cpp.
+Definition at line 805 of file modules.cpp.
-References fname.
+References cache.
- 00175 {
-00176 return EnumConf(fname.c_str(),tag.c_str());
-00177 }
+00806 {
+00807 return EnumConf(cache,tag.c_str());
+00808 }
|
-
-
+
+
- |
+ |
- | string ConfigReader::ReadValue |
+ int ConfigReader::EnumerateValues |
( |
- string |
- tag, |
+ std::string |
+ tag, |
|
|
- string |
- name, |
+ 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 810 of file modules.cpp.
+
+References cache.
+
+ 00811 {
+00812 return EnumValues(cache, tag.c_str(), index);
+00813 }
+ |
+
+
+
+
+
+
+
+
+ | 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 765 of file modules.cpp.
+
+References error.
+
+ 00766 {
+00767 long olderr = this->error;
+00768 this->error = 0;
+00769 return olderr;
+00770 }
+ |
+
+
+
+
+
+
+
+
+ | bool ConfigReader::ReadFlag |
+ ( |
+ std::string |
+ tag, |
+
+
+ |
+ |
+ std::string |
+ name, |
|
|
int |
- index |
+ index |
|
@@ -239,33 +445,193 @@ References fname.
-Retrieves a 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 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 }
+ |
+
+
+
+
+
+
+
+
+ | long ConfigReader::ReadInteger |
+ ( |
+ std::string |
+ tag, |
+
+
+ |
+ |
+ std::string |
+ name, |
+
+
+ |
+ |
+ int |
+ index, |
+
+
+ |
+ |
+ bool |
+ needs_unsigned |
+
+
+ |
+ ) |
+ |
+
+
+
+ |
+
+
+
+
+ |
+
+ |
+
+
-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.
+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 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 }
+ |
+
+
+
+
+
+
+
+
+ | std::string ConfigReader::ReadValue |
+ ( |
+ std::string |
+ tag, |
+
+
+ |
+ |
+ std::string |
+ name, |
+
+
+ |
+ |
+ int |
+ index |
+
+
+ |
+ ) |
+ |
+
+
+
+ |
+
+
+
+
+ |
+
+ |
+
+
-Definition at line 165 of file modules.cpp.
+Retrieves a value from the config file.
-References fname.
+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.
- 00166 {
-00167 char val[MAXBUF];
-00168 ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
-00169 string s = val;
-00170 return s;
-00171 }
+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 }
|
-
-
+
+
- |
+ |
| bool ConfigReader::Verify |
( |
- |
- ) |
+ |
+ ) |
|
@@ -281,26 +647,108 @@ References fname.
-Returns true if a config file is valid.
+Returns true if a config file is valid.
-This method is unimplemented and will always return true.
+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 180 of file modules.cpp.
+Definition at line 815 of file modules.cpp.
- 00181 {
-00182 return true;
-00183 }
+References readerror.
+
+ 00816 {
+00817 return this->readerror;
+00818 }
|
Member Data Documentation
-
-
+
+
+
+
+
+
+
+
+
+
+
The documentation for this class was generated from the following files:
-
Generated on Sun Mar 30 19:35:47 2003 for InspIRCd by
+
Generated on Wed Apr 13 13:07:02 2005 for InspIRCd by
- 1.3-rc3
+
+1.3.3
| | | | | |
