diff options
Diffstat (limited to 'docs/man/man3')
62 files changed, 1664 insertions, 1508 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 60dde5bf6..e2001754e 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "15 May 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 314 of file modules.cpp. +Definition at line 238 of file modules.cpp. .PP .nf -314 : Name(name), Email(email), Nick(nick) { }; +238 : 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 1d3720576..8fb296ba1 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index fe2042e0c..23b16d688 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "15 May 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 1147 of file modules.h. +Definition at line 1150 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ConfigReader::ConfigReader ()" .PP -Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 870 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 799 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -871 { -872 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -873 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -874 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -875 if (!this->readerror) -876 this->error = CONF_FILE_NOT_FOUND; -877 } +800 { +801 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +802 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +803 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +804 if (!this->readerror) +805 this->error = CONF_FILE_NOT_FOUND; +806 } .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 889 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 818 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -890 { -891 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -892 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -893 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -894 if (!this->readerror) -895 this->error = CONF_FILE_NOT_FOUND; -896 }; +819 { +820 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +821 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +822 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +823 if (!this->readerror) +824 this->error = CONF_FILE_NOT_FOUND; +825 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 880 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 809 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -881 { -882 if (this->cache) -883 delete this->cache; -884 if (this->errorlog) -885 delete this->errorlog; -886 } +810 { +811 if (this->cache) +812 delete this->cache; +813 if (this->errorlog) +814 delete this->errorlog; +815 } .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 967 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 896 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -968 { -969 if (bail) -970 { -971 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -972 exit(0); -973 } -974 else -975 { -976 char dataline[1024]; -977 if (user) -978 { -979 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -980 while (!errorlog->eof()) -981 { -982 errorlog->getline(dataline,1024); -983 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -984 } -985 } -986 else -987 { -988 WriteOpers('There were errors in the configuration file:',user->nick); -989 while (!errorlog->eof()) -990 { -991 errorlog->getline(dataline,1024); -992 WriteOpers(dataline); -993 } -994 } -995 return; -996 } -997 } +897 { +898 if (bail) +899 { +900 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +901 exit(0); +902 } +903 else +904 { +905 char dataline[1024]; +906 if (user) +907 { +908 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +909 while (!errorlog->eof()) +910 { +911 errorlog->getline(dataline,1024); +912 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +913 } +914 } +915 else +916 { +917 WriteOpers('There were errors in the configuration file:',user->nick); +918 while (!errorlog->eof()) +919 { +920 errorlog->getline(dataline,1024); +921 WriteOpers(dataline); +922 } +923 } +924 return; +925 } +926 } .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 1000 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 929 of file modules.cpp. .PP References cache. .PP .nf -1001 { -1002 return EnumConf(cache,tag.c_str()); -1003 } +930 { +931 return EnumConf(cache,tag.c_str()); +932 } .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 1005 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 934 of file modules.cpp. .PP References cache. .PP .nf -1006 { -1007 return EnumValues(cache, tag.c_str(), index); -1008 } +935 { +936 return EnumValues(cache, tag.c_str(), index); +937 } .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 960 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 889 of file modules.cpp. .PP References error. .PP .nf -961 { -962 long olderr = this->error; -963 this->error = 0; -964 return olderr; -965 } +890 { +891 long olderr = this->error; +892 this->error = 0; +893 return olderr; +894 } .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 914 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 843 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -915 { -916 char val[MAXBUF]; -917 char t[MAXBUF]; -918 char n[MAXBUF]; -919 strlcpy(t,tag.c_str(),MAXBUF); -920 strlcpy(n,name.c_str(),MAXBUF); -921 int res = ReadConf(cache,t,n,index,val); -922 if (!res) -923 { -924 this->error = CONF_VALUE_NOT_FOUND; -925 return false; -926 } -927 std::string s = val; -928 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -929 } +844 { +845 char val[MAXBUF]; +846 char t[MAXBUF]; +847 char n[MAXBUF]; +848 strlcpy(t,tag.c_str(),MAXBUF); +849 strlcpy(n,name.c_str(),MAXBUF); +850 int res = ReadConf(cache,t,n,index,val); +851 if (!res) +852 { +853 this->error = CONF_VALUE_NOT_FOUND; +854 return false; +855 } +856 std::string s = val; +857 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +858 } .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 931 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 860 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -932 { -933 char val[MAXBUF]; -934 char t[MAXBUF]; -935 char n[MAXBUF]; -936 strlcpy(t,tag.c_str(),MAXBUF); -937 strlcpy(n,name.c_str(),MAXBUF); -938 int res = ReadConf(cache,t,n,index,val); -939 if (!res) -940 { -941 this->error = CONF_VALUE_NOT_FOUND; -942 return 0; -943 } -944 for (int i = 0; i < strlen(val); i++) -945 { -946 if (!isdigit(val[i])) -947 { -948 this->error = CONF_NOT_A_NUMBER; -949 return 0; -950 } -951 } -952 if ((needs_unsigned) && (atoi(val)<0)) -953 { -954 this->error = CONF_NOT_UNSIGNED; -955 return 0; -956 } -957 return atoi(val); -958 } +861 { +862 char val[MAXBUF]; +863 char t[MAXBUF]; +864 char n[MAXBUF]; +865 strlcpy(t,tag.c_str(),MAXBUF); +866 strlcpy(n,name.c_str(),MAXBUF); +867 int res = ReadConf(cache,t,n,index,val); +868 if (!res) +869 { +870 this->error = CONF_VALUE_NOT_FOUND; +871 return 0; +872 } +873 for (int i = 0; i < strlen(val); i++) +874 { +875 if (!isdigit(val[i])) +876 { +877 this->error = CONF_NOT_A_NUMBER; +878 return 0; +879 } +880 } +881 if ((needs_unsigned) && (atoi(val)<0)) +882 { +883 this->error = CONF_NOT_UNSIGNED; +884 return 0; +885 } +886 return atoi(val); +887 } .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 898 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 827 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -899 { -900 char val[MAXBUF]; -901 char t[MAXBUF]; -902 char n[MAXBUF]; -903 strlcpy(t,tag.c_str(),MAXBUF); -904 strlcpy(n,name.c_str(),MAXBUF); -905 int res = ReadConf(cache,t,n,index,val); -906 if (!res) -907 { -908 this->error = CONF_VALUE_NOT_FOUND; -909 return ''; -910 } -911 return val; -912 } +828 { +829 char val[MAXBUF]; +830 char t[MAXBUF]; +831 char n[MAXBUF]; +832 strlcpy(t,tag.c_str(),MAXBUF); +833 strlcpy(n,name.c_str(),MAXBUF); +834 int res = ReadConf(cache,t,n,index,val); +835 if (!res) +836 { +837 this->error = CONF_VALUE_NOT_FOUND; +838 return ''; +839 } +840 return val; +841 } .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 1010 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 939 of file modules.cpp. .PP References readerror. .PP .nf -1011 { -1012 return this->readerror; -1013 } +940 { +941 return this->readerror; +942 } .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 1155 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 1158 of file modules.h. .PP Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader(). .SS "long \fBConfigReader::error\fP\fC [protected]\fP" .PP -Definition at line 1160 of file modules.h. +Definition at line 1163 of file modules.h. .PP Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP" .PP -Definition at line 1156 of file modules.h. +Definition at line 1159 of file modules.h. .PP Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader(). .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP" .PP -Used to store errors. Definition at line 1159 of file modules.h. +Used to store errors. Definition at line 1162 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 3a7c5d1f5..c71050d3c 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index 7af2610b6..f70f13979 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index dd20df94f..cf223c4a7 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Event.3 b/docs/man/man3/Event.3 index dabb4c1d4..249e9bcba 100644 --- a/docs/man/man3/Event.3 +++ b/docs/man/man3/Event.3 @@ -1,4 +1,4 @@ -.TH "Event" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Event" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -63,59 +63,59 @@ Definition at line 194 of file modules.h. .PP .SS "Event::Event (char * anydata, \fBModule\fP * src, std::string eventid)" .PP -Create a new Event. Definition at line 345 of file modules.cpp. +Create a new Event. Definition at line 269 of file modules.cpp. .PP .nf -345 : data(anydata), source(src), id(eventid) { }; +269 : data(anydata), source(src), id(eventid) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Event::GetData ()" .PP -Get the Event data. Definition at line 347 of file modules.cpp. +Get the Event data. Definition at line 271 of file modules.cpp. .PP References data. .PP .nf -348 { -349 return this->data; -350 } +272 { +273 return this->data; +274 } .fi .SS "std::string Event::GetEventID ()" .PP -Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 363 of file modules.cpp. +Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 287 of file modules.cpp. .PP References id. .PP .nf -364 { -365 return this->id; -366 } +288 { +289 return this->id; +290 } .fi .SS "\fBModule\fP * Event::GetSource ()" .PP -Get the event Source. Definition at line 352 of file modules.cpp. +Get the event Source. Definition at line 276 of file modules.cpp. .PP References source. .PP .nf -353 { -354 return this->source; -355 } +277 { +278 return this->source; +279 } .fi .SS "char * Event::Send ()\fC [virtual]\fP" .PP Send the Event. The return result of an \fBEvent::Send()\fP will always be NULL as no replies are expected. Implements \fBModuleMessage\fP. .PP -Definition at line 357 of file modules.cpp. +Definition at line 281 of file modules.cpp. .PP References FOREACH_MOD. .PP .nf -358 { -359 FOREACH_MOD OnEvent(this); -360 return NULL; -361 } +282 { +283 FOREACH_MOD OnEvent(this); +284 return NULL; +285 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index bd9e59b1e..b30ba6601 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index cb5210120..353b17ce3 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "15 May 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 212 of file modules.cpp. +Definition at line 136 of file modules.cpp. .PP References modechar, needsoper, params_when_off, params_when_on, and type. .PP .nf -212 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +136 : 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 211 of file modules.cpp. +Definition at line 135 of file modules.cpp. .SS "char \fBExtMode::modechar\fP" .PP -Definition at line 206 of file modules.cpp. +Definition at line 130 of file modules.cpp. .PP Referenced by ExtMode(). .SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 210 of file modules.cpp. +Definition at line 134 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 209 of file modules.cpp. +Definition at line 133 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 208 of file modules.cpp. +Definition at line 132 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::type\fP" .PP -Definition at line 207 of file modules.cpp. +Definition at line 131 of file modules.cpp. .PP Referenced by ExtMode(). diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index 530de1651..46a699705 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index d22ca3912..1df4ff063 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "15 May 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 1236 of file modules.h. +Definition at line 1239 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 1023 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 952 of file modules.cpp. .PP .nf -1024 { -1025 } +953 { +954 } .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 1016 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 945 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -1017 { -1018 file_cache c; -1019 readfile(c,filename.c_str()); -1020 this->fc = c; -1021 } +946 { +947 file_cache c; +948 readfile(c,filename.c_str()); +949 this->fc = c; +950 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 1035 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 964 of file modules.cpp. .PP .nf -1036 { -1037 } +965 { +966 } .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 1039 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 968 of file modules.cpp. .PP References fc. .PP .nf -1040 { -1041 if (fc.size() == 0) -1042 { -1043 return(false); -1044 } -1045 else -1046 { -1047 return(true); -1048 } -1049 } +969 { +970 if (fc.size() == 0) +971 { +972 return(false); +973 } +974 else +975 { +976 return(true); +977 } +978 } .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 1058 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 987 of file modules.cpp. .PP References fc. .PP .nf -1059 { -1060 return fc.size(); -1061 } +988 { +989 return fc.size(); +990 } .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 1051 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 980 of file modules.cpp. .PP References fc. .PP .nf -1052 { -1053 if ((x<0) || (x>fc.size())) -1054 return ''; -1055 return fc[x]; -1056 } +981 { +982 if ((x<0) || (x>fc.size())) +983 return ''; +984 return fc[x]; +985 } .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 1027 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 956 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -1028 { -1029 file_cache c; -1030 readfile(c,filename.c_str()); -1031 this->fc = c; -1032 } +957 { +958 file_cache c; +959 readfile(c,filename.c_str()); +960 this->fc = c; +961 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 1238 of file modules.h. +Definition at line 1241 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 720e44cf2..e781013fa 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index eeab03ac9..37b11a714 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "15 May 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 284f16016..38bfe4075 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,36 +1,35 @@ -.TH "InAddr_HashComp" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -InAddr_HashComp \- +InAddr_HashComp \- This class returns true if two in_addr structs match. + +.PP .SH SYNOPSIS .br .PP +\fC#include <hashcomp.h>\fP +.PP .SS "Public Member Functions" .in +1c .ti -1c .RI "bool \fBoperator()\fP (const in_addr &s1, const in_addr &s2) const" .br +.RI "\fIThe operator () does the actual comparison in hash_map. \fP" .in -1c -.SH "Member Function Documentation" +.SH "Detailed Description" .PP -.SS "bool InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const\fC [inline]\fP" +This class returns true if two in_addr structs match. + +Checking is done by copying both into a size_t then doing a numeric comparison of the two. .PP -Definition at line 171 of file modules.cpp. +Definition at line 71 of file hashcomp.h. +.SH "Member Function Documentation" +.PP +.SS "bool InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const" .PP -.nf -172 { -173 size_t q; -174 size_t p; -175 -176 memcpy(&q,&s1,sizeof(size_t)); -177 memcpy(&p,&s2,sizeof(size_t)); -178 -179 return (q == p); -180 } -.fi - +The operator () does the actual comparison in hash_map. .SH "Author" .PP diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 301a0d350..50608345f 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index 3040a4902..e09d4d9b5 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index 4281b3d43..ed73e3e15 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 1b6cfe6ed..2a85198db 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 49fa49d4b..b33e933cd 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -251,35 +251,35 @@ Definition at line 236 of file modules.h. .PP .SS "Module::Module ()" .PP -Default constructor creates a module class. Definition at line 370 of file modules.cpp. +Default constructor creates a module class. Definition at line 294 of file modules.cpp. .PP .nf -370 { } +294 { } .fi .SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class. Definition at line 371 of file modules.cpp. +Default destructor destroys a module class. Definition at line 295 of file modules.cpp. .PP .nf -371 { } +295 { } .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 383 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 307 of file modules.cpp. .PP References VF_VENDOR. .PP .nf -383 { return Version(1,0,0,0,VF_VENDOR); } +307 { 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 395 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 319 of file modules.cpp. .PP .nf -395 { }; +319 { }; .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP @@ -307,312 +307,312 @@ 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 392 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 316 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -392 { return ACR_DEFAULT; }; +316 { return ACR_DEFAULT; }; .fi .SS "int Module::OnAddBan (\fBuserrec\fP * source, \fBchanrec\fP * channel, std::string banmask)\fC [virtual]\fP" .PP -Called whenever a ban is added to a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being added.Definition at line 420 of file modules.cpp. +Called whenever a ban is added to a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being added.Definition at line 344 of file modules.cpp. .PP .nf -420 { return 0; }; +344 { return 0; }; .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 398 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 322 of file modules.cpp. .PP .nf -398 { }; +322 { }; .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 412 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 336 of file modules.cpp. .PP .nf -412 { return 0; }; +336 { 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 411 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 335 of file modules.cpp. .PP .nf -411 { return 0; }; +335 { 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 394 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 318 of file modules.cpp. .PP References string_list. .PP .nf -394 { string_list empty; return empty; } +318 { 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 409 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 333 of file modules.cpp. .PP .nf -409 { return 0; }; +333 { 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 406 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 330 of file modules.cpp. .PP .nf -406 { return 0; }; +330 { 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 407 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 331 of file modules.cpp. .PP .nf -407 { return 0; }; +331 { 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 408 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 332 of file modules.cpp. .PP .nf -408 { return 0; }; +332 { 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 401 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 325 of file modules.cpp. .PP .nf -401 { return true; }; +325 { return true; }; .fi .SS "int Module::OnDelBan (\fBuserrec\fP * source, \fBchanrec\fP * channel, std::string banmask)\fC [virtual]\fP" .PP -Called whenever a ban is removed from a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.Definition at line 421 of file modules.cpp. +Called whenever a ban is removed from a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.Definition at line 345 of file modules.cpp. .PP .nf -421 { return 0; }; +345 { return 0; }; .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 415 of file modules.cpp. +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 339 of file modules.cpp. .PP .nf -415 { return; }; +339 { 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 382 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 306 of file modules.cpp. .PP .nf -382 { return false; } +306 { return false; } .fi .SS "void Module::OnGlobalConnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user connects, anywhere on the network. This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.Definition at line 419 of file modules.cpp. +Called whenever a user connects, anywhere on the network. This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.Definition at line 343 of file modules.cpp. .PP .nf -419 { }; +343 { }; .fi .SS "void Module::OnGlobalOper (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user is given usermode +o, anywhere on the network. You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.Definition at line 418 of file modules.cpp. +Called whenever a user is given usermode +o, anywhere on the network. You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.Definition at line 342 of file modules.cpp. .PP .nf -418 { }; +342 { }; .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 385 of file modules.cpp. +<nick> :information hereDefinition at line 309 of file modules.cpp. .PP .nf -385 { }; +309 { }; .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 396 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 320 of file modules.cpp. .PP .nf -396 { return 0; }; +320 { 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 397 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 321 of file modules.cpp. .PP .nf -397 { }; +321 { }; .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 413 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 337 of file modules.cpp. .PP .nf -413 { return 0; }; +337 { 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 414 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 338 of file modules.cpp. .PP .nf -414 { return 0; }; +338 { 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 384 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 308 of file modules.cpp. .PP .nf -384 { }; +308 { }; .fi .SS "int Module::OnOperCompare (std::string password, std::string input)\fC [virtual]\fP" .PP -Called whenever an oper password is to be compared to what a user has input. The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.Definition at line 417 of file modules.cpp. +Called whenever an oper password is to be compared to what a user has input. The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.Definition at line 341 of file modules.cpp. .PP .nf -417 { return 0; }; +341 { return 0; }; .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 378 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 302 of file modules.cpp. .PP .nf -378 { } +302 { } .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 377 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 301 of file modules.cpp. .PP .nf -377 { } +301 { } .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 400 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 324 of file modules.cpp. .PP .nf -400 { return 0; }; +324 { 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 405 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 329 of file modules.cpp. .PP .nf -405 { return 0; }; +329 { return 0; }; .fi .SS "void Module::OnRawSocketAccept (int fd, std::string ip, int localport)\fC [virtual]\fP" .PP -Called immediately after any connection is accepted. This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.Definition at line 422 of file modules.cpp. +Called immediately after any connection is accepted. This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.Definition at line 346 of file modules.cpp. .PP .nf -422 { }; +346 { }; .fi .SS "void Module::OnRawSocketClose (int fd)\fC [virtual]\fP" .PP -Called immediately before any socket is closed. When this event is called, shutdown() has not yet been called on the socket.Definition at line 424 of file modules.cpp. +Called immediately before any socket is closed. When this event is called, shutdown() has not yet been called on the socket.Definition at line 348 of file modules.cpp. .PP .nf -424 { }; +348 { }; .fi .SS "int Module::OnRawSocketRead (int fd, char * buffer, unsigned int count, int & readresult)\fC [virtual]\fP" .PP -Called immediately before any read() operation on a client socket in the core. This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult.Definition at line 425 of file modules.cpp. +Called immediately before any read() operation on a client socket in the core. This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult.Definition at line 349 of file modules.cpp. .PP .nf -425 { return 0; }; +349 { return 0; }; .fi .SS "int Module::OnRawSocketWrite (int fd, char * buffer, int count)\fC [virtual]\fP" .PP -Called immediately before any write() operation on a user's socket in the core. Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write().Definition at line 423 of file modules.cpp. +Called immediately before any write() operation on a user's socket in the core. Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write().Definition at line 347 of file modules.cpp. .PP .nf -423 { return 0; }; +347 { 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 379 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 303 of file modules.cpp. .PP .nf -379 { } +303 { } .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 416 of file modules.cpp. +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 340 of file modules.cpp. .PP Referenced by Request::Send(). .PP .nf -416 { return NULL; }; +340 { 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 399 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 323 of file modules.cpp. .PP .nf -399 { }; +323 { }; .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 380 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 304 of file modules.cpp. .PP .nf -380 { } +304 { } .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 410 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 334 of file modules.cpp. .PP .nf -410 { }; +334 { }; .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 372 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 296 of file modules.cpp. .PP .nf -372 { } +296 { } .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 374 of file modules.cpp. +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 298 of file modules.cpp. .PP .nf -374 { } +298 { } .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 375 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 299 of file modules.cpp. .PP .nf -375 { } +299 { } .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 404 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 328 of file modules.cpp. .PP .nf -404 { }; +328 { }; .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 376 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 300 of file modules.cpp. .PP .nf -376 { } +300 { } .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 391 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 315 of file modules.cpp. .PP .nf -391 { }; +315 { }; .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 387 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 311 of file modules.cpp. .PP .nf -387 { return 0; }; +311 { return 0; }; .fi .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP" .PP @@ -620,68 +620,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 381 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 305 of file modules.cpp. .PP .nf -381 { return 0; } +305 { 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 403 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 327 of file modules.cpp. .PP .nf -403 { return 0; }; +327 { 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 388 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 312 of file modules.cpp. .PP .nf -388 { return 0; }; +312 { 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 390 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 314 of file modules.cpp. .PP .nf -390 { return 0; }; +314 { 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 389 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 313 of file modules.cpp. .PP .nf -389 { return 0; }; +313 { 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 *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 373 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 297 of file modules.cpp. .PP .nf -373 { } +297 { } .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 402 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 326 of file modules.cpp. .PP .nf -402 { }; +326 { }; .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 393 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 317 of file modules.cpp. .PP References string_list. .PP .nf -393 { string_list empty; return empty; } +317 { 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 386 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 310 of file modules.cpp. .PP .nf -386 { }; +310 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index 2abcbcd97..be57b64c8 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "15 May 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 1291 of file modules.h. +Definition at line 1294 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 1294 of file modules.h. +Definition at line 1297 of file modules.h. .PP .nf -1294 { } +1297 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 1295 of file modules.h. +Definition at line 1298 of file modules.h. .PP .nf -1295 { } +1298 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/ModuleMessage.3 b/docs/man/man3/ModuleMessage.3 index 8f1484c69..63b7dba85 100644 --- a/docs/man/man3/ModuleMessage.3 +++ b/docs/man/man3/ModuleMessage.3 @@ -1,4 +1,4 @@ -.TH "ModuleMessage" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleMessage" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index a57fa6e9d..3d9dbdc20 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Request.3 b/docs/man/man3/Request.3 index 61644568d..2f7487d15 100644 --- a/docs/man/man3/Request.3 +++ b/docs/man/man3/Request.3 @@ -1,4 +1,4 @@ -.TH "Request" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Request" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -63,65 +63,65 @@ Definition at line 154 of file modules.h. .PP .SS "Request::Request (char * anydata, \fBModule\fP * src, \fBModule\fP * dst)" .PP -Create a new Request. Definition at line 316 of file modules.cpp. +Create a new Request. Definition at line 240 of file modules.cpp. .PP .nf -316 : data(anydata), source(src), dest(dst) { }; +240 : data(anydata), source(src), dest(dst) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Request::GetData ()" .PP -Fetch the Request data. Definition at line 318 of file modules.cpp. +Fetch the Request data. Definition at line 242 of file modules.cpp. .PP References data. .PP .nf -319 { -320 return this->data; -321 } +243 { +244 return this->data; +245 } .fi .SS "\fBModule\fP * Request::GetDest ()" .PP -Fetch the request destination (should be 'this' in the receiving module). Definition at line 328 of file modules.cpp. +Fetch the request destination (should be 'this' in the receiving module). Definition at line 252 of file modules.cpp. .PP References dest. .PP .nf -329 { -330 return this->dest; -331 } +253 { +254 return this->dest; +255 } .fi .SS "\fBModule\fP * Request::GetSource ()" .PP -Fetch the request source. Definition at line 323 of file modules.cpp. +Fetch the request source. Definition at line 247 of file modules.cpp. .PP References source. .PP .nf -324 { -325 return this->source; -326 } +248 { +249 return this->source; +250 } .fi .SS "char * Request::Send ()\fC [virtual]\fP" .PP Send the Request. Upon returning the result will be arbitary data returned by the module you sent the request to. It is up to your module to know what this data is and how to deal with it. Implements \fBModuleMessage\fP. .PP -Definition at line 333 of file modules.cpp. +Definition at line 257 of file modules.cpp. .PP References dest, and Module::OnRequest(). .PP .nf -334 { -335 if (this->dest) -336 { -337 return dest->OnRequest(this); -338 } -339 else -340 { -341 return NULL; -342 } -343 } +258 { +259 if (this->dest) +260 { +261 return dest->OnRequest(this); +262 } +263 else +264 { +265 return NULL; +266 } +267 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index d9c89aa98..93daa2cc9 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -104,6 +104,10 @@ Inherits \fBclassbase\fP. .br .RI "\fIReturns the network name, global to all linked servers. \fP" .ti -1c +.RI "virtual std::string \fBGetServerDescription\fP ()" +.br +.RI "\fIReturns the server description string of the local server. \fP" +.ti -1c .RI "virtual \fBAdmin\fP \fBGetAdmin\fP ()" .br .RI "\fIReturns the information of the server as returned by the /ADMIN command. \fP" @@ -267,19 +271,19 @@ Definition at line 694 of file modules.h. .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 431 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 355 of file modules.cpp. .PP .nf -432 { -433 } +356 { +357 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 435 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 359 of file modules.cpp. .PP .nf -436 { -437 } +360 { +361 } .fi .SH "Member Function Documentation" .PP @@ -289,25 +293,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 504 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 428 of file modules.cpp. .PP References createcommand(). .PP .nf -505 { -506 createcommand(cmd,f,flags,minparams,source); -507 } +429 { +430 createcommand(cmd,f,flags,minparams,source); +431 } .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 750 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 679 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf -751 { -752 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -753 } +680 { +681 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +682 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -321,540 +325,549 @@ 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 667 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 596 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -668 { -669 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -670 if (res) -671 ModeMakeList(modechar); -672 return res; -673 } +597 { +598 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +599 if (res) +600 ModeMakeList(modechar); +601 return res; +602 } .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 639 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 568 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -640 { -641 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) -642 { -643 if (type == MT_SERVER) -644 { -645 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -646 return false; -647 } -648 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -649 { -650 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -651 return false; -652 } -653 if ((params_when_on>1) || (params_when_off>1)) -654 { -655 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -656 return false; -657 } -658 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -659 } -660 else -661 { -662 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); -663 } -664 return false; -665 } +569 { +570 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) +571 { +572 if (type == MT_SERVER) +573 { +574 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +575 return false; +576 } +577 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +578 { +579 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +580 return false; +581 } +582 if ((params_when_on>1) || (params_when_off>1)) +583 { +584 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +585 return false; +586 } +587 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +588 } +589 else +590 { +591 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); +592 } +593 return false; +594 } .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 730 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 659 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf -731 { -732 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -733 } +660 { +661 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +662 } .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 745 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 674 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf -746 { -747 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -748 } +675 { +676 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +677 } .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 735 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 664 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf -736 { -737 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -738 } +665 { +666 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +667 } .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 740 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 669 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf -741 { -742 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -743 } +670 { +671 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +672 } .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 780 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 709 of file modules.cpp. .PP References duration(). .PP .nf -781 { -782 return duration(delta.c_str()); -783 } +710 { +711 return duration(delta.c_str()); +712 } .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 494 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 418 of file modules.cpp. .PP .nf -495 { -496 call_handler(commandname.c_str(),parameters,pcnt,user); -497 } +419 { +420 call_handler(commandname.c_str(),parameters,pcnt,user); +421 } .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 587 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 511 of file modules.cpp. .PP References ChangeName(). .PP .nf -588 { -589 ChangeName(user,gecos.c_str()); -590 } +512 { +513 ChangeName(user,gecos.c_str()); +514 } .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 582 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 506 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -583 { -584 ChangeDisplayedHost(user,host.c_str()); -585 } +507 { +508 ChangeDisplayedHost(user,host.c_str()); +509 } .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 479 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 403 of file modules.cpp. .PP .nf -480 { -481 force_nickchange(user,nickname.c_str()); -482 } +404 { +405 force_nickchange(user,nickname.c_str()); +406 } .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 612 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 536 of file modules.cpp. .PP References cmode(). .PP .nf -613 { -614 return cmode(User,Chan); -615 } +537 { +538 return cmode(User,Chan); +539 } .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 560 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 484 of file modules.cpp. .PP References common_channels(). .PP .nf -561 { -562 return (common_channels(u1,u2) != 0); -563 } +485 { +486 return (common_channels(u1,u2) != 0); +487 } .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 675 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 604 of file modules.cpp. .PP .nf -676 { -677 return usercount(c); -678 } +605 { +606 return usercount(c); +607 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local E-Line. Definition at line 775 of file modules.cpp. +Deletes a local E-Line. Definition at line 704 of file modules.cpp. .PP References del_eline(). .PP .nf -776 { -777 del_eline(hostmask.c_str()); -778 } +705 { +706 del_eline(hostmask.c_str()); +707 } .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 755 of file modules.cpp. +Deletes a G-Line from all servers on the mesh. Definition at line 684 of file modules.cpp. .PP References del_gline(). .PP .nf -756 { -757 del_gline(hostmask.c_str()); -758 } +685 { +686 del_gline(hostmask.c_str()); +687 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local K-Line. Definition at line 770 of file modules.cpp. +Deletes a local K-Line. Definition at line 699 of file modules.cpp. .PP References del_kline(). .PP .nf -771 { -772 del_kline(hostmask.c_str()); -773 } +700 { +701 del_kline(hostmask.c_str()); +702 } .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 760 of file modules.cpp. +Deletes a Q-Line from all servers on the mesh. Definition at line 689 of file modules.cpp. .PP References del_qline(). .PP .nf -761 { -762 del_qline(nickname.c_str()); -763 } +690 { +691 del_qline(nickname.c_str()); +692 } .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 765 of file modules.cpp. +Deletes a Z-Line from all servers on the mesh. Definition at line 694 of file modules.cpp. .PP References del_zline(). .PP .nf -766 { -767 del_zline(ipaddr.c_str()); -768 } +695 { +696 del_zline(ipaddr.c_str()); +697 } .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 607 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 531 of file modules.cpp. .PP .nf -608 { -609 return FindChan(channel.c_str()); -610 } +532 { +533 return FindChan(channel.c_str()); +534 } .fi .SS "\fBuserrec\fP * Server::FindDescriptor (int socket)\fC [virtual]\fP" .PP -Attempts to look up a nick using the file descriptor associated with that nick. This function will return NULL if the file descriptor is not associated with a valid user.Definition at line 602 of file modules.cpp. +Attempts to look up a nick using the file descriptor associated with that nick. This function will return NULL if the file descriptor is not associated with a valid user.Definition at line 526 of file modules.cpp. .PP References fd_ref_table. .PP .nf -603 { -604 return (socket < 65536 ? fd_ref_table[socket] : NULL); -605 } +527 { +528 return (socket < 65536 ? fd_ref_table[socket] : NULL); +529 } .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 858 of file modules.cpp. +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 787 of file modules.cpp. .PP References MODCOUNT, module_names, and modules. .PP .nf -859 { -860 for (int i = 0; i <= MODCOUNT; i++) -861 { -862 if (module_names[i] == name) -863 { -864 return modules[i]; -865 } -866 } -867 return NULL; -868 } +788 { +789 for (int i = 0; i <= MODCOUNT; i++) +790 { +791 if (module_names[i] == name) +792 { +793 return modules[i]; +794 } +795 } +796 return NULL; +797 } .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 597 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 521 of file modules.cpp. .PP .nf -598 { -599 return Find(nick); -600 } +522 { +523 return Find(nick); +524 } .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 632 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 561 of file modules.cpp. .PP .nf -633 { -634 return Admin(getadminname(),getadminemail(),getadminnick()); -635 } +562 { +563 return Admin(getadminname(),getadminemail(),getadminnick()); +564 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 627 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 551 of file modules.cpp. +.PP +.nf +552 { +553 return getnetworkname(); +554 } +.fi +.SS "std::string Server::GetServerDescription ()\fC [virtual]\fP" +.PP +Returns the server description string of the local server. Definition at line 556 of file modules.cpp. .PP .nf -628 { -629 return getnetworkname(); -630 } +557 { +558 return getserverdesc(); +559 } .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 622 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 546 of file modules.cpp. .PP .nf -623 { -624 return getservername(); -625 } +547 { +548 return getservername(); +549 } .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 467 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 391 of file modules.cpp. .PP References chanuserlist, chanrec::GetUsers(), and list. .PP .nf -468 { -469 chanuserlist userl; -470 userl.clear(); -471 std::vector<char*> *list = chan->GetUsers(); -472 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) -473 { -474 char* o = *i; -475 userl.push_back((userrec*)o); -476 } -477 return userl; -478 } +392 { +393 chanuserlist userl; +394 userl.clear(); +395 std::vector<char*> *list = chan->GetUsers(); +396 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) +397 { +398 char* o = *i; +399 userl.push_back((userrec*)o); +400 } +401 return userl; +402 } .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 592 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 516 of file modules.cpp. .PP References isnick(). .PP .nf -593 { -594 return (isnick(nick.c_str()) != 0); -595 } +517 { +518 return (isnick(nick.c_str()) != 0); +519 } .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 617 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 541 of file modules.cpp. .PP References has_channel(). .PP .nf -618 { -619 return has_channel(User,Chan); -620 } +542 { +543 return has_channel(User,Chan); +544 } .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 489 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 413 of file modules.cpp. .PP References is_uline(). .PP .nf -490 { -491 return is_uline(server.c_str()); -492 } +414 { +415 return is_uline(server.c_str()); +416 } .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 785 of file modules.cpp. +Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 714 of file modules.cpp. .PP .nf -786 { -787 const char* dest = mask.c_str(); -788 if (strchr(dest,'!')==0) -789 return false; -790 if (strchr(dest,'@')==0) -791 return false; -792 for (int i = 0; i < strlen(dest); i++) -793 if (dest[i] < 32) -794 return false; -795 for (int i = 0; i < strlen(dest); i++) -796 if (dest[i] > 126) -797 return false; -798 int c = 0; -799 for (int i = 0; i < strlen(dest); i++) -800 if (dest[i] == '!') -801 c++; -802 if (c>1) -803 return false; -804 c = 0; -805 for (int i = 0; i < strlen(dest); i++) -806 if (dest[i] == '@') -807 c++; -808 if (c>1) -809 return false; -810 -811 return true; -812 } +715 { +716 const char* dest = mask.c_str(); +717 if (strchr(dest,'!')==0) +718 return false; +719 if (strchr(dest,'@')==0) +720 return false; +721 for (int i = 0; i < strlen(dest); i++) +722 if (dest[i] < 32) +723 return false; +724 for (int i = 0; i < strlen(dest); i++) +725 if (dest[i] > 126) +726 return false; +727 int c = 0; +728 for (int i = 0; i < strlen(dest); i++) +729 if (dest[i] == '!') +730 c++; +731 if (c>1) +732 return false; +733 c = 0; +734 for (int i = 0; i < strlen(dest); i++) +735 if (dest[i] == '@') +736 c++; +737 if (c>1) +738 return false; +739 +740 return true; +741 } .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 457 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 381 of file modules.cpp. .PP .nf -458 { -459 return add_channel(user,cname.c_str(),key.c_str(),false); -460 } +382 { +383 return add_channel(user,cname.c_str(),key.c_str(),false); +384 } .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 499 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 423 of file modules.cpp. .PP .nf -500 { -501 log(level,'%s',s.c_str()); -502 } +424 { +425 log(level,'%s',s.c_str()); +426 } .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 444 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 368 of file modules.cpp. .PP .nf -445 { -446 char literal[MAXBUF],pattern[MAXBUF]; -447 strlcpy(literal,sliteral.c_str(),MAXBUF); -448 strlcpy(pattern,spattern.c_str(),MAXBUF); -449 return match(literal,pattern); -450 } +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 } .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 840 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 769 of file modules.cpp. .PP .nf -841 { -842 if (c) -843 { -844 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -845 } -846 else return false; -847 } +770 { +771 if (c) +772 { +773 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +774 } +775 else return false; +776 } .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 849 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 778 of file modules.cpp. .PP .nf -850 { -851 if (u) -852 { -853 return CommonOnThisServer(u,(char*)servername.c_str()); -854 } -855 else return false; -856 } +779 { +780 if (u) +781 { +782 return CommonOnThisServer(u,(char*)servername.c_str()); +783 } +784 else return false; +785 } .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 814 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 743 of file modules.cpp. .PP .nf -815 { -816 NetSendToAll((char*)text.c_str()); -817 } +744 { +745 NetSendToAll((char*)text.c_str()); +746 } .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 825 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 754 of file modules.cpp. .PP .nf -826 { -827 NetSendToAllAlive((char*)text.c_str()); -828 } +755 { +756 NetSendToAllAlive((char*)text.c_str()); +757 } .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 835 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 764 of file modules.cpp. .PP .nf -836 { -837 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -838 } +765 { +766 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); +767 } .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 819 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 748 of file modules.cpp. .PP .nf -820 { -821 if (user) -822 NetSendToCommon(user,(char*)text.c_str()); -823 } +749 { +750 if (user) +751 NetSendToCommon(user,(char*)text.c_str()); +752 } .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 830 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 759 of file modules.cpp. .PP .nf -831 { -832 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -833 } +760 { +761 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +762 } .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 462 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 386 of file modules.cpp. .PP .nf -463 { -464 return del_channel(user,cname.c_str(),reason.c_str(),false); -465 } +387 { +388 return del_channel(user,cname.c_str(),reason.c_str(),false); +389 } .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 700 of file modules.cpp. +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 629 of file modules.cpp. .PP References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. .PP .nf -701 { -702 zombie->fd = alive->fd; -703 alive->fd = FD_MAGIC_NUMBER; -704 alive->ClearBuffer(); -705 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); -706 kill_link(alive,message.c_str()); -707 fd_ref_table[zombie->fd] = zombie; -708 for (int i = 0; i != MAXCHANS; i++) -709 { -710 if (zombie->chans[i].channel != NULL) -711 { -712 if (zombie->chans[i].channel->name) -713 { -714 chanrec* Ptr = zombie->chans[i].channel; -715 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); -716 if (Ptr->topicset) -717 { -718 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); -719 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); -720 } -721 userlist(zombie,Ptr); -722 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); -723 -724 } -725 } -726 } -727 -728 } +630 { +631 zombie->fd = alive->fd; +632 alive->fd = FD_MAGIC_NUMBER; +633 alive->ClearBuffer(); +634 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +635 kill_link(alive,message.c_str()); +636 fd_ref_table[zombie->fd] = zombie; +637 for (int i = 0; i != MAXCHANS; i++) +638 { +639 if (zombie->chans[i].channel != NULL) +640 { +641 if (zombie->chans[i].channel->name) +642 { +643 chanrec* Ptr = zombie->chans[i].channel; +644 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +645 if (Ptr->topicset) +646 { +647 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +648 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +649 } +650 userlist(zombie,Ptr); +651 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +652 +653 } +654 } +655 } +656 +657 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -862,71 +875,71 @@ 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 484 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 408 of file modules.cpp. .PP .nf -485 { -486 kill_link(user,reason.c_str()); -487 } +409 { +410 kill_link(user,reason.c_str()); +411 } .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 514 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 438 of file modules.cpp. .PP .nf -515 { -516 Write(Socket,'%s',s.c_str()); -517 } +439 { +440 Write(Socket,'%s',s.c_str()); +441 } .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 548 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 472 of file modules.cpp. .PP .nf -549 { -550 if (IncludeSender) -551 { -552 WriteChannel(Channel,User,'%s',s.c_str()); -553 } -554 else -555 { -556 ChanExceptSender(Channel,User,'%s',s.c_str()); -557 } -558 } +473 { +474 if (IncludeSender) +475 { +476 WriteChannel(Channel,User,'%s',s.c_str()); +477 } +478 else +479 { +480 ChanExceptSender(Channel,User,'%s',s.c_str()); +481 } +482 } .fi .SS "void Server::SendChannelServerNotice (std::string ServName, \fBchanrec\fP * Channel, std::string text)\fC [virtual]\fP" .PP -Writes text to a channel, but from a server, including all. This can be used to send server notices to a group of users.Definition at line 543 of file modules.cpp. +Writes text to a channel, but from a server, including all. This can be used to send server notices to a group of users.Definition at line 467 of file modules.cpp. .PP .nf -544 { -545 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); -546 } +468 { +469 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); +470 } .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 565 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 489 of file modules.cpp. .PP .nf -566 { -567 if (IncludeSender) -568 { -569 WriteCommon(User,'%s',text.c_str()); -570 } -571 else -572 { -573 WriteCommonExcept(User,'%s',text.c_str()); -574 } -575 } +490 { +491 if (IncludeSender) +492 { +493 WriteCommon(User,'%s',text.c_str()); +494 } +495 else +496 { +497 WriteCommonExcept(User,'%s',text.c_str()); +498 } +499 } .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 524 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 448 of file modules.cpp. .PP .nf -525 { -526 WriteFrom(Socket,User,'%s',s.c_str()); -527 } +449 { +450 WriteFrom(Socket,User,'%s',s.c_str()); +451 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -944,32 +957,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 509 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 433 of file modules.cpp. .PP References server_mode(). .PP .nf -510 { -511 server_mode(parameters,pcnt,user); -512 } +434 { +435 server_mode(parameters,pcnt,user); +436 } .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 439 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 363 of file modules.cpp. .PP .nf -440 { -441 WriteOpers('%s',s.c_str()); -442 } +364 { +365 WriteOpers('%s',s.c_str()); +366 } .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 519 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 443 of file modules.cpp. .PP .nf -520 { -521 WriteServ(Socket,'%s',s.c_str()); -522 } +444 { +445 WriteServ(Socket,'%s',s.c_str()); +446 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -981,23 +994,23 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 529 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 453 of file modules.cpp. .PP References connection::fd. .PP .nf -530 { -531 if (!Source) -532 { -533 // if source is NULL, then the message originates from the local server -534 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -535 } -536 else -537 { -538 // otherwise it comes from the user specified -539 WriteTo(Source,Dest,'%s',s.c_str()); -540 } -541 } +454 { +455 if (!Source) +456 { +457 // if source is NULL, then the message originates from the local server +458 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +459 } +460 else +461 { +462 // otherwise it comes from the user specified +463 WriteTo(Source,Dest,'%s',s.c_str()); +464 } +465 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -1005,46 +1018,46 @@ 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 452 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 376 of file modules.cpp. .PP .nf -453 { -454 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -455 } +377 { +378 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +379 } .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 577 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 501 of file modules.cpp. .PP .nf -578 { -579 WriteWallOps(User,false,'%s',text.c_str()); -580 } +502 { +503 WriteWallOps(User,false,'%s',text.c_str()); +504 } .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 681 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 610 of file modules.cpp. .PP References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf -682 { -683 unsigned int old_fd = user->fd; -684 user->fd = FD_MAGIC_NUMBER; -685 user->ClearBuffer(); -686 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); -687 #ifdef USE_KQUEUE -688 struct kevent ke; -689 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); -690 int i = kevent(kq, &ke, 1, 0, 0, NULL); -691 if (i == -1) -692 { -693 log(DEBUG,'kqueue: Failed to remove user from queue!'); -694 } -695 #endif -696 shutdown(old_fd,2); -697 close(old_fd); -698 } +611 { +612 unsigned int old_fd = user->fd; +613 user->fd = FD_MAGIC_NUMBER; +614 user->ClearBuffer(); +615 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +616 #ifdef USE_KQUEUE +617 struct kevent ke; +618 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); +619 int i = kevent(kq, &ke, 1, 0, 0, NULL); +620 if (i == -1) +621 { +622 log(DEBUG,'kqueue: Failed to remove user from queue!'); +623 } +624 #endif +625 shutdown(old_fd,2); +626 close(old_fd); +627 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 24b2ebb81..bff4dec00 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,35 +1,35 @@ -.TH "StrHashComp" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME -StrHashComp \- +StrHashComp \- This class returns true if two strings match. + +.PP .SH SYNOPSIS .br .PP +\fC#include <hashcomp.h>\fP +.PP .SS "Public Member Functions" .in +1c .ti -1c .RI "bool \fBoperator()\fP (const string &s1, const string &s2) const" .br +.RI "\fIThe operator () does the actual comparison in hash_map. \fP" .in -1c -.SH "Member Function Documentation" +.SH "Detailed Description" .PP -.SS "bool StrHashComp::operator() (const string & s1, const string & s2) const\fC [inline]\fP" +This class returns true if two strings match. + +Case sensitivity is ignored, and the RFC 'character set' is adhered to .PP -Definition at line 156 of file modules.cpp. +Definition at line 60 of file hashcomp.h. +.SH "Member Function Documentation" +.PP +.SS "bool StrHashComp::operator() (const string & s1, const string & s2) const" .PP -.nf -157 { -158 char a[MAXBUF],b[MAXBUF]; -159 strlcpy(a,s1.c_str(),MAXBUF); -160 strlcpy(b,s2.c_str(),MAXBUF); -161 strlower(a); -162 strlower(b); -163 return (strcasecmp(a,b) == 0); -164 } -.fi - +The operator () does the actual comparison in hash_map. .SH "Author" .PP diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index f755c1cfb..b553e9e20 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "15 May 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 310 of file modules.cpp. +Definition at line 234 of file modules.cpp. .PP .nf -310 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; +234 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/WhoWasUser.3 b/docs/man/man3/WhoWasUser.3 index 40ffbca4b..a6d45973f 100644 --- a/docs/man/man3/WhoWasUser.3 +++ b/docs/man/man3/WhoWasUser.3 @@ -1,4 +1,4 @@ -.TH "WhoWasUser" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "WhoWasUser" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -37,30 +37,30 @@ WhoWasUser \- A lightweight userrec used by WHOWAS. .in -1c .SH "Detailed Description" .PP -A lightweight userrec used by WHOWAS. Definition at line 315 of file users.h. +A lightweight userrec used by WHOWAS. Definition at line 318 of file users.h. .SH "Member Data Documentation" .PP .SS "char \fBWhoWasUser::dhost\fP[160]" .PP -Definition at line 320 of file users.h. +Definition at line 323 of file users.h. .SS "char \fBWhoWasUser::fullname\fP[128]" .PP -Definition at line 322 of file users.h. +Definition at line 325 of file users.h. .SS "char \fBWhoWasUser::host\fP[160]" .PP -Definition at line 321 of file users.h. +Definition at line 324 of file users.h. .SS "char \fBWhoWasUser::ident\fP[16]" .PP -Definition at line 319 of file users.h. +Definition at line 322 of file users.h. .SS "char \fBWhoWasUser::nick\fP[NICKMAX]" .PP -Definition at line 318 of file users.h. +Definition at line 321 of file users.h. .SS "char \fBWhoWasUser::server\fP[256]" .PP -Definition at line 323 of file users.h. +Definition at line 326 of file users.h. .SS "time_t \fBWhoWasUser::signon\fP" .PP -Definition at line 324 of file users.h. +Definition at line 327 of file users.h. .SH "Author" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 2933362c4..8cd21fa0c 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 72dbca6fc..916e3681f 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "15 May 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 f3784d649..d3d7d4065 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "15 May 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 9cf60156c..1b0bc51c5 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -16,16 +16,12 @@ channels.cpp \- .br \fC#include <unistd.h>\fP .br -\fC#include <fcntl.h>\fP -.br \fC#include <sys/errno.h>\fP .br \fC#include <sys/ioctl.h>\fP .br \fC#include <sys/utsname.h>\fP .br -\fC#include <cstdio>\fP -.br \fC#include <time.h>\fP .br \fC#include <string>\fP @@ -38,12 +34,8 @@ channels.cpp \- .br \fC#include <vector>\fP .br -\fC#include <errno.h>\fP -.br \fC#include <deque>\fP .br -\fC#include <sched.h>\fP -.br \fC#include 'connection.h'\fP .br \fC#include 'users.h'\fP @@ -68,6 +60,8 @@ channels.cpp \- .br \fC#include 'inspstring.h'\fP .br +\fC#include 'helperfuncs.h'\fP +.br .SS "Namespaces" @@ -205,137 +199,137 @@ channels.cpp \- .PP .SS "#define nspace std" .PP -Definition at line 58 of file channels.cpp. +Definition at line 53 of file channels.cpp. .SH "Variable Documentation" .PP .SS "char \fBAdminEmail\fP[MAXBUF]" .PP -Definition at line 72 of file channels.cpp. +Definition at line 67 of file channels.cpp. .SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 71 of file channels.cpp. +Definition at line 66 of file channels.cpp. .SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 73 of file channels.cpp. +Definition at line 68 of file channels.cpp. .SS "std::vector<long> \fBauth_cookies\fP" .PP -Definition at line 100 of file channels.cpp. +Definition at line 95 of file channels.cpp. .SS "int \fBboundPortCount\fP" .PP -Definition at line 94 of file channels.cpp. +Definition at line 89 of file channels.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 101 of file channels.cpp. +Definition at line 96 of file channels.cpp. .PP Referenced by userrec::HasPermission(). .SS "std::vector<\fBModeParameter\fP> \fBcustom_mode_params\fP" .PP -Definition at line 111 of file channels.cpp. +Definition at line 106 of file channels.cpp. .PP Referenced by chanrec::GetModeParameter(), and chanrec::SetCustomModeParam(). .SS "int \fBdebugging\fP" .PP -Definition at line 82 of file channels.cpp. +Definition at line 77 of file channels.cpp. .SS "int \fBdefaultRoute\fP" .PP -Definition at line 98 of file channels.cpp. +Definition at line 93 of file channels.cpp. .SS "int \fBDieDelay\fP" .PP -Definition at line 85 of file channels.cpp. +Definition at line 80 of file channels.cpp. .SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 74 of file channels.cpp. +Definition at line 69 of file channels.cpp. .SS "char \fBDieValue\fP[MAXBUF]" .PP -Definition at line 80 of file channels.cpp. +Definition at line 75 of file channels.cpp. .SS "std::vector<\fBircd_module\fP*> factory" .PP -Definition at line 65 of file channels.cpp. +Definition at line 60 of file channels.cpp. .SS "std::vector<int> \fBfd_reap\fP" .PP -Definition at line 91 of file channels.cpp. +Definition at line 86 of file channels.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 78 of file channels.cpp. +Definition at line 73 of file channels.cpp. .PP Referenced by Server::GetUsers(). .SS "FILE* \fBlog_file\fP" .PP -Definition at line 105 of file channels.cpp. +Definition at line 100 of file channels.cpp. .SS "int \fBLogLevel\fP" .PP -Definition at line 67 of file channels.cpp. +Definition at line 62 of file channels.cpp. .SS "int \fBMaxWhoResults\fP" .PP -Definition at line 88 of file channels.cpp. +Definition at line 83 of file channels.cpp. .SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 103 of file channels.cpp. +Definition at line 98 of file channels.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1067 of file modules.cpp. +Definition at line 996 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. +Definition at line 87 of file channels.cpp. .PP Referenced by Server::FindModule(). .SS "std::vector<\fBModule\fP*> modules" .PP -Definition at line 64 of file channels.cpp. +Definition at line 59 of file channels.cpp. .PP Referenced by Server::FindModule(). .SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 76 of file channels.cpp. +Definition at line 71 of file channels.cpp. .SS "time_t \fBnb_start\fP" .PP -Definition at line 89 of file channels.cpp. +Definition at line 84 of file channels.cpp. .SS "int \fBNetBufferSize\fP" .PP -Definition at line 87 of file channels.cpp. +Definition at line 82 of file channels.cpp. .SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 69 of file channels.cpp. +Definition at line 64 of file channels.cpp. .SS "int \fBportCount\fP" .PP -Definition at line 95 of file channels.cpp. +Definition at line 90 of file channels.cpp. .SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 97 of file channels.cpp. +Definition at line 92 of file channels.cpp. .SS "char \fBPrefixQuit\fP[MAXBUF]" .PP -Definition at line 79 of file channels.cpp. +Definition at line 74 of file channels.cpp. .SS "char \fBrestartpass\fP[MAXBUF]" .PP -Definition at line 75 of file channels.cpp. +Definition at line 70 of file channels.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP -Definition at line 77 of file channels.cpp. +Definition at line 72 of file channels.cpp. .SS "char \fBServerDesc\fP[MAXBUF]" .PP -Definition at line 70 of file channels.cpp. +Definition at line 65 of file channels.cpp. .SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 68 of file channels.cpp. +Definition at line 63 of file channels.cpp. .SS "int \fBSERVERportCount\fP" .PP -Definition at line 96 of file channels.cpp. +Definition at line 91 of file channels.cpp. .SS "time_t \fBstartup_time\fP" .PP -Definition at line 86 of file channels.cpp. +Definition at line 81 of file channels.cpp. .SS "time_t \fBTIME\fP" .PP -Definition at line 107 of file channels.cpp. +Definition at line 102 of file channels.cpp. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "int \fBWHOWAS_MAX\fP" .PP -Definition at line 84 of file channels.cpp. +Definition at line 79 of file channels.cpp. .SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 83 of file channels.cpp. +Definition at line 78 of file channels.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index 97577d320..0609a03e6 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 2e965d43a..0831e46b3 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -114,21 +114,21 @@ Definition at line 101 of file channels.h. .PP .SS "chanrec::chanrec ()" .PP -Creates a channel record and initialises it with default values. Definition at line 113 of file channels.cpp. +Creates a channel record and initialises it with default values. Definition at line 108 of file channels.cpp. .PP References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset. .PP .nf -114 { -115 strcpy(name,''); -116 strcpy(custom_modes,''); -117 strcpy(topic,''); -118 strcpy(setby,''); -119 strcpy(key,''); -120 created = topicset = limit = 0; -121 binarymodes = 0; -122 internal_userlist.clear(); -123 } +109 { +110 strcpy(name,''); +111 strcpy(custom_modes,''); +112 strcpy(topic,''); +113 strcpy(setby,''); +114 strcpy(key,''); +115 created = topicset = limit = 0; +116 binarymodes = 0; +117 internal_userlist.clear(); +118 } .fi .SS "virtual chanrec::~\fBchanrec\fP ()\fC [inline, virtual]\fP" .PP @@ -141,161 +141,161 @@ Definition at line 205 of file channels.h. .PP .SS "void chanrec::AddUser (char * castuser)" .PP -Add a user pointer to the internal reference list The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 207 of file channels.cpp. +Add a user pointer to the internal reference list The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 202 of file channels.cpp. .PP References DEBUG, and internal_userlist. .PP .nf -208 { -209 internal_userlist.push_back(castuser); -210 log(DEBUG,'Added casted user to channel's internal list'); -211 } +203 { +204 internal_userlist.push_back(castuser); +205 log(DEBUG,'Added casted user to channel's internal list'); +206 } .fi .SS "void chanrec::DelUser (char * castuser)" .PP -Delete a user pointer to the internal reference list The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 213 of file channels.cpp. +Delete a user pointer to the internal reference list The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 208 of file channels.cpp. .PP References DEBUG, internal_userlist, and name. .PP .nf -214 { -215 for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) -216 { -217 if (*a == castuser) -218 { -219 log(DEBUG,'Removed casted user from channel's internal list'); -220 internal_userlist.erase(a); -221 return; -222 } -223 } -224 log(DEBUG,'BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!',name); -225 } +209 { +210 for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) +211 { +212 if (*a == castuser) +213 { +214 log(DEBUG,'Removed casted user from channel's internal list'); +215 internal_userlist.erase(a); +216 return; +217 } +218 } +219 log(DEBUG,'BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!',name); +220 } .fi .SS "std::string chanrec::GetModeParameter (char mode)" .PP -Returns the parameter for a custom mode on a channel. For example if '+L #foo' is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.Definition at line 187 of file channels.cpp. +Returns the parameter for a custom mode on a channel. For example if '+L #foo' is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.Definition at line 182 of file channels.cpp. .PP References custom_mode_params. .PP .nf -188 { -189 if (custom_mode_params.size()) -190 { -191 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) -192 { -193 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) -194 { -195 return i->parameter; -196 } -197 } -198 } -199 return ''; -200 } +183 { +184 if (custom_mode_params.size()) +185 { +186 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +187 { +188 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +189 { +190 return i->parameter; +191 } +192 } +193 } +194 return ''; +195 } .fi .SS "long chanrec::GetUserCounter ()" .PP -Obtain the channel 'user counter' This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks. Definition at line 202 of file channels.cpp. +Obtain the channel 'user counter' This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks. Definition at line 197 of file channels.cpp. .PP References internal_userlist. .PP .nf -203 { -204 return (this->internal_userlist.size()); -205 } +198 { +199 return (this->internal_userlist.size()); +200 } .fi .SS "std::vector< char * > * chanrec::GetUsers ()" .PP -Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*. These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.Definition at line 227 of file channels.cpp. +Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*. These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.Definition at line 222 of file channels.cpp. .PP References internal_userlist. .PP Referenced by Server::GetUsers(). .PP .nf -228 { -229 return &internal_userlist; -230 } +223 { +224 return &internal_userlist; +225 } .fi .SS "bool chanrec::IsCustomModeSet (char mode)" .PP -Returns true if a custom mode is set on a channel. Definition at line 181 of file channels.cpp. +Returns true if a custom mode is set on a channel. Definition at line 176 of file channels.cpp. .PP References DEBUG. .PP .nf -182 { -183 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); -184 return (strchr(this->custom_modes,mode) != 0); -185 } +177 { +178 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); +179 return (strchr(this->custom_modes,mode) != 0); +180 } .fi .SS "void chanrec::SetCustomMode (char mode, bool mode_on)" .PP -Sets or unsets a custom mode in the channels info. Definition at line 125 of file channels.cpp. +Sets or unsets a custom mode in the channels info. Definition at line 120 of file channels.cpp. .PP References custom_modes, DEBUG, and SetCustomModeParam(). .PP .nf -126 { -127 if (mode_on) { -128 static char m[3]; -129 m[0] = mode; -130 m[1] = '\0'; -131 if (!strchr(this->custom_modes,mode)) -132 { -133 strlcat(custom_modes,m,MAXMODES); -134 } -135 log(DEBUG,'Custom mode %c set',mode); -136 } -137 else { +121 { +122 if (mode_on) { +123 static char m[3]; +124 m[0] = mode; +125 m[1] = '\0'; +126 if (!strchr(this->custom_modes,mode)) +127 { +128 strlcat(custom_modes,m,MAXMODES); +129 } +130 log(DEBUG,'Custom mode %c set',mode); +131 } +132 else { +133 +134 std::string a = this->custom_modes; +135 int pos = a.find(mode); +136 a.erase(pos,1); +137 strncpy(this->custom_modes,a.c_str(),MAXMODES); 138 -139 std::string a = this->custom_modes; -140 int pos = a.find(mode); -141 a.erase(pos,1); -142 strncpy(this->custom_modes,a.c_str(),MAXMODES); -143 -144 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes); -145 this->SetCustomModeParam(mode,'',false); -146 } -147 } +139 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes); +140 this->SetCustomModeParam(mode,'',false); +141 } +142 } .fi .SS "void chanrec::SetCustomModeParam (char mode, char * parameter, bool mode_on)" .PP -Sets or unsets the parameters for a custom mode in a channels info. Definition at line 150 of file channels.cpp. +Sets or unsets the parameters for a custom mode in a channels info. Definition at line 145 of file channels.cpp. .PP References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter. .PP Referenced by SetCustomMode(). .PP .nf -151 { -152 -153 log(DEBUG,'SetCustomModeParam called'); -154 ModeParameter M; -155 M.mode = mode; -156 strlcpy(M.channel,this->name,CHANMAX); -157 strlcpy(M.parameter,parameter,MAXBUF); -158 if (mode_on) +146 { +147 +148 log(DEBUG,'SetCustomModeParam called'); +149 ModeParameter M; +150 M.mode = mode; +151 strlcpy(M.channel,this->name,CHANMAX); +152 strlcpy(M.parameter,parameter,MAXBUF); +153 if (mode_on) +154 { +155 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter); +156 custom_mode_params.push_back(M); +157 } +158 else 159 { -160 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter); -161 custom_mode_params.push_back(M); -162 } -163 else -164 { -165 if (custom_mode_params.size()) -166 { -167 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) -168 { -169 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) -170 { -171 log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter); -172 custom_mode_params.erase(i); -173 return; -174 } -175 } -176 } -177 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!'); -178 } -179 } +160 if (custom_mode_params.size()) +161 { +162 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +163 { +164 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +165 { +166 log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter); +167 custom_mode_params.erase(i); +168 return; +169 } +170 } +171 } +172 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!'); +173 } +174 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index d3c9b34b4..9530bb7c8 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/command_t.3 b/docs/man/man3/command_t.3 index fe5b1b348..8309583b7 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "15 May 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 3033594c2..c13b7bd21 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -178,78 +178,78 @@ commands.h \- .RI "void \fBhandle_unloadmodule\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br .ti -1c -.RI "void \fBhandle_link_packet\fP (char *tcp_msg, char *tcp_host, \fBserverrec\fP *serv)" +.RI "void \fBhandle_link_packet\fP (char *tcp_msg, char *tcp_host, \fBserverrec\fP *serv, char *tcp_sum)" .br .RI "\fISpecial functions for processing server to server traffic. \fP" .ti -1c -.RI "void \fBprocess_restricted_commands\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *ipaddr, int port)" +.RI "void \fBprocess_restricted_commands\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *ipaddr, int port, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_amp\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_amp\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .RI "\fIThese are the handlers for server commands (tokens). \fP" .ti -1c -.RI "void \fBhandle_dollar\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_dollar\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_J\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_J\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_R\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_R\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_plus\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_plus\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_b\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_b\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_a\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_a\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_F\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_F\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_N\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_N\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_AT\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_AT\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_k\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_k\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_n\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_n\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_Q\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_Q\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_K\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_K\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_L\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_L\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_m\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_m\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_M\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_M\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_T\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_T\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_t\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_t\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_i\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_i\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_P\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_P\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c -.RI "void \fBhandle_V\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host)" +.RI "void \fBhandle_V\fP (char token, char *params, \fBserverrec\fP *source, \fBserverrec\fP *reply, char *tcp_host, char *tcp_sum)" .br .ti -1c .RI "bool \fBis_uline\fP (const char *server)" @@ -265,32 +265,32 @@ commands.h \- .SS "long duration (const char * str)" .PP Other useful functions. Referenced by Server::AddELine(), Server::AddGLine(), Server::AddKLine(), Server::AddQLine(), Server::AddZLine(), and Server::CalcDuration(). -.SS "void handle_a (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_a (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_admin (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_amp (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_amp (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP These are the handlers for server commands (tokens). -.SS "void handle_AT (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_AT (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_away (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_b (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_b (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_connect (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP .SS "void handle_die (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_dollar (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_dollar (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_eline (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_F (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_F (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_gline (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_i (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_i (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_info (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -298,14 +298,14 @@ These are the handlers for server commands (tokens). .PP .SS "void handle_ison (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_J (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_J (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_join (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP These are the handlers for user commands. -.SS "void handle_K (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_K (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP -.SS "void handle_k (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_k (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_kick (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -313,9 +313,9 @@ These are the handlers for user commands. .PP .SS "void handle_kline (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_L (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_L (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP -.SS "void handle_link_packet (char * tcp_msg, char * tcp_host, \fBserverrec\fP * serv)" +.SS "void handle_link_packet (char * tcp_msg, char * tcp_host, \fBserverrec\fP * serv, char * tcp_sum)" .PP Special functions for processing server to server traffic. .SS "void handle_links (char ** parameters, int pcnt, \fBuserrec\fP * user)" @@ -326,9 +326,9 @@ Special functions for processing server to server traffic. .PP .SS "void handle_lusers (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_M (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_M (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP -.SS "void handle_m (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_m (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_map (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -336,9 +336,9 @@ Special functions for processing server to server traffic. .PP .SS "void handle_motd (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_n (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_n (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP -.SS "void handle_N (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_N (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_names (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -348,7 +348,7 @@ Special functions for processing server to server traffic. .PP .SS "void handle_oper (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_P (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_P (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_part (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -356,19 +356,19 @@ Special functions for processing server to server traffic. .PP .SS "void handle_ping (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_plus (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_plus (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_pong (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP .SS "void handle_privmsg (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_Q (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_Q (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_qline (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP .SS "void handle_quit (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_R (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_R (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_rehash (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -384,9 +384,9 @@ Special functions for processing server to server traffic. .PP .SS "void handle_summon (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_t (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_t (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP -.SS "void handle_T (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_T (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_time (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -402,7 +402,7 @@ Special functions for processing server to server traffic. .PP .SS "void handle_users (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP -.SS "void handle_V (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" +.SS "void handle_V (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP .SS "void handle_wallops (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP @@ -417,7 +417,7 @@ Special functions for processing server to server traffic. .SS "bool is_uline (const char * server)" .PP Functions for u:lined servers. Referenced by Server::IsUlined(). -.SS "void process_restricted_commands (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * ipaddr, int port)" +.SS "void process_restricted_commands (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * ipaddr, int port, char * tcp_sum)" .PP .SH "Author" .PP diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index 089bd108e..e21a84b8d 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -42,7 +42,7 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .br .RI "\fISend a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false. \fP" .ti -1c -.RI "bool \fBRecvPacket\fP (std::deque< std::string > &messages, char *\fBhost\fP)" +.RI "bool \fBRecvPacket\fP (std::deque< std::string > &messages, char *\fBhost\fP, std::deque< std::string > &sums)" .br .RI "\fIReturns the next available packet and returns true if data is available. \fP" .ti -1c @@ -120,7 +120,7 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .in -1c .SH "Detailed Description" .PP -Please note: classes serverrec and userrec both inherit from class connection. Definition at line 210 of file connection.h. +Please note: classes serverrec and userrec both inherit from class connection. Definition at line 212 of file connection.h. .SH "Constructor & Destructor Documentation" .PP .SS "connection::connection ()" @@ -143,7 +143,7 @@ Find the \fBircd_connector\fP oject related to a certain servername given in 'ho .SS "bool connection::MeshCookie (char * targethost, int port, unsigned long cookie, char * servername)" .PP Begin an outbound mesh link to another ircd on a network you are already an authenticated member of. -.SS "bool connection::RecvPacket (std::deque< std::string > & messages, char * host)" +.SS "bool connection::RecvPacket (std::deque< std::string > & messages, char * host, std::deque< std::string > & sums)" .PP Returns the next available packet and returns true if data is available. Writes the servername the data came from to 'host'. If no data is available this function returns false. This function will automatically close broken links and reroute pathways, generating split messages on the network. .SS "bool connection::SendPacket (char * message, const char * host)" @@ -156,75 +156,75 @@ Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnecti .PP .SS "long \fBconnection::bytes_in\fP" .PP -Stats counter for bytes inbound. Definition at line 227 of file connection.h. +Stats counter for bytes inbound. Definition at line 229 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::bytes_out\fP" .PP -Stats counter for bytes outbound. Definition at line 231 of file connection.h. +Stats counter for bytes outbound. Definition at line 233 of file connection.h. .PP Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). .SS "long \fBconnection::cmds_in\fP" .PP -Stats counter for commands inbound. Definition at line 235 of file connection.h. +Stats counter for commands inbound. Definition at line 237 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::cmds_out\fP" .PP -Stats counter for commands outbound. Definition at line 239 of file connection.h. +Stats counter for commands outbound. Definition at line 241 of file connection.h. .PP Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). .SS "std::vector<\fBircd_connector\fP> \fBconnection::connectors\fP" .PP -With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 274 of file connection.h. +With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 276 of file connection.h. .SS "int \fBconnection::fd\fP" .PP -File descriptor of the connection. Definition at line 215 of file connection.h. +File descriptor of the connection. Definition at line 217 of file connection.h. .PP Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). .SS "bool \fBconnection::haspassed\fP" .PP -True if server/user has authenticated, false if otherwise. Definition at line 243 of file connection.h. +True if server/user has authenticated, false if otherwise. Definition at line 245 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::host\fP[160]" .PP -Hostname of connection. Not used if this is a serverrecDefinition at line 219 of file connection.h. +Hostname of connection. Not used if this is a serverrecDefinition at line 221 of file connection.h. .PP Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo(). .SS "time_t \fBconnection::idle_lastmsg\fP" .PP -Time that the connection last sent data, used to calculate idle time. Definition at line 265 of file connection.h. +Time that the connection last sent data, used to calculate idle time. Definition at line 267 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::ip\fP[16]" .PP -IP of connection. Definition at line 223 of file connection.h. +IP of connection. Definition at line 225 of file connection.h. .PP Referenced by userrec::userrec(). .SS "time_t \fBconnection::lastping\fP" .PP -Time the connection was last pinged. Definition at line 257 of file connection.h. +Time the connection was last pinged. Definition at line 259 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "time_t \fBconnection::nping\fP" .PP -Used by PING checks with clients. Definition at line 269 of file connection.h. +Used by PING checks with clients. Definition at line 271 of file connection.h. .PP Referenced by userrec::userrec(). .SS "int \fBconnection::port\fP" .PP -Port number For a userrec, this is the port they connected to the network on. For a serverrec this is the current listening port of the serverrec object.Definition at line 249 of file connection.h. +Port number For a userrec, this is the port they connected to the network on. For a serverrec this is the current listening port of the serverrec object.Definition at line 251 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::registered\fP" .PP -Used by userrec to indicate the registration status of the connection. Definition at line 253 of file connection.h. +Used by userrec to indicate the registration status of the connection. Definition at line 255 of file connection.h. .PP Referenced by userrec::userrec(). .SS "time_t \fBconnection::signon\fP" .PP -Time the connection was created, set in the constructor. Definition at line 261 of file connection.h. +Time the connection was created, set in the constructor. Definition at line 263 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index 20f716f16..2bd9c858a 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -69,6 +69,13 @@ connection.h \- .RI "#define \fBSTATE_SERVICES\fP 5" .br .in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "std::string \fBCreateSum\fP ()" +.br +.in -1c .SH "Define Documentation" .PP .SS "#define STATE_CONNECTED 1" @@ -89,6 +96,10 @@ Definition at line 40 of file connection.h. .SS "#define STATE_SYNC 2" .PP Definition at line 37 of file connection.h. +.SH "Function Documentation" +.PP +.SS "std::string CreateSum ()" +.PP .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/ctables.h.3 b/docs/man/man3/ctables.h.3 index dbbfcd783..2d7eb05c9 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "15 May 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 2262c8192..aca6fe856 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "15 May 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 72756c11c..a3835ec7f 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/hashcomp.h.3 b/docs/man/man3/hashcomp.h.3 new file mode 100644 index 000000000..abd940138 --- /dev/null +++ b/docs/man/man3/hashcomp.h.3 @@ -0,0 +1,50 @@ +.TH "hashcomp.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +hashcomp.h \- +.SH SYNOPSIS +.br +.PP +\fC#include 'inspircd_config.h'\fP +.br +\fC#include <ext/hash_map>\fP +.br + +.SS "Namespaces" + +.in +1c +.ti -1c +.RI "namespace \fBirc\fP" +.br +.ti -1c +.RI "namespace \fBnspace\fP" +.br +.in -1c +.SS "Compounds" + +.in +1c +.ti -1c +.RI "struct \fBInAddr_HashComp\fP" +.br +.RI "\fIThis class returns true if two in_addr structs match. \fP" +.ti -1c +.RI "struct \fBStrHashComp\fP" +.br +.RI "\fIThis class returns true if two strings match. \fP" +.in -1c +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBnspace\fP __gnu_cxx" +.br +.in -1c +.SH "Define Documentation" +.PP +.SS "#define nspace __gnu_cxx" +.PP +Definition at line 29 of file hashcomp.h. +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/irc.3 b/docs/man/man3/irc.3 new file mode 100644 index 000000000..a825271ad --- /dev/null +++ b/docs/man/man3/irc.3 @@ -0,0 +1,36 @@ +.TH "irc" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +irc \- The irc namespace contains a number of helper classes. + +.SH SYNOPSIS +.br +.PP +.SS "Compounds" + +.in +1c +.ti -1c +.RI "struct \fBirc_char_traits\fP" +.br +.RI "\fIThe \fBirc_char_traits\fP class is used for RFC-style comparison of strings. \fP" +.in -1c +.SS "Typedefs" + +.in +1c +.ti -1c +.RI "typedef basic_string< char, \fBirc_char_traits\fP, allocator< char > > \fBstring\fP" +.br +.RI "\fIThis typedef declares \fBirc::string\fP based upon \fBirc_char_traits\fP. \fP" +.in -1c +.SH "Detailed Description" +.PP +The irc namespace contains a number of helper classes. +.SH "Typedef Documentation" +.PP +.SS "typedef basic_string<char, \fBirc_char_traits\fP, allocator<char> > \fBirc::string\fP" +.PP +This typedef declares \fBirc::string\fP based upon \fBirc_char_traits\fP. Definition at line 111 of file hashcomp.h. +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/irc_irc_char_traits.3 b/docs/man/man3/irc_irc_char_traits.3 new file mode 100644 index 000000000..1ee931ba6 --- /dev/null +++ b/docs/man/man3/irc_irc_char_traits.3 @@ -0,0 +1,66 @@ +.TH "irc::irc_char_traits" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +irc::irc_char_traits \- The \fBirc_char_traits\fP class is used for RFC-style comparison of strings. + +.PP +.SH SYNOPSIS +.br +.PP +\fC#include <hashcomp.h>\fP +.PP +Inherits \fBchar_traits< char >\fP. +.PP +.SS "Static Public Member Functions" + +.in +1c +.ti -1c +.RI "bool \fBeq\fP (char c1st, char c2nd)" +.br +.RI "\fICheck if two chars match. \fP" +.ti -1c +.RI "bool \fBne\fP (char c1st, char c2nd)" +.br +.RI "\fICheck if two chars do NOT match. \fP" +.ti -1c +.RI "bool \fBlt\fP (char c1st, char c2nd)" +.br +.RI "\fICheck if one char is less than another. \fP" +.ti -1c +.RI "int \fBcompare\fP (const char *str1, const char *str2, size_t n)" +.br +.RI "\fICompare two strings of size n. \fP" +.ti -1c +.RI "const char * \fBfind\fP (const char *s1, int n, char c)" +.br +.RI "\fIFind a char within a string up to position n. \fP" +.in -1c +.SH "Detailed Description" +.PP +The \fBirc_char_traits\fP class is used for RFC-style comparison of strings. + +This class is used to implement \fBirc::string\fP, a case-insensitive, RFC- comparing string class. +.PP +Definition at line 86 of file hashcomp.h. +.SH "Member Function Documentation" +.PP +.SS "int irc::irc_char_traits::compare (const char * str1, const char * str2, size_t n)\fC [static]\fP" +.PP +Compare two strings of size n. +.SS "bool irc::irc_char_traits::eq (char c1st, char c2nd)\fC [static]\fP" +.PP +Check if two chars match. +.SS "const char* irc::irc_char_traits::find (const char * s1, int n, char c)\fC [static]\fP" +.PP +Find a char within a string up to position n. +.SS "bool irc::irc_char_traits::lt (char c1st, char c2nd)\fC [static]\fP" +.PP +Check if one char is less than another. +.SS "bool irc::irc_char_traits::ne (char c1st, char c2nd)\fC [static]\fP" +.PP +Check if two chars do NOT match. + +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index f45d65f95..226b6797e 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -160,7 +160,7 @@ Each connection has one or more of these each represents ONE outbound connection A listening socket that accepts server type connections is represented by one class serverrec. Class serverrec will instantiate several objects of type ircd_connector to represent each established connection, inbound or outbound. So, to determine all linked servers you must walk through all the serverrecs that the core defines, and in each one iterate through until you find connection(s) relating to the server you want information on. The core and module API provide functions for this. .PP -Definition at line 54 of file connection.h. +Definition at line 56 of file connection.h. .SH "Member Function Documentation" .PP .SS "void ircd_connector::AddBuffer (std::string a)" @@ -230,36 +230,36 @@ This method sets the version string of the remote server. .PP .SS "sockaddr_in \fBircd_connector::addr\fP\fC [private]\fP" .PP -Sockaddr of the outbound ip and port. Definition at line 59 of file connection.h. +Sockaddr of the outbound ip and port. Definition at line 61 of file connection.h. .SS "std::string \fBircd_connector::description\fP\fC [private]\fP" .PP -\fBServer\fP 'GECOS'. Definition at line 71 of file connection.h. +\fBServer\fP 'GECOS'. Definition at line 73 of file connection.h. .SS "int \fBircd_connector::fd\fP\fC [private]\fP" .PP -File descriptor of the connection. Definition at line 63 of file connection.h. +File descriptor of the connection. Definition at line 65 of file connection.h. .SS "char \fBircd_connector::host\fP[MAXBUF]" .PP -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 99 of file connection.h. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 101 of file connection.h. .SS "std::string \fBircd_connector::ircdbuffer\fP" .PP IRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a .br - seperator. Definition at line 92 of file connection.h. + seperator. Definition at line 94 of file connection.h. .SS "int \fBircd_connector::port\fP" .PP -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 105 of file connection.h. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 107 of file connection.h. .SS "std::vector<std::string> \fBircd_connector::routes\fP" .PP -\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. Definition at line 111 of file connection.h. +\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. Definition at line 113 of file connection.h. .SS "std::string \fBircd_connector::servername\fP\fC [private]\fP" .PP -\fBServer\fP name. Definition at line 67 of file connection.h. +\fBServer\fP name. Definition at line 69 of file connection.h. .SS "char \fBircd_connector::state\fP\fC [private]\fP" .PP -State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTEDDefinition at line 76 of file connection.h. +State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTEDDefinition at line 78 of file connection.h. .SS "std::string \fBircd_connector::version\fP\fC [private]\fP" .PP -This string holds the ircd's version response. Definition at line 84 of file connection.h. +This string holds the ircd's version response. Definition at line 86 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 3cbc9f2c8..5b7529f6c 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "15 May 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 9d1833afe..51981f20d 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "15 May 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 2c42d18cb..dfea1301b 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -16,16 +16,8 @@ modules.cpp \- .br \fC#include <unistd.h>\fP .br -\fC#include <fcntl.h>\fP -.br \fC#include <sys/errno.h>\fP .br -\fC#include <sys/ioctl.h>\fP -.br -\fC#include <sys/utsname.h>\fP -.br -\fC#include <cstdio>\fP -.br \fC#include <time.h>\fP .br \fC#include <string>\fP @@ -38,12 +30,8 @@ modules.cpp \- .br \fC#include <vector>\fP .br -\fC#include <errno.h>\fP -.br \fC#include <deque>\fP .br -\fC#include <sched.h>\fP -.br \fC#include 'connection.h'\fP .br \fC#include 'users.h'\fP @@ -70,33 +58,17 @@ modules.cpp \- .br \fC#include 'inspstring.h'\fP .br - -.SS "Namespaces" - -.in +1c -.ti -1c -.RI "namespace \fBnspace\fP" +\fC#include 'helperfuncs.h'\fP .br -.in -1c +\fC#include 'hashcomp.h'\fP +.br + .SS "Compounds" .in +1c .ti -1c .RI "class \fBExtMode\fP" .br -.ti -1c -.RI "struct \fBInAddr_HashComp\fP" -.br -.ti -1c -.RI "struct \fBStrHashComp\fP" -.br -.in -1c -.SS "Defines" - -.in +1c -.ti -1c -.RI "#define \fBnspace\fP std" -.br .in -1c .SS "Typedefs" @@ -296,169 +268,164 @@ modules.cpp \- .RI "\fBExtModeList\fP \fBEMode\fP" .br .in -1c -.SH "Define Documentation" -.PP -.SS "#define nspace std" -.PP -Definition at line 64 of file modules.cpp. .SH "Typedef Documentation" .PP .SS "typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 187 of file modules.cpp. +Definition at line 111 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 186 of file modules.cpp. +Definition at line 110 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 189 of file modules.cpp. +Definition at line 113 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 215 of file modules.cpp. +Definition at line 139 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 216 of file modules.cpp. +Definition at line 140 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 185 of file modules.cpp. +Definition at line 109 of file modules.cpp. .SS "typedef nspace::hash_map<std::string, \fBWhoWasUser\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBwhowas_hash\fP" .PP -Definition at line 188 of file modules.cpp. +Definition at line 112 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 285 of file modules.cpp. +Definition at line 209 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -286 { -287 if (ModeDefined(modechar,type)) { -288 return false; -289 } -290 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -291 return true; -292 } +210 { +211 if (ModeDefined(modechar,type)) { +212 return false; +213 } +214 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +215 return true; +216 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 222 of file modules.cpp. +Definition at line 146 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -223 { -224 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -225 { -226 if ((i->modechar == modechar) && (i->type == type)) -227 { -228 return true; -229 } -230 } -231 return false; -232 } +147 { +148 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +149 { +150 if ((i->modechar == modechar) && (i->type == type)) +151 { +152 return true; +153 } +154 } +155 return false; +156 } .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 272 of file modules.cpp. +Definition at line 196 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -273 { -274 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -275 { -276 if ((i->modechar == modechar) && (i->type == type)) -277 { -278 return i->params_when_off; -279 } -280 } -281 return 0; -282 } +197 { +198 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +199 { +200 if ((i->modechar == modechar) && (i->type == type)) +201 { +202 return i->params_when_off; +203 } +204 } +205 return 0; +206 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 259 of file modules.cpp. +Definition at line 183 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -260 { -261 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -262 { -263 if ((i->modechar == modechar) && (i->type == type)) -264 { -265 return i->params_when_on; -266 } -267 } -268 return 0; -269 } +184 { +185 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +186 { +187 if ((i->modechar == modechar) && (i->type == type)) +188 { +189 return i->params_when_on; +190 } +191 } +192 return 0; +193 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 246 of file modules.cpp. +Definition at line 170 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -247 { -248 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -249 { -250 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) -251 { -252 return true; -253 } -254 } -255 return false; -256 } +171 { +172 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +173 { +174 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +175 { +176 return true; +177 } +178 } +179 return false; +180 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP -Definition at line 234 of file modules.cpp. +Definition at line 158 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -235 { -236 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -237 { -238 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) -239 { -240 return true; -241 } -242 } -243 return false; -244 } +159 { +160 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +161 { +162 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +163 { +164 return true; +165 } +166 } +167 return false; +168 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 295 of file modules.cpp. +Definition at line 219 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -296 { -297 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -298 { -299 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -300 { -301 i->list = true; -302 return; -303 } -304 } -305 return; -306 } +220 { +221 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +222 { +223 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +224 { +225 i->list = true; +226 return; +227 } +228 } +229 return; +230 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -466,146 +433,146 @@ Referenced by Server::AddExtendedListMode(). .PP .SS "char \fBAdminEmail\fP[MAXBUF]" .PP -Definition at line 84 of file modules.cpp. +Definition at line 72 of file modules.cpp. .SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 83 of file modules.cpp. +Definition at line 71 of file modules.cpp. .SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 85 of file modules.cpp. +Definition at line 73 of file modules.cpp. .SS "std::vector<long> \fBauth_cookies\fP" .PP -Definition at line 112 of file modules.cpp. +Definition at line 100 of file modules.cpp. .SS "int \fBboundPortCount\fP" .PP -Definition at line 106 of file modules.cpp. +Definition at line 94 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 193 of file modules.cpp. +Definition at line 117 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 192 of file modules.cpp. +Definition at line 116 of file modules.cpp. .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 195 of file modules.cpp. +Definition at line 119 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 113 of file modules.cpp. +Definition at line 101 of file modules.cpp. .SS "int \fBdebugging\fP" .PP -Definition at line 94 of file modules.cpp. +Definition at line 82 of file modules.cpp. .SS "int \fBdefaultRoute\fP" .PP -Definition at line 110 of file modules.cpp. +Definition at line 98 of file modules.cpp. .SS "int \fBDieDelay\fP" .PP -Definition at line 97 of file modules.cpp. +Definition at line 85 of file modules.cpp. .SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 86 of file modules.cpp. +Definition at line 74 of file modules.cpp. .SS "char \fBDieValue\fP[MAXBUF]" .PP -Definition at line 92 of file modules.cpp. +Definition at line 80 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 219 of file modules.cpp. +Definition at line 143 of file modules.cpp. .PP Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "std::vector<\fBircd_module\fP*> factory" .PP -Definition at line 75 of file modules.cpp. +Definition at line 63 of file modules.cpp. .SS "std::vector<int> \fBfd_reap\fP" .PP -Definition at line 103 of file modules.cpp. +Definition at line 91 of file modules.cpp. .SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]" .PP -Definition at line 119 of file modules.cpp. +Definition at line 107 of file modules.cpp. .PP Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 198 of file modules.cpp. +Definition at line 122 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 90 of file modules.cpp. +Definition at line 78 of file modules.cpp. .SS "FILE* \fBlog_file\fP" .PP -Definition at line 117 of file modules.cpp. +Definition at line 105 of file modules.cpp. .SS "int \fBLogLevel\fP" .PP -Definition at line 79 of file modules.cpp. +Definition at line 67 of file modules.cpp. .SS "int \fBMaxWhoResults\fP" .PP -Definition at line 100 of file modules.cpp. +Definition at line 88 of file modules.cpp. .SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 115 of file modules.cpp. +Definition at line 103 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1067 of file modules.cpp. +Definition at line 996 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP -Definition at line 104 of file modules.cpp. +Definition at line 92 of file modules.cpp. .SS "std::vector<\fBModule\fP*> modules" .PP -Definition at line 74 of file modules.cpp. +Definition at line 62 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 196 of file modules.cpp. +Definition at line 120 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 88 of file modules.cpp. +Definition at line 76 of file modules.cpp. .SS "time_t \fBnb_start\fP" .PP -Definition at line 101 of file modules.cpp. +Definition at line 89 of file modules.cpp. .SS "int \fBNetBufferSize\fP" .PP -Definition at line 99 of file modules.cpp. +Definition at line 87 of file modules.cpp. .SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 81 of file modules.cpp. +Definition at line 69 of file modules.cpp. .SS "int \fBportCount\fP" .PP -Definition at line 107 of file modules.cpp. +Definition at line 95 of file modules.cpp. .SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 109 of file modules.cpp. +Definition at line 97 of file modules.cpp. .SS "char \fBPrefixQuit\fP[MAXBUF]" .PP -Definition at line 91 of file modules.cpp. +Definition at line 79 of file modules.cpp. .SS "char \fBrestartpass\fP[MAXBUF]" .PP -Definition at line 87 of file modules.cpp. +Definition at line 75 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 197 of file modules.cpp. +Definition at line 121 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP -Definition at line 89 of file modules.cpp. +Definition at line 77 of file modules.cpp. .SS "char \fBServerDesc\fP[MAXBUF]" .PP -Definition at line 82 of file modules.cpp. +Definition at line 70 of file modules.cpp. .SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 80 of file modules.cpp. +Definition at line 68 of file modules.cpp. .SS "int \fBSERVERportCount\fP" .PP -Definition at line 108 of file modules.cpp. +Definition at line 96 of file modules.cpp. .SS "time_t \fBstartup_time\fP" .PP -Definition at line 98 of file modules.cpp. +Definition at line 86 of file modules.cpp. .SS "time_t \fBTIME\fP" .PP -Definition at line 77 of file modules.cpp. +Definition at line 65 of file modules.cpp. .SS "\fBwhowas_hash\fP \fBwhowas\fP" .PP -Definition at line 194 of file modules.cpp. +Definition at line 118 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP -Definition at line 96 of file modules.cpp. +Definition at line 84 of file modules.cpp. .SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 95 of file modules.cpp. +Definition at line 83 of file modules.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index ac7e9ea35..38bf3733a 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -230,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 1138 of file modules.h. +Definition at line 1141 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 1135 of file modules.h. +Definition at line 1138 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 1136 of file modules.h. +Definition at line 1139 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 1137 of file modules.h. +Definition at line 1140 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" @@ -333,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 1304 of file modules.h. +Definition at line 1307 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 736e4cfb7..cbe375840 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "15 May 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 43b548dd9..a21b8fa75 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 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -6,6 +6,8 @@ nspace::nspace::hash< in_addr > \- .SH SYNOPSIS .br .PP +\fC#include <hashcomp.h>\fP +.PP .SS "Public Member Functions" .in +1c @@ -18,17 +20,8 @@ nspace::nspace::hash< in_addr > \- .SH "Member Function Documentation" .PP -.SS "size_t nspace::hash< in_addr >::operator() (const struct in_addr & a) const\fC [inline]\fP" -.PP -Definition at line 129 of file modules.cpp. +.SS "size_t nspace::hash< in_addr >::operator() (const struct in_addr & a) const" .PP -.nf -130 { -131 size_t q; -132 memcpy(&q,&a,sizeof(size_t)); -133 return q; -134 } -.fi .SH "Author" diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index ba9c5a6f5..58c32c257 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 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -6,6 +6,8 @@ nspace::nspace::hash< string > \- .SH SYNOPSIS .br .PP +\fC#include <hashcomp.h>\fP +.PP .SS "Public Member Functions" .in +1c @@ -18,19 +20,8 @@ nspace::nspace::hash< string > \- .SH "Member Function Documentation" .PP -.SS "size_t nspace::hash< string >::operator() (const string & s) const\fC [inline]\fP" -.PP -Definition at line 142 of file modules.cpp. +.SS "size_t nspace::hash< string >::operator() (const string & s) const" .PP -.nf -143 { -144 char a[MAXBUF]; -145 static struct hash<const char *> strhash; -146 strlcpy(a,s.c_str(),MAXBUF); -147 strlower(a); -148 return strhash(a); -149 } -.fi .SH "Author" diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 8f2ed614c..6dd9d4387 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -82,51 +82,51 @@ A class that defines the local server or a remote server. Definition at line 30 .PP .SS "serverrec::serverrec ()" .PP -Constructor. Definition at line 26 of file servers.cpp. +Constructor. Definition at line 27 of file servers.cpp. .PP References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, TIME, usercount, usercount_i, and version. .PP .nf -27 { -28 strlcpy(name,'',256); -29 pingtime = 0; -30 lastping = TIME; -31 usercount_i = usercount = opercount = version = 0; -32 hops_away = 1; -33 signon = TIME; -34 jupiter = false; -35 fd = 0; -36 sync_soon = false; -37 strlcpy(nickserv,'',NICKMAX); -38 } +28 { +29 strlcpy(name,'',256); +30 pingtime = 0; +31 lastping = TIME; +32 usercount_i = usercount = opercount = version = 0; +33 hops_away = 1; +34 signon = TIME; +35 jupiter = false; +36 fd = 0; +37 sync_soon = false; +38 strlcpy(nickserv,'',NICKMAX); +39 } .fi .SS "serverrec::serverrec (char * n, long ver, bool jupe)" .PP -Constructor which initialises some of the main variables. Definition at line 45 of file servers.cpp. +Constructor which initialises some of the main variables. Definition at line 46 of file servers.cpp. .PP References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, TIME, usercount, usercount_i, and version. .PP .nf -46 { -47 strlcpy(name,n,256); -48 lastping = TIME; -49 usercount_i = usercount = opercount = 0; -50 version = ver; -51 hops_away = 1; -52 signon = TIME; -53 jupiter = jupe; -54 fd = 0; -55 sync_soon = false; -56 strlcpy(nickserv,'',NICKMAX); -57 } +47 { +48 strlcpy(name,n,256); +49 lastping = TIME; +50 usercount_i = usercount = opercount = 0; +51 version = ver; +52 hops_away = 1; +53 signon = TIME; +54 jupiter = jupe; +55 fd = 0; +56 sync_soon = false; +57 strlcpy(nickserv,'',NICKMAX); +58 } .fi .SS "serverrec::~\fBserverrec\fP ()" .PP -Destructor. Definition at line 41 of file servers.cpp. +Destructor. Definition at line 42 of file servers.cpp. .PP .nf -42 { -43 } +43 { +44 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index e02fb0eb2..af036f7c6 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -18,6 +18,8 @@ servers.cpp \- .br \fC#include 'inspstring.h'\fP .br +\fC#include 'helperfuncs.h'\fP +.br .SS "Variables" @@ -30,7 +32,7 @@ servers.cpp \- .PP .SS "time_t \fBTIME\fP" .PP -Definition at line 24 of file servers.cpp. +Definition at line 25 of file servers.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/servers.h.3 b/docs/man/man3/servers.h.3 index cb3f26dd6..a048d2a6e 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 77d52825a..6d1a2ae72 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std_char_traits.3 b/docs/man/man3/std_char_traits.3 new file mode 100644 index 000000000..64a98bafc --- /dev/null +++ b/docs/man/man3/std_char_traits.3 @@ -0,0 +1,15 @@ +.TH "std::char_traits" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +std::char_traits \- +.SH SYNOPSIS +.br +.PP +Inherited by \fBirc::irc_char_traits\fP. +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 986d2ba8f..efe396234 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 3afc6d02c..61e70f590 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -77,6 +77,10 @@ Inherits \fBconnection\fP. .RI "void \fBFlushWriteBuf\fP ()" .br .RI "\fIFlushes as much of the user's buffer to the file descriptor as possible. \fP" +.ti -1c +.RI "\fBInvitedList\fP * \fBGetInviteList\fP ()" +.br +.RI "\fIReturns the list of channels this user has been invited to but has not yet joined. \fP" .in -1c .SS "Public Attributes" @@ -189,40 +193,40 @@ Definition at line 108 of file users.h. .PP .SS "userrec::userrec ()" .PP -Definition at line 28 of file users.cpp. +Definition at line 29 of file users.cpp. .PP References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, result, sendq, server, connection::signon, TIME, timeout, and ucrec::uc_modes. .PP .nf -29 { -30 // the PROPER way to do it, AVOID bzero at *ALL* costs -31 strcpy(nick,''); -32 strcpy(ip,'127.0.0.1'); -33 timeout = 0; -34 strcpy(ident,''); -35 strcpy(host,''); -36 strcpy(dhost,''); -37 strcpy(fullname,''); -38 strcpy(modes,''); -39 strcpy(server,''); -40 strcpy(awaymsg,''); -41 strcpy(oper,''); -42 reset_due = TIME; -43 lines_in = 0; -44 fd = lastping = signon = idle_lastmsg = nping = registered = 0; -45 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; -46 haspassed = false; -47 dns_done = false; -48 recvq = ''; -49 sendq = ''; -50 strcpy(result,''); -51 for (int i = 0; i < MAXCHANS; i++) -52 { -53 this->chans[i].channel = NULL; -54 this->chans[i].uc_modes = 0; -55 } -56 invites.clear(); -57 } +30 { +31 // the PROPER way to do it, AVOID bzero at *ALL* costs +32 strcpy(nick,''); +33 strcpy(ip,'127.0.0.1'); +34 timeout = 0; +35 strcpy(ident,''); +36 strcpy(host,''); +37 strcpy(dhost,''); +38 strcpy(fullname,''); +39 strcpy(modes,''); +40 strcpy(server,''); +41 strcpy(awaymsg,''); +42 strcpy(oper,''); +43 reset_due = TIME; +44 lines_in = 0; +45 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +46 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +47 haspassed = false; +48 dns_done = false; +49 recvq = ''; +50 sendq = ''; +51 strcpy(result,''); +52 for (int i = 0; i < MAXCHANS; i++) +53 { +54 this->chans[i].channel = NULL; +55 this->chans[i].uc_modes = 0; +56 } +57 invites.clear(); +58 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP @@ -235,305 +239,316 @@ Definition at line 222 of file users.h. .PP .SS "bool userrec::AddBuffer (std::string a)" .PP -This method adds data to the buffer of the user. The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted.Definition at line 169 of file users.cpp. +This method adds data to the buffer of the user. The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted.Definition at line 175 of file users.cpp. .PP References recvq, recvqmax, and SetWriteError(). .PP .nf -170 { -171 std::string b = ''; -172 for (int i = 0; i < a.length(); i++) -173 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) -174 b = b + a[i]; -175 std::stringstream stream(recvq); -176 stream << b; -177 recvq = stream.str(); -178 int i = 0; -179 // count the size of the first line in the buffer. -180 while (i < recvq.length()) -181 { -182 if (recvq[i++] == '\n') -183 break; -184 } -185 if (recvq.length() > this->recvqmax) -186 { -187 this->SetWriteError('RecvQ exceeded'); -188 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax); -189 } -190 // return false if we've had more than 600 characters WITHOUT -191 // a carriage return (this is BAD, drop the socket) -192 return (i < 600); -193 } +176 { +177 std::string b = ''; +178 for (int i = 0; i < a.length(); i++) +179 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) +180 b = b + a[i]; +181 std::stringstream stream(recvq); +182 stream << b; +183 recvq = stream.str(); +184 int i = 0; +185 // count the size of the first line in the buffer. +186 while (i < recvq.length()) +187 { +188 if (recvq[i++] == '\n') +189 break; +190 } +191 if (recvq.length() > this->recvqmax) +192 { +193 this->SetWriteError('RecvQ exceeded'); +194 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax); +195 } +196 // return false if we've had more than 600 characters WITHOUT +197 // a carriage return (this is BAD, drop the socket) +198 return (i < 600); +199 } .fi .SS "void userrec::AddWriteBuf (std::string data)" .PP -Adds to the user's write buffer. You may add any amount of text up to this users sendq value, if you exceed the sendq value, \fBSetWriteError()\fP will be called to set the users error string to 'SendQ exceeded', and further buffer adds will be dropped.Definition at line 225 of file users.cpp. +Adds to the user's write buffer. You may add any amount of text up to this users sendq value, if you exceed the sendq value, \fBSetWriteError()\fP will be called to set the users error string to 'SendQ exceeded', and further buffer adds will be dropped.Definition at line 231 of file users.cpp. .PP References GetWriteError(), sendq, sendqmax, and SetWriteError(). .PP .nf -226 { -227 if (this->GetWriteError() != '') -228 return; -229 if (sendq.length() + data.length() > this->sendqmax) -230 { -231 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax); -232 this->SetWriteError('SendQ exceeded'); -233 return; -234 } -235 std::stringstream stream; -236 stream << sendq << data; -237 sendq = stream.str(); -238 } +232 { +233 if (this->GetWriteError() != '') +234 return; +235 if (sendq.length() + data.length() > this->sendqmax) +236 { +237 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax); +238 this->SetWriteError('SendQ exceeded'); +239 return; +240 } +241 std::stringstream stream; +242 stream << sendq << data; +243 sendq = stream.str(); +244 } .fi .SS "bool userrec::BufferIsReady ()" .PP -This method returns true if the buffer contains at least one carriage return character (e.g. one complete line may be read)Definition at line 195 of file users.cpp. +This method returns true if the buffer contains at least one carriage return character (e.g. one complete line may be read)Definition at line 201 of file users.cpp. .PP References recvq. .PP .nf -196 { -197 for (int i = 0; i < recvq.length(); i++) -198 if (recvq[i] == '\n') -199 return true; -200 return false; -201 } +202 { +203 for (int i = 0; i < recvq.length(); i++) +204 if (recvq[i] == '\n') +205 return true; +206 return false; +207 } .fi .SS "void userrec::ClearBuffer ()" .PP -This function clears the entire buffer by setting it to an empty string. Definition at line 203 of file users.cpp. +This function clears the entire buffer by setting it to an empty string. Definition at line 209 of file users.cpp. .PP References recvq. .PP Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). .PP .nf -204 { -205 recvq = ''; -206 } +210 { +211 recvq = ''; +212 } .fi .SS "void userrec::FlushWriteBuf ()" .PP -Flushes as much of the user's buffer to the file descriptor as possible. This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method.Definition at line 241 of file users.cpp. +Flushes as much of the user's buffer to the file descriptor as possible. This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method.Definition at line 247 of file users.cpp. .PP References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). .PP .nf -242 { -243 if (sendq.length()) -244 { -245 char* tb = (char*)this->sendq.c_str(); -246 int n_sent = write(this->fd,tb,this->sendq.length()); -247 if (n_sent == -1) -248 { -249 this->SetWriteError(strerror(errno)); -250 } -251 else -252 { -253 // advance the queue -254 tb += n_sent; -255 this->sendq = tb; -256 // update the user's stats counters -257 this->bytes_out += n_sent; -258 this->cmds_out++; -259 } -260 } -261 } +248 { +249 if (sendq.length()) +250 { +251 char* tb = (char*)this->sendq.c_str(); +252 int n_sent = write(this->fd,tb,this->sendq.length()); +253 if (n_sent == -1) +254 { +255 this->SetWriteError(strerror(errno)); +256 } +257 else +258 { +259 // advance the queue +260 tb += n_sent; +261 this->sendq = tb; +262 // update the user's stats counters +263 this->bytes_out += n_sent; +264 this->cmds_out++; +265 } +266 } +267 } .fi .SS "std::string userrec::GetBuffer ()" .PP -This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use \fBBufferIsReady()\fP to check if it is ok to read the buffer before calling \fBGetBuffer()\fP.Definition at line 208 of file users.cpp. +This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use \fBBufferIsReady()\fP to check if it is ok to read the buffer before calling \fBGetBuffer()\fP.Definition at line 214 of file users.cpp. .PP References recvq. .PP .nf -209 { -210 if (recvq == '') -211 return ''; -212 char* line = (char*)recvq.c_str(); -213 std::string ret = ''; -214 while ((*line != '\n') && (strlen(line))) -215 { -216 ret = ret + *line; -217 line++; -218 } -219 if ((*line == '\n') || (*line == '\r')) -220 line++; -221 recvq = line; -222 return ret; -223 } +215 { +216 if (recvq == '') +217 return ''; +218 char* line = (char*)recvq.c_str(); +219 std::string ret = ''; +220 while ((*line != '\n') && (strlen(line))) +221 { +222 ret = ret + *line; +223 line++; +224 } +225 if ((*line == '\n') || (*line == '\r')) +226 line++; +227 recvq = line; +228 return ret; +229 } .fi .SS "char * userrec::GetFullHost ()\fC [virtual]\fP" .PP -Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 61 of file users.cpp. +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 62 of file users.cpp. .PP References dhost, ident, nick, and result. .PP .nf -62 { -63 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -64 return result; -65 } +63 { +64 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +65 return result; +66 } .fi .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP" .PP -Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 68 of file users.cpp. +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 69 of file users.cpp. .PP References connection::host, ident, nick, and result. .PP .nf -69 { -70 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -71 return result; -72 } +70 { +71 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +72 return result; +73 } +.fi +.SS "\fBInvitedList\fP * userrec::GetInviteList ()" +.PP +Returns the list of channels this user has been invited to but has not yet joined. Definition at line 89 of file users.cpp. +.PP +References InvitedList, and invites. +.PP +.nf +90 { +91 return &invites; +92 } .fi .SS "std::string userrec::GetWriteError ()" .PP -Returns the write error which last occured on this connection or an empty string if none occured. Definition at line 271 of file users.cpp. +Returns the write error which last occured on this connection or an empty string if none occured. Definition at line 277 of file users.cpp. .PP References WriteError. .PP Referenced by AddWriteBuf(). .PP .nf -272 { -273 return this->WriteError; -274 } +278 { +279 return this->WriteError; +280 } .fi .SS "bool userrec::HasPermission (char * command)" .PP -Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 117 of file users.cpp. +Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 123 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -118 { -119 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -120 char* mycmd; -121 char* savept; -122 char* savept2; -123 -124 // are they even an oper at all? -125 if (strchr(this->modes,'o')) -126 { -127 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -128 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -129 { -130 ConfValue('type','name',j,TypeName,&config_f); -131 if (!strcmp(TypeName,this->oper)) -132 { -133 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -134 ConfValue('type','classes',j,Classes,&config_f); -135 char* myclass = strtok_r(Classes,' ',&savept); -136 while (myclass) -137 { -138 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -139 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -140 { -141 ConfValue('class','name',k,ClassName,&config_f); -142 if (!strcmp(ClassName,myclass)) -143 { -144 ConfValue('class','commands',k,CommandList,&config_f); -145 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -146 -147 -148 mycmd = strtok_r(CommandList,' ',&savept2); -149 while (mycmd) -150 { -151 if (!strcasecmp(mycmd,command)) -152 { -153 log(DEBUG,'*** Command %s found, returning true',command); -154 return true; -155 } -156 mycmd = strtok_r(NULL,' ',&savept2); -157 } -158 } -159 } -160 myclass = strtok_r(NULL,' ',&savept); -161 } -162 } -163 } -164 } -165 return false; -166 } +124 { +125 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +126 char* mycmd; +127 char* savept; +128 char* savept2; +129 +130 // are they even an oper at all? +131 if (strchr(this->modes,'o')) +132 { +133 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +134 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +135 { +136 ConfValue('type','name',j,TypeName,&config_f); +137 if (!strcmp(TypeName,this->oper)) +138 { +139 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +140 ConfValue('type','classes',j,Classes,&config_f); +141 char* myclass = strtok_r(Classes,' ',&savept); +142 while (myclass) +143 { +144 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +145 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +146 { +147 ConfValue('class','name',k,ClassName,&config_f); +148 if (!strcmp(ClassName,myclass)) +149 { +150 ConfValue('class','commands',k,CommandList,&config_f); +151 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); +152 +153 +154 mycmd = strtok_r(CommandList,' ',&savept2); +155 while (mycmd) +156 { +157 if (!strcasecmp(mycmd,command)) +158 { +159 log(DEBUG,'*** Command %s found, returning true',command); +160 return true; +161 } +162 mycmd = strtok_r(NULL,' ',&savept2); +163 } +164 } +165 } +166 myclass = strtok_r(NULL,' ',&savept); +167 } +168 } +169 } +170 } +171 return false; +172 } .fi .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP" .PP -Adds a channel to a users invite list (invites them to a channel). Definition at line 88 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 94 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -89 { -90 Invited i; -91 strlcpy(i.channel,channel,CHANMAX); -92 invites.push_back(i); -93 } +95 { +96 Invited i; +97 strlcpy(i.channel,channel,CHANMAX); +98 invites.push_back(i); +99 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 74 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 75 of file users.cpp. .PP References invites. .PP .nf -75 { -76 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -77 { -78 if (i->channel) { -79 if (!strcasecmp(i->channel,channel)) -80 { -81 return true; -82 } -83 } -84 } -85 return false; -86 } +76 { +77 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +78 { +79 if (i->channel) { +80 if (!strcasecmp(i->channel,channel)) +81 { +82 return true; +83 } +84 } +85 } +86 return false; +87 } .fi .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP" .PP -Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 95 of file users.cpp. +Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 101 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -96 { -97 log(DEBUG,'Removing invites'); -98 if (channel) -99 { -100 if (invites.size()) -101 { -102 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -103 { -104 if (i->channel) -105 { -106 if (!strcasecmp(i->channel,channel)) -107 { -108 invites.erase(i); -109 return; -110 } -111 } -112 } -113 } -114 } -115 } +102 { +103 log(DEBUG,'Removing invites'); +104 if (channel) +105 { +106 if (invites.size()) +107 { +108 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +109 { +110 if (i->channel) +111 { +112 if (!strcasecmp(i->channel,channel)) +113 { +114 invites.erase(i); +115 return; +116 } +117 } +118 } +119 } +120 } +121 } .fi .SS "void userrec::SetWriteError (std::string error)" .PP -Sets the write error for a connection. This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged.Definition at line 263 of file users.cpp. +Sets the write error for a connection. This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged.Definition at line 269 of file users.cpp. .PP References DEBUG, and WriteError. .PP Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf(). .PP .nf -264 { -265 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str()); -266 // don't try to set the error twice, its already set take the first string. -267 if (this->WriteError == '') -268 this->WriteError = error; -269 } +270 { +271 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str()); +272 // don't try to set the error twice, its already set take the first string. +273 if (this->WriteError == '') +274 this->WriteError = error; +275 } .fi .SH "Member Data Documentation" .PP @@ -576,7 +591,7 @@ Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec( .PP A list of channels the user has a pending invite to. Definition at line 114 of file users.h. .PP -Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). +Referenced by GetInviteList(), InviteTo(), IsInvited(), RemoveInvite(), and userrec(). .SS "int \fBuserrec::lines_in\fP" .PP Flood counters. Definition at line 204 of file users.h. diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index 72cf2e6fb..e8d74655d 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -18,6 +18,8 @@ users.cpp \- .br \fC#include 'inspstring.h'\fP .br +\fC#include 'helperfuncs.h'\fP +.br .SS "Variables" @@ -33,10 +35,10 @@ users.cpp \- .PP .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 24 of file users.cpp. +Definition at line 25 of file users.cpp. .SS "time_t \fBTIME\fP" .PP -Definition at line 26 of file users.cpp. +Definition at line 27 of file users.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/users.h.3 b/docs/man/man3/users.h.3 index ea393b917..234320343 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -99,6 +99,8 @@ Holds a complete list of all allow and deny tags from the configuration file (co .SS "typedef std::vector<\fBInvited\fP> \fBInvitedList\fP" .PP Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 94 of file users.h. +.PP +Referenced by userrec::GetInviteList(). .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 49c111470..65e55d871 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME |