diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-20 15:48:27 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-20 15:48:27 +0000 |
| commit | 2db0df5813e46fe5e077e014003acbd10698b913 (patch) | |
| tree | 8d18035c30623c3dcd677c2b93fd832e6cb3d09d /docs/man/man3 | |
| parent | 15228d509a36036af6d8ab1f63f0ccbc0eeb0c3d (diff) | |
Added module message passing architecture
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1136 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3')
54 files changed, 884 insertions, 805 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 9a8030ec4..bc5466d24 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -43,10 +43,10 @@ Definition at line 123 of file modules.h. .PP .SS "Admin::Admin (std::string name, std::string email, std::string nick)" .PP -Definition at line 304 of file modules.cpp. +Definition at line 306 of file modules.cpp. .PP .nf -304 : Name(name), Email(email), Nick(nick) { }; +306 : Name(name), Email(email), Nick(nick) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index c98be4ec2..d860624f0 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index d0f0a1d5f..1b6478571 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -84,239 +84,239 @@ Allows reading of values from configuration files This class allows a module to 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 944 of file modules.h. +Definition at line 1072 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 762 of file modules.cpp. +Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 833 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -763 { -764 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -765 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -766 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -767 if (!this->readerror) -768 this->error = CONF_FILE_NOT_FOUND; -769 } +834 { +835 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +836 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +837 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +838 if (!this->readerror) +839 this->error = CONF_FILE_NOT_FOUND; +840 } .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 781 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 852 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -782 { -783 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -784 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -785 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -786 if (!this->readerror) -787 this->error = CONF_FILE_NOT_FOUND; -788 }; +853 { +854 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +855 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +856 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +857 if (!this->readerror) +858 this->error = CONF_FILE_NOT_FOUND; +859 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 772 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 843 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -773 { -774 if (this->cache) -775 delete this->cache; -776 if (this->errorlog) -777 delete this->errorlog; -778 } +844 { +845 if (this->cache) +846 delete this->cache; +847 if (this->errorlog) +848 delete this->errorlog; +849 } .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 859 of file modules.cpp. +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 930 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -860 { -861 if (bail) -862 { -863 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -864 exit(0); -865 } -866 else -867 { -868 char dataline[1024]; -869 if (user) -870 { -871 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -872 while (!errorlog->eof()) -873 { -874 errorlog->getline(dataline,1024); -875 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -876 } -877 } -878 else -879 { -880 WriteOpers('There were errors in the configuration file:',user->nick); -881 while (!errorlog->eof()) -882 { -883 errorlog->getline(dataline,1024); -884 WriteOpers(dataline); -885 } -886 } -887 return; -888 } -889 } +931 { +932 if (bail) +933 { +934 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +935 exit(0); +936 } +937 else +938 { +939 char dataline[1024]; +940 if (user) +941 { +942 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +943 while (!errorlog->eof()) +944 { +945 errorlog->getline(dataline,1024); +946 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +947 } +948 } +949 else +950 { +951 WriteOpers('There were errors in the configuration file:',user->nick); +952 while (!errorlog->eof()) +953 { +954 errorlog->getline(dataline,1024); +955 WriteOpers(dataline); +956 } +957 } +958 return; +959 } +960 } .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 892 of file modules.cpp. +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 963 of file modules.cpp. .PP References cache. .PP .nf -893 { -894 return EnumConf(cache,tag.c_str()); -895 } +964 { +965 return EnumConf(cache,tag.c_str()); +966 } .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 897 of file modules.cpp. +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 968 of file modules.cpp. .PP References cache. .PP .nf -898 { -899 return EnumValues(cache, tag.c_str(), index); -900 } +969 { +970 return EnumValues(cache, tag.c_str(), index); +971 } .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 852 of file modules.cpp. +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 923 of file modules.cpp. .PP References error. .PP .nf -853 { -854 long olderr = this->error; -855 this->error = 0; -856 return olderr; -857 } +924 { +925 long olderr = this->error; +926 this->error = 0; +927 return olderr; +928 } .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 806 of file modules.cpp. +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 877 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -807 { -808 char val[MAXBUF]; -809 char t[MAXBUF]; -810 char n[MAXBUF]; -811 strlcpy(t,tag.c_str(),MAXBUF); -812 strlcpy(n,name.c_str(),MAXBUF); -813 int res = ReadConf(cache,t,n,index,val); -814 if (!res) -815 { -816 this->error = CONF_VALUE_NOT_FOUND; -817 return false; -818 } -819 std::string s = val; -820 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -821 } +878 { +879 char val[MAXBUF]; +880 char t[MAXBUF]; +881 char n[MAXBUF]; +882 strlcpy(t,tag.c_str(),MAXBUF); +883 strlcpy(n,name.c_str(),MAXBUF); +884 int res = ReadConf(cache,t,n,index,val); +885 if (!res) +886 { +887 this->error = CONF_VALUE_NOT_FOUND; +888 return false; +889 } +890 std::string s = val; +891 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +892 } .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 823 of file modules.cpp. +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 894 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -824 { -825 char val[MAXBUF]; -826 char t[MAXBUF]; -827 char n[MAXBUF]; -828 strlcpy(t,tag.c_str(),MAXBUF); -829 strlcpy(n,name.c_str(),MAXBUF); -830 int res = ReadConf(cache,t,n,index,val); -831 if (!res) -832 { -833 this->error = CONF_VALUE_NOT_FOUND; -834 return 0; -835 } -836 for (int i = 0; i < strlen(val); i++) -837 { -838 if (!isdigit(val[i])) -839 { -840 this->error = CONF_NOT_A_NUMBER; -841 return 0; -842 } -843 } -844 if ((needs_unsigned) && (atoi(val)<0)) -845 { -846 this->error = CONF_NOT_UNSIGNED; -847 return 0; -848 } -849 return atoi(val); -850 } +895 { +896 char val[MAXBUF]; +897 char t[MAXBUF]; +898 char n[MAXBUF]; +899 strlcpy(t,tag.c_str(),MAXBUF); +900 strlcpy(n,name.c_str(),MAXBUF); +901 int res = ReadConf(cache,t,n,index,val); +902 if (!res) +903 { +904 this->error = CONF_VALUE_NOT_FOUND; +905 return 0; +906 } +907 for (int i = 0; i < strlen(val); i++) +908 { +909 if (!isdigit(val[i])) +910 { +911 this->error = CONF_NOT_A_NUMBER; +912 return 0; +913 } +914 } +915 if ((needs_unsigned) && (atoi(val)<0)) +916 { +917 this->error = CONF_NOT_UNSIGNED; +918 return 0; +919 } +920 return atoi(val); +921 } .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 790 of file modules.cpp. +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 861 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -791 { -792 char val[MAXBUF]; -793 char t[MAXBUF]; -794 char n[MAXBUF]; -795 strlcpy(t,tag.c_str(),MAXBUF); -796 strlcpy(n,name.c_str(),MAXBUF); -797 int res = ReadConf(cache,t,n,index,val); -798 if (!res) -799 { -800 this->error = CONF_VALUE_NOT_FOUND; -801 return ''; -802 } -803 return std::string(val); -804 } +862 { +863 char val[MAXBUF]; +864 char t[MAXBUF]; +865 char n[MAXBUF]; +866 strlcpy(t,tag.c_str(),MAXBUF); +867 strlcpy(n,name.c_str(),MAXBUF); +868 int res = ReadConf(cache,t,n,index,val); +869 if (!res) +870 { +871 this->error = CONF_VALUE_NOT_FOUND; +872 return ''; +873 } +874 return std::string(val); +875 } .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 902 of file modules.cpp. +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 973 of file modules.cpp. .PP References readerror. .PP .nf -903 { -904 return this->readerror; -905 } +974 { +975 return this->readerror; +976 } .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 952 of file modules.h. +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 1080 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 957 of file modules.h. +Definition at line 1085 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 953 of file modules.h. +Definition at line 1081 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 956 of file modules.h. +Used to store errors. Definition at line 1084 of file modules.h. .PP Referenced by ConfigReader(), and Verify(). diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index eed17b2c2..ed5ed3e81 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index b45e7b7a3..8c44aa268 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index 0454ad266..e7d6c5374 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index 99fb1e77b..a95a85bdf 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index f22da5c54..8df2a5c5f 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -41,41 +41,41 @@ Inherits \fBclassbase\fP. .PP .SS "ExtMode::ExtMode (char mc, int ty, bool oper, int p_on, int p_off)\fC [inline]\fP" .PP -Definition at line 199 of file modules.cpp. +Definition at line 201 of file modules.cpp. .PP References modechar, needsoper, params_when_off, params_when_on, and type. .PP .nf -199 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +201 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; .fi .SH "Member Data Documentation" .PP .SS "bool \fBExtMode::list\fP" .PP -Definition at line 198 of file modules.cpp. +Definition at line 200 of file modules.cpp. .SS "char \fBExtMode::modechar\fP" .PP -Definition at line 193 of file modules.cpp. +Definition at line 195 of file modules.cpp. .PP Referenced by ExtMode(). .SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 197 of file modules.cpp. +Definition at line 199 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 196 of file modules.cpp. +Definition at line 198 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 195 of file modules.cpp. +Definition at line 197 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::type\fP" .PP -Definition at line 194 of file modules.cpp. +Definition at line 196 of file modules.cpp. .PP Referenced by ExtMode(). diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index 65703e1f2..94ffff5f8 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index b09240cc6..6bea2ee1e 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -57,100 +57,100 @@ Caches a text file into memory and can be used to retrieve lines from it. This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. .PP -Definition at line 1033 of file modules.h. +Definition at line 1161 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" .PP -Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 915 of file modules.cpp. +Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 986 of file modules.cpp. .PP .nf -916 { -917 } +987 { +988 } .fi .SS "FileReader::FileReader (std::string filename)" .PP -Secondary constructor. This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 908 of file modules.cpp. +Secondary constructor. This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 979 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -909 { -910 file_cache c; -911 readfile(c,filename.c_str()); -912 this->fc = c; -913 } +980 { +981 file_cache c; +982 readfile(c,filename.c_str()); +983 this->fc = c; +984 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 927 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 998 of file modules.cpp. .PP .nf -928 { -929 } +999 { +1000 } .fi .SH "Member Function Documentation" .PP .SS "bool FileReader::Exists ()" .PP -Returns true if the file exists This function will return false if the file could not be opened. Definition at line 931 of file modules.cpp. +Returns true if the file exists This function will return false if the file could not be opened. Definition at line 1002 of file modules.cpp. .PP References fc. .PP .nf -932 { -933 if (fc.size() == 0) -934 { -935 return(false); -936 } -937 else -938 { -939 return(true); -940 } -941 } +1003 { +1004 if (fc.size() == 0) +1005 { +1006 return(false); +1007 } +1008 else +1009 { +1010 return(true); +1011 } +1012 } .fi .SS "int FileReader::FileSize ()" .PP -Returns the size of the file in lines. This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.Definition at line 950 of file modules.cpp. +Returns the size of the file in lines. This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.Definition at line 1021 of file modules.cpp. .PP References fc. .PP .nf -951 { -952 return fc.size(); -953 } +1022 { +1023 return fc.size(); +1024 } .fi .SS "std::string FileReader::GetLine (int x)" .PP -Retrieve one line from the file. This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.Definition at line 943 of file modules.cpp. +Retrieve one line from the file. This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.Definition at line 1014 of file modules.cpp. .PP References fc. .PP .nf -944 { -945 if ((x<0) || (x>fc.size())) -946 return ''; -947 return fc[x]; -948 } +1015 { +1016 if ((x<0) || (x>fc.size())) +1017 return ''; +1018 return fc[x]; +1019 } .fi .SS "void FileReader::LoadFile (std::string filename)" .PP -Used to load a file. This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 919 of file modules.cpp. +Used to load a file. This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 990 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -920 { -921 file_cache c; -922 readfile(c,filename.c_str()); -923 this->fc = c; -924 } +991 { +992 file_cache c; +993 readfile(c,filename.c_str()); +994 this->fc = c; +995 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 1035 of file modules.h. +Definition at line 1163 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index ab03c1448..0c263effd 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index eb277802b..1a74b43f1 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InAddr_HashComp.3 b/docs/man/man3/InAddr_HashComp.3 index 0e0630d21..a0b6759c0 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,18 +17,18 @@ InAddr_HashComp \- .PP .SS "bool InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const\fC [inline]\fP" .PP -Definition at line 159 of file modules.cpp. +Definition at line 161 of file modules.cpp. .PP .nf -160 { -161 size_t q; -162 size_t p; -163 -164 memcpy(&q,&s1,sizeof(size_t)); -165 memcpy(&p,&s2,sizeof(size_t)); -166 -167 return (q == p); -168 } +162 { +163 size_t q; +164 size_t p; +165 +166 memcpy(&q,&s1,sizeof(size_t)); +167 memcpy(&p,&s2,sizeof(size_t)); +168 +169 return (q == p); +170 } .fi diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index ef09e83a1..187472a3c 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index 9f8acb58e..be48e1d72 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index e4b8175d8..42eb9f1dd 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 51821f88b..6e62ab564 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 5a2bb7733..9acfc10ce 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -36,6 +36,10 @@ Inherits \fBclassbase\fP. .br .RI "\fICalled when a user quits. \fP" .ti -1c +.RI "virtual void \fBOnUserDisconnect\fP (\fBuserrec\fP *user)" +.br +.RI "\fICalled whenever a user's socket is closed. \fP" +.ti -1c .RI "virtual void \fBOnUserJoin\fP (\fBuserrec\fP *user, \fBchanrec\fP *channel)" .br .RI "\fICalled when a user joins a channel. \fP" @@ -191,6 +195,14 @@ Inherits \fBclassbase\fP. .RI "virtual int \fBOnMeshToken\fP (char token, \fBstring_list\fP params, \fBserverrec\fP *source, \fBserverrec\fP *reply, std::string tcp_host, std::string ipaddr, int port)" .br .RI "\fICalled whenever an unknown token is received in a server to server link. \fP" +.ti -1c +.RI "virtual void \fBOnEvent\fP (\fBEvent\fP *event)" +.br +.RI "\fICalled whenever an \fBEvent\fP class is sent to all module by another module. \fP" +.ti -1c +.RI "virtual char * \fBOnRequest\fP (\fBRequest\fP *request)" +.br +.RI "\fICalled whenever a \fBRequest\fP class is sent to your module by another module. \fP" .in -1c .SH "Detailed Description" .PP @@ -198,40 +210,40 @@ Base class for all InspIRCd modules This class is the base class for InspIRCd mo All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the \fBModuleFactory\fP class (see relevent section) for the plugin to be initialised. .PP -Definition at line 135 of file modules.h. +Definition at line 233 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Module::Module ()" .PP -Default constructor creates a module class. Definition at line 306 of file modules.cpp. +Default constructor creates a module class. Definition at line 361 of file modules.cpp. .PP .nf -306 { } +361 { } .fi .SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class. Definition at line 307 of file modules.cpp. +Default destructor destroys a module class. Definition at line 362 of file modules.cpp. .PP .nf -307 { } +362 { } .fi .SH "Member Function Documentation" .PP .SS "\fBVersion\fP Module::GetVersion ()\fC [virtual]\fP" .PP -Returns the version number of a Module. The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 318 of file modules.cpp. +Returns the version number of a Module. The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 374 of file modules.cpp. .PP References VF_VENDOR. .PP .nf -318 { return Version(1,0,0,0,VF_VENDOR); } +374 { return Version(1,0,0,0,VF_VENDOR); } .fi .SS "void Module::On005Numeric (std::string & output)\fC [virtual]\fP" .PP -Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features.Definition at line 330 of file modules.cpp. +Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features.Definition at line 386 of file modules.cpp. .PP .nf -330 { }; +386 { }; .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP @@ -259,226 +271,249 @@ Called before an action which requires a channel privilage check. This function .br .br - Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 327 of file modules.cpp. + Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 383 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -327 { return ACR_DEFAULT; }; +383 { return ACR_DEFAULT; }; .fi .SS "void Module::OnBackgroundTimer (time_t curtime)\fC [virtual]\fP" .PP -Called once every five seconds for background processing. This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.Definition at line 333 of file modules.cpp. +Called once every five seconds for background processing. This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.Definition at line 389 of file modules.cpp. .PP .nf -333 { }; +389 { }; .fi .SS "int Module::OnChangeLocalUserGECOS (\fBuserrec\fP * user, std::string newhost)\fC [virtual]\fP" .PP -Called whenever a change of a local users GECOS (fullname field) is attempted. return 1 to deny the name change, or 0 to allow it.Definition at line 347 of file modules.cpp. +Called whenever a change of a local users GECOS (fullname field) is attempted. return 1 to deny the name change, or 0 to allow it.Definition at line 403 of file modules.cpp. .PP .nf -347 { return 0; }; +403 { return 0; }; .fi .SS "int Module::OnChangeLocalUserHost (\fBuserrec\fP * user, std::string newhost)\fC [virtual]\fP" .PP -Called whenever a change of a local users displayed host is attempted. Return 1 to deny the host change, or 0 to allow it.Definition at line 346 of file modules.cpp. +Called whenever a change of a local users displayed host is attempted. Return 1 to deny the host change, or 0 to allow it.Definition at line 402 of file modules.cpp. .PP .nf -346 { return 0; }; +402 { return 0; }; .fi .SS "\fBstring_list\fP Module::OnChannelSync (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called during a netburst to sync channel data. This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 329 of file modules.cpp. +Called during a netburst to sync channel data. This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 385 of file modules.cpp. .PP References string_list. .PP .nf -329 { string_list empty; return empty; } +385 { string_list empty; return empty; } .fi .SS "int Module::OnCheckBan (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 344 of file modules.cpp. +Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 400 of file modules.cpp. .PP .nf -344 { return 0; }; +400 { return 0; }; .fi .SS "int Module::OnCheckInvite (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if invite checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.Definition at line 341 of file modules.cpp. +Called whenever a user joins a channel, to determine if invite checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.Definition at line 397 of file modules.cpp. .PP .nf -341 { return 0; }; +397 { return 0; }; .fi .SS "int Module::OnCheckKey (\fBuserrec\fP * user, \fBchanrec\fP * chan, std::string keygiven)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if key checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 342 of file modules.cpp. +Called whenever a user joins a channel, to determine if key checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 398 of file modules.cpp. .PP .nf -342 { return 0; }; +398 { return 0; }; .fi .SS "int Module::OnCheckLimit (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 343 of file modules.cpp. +Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 399 of file modules.cpp. .PP .nf -343 { return 0; }; +399 { return 0; }; .fi .SS "bool Module::OnCheckReady (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.Definition at line 336 of file modules.cpp. +Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.Definition at line 392 of file modules.cpp. +.PP +.nf +392 { return true; }; +.fi +.SS "void Module::OnEvent (\fBEvent\fP * event)\fC [virtual]\fP" +.PP +Called whenever an \fBEvent\fP class is sent to all module by another module. Please see the documentation of \fBEvent::Send()\fP for further information. The \fBEvent\fP sent can always be assumed to be non-NULL, you should *always* check the value of \fBEvent::GetEventID()\fP before doing anything to the event data, and you should *not* change the event data in any way!Definition at line 406 of file modules.cpp. .PP .nf -336 { return true; }; +406 { return; }; .fi .SS "int Module::OnExtendedMode (\fBuserrec\fP * user, void * target, char modechar, int type, bool mode_on, \fBstring_list\fP & params)\fC [virtual]\fP" .PP -Called whenever an extended mode is to be processed. The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 317 of file modules.cpp. +Called whenever an extended mode is to be processed. The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 373 of file modules.cpp. .PP .nf -317 { return false; } +373 { return false; } .fi .SS "void Module::OnInfo (\fBuserrec\fP * user)\fC [virtual]\fP" .PP Called whenever a user types /INFO. The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format: .PP -<nick> :information hereDefinition at line 320 of file modules.cpp. +<nick> :information hereDefinition at line 376 of file modules.cpp. .PP .nf -320 { }; +376 { }; .fi .SS "int Module::OnKill (\fBuserrec\fP * source, \fBuserrec\fP * dest, std::string reason)\fC [virtual]\fP" .PP -Called when a client is disconnected by KILL. If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!Definition at line 331 of file modules.cpp. +Called when a client is disconnected by KILL. If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!Definition at line 387 of file modules.cpp. .PP .nf -331 { return 0; }; +387 { return 0; }; .fi .SS "void Module::OnLoadModule (\fBModule\fP * mod, std::string name)\fC [virtual]\fP" .PP -Called whenever a module is loaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded 'm_killwidgets.so' with 'm_makewidgets.so'. It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).Definition at line 332 of file modules.cpp. +Called whenever a module is loaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded 'm_killwidgets.so' with 'm_makewidgets.so'. It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).Definition at line 388 of file modules.cpp. .PP .nf -332 { }; +388 { }; .fi .SS "int Module::OnLocalTopicChange (\fBuserrec\fP * user, \fBchanrec\fP * chan, std::string topic)\fC [virtual]\fP" .PP -Called whenever a topic is changed by a local user. Return 1 to deny the topic change, or 0 to allow it.Definition at line 348 of file modules.cpp. +Called whenever a topic is changed by a local user. Return 1 to deny the topic change, or 0 to allow it.Definition at line 404 of file modules.cpp. .PP .nf -348 { return 0; }; +404 { return 0; }; .fi .SS "int Module::OnMeshToken (char token, \fBstring_list\fP params, \fBserverrec\fP * source, \fBserverrec\fP * reply, std::string tcp_host, std::string ipaddr, int port)\fC [virtual]\fP" .PP -Called whenever an unknown token is received in a server to server link. The token value is the unknown token -- please check that no other modules are using the token that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to all opers with +s. The params list is a list of parameters, and if any parameters start with a colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are handled. source is the sender of the message, and reply is what should be replied to for a unicast message. Note that there are not many messages in the mesh protocol which require unicast messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal notation and port is the port number it is using.Definition at line 349 of file modules.cpp. +Called whenever an unknown token is received in a server to server link. The token value is the unknown token -- please check that no other modules are using the token that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to all opers with +s. The params list is a list of parameters, and if any parameters start with a colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are handled. source is the sender of the message, and reply is what should be replied to for a unicast message. Note that there are not many messages in the mesh protocol which require unicast messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal notation and port is the port number it is using.Definition at line 405 of file modules.cpp. .PP .nf -349 { return 0; }; +405 { return 0; }; .fi .SS "void Module::OnOper (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 319 of file modules.cpp. +Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 375 of file modules.cpp. .PP .nf -319 { }; +375 { }; .fi .SS "void Module::OnPacketReceive (std::string & data, std::string serv)\fC [virtual]\fP" .PP -Called after a packet is received from another irc server. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 313 of file modules.cpp. +Called after a packet is received from another irc server. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 369 of file modules.cpp. .PP .nf -313 { } +369 { } .fi .SS "void Module::OnPacketTransmit (std::string & data, std::string serv)\fC [virtual]\fP" .PP -Called before a packet is transmitted across the irc network between two irc servers. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 312 of file modules.cpp. +Called before a packet is transmitted across the irc network between two irc servers. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 368 of file modules.cpp. .PP .nf -312 { } +368 { } .fi .SS "int Module::OnPreCommand (std::string command, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever any command is about to be executed. This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using \fBServer::QuitUser\fP) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)Definition at line 335 of file modules.cpp. +Called whenever any command is about to be executed. This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using \fBServer::QuitUser\fP) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)Definition at line 391 of file modules.cpp. .PP .nf -335 { return 0; }; +391 { return 0; }; .fi .SS "int Module::OnRawMode (\fBuserrec\fP * user, \fBchanrec\fP * chan, char mode, std::string param, bool adding, int pcnt)\fC [virtual]\fP" .PP -Called whenever a mode character is processed. Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!Definition at line 340 of file modules.cpp. +Called whenever a mode character is processed. Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!Definition at line 396 of file modules.cpp. .PP .nf -340 { return 0; }; +396 { return 0; }; .fi .SS "void Module::OnRehash ()\fC [virtual]\fP" .PP -Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 314 of file modules.cpp. +Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 370 of file modules.cpp. .PP .nf -314 { } +370 { } +.fi +.SS "char * Module::OnRequest (\fBRequest\fP * request)\fC [virtual]\fP" +.PP +Called whenever a \fBRequest\fP class is sent to your module by another module. Please see the documentation of \fBRequest::Send()\fP for further information. The \fBRequest\fP sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).Definition at line 407 of file modules.cpp. +.PP +Referenced by Request::Send(). +.PP +.nf +407 { return NULL; }; .fi .SS "void Module::OnSendList (\fBuserrec\fP * user, \fBchanrec\fP * channel, char mode)\fC [virtual]\fP" .PP -Called whenever a list is needed for a listmode. For example, when a /MODE #channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.Definition at line 334 of file modules.cpp. +Called whenever a list is needed for a listmode. For example, when a /MODE #channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.Definition at line 390 of file modules.cpp. .PP .nf -334 { }; +390 { }; .fi .SS "void Module::OnServerRaw (std::string & raw, bool inbound, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 315 of file modules.cpp. +Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 371 of file modules.cpp. .PP .nf -315 { } +371 { } .fi .SS "void Module::OnStats (char symbol)\fC [virtual]\fP" .PP -Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. Definition at line 345 of file modules.cpp. +Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. Definition at line 401 of file modules.cpp. .PP .nf -345 { }; +401 { }; .fi .SS "void Module::OnUserConnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user connects. The details of the connecting user are available to you in the parameter userrec *userDefinition at line 308 of file modules.cpp. +Called when a user connects. The details of the connecting user are available to you in the parameter userrec *userDefinition at line 363 of file modules.cpp. +.PP +.nf +363 { } +.fi +.SS "void Module::OnUserDisconnect (\fBuserrec\fP * user)\fC [virtual]\fP" +.PP +Called whenever a user's socket is closed. The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.Definition at line 365 of file modules.cpp. .PP .nf -308 { } +365 { } .fi .SS "void Module::OnUserJoin (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user joins a channel. The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 310 of file modules.cpp. +Called when a user joins a channel. The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 366 of file modules.cpp. .PP .nf -310 { } +366 { } .fi .SS "void Module::OnUserKick (\fBuserrec\fP * source, \fBuserrec\fP * user, \fBchanrec\fP * chan, std::string reason)\fC [virtual]\fP" .PP -Called whenever a user is kicked. If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use \fBModule::OnUserPreKick\fP instead of this method.Definition at line 339 of file modules.cpp. +Called whenever a user is kicked. If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use \fBModule::OnUserPreKick\fP instead of this method.Definition at line 395 of file modules.cpp. .PP .nf -339 { }; +395 { }; .fi .SS "void Module::OnUserPart (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user parts a channel. The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 311 of file modules.cpp. +Called when a user parts a channel. The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 367 of file modules.cpp. .PP .nf -311 { } +367 { } .fi .SS "void Module::OnUserPostNick (\fBuserrec\fP * user, std::string oldnick)\fC [virtual]\fP" .PP -Called after any nickchange, local or remote. This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this. Definition at line 326 of file modules.cpp. +Called after any nickchange, local or remote. This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this. Definition at line 382 of file modules.cpp. .PP .nf -326 { }; +382 { }; .fi .SS "int Module::OnUserPreInvite (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.Definition at line 322 of file modules.cpp. +Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.Definition at line 378 of file modules.cpp. .PP .nf -322 { return 0; }; +378 { return 0; }; .fi .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP" .PP @@ -486,68 +521,68 @@ Called whenever a user is about to join a channel, before any processing is done .PP IMPORTANT NOTE! .PP -If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 316 of file modules.cpp. +If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 372 of file modules.cpp. .PP .nf -316 { return 0; } +372 { return 0; } .fi .SS "int Module::OnUserPreKick (\fBuserrec\fP * source, \fBuserrec\fP * user, \fBchanrec\fP * chan, std::string reason)\fC [virtual]\fP" .PP -Called whenever a user is about to be kicked. Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. Definition at line 338 of file modules.cpp. +Called whenever a user is about to be kicked. Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. Definition at line 394 of file modules.cpp. .PP .nf -338 { return 0; }; +394 { return 0; }; .fi .SS "int Module::OnUserPreMessage (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 323 of file modules.cpp. +Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 379 of file modules.cpp. .PP .nf -323 { return 0; }; +379 { return 0; }; .fi .SS "int Module::OnUserPreNick (\fBuserrec\fP * user, std::string newnick)\fC [virtual]\fP" .PP -Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.Definition at line 325 of file modules.cpp. +Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.Definition at line 381 of file modules.cpp. .PP .nf -325 { return 0; }; +381 { return 0; }; .fi .SS "int Module::OnUserPreNotice (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 324 of file modules.cpp. +Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 380 of file modules.cpp. .PP .nf -324 { return 0; }; +380 { return 0; }; .fi .SS "void Module::OnUserQuit (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user quits. The details of the exiting user are available to you in the parameter userrec *userDefinition at line 309 of file modules.cpp. +Called when a user quits. The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.Definition at line 364 of file modules.cpp. .PP .nf -309 { } +364 { } .fi .SS "void Module::OnUserRegister (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user is about to register their connection (e.g. before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.Definition at line 337 of file modules.cpp. +Called whenever a user is about to register their connection (e.g. before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.Definition at line 393 of file modules.cpp. .PP .nf -337 { }; +393 { }; .fi .SS "\fBstring_list\fP Module::OnUserSync (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called during a netburst to sync user data. This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 328 of file modules.cpp. +Called during a netburst to sync user data. This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 384 of file modules.cpp. .PP References string_list. .PP .nf -328 { string_list empty; return empty; } +384 { string_list empty; return empty; } .fi .SS "void Module::OnWhois (\fBuserrec\fP * source, \fBuserrec\fP * dest)\fC [virtual]\fP" .PP -Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 321 of file modules.cpp. +Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 377 of file modules.cpp. .PP .nf -321 { }; +377 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index ae4465776..44c837e10 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -32,22 +32,22 @@ Instantiates classes inherited from \fBModule\fP This class creates a class inhe This is to allow for modules to create many different variants of \fBModule\fP, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules. .PP -Definition at line 1088 of file modules.h. +Definition at line 1216 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 1091 of file modules.h. +Definition at line 1219 of file modules.h. .PP .nf -1091 { } +1219 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 1092 of file modules.h. +Definition at line 1220 of file modules.h. .PP .nf -1092 { } +1220 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index d6d1fc70d..54c689494 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 59d18fd04..3749d4cd3 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -243,6 +243,10 @@ Inherits \fBclassbase\fP. .RI "virtual bool \fBMeshCheckCommon\fP (\fBuserrec\fP *u, std::string servername)" .br .RI "\fIThis function is used to check if user u has any channels in common with users on servername. \fP" +.ti -1c +.RI "virtual \fBModule\fP * \fBFindModule\fP (std::string name)" +.br +.RI "\fIThis function finds a module by name. \fP" .in -1c .SH "Detailed Description" .PP @@ -250,24 +254,24 @@ Allows server output and query functions This class contains methods which allow All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. .PP -Definition at line 505 of file modules.h. +Definition at line 627 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 355 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 414 of file modules.cpp. .PP .nf -356 { -357 } +415 { +416 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 359 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 418 of file modules.cpp. .PP .nf -360 { -361 } +419 { +420 } .fi .SH "Member Function Documentation" .PP @@ -277,25 +281,25 @@ Adds a command to the command table. This allows modules to add extra commands i .PP typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP .PP -When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. 'm_blarp.so'. If you place the wrong identifier here, you can cause crashes if your module is unloaded.Definition at line 436 of file modules.cpp. +When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. 'm_blarp.so'. If you place the wrong identifier here, you can cause crashes if your module is unloaded.Definition at line 495 of file modules.cpp. .PP References createcommand(). .PP .nf -437 { -438 createcommand(cmd,f,flags,minparams,source); -439 } +496 { +497 createcommand(cmd,f,flags,minparams,source); +498 } .fi .SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP -Adds a E-line The E-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 654 of file modules.cpp. +Adds a E-line The E-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 713 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf -655 { -656 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -657 } +714 { +715 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +716 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -309,510 +313,528 @@ Adds an extended mode letter which is parsed by a module and handled in a list f .PP (4) The mode and its parameter are NOT stored in the channels modes structure .PP -It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.Definition at line 581 of file modules.cpp. +It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.Definition at line 640 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -582 { -583 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -584 if (res) -585 ModeMakeList(modechar); -586 return res; -587 } +641 { +642 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +643 if (res) +644 ModeMakeList(modechar); +645 return res; +646 } .fi .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP" .PP -Adds an extended mode letter which is parsed by a module. This allows modules to add extra mode letters, e.g. +x for hostcloak. the 'type' parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.Definition at line 561 of file modules.cpp. +Adds an extended mode letter which is parsed by a module. This allows modules to add extra mode letters, e.g. +x for hostcloak. the 'type' parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.Definition at line 620 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -562 { -563 if (type == MT_SERVER) -564 { -565 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -566 return false; -567 } -568 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -569 { -570 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -571 return false; -572 } -573 if ((params_when_on>1) || (params_when_off>1)) -574 { -575 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -576 return false; -577 } -578 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -579 } +621 { +622 if (type == MT_SERVER) +623 { +624 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +625 return false; +626 } +627 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +628 { +629 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +630 return false; +631 } +632 if ((params_when_on>1) || (params_when_off>1)) +633 { +634 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +635 return false; +636 } +637 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +638 } .fi .SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP -Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.Definition at line 634 of file modules.cpp. +Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.Definition at line 693 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf -635 { -636 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -637 } +694 { +695 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +696 } .fi .SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP -Adds a K-line The K-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 649 of file modules.cpp. +Adds a K-line The K-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 708 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf -650 { -651 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -652 } +709 { +710 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +711 } .fi .SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP" .PP -Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 639 of file modules.cpp. +Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 698 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf -640 { -641 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -642 } +699 { +700 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +701 } .fi .SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP" .PP -Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 644 of file modules.cpp. +Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 703 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf -645 { -646 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -647 } +704 { +705 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +706 } .fi .SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP" .PP -Calculates a duration This method will take a string containing a formatted duration (e.g. '1w2d') and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.Definition at line 684 of file modules.cpp. +Calculates a duration This method will take a string containing a formatted duration (e.g. '1w2d') and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.Definition at line 743 of file modules.cpp. .PP References duration(). .PP .nf -685 { -686 return duration(delta.c_str()); -687 } +744 { +745 return duration(delta.c_str()); +746 } .fi .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP Calls the handler for a command, either implemented by the core or by another module. You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or .br -) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih \fBAddCommand()\fP. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.Definition at line 426 of file modules.cpp. +) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih \fBAddCommand()\fP. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.Definition at line 485 of file modules.cpp. .PP .nf -427 { -428 call_handler(commandname.c_str(),parameters,pcnt,user); -429 } +486 { +487 call_handler(commandname.c_str(),parameters,pcnt,user); +488 } .fi .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP" .PP -Change GECOS (fullname) of a user. You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 514 of file modules.cpp. +Change GECOS (fullname) of a user. You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 573 of file modules.cpp. .PP References ChangeName(). .PP .nf -515 { -516 ChangeName(user,gecos.c_str()); -517 } +574 { +575 ChangeName(user,gecos.c_str()); +576 } .fi .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP" .PP -Change displayed hostname of a user. You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 509 of file modules.cpp. +Change displayed hostname of a user. You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 568 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -510 { -511 ChangeDisplayedHost(user,host.c_str()); -512 } +569 { +570 ChangeDisplayedHost(user,host.c_str()); +571 } .fi .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP" .PP -Forces a user nickchange. This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 410 of file modules.cpp. +Forces a user nickchange. This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 469 of file modules.cpp. .PP .nf -411 { -412 force_nickchange(user,nickname.c_str()); -413 } +470 { +471 force_nickchange(user,nickname.c_str()); +472 } .fi .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP -Attempts to look up a user's privilages on a channel. This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 534 of file modules.cpp. +Attempts to look up a user's privilages on a channel. This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 593 of file modules.cpp. .PP References cmode(). .PP .nf -535 { -536 return cmode(User,Chan); -537 } +594 { +595 return cmode(User,Chan); +596 } .fi .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP" .PP -Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 487 of file modules.cpp. +Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 546 of file modules.cpp. .PP References common_channels(). .PP .nf -488 { -489 return (common_channels(u1,u2) != 0); -490 } +547 { +548 return (common_channels(u1,u2) != 0); +549 } .fi .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP" .PP -Returns a count of the number of users on a channel. This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.Definition at line 589 of file modules.cpp. +Returns a count of the number of users on a channel. This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.Definition at line 648 of file modules.cpp. .PP .nf -590 { -591 return usercount(c); -592 } +649 { +650 return usercount(c); +651 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local E-Line. Definition at line 679 of file modules.cpp. +Deletes a local E-Line. Definition at line 738 of file modules.cpp. .PP References del_eline(). .PP .nf -680 { -681 del_eline(hostmask.c_str()); -682 } +739 { +740 del_eline(hostmask.c_str()); +741 } .fi .SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a G-Line from all servers on the mesh. Definition at line 659 of file modules.cpp. +Deletes a G-Line from all servers on the mesh. Definition at line 718 of file modules.cpp. .PP References del_gline(). .PP .nf -660 { -661 del_gline(hostmask.c_str()); -662 } +719 { +720 del_gline(hostmask.c_str()); +721 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local K-Line. Definition at line 674 of file modules.cpp. +Deletes a local K-Line. Definition at line 733 of file modules.cpp. .PP References del_kline(). .PP .nf -675 { -676 del_kline(hostmask.c_str()); -677 } +734 { +735 del_kline(hostmask.c_str()); +736 } .fi .SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP" .PP -Deletes a Q-Line from all servers on the mesh. Definition at line 664 of file modules.cpp. +Deletes a Q-Line from all servers on the mesh. Definition at line 723 of file modules.cpp. .PP References del_qline(). .PP .nf -665 { -666 del_qline(nickname.c_str()); -667 } +724 { +725 del_qline(nickname.c_str()); +726 } .fi .SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP" .PP -Deletes a Z-Line from all servers on the mesh. Definition at line 669 of file modules.cpp. +Deletes a Z-Line from all servers on the mesh. Definition at line 728 of file modules.cpp. .PP References del_zline(). .PP .nf -670 { -671 del_zline(ipaddr.c_str()); -672 } +729 { +730 del_zline(ipaddr.c_str()); +731 } .fi .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP" .PP -Attempts to look up a channel and return a pointer to it. This function will return NULL if the channel does not exist.Definition at line 529 of file modules.cpp. +Attempts to look up a channel and return a pointer to it. This function will return NULL if the channel does not exist.Definition at line 588 of file modules.cpp. .PP .nf -530 { -531 return FindChan(channel.c_str()); -532 } +589 { +590 return FindChan(channel.c_str()); +591 } +.fi +.SS "\fBModule\fP * Server::FindModule (std::string name)\fC [virtual]\fP" +.PP +This function finds a module by name. You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.Definition at line 821 of file modules.cpp. +.PP +References MODCOUNT, module_names, and modules. +.PP +.nf +822 { +823 for (int i = 0; i <= MODCOUNT; i++) +824 { +825 if (module_names[i] == name) +826 { +827 return modules[i]; +828 } +829 } +830 return NULL; +831 } .fi .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP" .PP -Attempts to look up a nick and return a pointer to it. This function will return NULL if the nick does not exist.Definition at line 524 of file modules.cpp. +Attempts to look up a nick and return a pointer to it. This function will return NULL if the nick does not exist.Definition at line 583 of file modules.cpp. .PP .nf -525 { -526 return Find(nick); -527 } +584 { +585 return Find(nick); +586 } .fi .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP" .PP -Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 554 of file modules.cpp. +Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 613 of file modules.cpp. .PP .nf -555 { -556 return Admin(getadminname(),getadminemail(),getadminnick()); -557 } +614 { +615 return Admin(getadminname(),getadminemail(),getadminnick()); +616 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 549 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 608 of file modules.cpp. .PP .nf -550 { -551 return getnetworkname(); -552 } +609 { +610 return getnetworkname(); +611 } .fi .SS "std::string Server::GetServerName ()\fC [virtual]\fP" .PP -Returns the server name of the server where the module is loaded. Definition at line 544 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 603 of file modules.cpp. .PP .nf -545 { -546 return getservername(); -547 } +604 { +605 return getservername(); +606 } .fi .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 391 of file modules.cpp. +Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 450 of file modules.cpp. .PP References chanuserlist, clientlist, has_channel(), and isnick(). .PP .nf -392 { -393 chanuserlist userl; -394 userl.clear(); -395 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) -396 { -397 if (i->second) -398 { -399 if (has_channel(i->second,chan)) -400 { -401 if (isnick(i->second->nick)) -402 { -403 userl.push_back(i->second); -404 } -405 } -406 } -407 } -408 return userl; -409 } +451 { +452 chanuserlist userl; +453 userl.clear(); +454 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) +455 { +456 if (i->second) +457 { +458 if (has_channel(i->second,chan)) +459 { +460 if (isnick(i->second->nick)) +461 { +462 userl.push_back(i->second); +463 } +464 } +465 } +466 } +467 return userl; +468 } .fi .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP" .PP -Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 519 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 578 of file modules.cpp. .PP References isnick(). .PP .nf -520 { -521 return (isnick(nick.c_str()) != 0); -522 } +579 { +580 return (isnick(nick.c_str()) != 0); +581 } .fi .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP -Checks if a user is on a channel. This function will return true or false to indicate if user 'User' is on channel 'Chan'.Definition at line 539 of file modules.cpp. +Checks if a user is on a channel. This function will return true or false to indicate if user 'User' is on channel 'Chan'.Definition at line 598 of file modules.cpp. .PP References has_channel(). .PP .nf -540 { -541 return has_channel(User,Chan); -542 } +599 { +600 return has_channel(User,Chan); +601 } .fi .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP" .PP -Returns true if the servername you give is ulined. ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.Definition at line 421 of file modules.cpp. +Returns true if the servername you give is ulined. ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.Definition at line 480 of file modules.cpp. .PP References is_uline(). .PP .nf -422 { -423 return is_uline(server.c_str()); -424 } +481 { +482 return is_uline(server.c_str()); +483 } .fi .SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP" .PP -Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 689 of file modules.cpp. -.PP -.nf -690 { -691 const char* dest = mask.c_str(); -692 if (strchr(dest,'!')==0) -693 return false; -694 if (strchr(dest,'@')==0) -695 return false; -696 for (int i = 0; i < strlen(dest); i++) -697 if (dest[i] < 32) -698 return false; -699 for (int i = 0; i < strlen(dest); i++) -700 if (dest[i] > 126) -701 return false; -702 int c = 0; -703 for (int i = 0; i < strlen(dest); i++) -704 if (dest[i] == '!') -705 c++; -706 if (c>1) -707 return false; -708 c = 0; -709 for (int i = 0; i < strlen(dest); i++) -710 if (dest[i] == '@') -711 c++; -712 if (c>1) -713 return false; -714 -715 return true; -716 } +Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 748 of file modules.cpp. +.PP +.nf +749 { +750 const char* dest = mask.c_str(); +751 if (strchr(dest,'!')==0) +752 return false; +753 if (strchr(dest,'@')==0) +754 return false; +755 for (int i = 0; i < strlen(dest); i++) +756 if (dest[i] < 32) +757 return false; +758 for (int i = 0; i < strlen(dest); i++) +759 if (dest[i] > 126) +760 return false; +761 int c = 0; +762 for (int i = 0; i < strlen(dest); i++) +763 if (dest[i] == '!') +764 c++; +765 if (c>1) +766 return false; +767 c = 0; +768 for (int i = 0; i < strlen(dest); i++) +769 if (dest[i] == '@') +770 c++; +771 if (c>1) +772 return false; +773 +774 return true; +775 } .fi .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP" .PP -Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 381 of file modules.cpp. +Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 440 of file modules.cpp. .PP .nf -382 { -383 return add_channel(user,cname.c_str(),key.c_str(),true); -384 } +441 { +442 return add_channel(user,cname.c_str(),key.c_str(),true); +443 } .fi .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP" .PP -Writes a log string. This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.Definition at line 431 of file modules.cpp. +Writes a log string. This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.Definition at line 490 of file modules.cpp. .PP .nf -432 { -433 log(level,'%s',s.c_str()); -434 } +491 { +492 log(level,'%s',s.c_str()); +493 } .fi .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP" .PP -Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 368 of file modules.cpp. +Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 427 of file modules.cpp. .PP .nf -369 { -370 char literal[MAXBUF],pattern[MAXBUF]; -371 strlcpy(literal,sliteral.c_str(),MAXBUF); -372 strlcpy(pattern,spattern.c_str(),MAXBUF); -373 return match(literal,pattern); -374 } +428 { +429 char literal[MAXBUF],pattern[MAXBUF]; +430 strlcpy(literal,sliteral.c_str(),MAXBUF); +431 strlcpy(pattern,spattern.c_str(),MAXBUF); +432 return match(literal,pattern); +433 } .fi .SS "bool Server::MeshCheckChan (\fBchanrec\fP * c, std::string servername)\fC [virtual]\fP" .PP -This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 744 of file modules.cpp. +This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 803 of file modules.cpp. .PP .nf -745 { -746 if (c) -747 { -748 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -749 } -750 else return false; -751 } +804 { +805 if (c) +806 { +807 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +808 } +809 else return false; +810 } .fi .SS "bool Server::MeshCheckCommon (\fBuserrec\fP * u, std::string servername)\fC [virtual]\fP" .PP -This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 753 of file modules.cpp. +This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 812 of file modules.cpp. .PP .nf -754 { -755 if (u) -756 { -757 return CommonOnThisServer(u,(char*)servername.c_str()); -758 } -759 else return false; -760 } +813 { +814 if (u) +815 { +816 return CommonOnThisServer(u,(char*)servername.c_str()); +817 } +818 else return false; +819 } .fi .SS "void Server::MeshSendAll (std::string text)\fC [virtual]\fP" .PP -Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 718 of file modules.cpp. +Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 777 of file modules.cpp. .PP .nf -719 { -720 NetSendToAll((char*)text.c_str()); -721 } +778 { +779 NetSendToAll((char*)text.c_str()); +780 } .fi .SS "void Server::MeshSendAllAlive (std::string text)\fC [virtual]\fP" .PP -This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 729 of file modules.cpp. +This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 788 of file modules.cpp. .PP .nf -730 { -731 NetSendToAllAlive((char*)text.c_str()); -732 } +789 { +790 NetSendToAllAlive((char*)text.c_str()); +791 } .fi .SS "void Server::MeshSendAllExcept (std::string target, std::string text)\fC [virtual]\fP" .PP -This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 739 of file modules.cpp. +This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 798 of file modules.cpp. .PP .nf -740 { -741 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -742 } +799 { +800 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); +801 } .fi .SS "void Server::MeshSendCommon (\fBuserrec\fP * user, std::string text)\fC [virtual]\fP" .PP -This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 723 of file modules.cpp. +This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 782 of file modules.cpp. .PP .nf -724 { -725 if (user) -726 NetSendToCommon(user,(char*)text.c_str()); -727 } +783 { +784 if (user) +785 NetSendToCommon(user,(char*)text.c_str()); +786 } .fi .SS "void Server::MeshSendUnicast (std::string destination, std::string text)\fC [virtual]\fP" .PP -This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 734 of file modules.cpp. +This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 793 of file modules.cpp. .PP .nf -735 { -736 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -737 } +794 { +795 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +796 } .fi .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP" .PP -Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 386 of file modules.cpp. +Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 445 of file modules.cpp. .PP .nf -387 { -388 return del_channel(user,cname.c_str(),reason.c_str(),false); -389 } +446 { +447 return del_channel(user,cname.c_str(),reason.c_str(),false); +448 } .fi .SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP" .PP -This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.Definition at line 604 of file modules.cpp. -.PP -References ucrec::channel, userrec::chans, chanrec::created, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. -.PP -.nf -605 { -606 zombie->fd = alive->fd; -607 alive->fd = FD_MAGIC_NUMBER; -608 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); -609 kill_link(alive,message.c_str()); -610 for (int i = 0; i != MAXCHANS; i++) -611 { -612 if (zombie->chans[i].channel != NULL) -613 { -614 if (zombie->chans[i].channel->name) -615 { -616 chanrec* Ptr = zombie->chans[i].channel; -617 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); -618 if (Ptr->topicset) -619 { -620 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); -621 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); -622 } -623 userlist(zombie,Ptr); -624 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); -625 WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr)); -626 WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created); -627 -628 } -629 } -630 } -631 -632 } +This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.Definition at line 663 of file modules.cpp. +.PP +References ucrec::channel, userrec::chans, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. +.PP +.nf +664 { +665 zombie->fd = alive->fd; +666 alive->fd = FD_MAGIC_NUMBER; +667 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +668 kill_link(alive,message.c_str()); +669 for (int i = 0; i != MAXCHANS; i++) +670 { +671 if (zombie->chans[i].channel != NULL) +672 { +673 if (zombie->chans[i].channel->name) +674 { +675 chanrec* Ptr = zombie->chans[i].channel; +676 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +677 if (Ptr->topicset) +678 { +679 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +680 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +681 } +682 userlist(zombie,Ptr); +683 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +684 //WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr)); +685 //WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created); +686 +687 } +688 } +689 } +690 +691 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -820,65 +842,65 @@ Forces a user to quit with the specified reason. To the user, it will appear as .PP WARNING! .PP -Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 415 of file modules.cpp. +Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 474 of file modules.cpp. .PP References userrec::nick, and send_network_quit(). .PP .nf -416 { -417 send_network_quit(user->nick,reason.c_str()); -418 kill_link(user,reason.c_str()); -419 } +475 { +476 send_network_quit(user->nick,reason.c_str()); +477 kill_link(user,reason.c_str()); +478 } .fi .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP" .PP -Sends a line of text down a TCP/IP socket. This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.Definition at line 446 of file modules.cpp. +Sends a line of text down a TCP/IP socket. This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.Definition at line 505 of file modules.cpp. .PP .nf -447 { -448 Write(Socket,'%s',s.c_str()); -449 } +506 { +507 Write(Socket,'%s',s.c_str()); +508 } .fi .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP" .PP -Sends text from a user to a channel (mulicast). This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).Definition at line 475 of file modules.cpp. +Sends text from a user to a channel (mulicast). This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).Definition at line 534 of file modules.cpp. .PP .nf -476 { -477 if (IncludeSender) -478 { -479 WriteChannel(Channel,User,'%s',s.c_str()); -480 } -481 else -482 { -483 ChanExceptSender(Channel,User,'%s',s.c_str()); -484 } -485 } +535 { +536 if (IncludeSender) +537 { +538 WriteChannel(Channel,User,'%s',s.c_str()); +539 } +540 else +541 { +542 ChanExceptSender(Channel,User,'%s',s.c_str()); +543 } +544 } .fi .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP" .PP -Sends text from a user to one or more channels (mulicast). This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.Definition at line 492 of file modules.cpp. +Sends text from a user to one or more channels (mulicast). This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.Definition at line 551 of file modules.cpp. .PP .nf -493 { -494 if (IncludeSender) -495 { -496 WriteCommon(User,'%s',text.c_str()); -497 } -498 else -499 { -500 WriteCommonExcept(User,'%s',text.c_str()); -501 } -502 } +552 { +553 if (IncludeSender) +554 { +555 WriteCommon(User,'%s',text.c_str()); +556 } +557 else +558 { +559 WriteCommonExcept(User,'%s',text.c_str()); +560 } +561 } .fi .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP" .PP -Sends text from a user to a socket. This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)Definition at line 456 of file modules.cpp. +Sends text from a user to a socket. This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)Definition at line 515 of file modules.cpp. .PP .nf -457 { -458 WriteFrom(Socket,User,'%s',s.c_str()); -459 } +516 { +517 WriteFrom(Socket,User,'%s',s.c_str()); +518 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -896,32 +918,32 @@ modes[2] = user->nick; .PP Srv->SendMode(modes,3,user); .PP -The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!Definition at line 441 of file modules.cpp. +The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!Definition at line 500 of file modules.cpp. .PP References server_mode(). .PP .nf -442 { -443 server_mode(parameters,pcnt,user); -444 } +501 { +502 server_mode(parameters,pcnt,user); +503 } .fi .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP" .PP -Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 363 of file modules.cpp. +Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 422 of file modules.cpp. .PP .nf -364 { -365 WriteOpers('%s',s.c_str()); -366 } +423 { +424 WriteOpers('%s',s.c_str()); +425 } .fi .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP" .PP -Sends text from the server to a socket. This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)Definition at line 451 of file modules.cpp. +Sends text from the server to a socket. This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)Definition at line 510 of file modules.cpp. .PP .nf -452 { -453 WriteServ(Socket,'%s',s.c_str()); -454 } +511 { +512 WriteServ(Socket,'%s',s.c_str()); +513 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -933,23 +955,23 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 461 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 520 of file modules.cpp. .PP References connection::fd. .PP .nf -462 { -463 if (!Source) -464 { -465 // if source is NULL, then the message originates from the local server -466 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -467 } -468 else -469 { -470 // otherwise it comes from the user specified -471 WriteTo(Source,Dest,'%s',s.c_str()); -472 } -473 } +521 { +522 if (!Source) +523 { +524 // if source is NULL, then the message originates from the local server +525 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +526 } +527 else +528 { +529 // otherwise it comes from the user specified +530 WriteTo(Source,Dest,'%s',s.c_str()); +531 } +532 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -957,36 +979,36 @@ Sends to all users matching a mode mask You must specify one or more usermodes a .PP Serv->SendToModeMask('xi', WM_OR, 'm00'); .PP -Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 376 of file modules.cpp. +Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 435 of file modules.cpp. .PP .nf -377 { -378 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -379 } +436 { +437 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +438 } .fi .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP" .PP -Sends a WALLOPS message. This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.Definition at line 504 of file modules.cpp. +Sends a WALLOPS message. This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.Definition at line 563 of file modules.cpp. .PP .nf -505 { -506 WriteWallOps(User,false,'%s',text.c_str()); -507 } +564 { +565 WriteWallOps(User,false,'%s',text.c_str()); +566 } .fi .SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP" .PP -Remove a user's connection to the irc server, but leave their client in existence in the user hash. When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.Definition at line 595 of file modules.cpp. +Remove a user's connection to the irc server, but leave their client in existence in the user hash. When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.Definition at line 654 of file modules.cpp. .PP References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf -596 { -597 unsigned int old_fd = user->fd; -598 user->fd = FD_MAGIC_NUMBER; -599 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); -600 close(old_fd); -601 shutdown (old_fd,2); -602 } +655 { +656 unsigned int old_fd = user->fd; +657 user->fd = FD_MAGIC_NUMBER; +658 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +659 close(old_fd); +660 shutdown (old_fd,2); +661 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 9ef8b6982..1c6c04405 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -24,8 +24,10 @@ Definition at line 146 of file modules.cpp. 148 char a[MAXBUF],b[MAXBUF]; 149 strlcpy(a,s1.c_str(),MAXBUF); 150 strlcpy(b,s2.c_str(),MAXBUF); -151 return (strcasecmp(a,b) == 0); -152 } +151 strlower(a); +152 strlower(b); +153 return (strcasecmp(a,b) == 0); +154 } .fi diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index 859d315d6..245c2b184 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -49,10 +49,10 @@ Definition at line 111 of file modules.h. .PP .SS "Version::Version (int major, int minor, int revision, int build, int flags)" .PP -Definition at line 300 of file modules.cpp. +Definition at line 302 of file modules.cpp. .PP .nf -300 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; +302 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 9a220f0f1..cb8a54538 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index d3cf8c290..3ce871a94 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/base.h.3 b/docs/man/man3/base.h.3 index 24279547a..5d513596e 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/channels.cpp.3 b/docs/man/man3/channels.cpp.3 index 9b812d4e9..cba651bbc 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -271,13 +271,19 @@ Definition at line 88 of file channels.cpp. Definition at line 103 of file channels.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 959 of file modules.cpp. +Definition at line 1030 of file modules.cpp. +.PP +Referenced by Server::FindModule(). .SS "std::vector<std::string> \fBmodule_names\fP" .PP Definition at line 92 of file channels.cpp. +.PP +Referenced by Server::FindModule(). .SS "std::vector<\fBModule\fP*> modules" .PP Definition at line 64 of file channels.cpp. +.PP +Referenced by Server::FindModule(). .SS "char \fBmotd\fP[MAXBUF]" .PP Definition at line 76 of file channels.cpp. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index bafd88bd4..028883c6d 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 6a5e817bd..5c9d0d9c4 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -254,7 +254,7 @@ Referenced by chanrec(). .PP Creation time. Definition at line 111 of file channels.h. .PP -Referenced by chanrec(), and Server::PseudoToUser(). +Referenced by chanrec(). .SS "char \fBchanrec::custom_modes\fP[MAXMODES]" .PP Custom modes for the channel. Plugins may use this field in any way they see fit.Definition at line 103 of file channels.h. diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index da9faefb7..a8299e1f5 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -10,7 +10,7 @@ classbase \- The base class for all inspircd classes. .PP \fC#include <base.h>\fP .PP -Inherited by \fBAdmin\fP, \fBConfigReader\fP, \fBConnectClass\fP, \fBExtensible\fP, \fBExtMode\fP, \fBFileReader\fP, \fBHostItem\fP, \fBInvited\fP, \fBModeParameter\fP, \fBModule\fP, \fBModuleFactory\fP, \fBServer\fP, \fBucrec\fP, \fBVersion\fP, and \fBXLine\fP. +Inherited by \fBAdmin\fP, \fBConfigReader\fP, \fBConnectClass\fP, \fBExtensible\fP, \fBExtMode\fP, \fBFileReader\fP, \fBHostItem\fP, \fBInvited\fP, \fBModeParameter\fP, \fBModule\fP, \fBModuleFactory\fP, \fBModuleMessage\fP, \fBServer\fP, \fBucrec\fP, \fBVersion\fP, and \fBXLine\fP. .PP .SS "Public Member Functions" diff --git a/docs/man/man3/command_t.3 b/docs/man/man3/command_t.3 index 4fa056288..ba965234c 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/commands.h.3 b/docs/man/man3/commands.h.3 index d01b59391..27fa66676 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index baba8f9d3..d1e4e7e63 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index cca65c993..e57b5cede 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ctables.h.3 b/docs/man/man3/ctables.h.3 index 27dd9e13a..cf8d86cc3 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/dns.h.3 b/docs/man/man3/dns.h.3 index 8ecd135f8..508f04cff 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/dns_ip4list.3 b/docs/man/man3/dns_ip4list.3 index 5565e04c4..756ce99df 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index ff0630ea8..9a47718e0 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 003124253..613102a3a 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index 065d24ebd..be2164f1b 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/modules.cpp.3 b/docs/man/man3/modules.cpp.3 index 5e8cde7c9..b91ae0484 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -299,160 +299,160 @@ Definition at line 59 of file modules.cpp. .PP .SS "typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 175 of file modules.cpp. +Definition at line 177 of file modules.cpp. .SS "typedef nspace::hash_map<std::string, \fBchanrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBchan_hash\fP" .PP -Definition at line 174 of file modules.cpp. +Definition at line 176 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 176 of file modules.cpp. +Definition at line 178 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 202 of file modules.cpp. +Definition at line 204 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 203 of file modules.cpp. +Definition at line 205 of file modules.cpp. .PP Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "typedef nspace::hash_map<std::string, \fBuserrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 173 of file modules.cpp. +Definition at line 175 of file modules.cpp. .SH "Function Documentation" .PP .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)" .PP -Definition at line 275 of file modules.cpp. +Definition at line 277 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -276 { -277 if (ModeDefined(modechar,type)) { -278 return false; -279 } -280 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -281 return true; -282 } +278 { +279 if (ModeDefined(modechar,type)) { +280 return false; +281 } +282 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +283 return true; +284 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 209 of file modules.cpp. +Definition at line 211 of file modules.cpp. .PP References DEBUG, EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -210 { -211 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -212 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -213 { -214 if ((i->modechar == modechar) && (i->type == type)) -215 { -216 return true; -217 } -218 } -219 return false; -220 } +212 { +213 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +214 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +215 { +216 if ((i->modechar == modechar) && (i->type == type)) +217 { +218 return true; +219 } +220 } +221 return false; +222 } .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 262 of file modules.cpp. +Definition at line 264 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -263 { -264 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -265 { -266 if ((i->modechar == modechar) && (i->type == type)) -267 { -268 return i->params_when_off; -269 } -270 } -271 return 0; -272 } +265 { +266 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +267 { +268 if ((i->modechar == modechar) && (i->type == type)) +269 { +270 return i->params_when_off; +271 } +272 } +273 return 0; +274 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 249 of file modules.cpp. +Definition at line 251 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -250 { -251 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -252 { -253 if ((i->modechar == modechar) && (i->type == type)) -254 { -255 return i->params_when_on; -256 } -257 } -258 return 0; -259 } +252 { +253 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +254 { +255 if ((i->modechar == modechar) && (i->type == type)) +256 { +257 return i->params_when_on; +258 } +259 } +260 return 0; +261 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 235 of file modules.cpp. +Definition at line 237 of file modules.cpp. .PP References DEBUG, EMode, and ExtModeListIter. .PP .nf -236 { -237 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -238 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -239 { -240 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) -241 { -242 return true; -243 } -244 } -245 return false; -246 } +238 { +239 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +240 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +241 { +242 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +243 { +244 return true; +245 } +246 } +247 return false; +248 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP -Definition at line 222 of file modules.cpp. +Definition at line 224 of file modules.cpp. .PP References DEBUG, EMode, and ExtModeListIter. .PP .nf -223 { -224 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -225 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -226 { -227 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) -228 { -229 return true; -230 } -231 } -232 return false; -233 } +225 { +226 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +227 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +228 { +229 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +230 { +231 return true; +232 } +233 } +234 return false; +235 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 285 of file modules.cpp. +Definition at line 287 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -286 { -287 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -288 { -289 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -290 { -291 i->list = true; -292 return; -293 } -294 } -295 return; -296 } +288 { +289 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +290 { +291 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +292 { +293 i->list = true; +294 return; +295 } +296 } +297 return; +298 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -475,15 +475,15 @@ Definition at line 103 of file modules.cpp. Definition at line 97 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 180 of file modules.cpp. +Definition at line 182 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 179 of file modules.cpp. +Definition at line 181 of file modules.cpp. .PP Referenced by Server::GetUsers(). .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 182 of file modules.cpp. +Definition at line 184 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP Definition at line 104 of file modules.cpp. @@ -504,7 +504,7 @@ Definition at line 77 of file modules.cpp. Definition at line 83 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 206 of file modules.cpp. +Definition at line 208 of file modules.cpp. .PP Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "std::vector<\fBircd_module\fP*> factory" @@ -515,7 +515,7 @@ Definition at line 66 of file modules.cpp. Definition at line 94 of file modules.cpp. .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 185 of file modules.cpp. +Definition at line 187 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP Definition at line 81 of file modules.cpp. @@ -533,7 +533,7 @@ Definition at line 91 of file modules.cpp. Definition at line 106 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 959 of file modules.cpp. +Definition at line 1030 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP Definition at line 95 of file modules.cpp. @@ -542,7 +542,7 @@ Definition at line 95 of file modules.cpp. Definition at line 65 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 183 of file modules.cpp. +Definition at line 185 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP Definition at line 79 of file modules.cpp. @@ -569,7 +569,7 @@ Definition at line 82 of file modules.cpp. Definition at line 78 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 184 of file modules.cpp. +Definition at line 186 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP Definition at line 80 of file modules.cpp. @@ -590,7 +590,7 @@ Definition at line 68 of file modules.cpp. Definition at line 99 of file modules.cpp. .SS "\fBuser_hash\fP \fBwhowas\fP" .PP -Definition at line 181 of file modules.cpp. +Definition at line 183 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP Definition at line 87 of file modules.cpp. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index df75da980..d2fb56fd4 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -31,6 +31,10 @@ modules.h \- .br .RI "\fIAllows 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. \fP" .ti -1c +.RI "class \fBEvent\fP" +.br +.RI "\fIThe Event class is a unicast message directed at all modules. \fP" +.ti -1c .RI "class \fBFileReader\fP" .br .RI "\fICaches a text file into memory and can be used to retrieve lines from it. \fP" @@ -43,6 +47,14 @@ modules.h \- .br .RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. \fP" .ti -1c +.RI "class \fBModuleMessage\fP" +.br +.RI "\fIThe ModuleMessage class is the base class of \fBRequest\fP and \fBEvent\fP This class is used to represent a basic data structure which is passed between modules for safe inter-module communications. \fP" +.ti -1c +.RI "class \fBRequest\fP" +.br +.RI "\fIThe Request class is a unicast message directed at a given module. \fP" +.ti -1c .RI "class \fBServer\fP" .br .RI "\fIAllows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. \fP" @@ -218,22 +230,22 @@ Referenced by Module::OnAccessCheck(). Definition at line 38 of file modules.h. .SS "#define CONF_FILE_NOT_FOUND 0x000200" .PP -Definition at line 935 of file modules.h. +Definition at line 1063 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 932 of file modules.h. +Definition at line 1060 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 933 of file modules.h. +Definition at line 1061 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 934 of file modules.h. +Definition at line 1062 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" @@ -252,6 +264,8 @@ Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). .SS "#define FOREACH_MOD for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->" .PP Definition at line 79 of file modules.h. +.PP +Referenced by Event::Send(). .SS "#define FOREACH_RESULT(x)" .PP \fBValue:\fP.nf @@ -319,7 +333,7 @@ Low level definition of a \fBFileReader\fP classes file cache area. Definition a Referenced by FileReader::FileReader(), and FileReader::LoadFile(). .SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP" .PP -Definition at line 1101 of file modules.h. +Definition at line 1229 of file modules.h. .SS "typedef \fBfile_cache\fP \fBstring_list\fP" .PP Definition at line 68 of file modules.h. diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index 44795c08d..9ff36fa71 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 index 6725acc75..2c771436c 100644 --- a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 +++ b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< in_addr >" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index 680c5c330..2c89b3913 100644 --- a/docs/man/man3/nspace_nspace_hash_ string _.3 +++ b/docs/man/man3/nspace_nspace_hash_ string _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< string >" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 9db02494f..937637ec0 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index 7e5d6d624..00ab9528d 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.h.3 b/docs/man/man3/servers.h.3 index 656a48f10..707489eb1 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 2fa2488ad..37b3ebb26 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 27ad6b9b0..5b5cc3285 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 4b5c038c5..83d323e83 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index f869f127f..5b1969971 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/users.h.3 b/docs/man/man3/users.h.3 index a17206813..6e3177d25 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 0b33eb10c..3cbdff2e2 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "16 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "20 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME |