diff options
Diffstat (limited to 'docs/man/man3')
62 files changed, 2027 insertions, 1439 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index e2001754e..416575798 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "24 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 238 of file modules.cpp. +Definition at line 247 of file modules.cpp. .PP .nf -238 : Name(name), Email(email), Nick(nick) { }; +247 : 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 8fb296ba1..1df522d83 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 23b16d688..db2f5d282 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -89,213 +89,213 @@ Definition at line 1150 of file modules.h. .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 799 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 819 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -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 } +820 { +821 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +822 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +823 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +824 if (!this->readerror) +825 this->error = CONF_FILE_NOT_FOUND; +826 } .fi .SS "ConfigReader::ConfigReader (std::string filename)" .PP -Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 818 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 838 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -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 }; +839 { +840 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +841 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +842 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +843 if (!this->readerror) +844 this->error = CONF_FILE_NOT_FOUND; +845 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 809 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 829 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -810 { -811 if (this->cache) -812 delete this->cache; -813 if (this->errorlog) -814 delete this->errorlog; -815 } +830 { +831 if (this->cache) +832 delete this->cache; +833 if (this->errorlog) +834 delete this->errorlog; +835 } .fi .SH "Member Function Documentation" .PP .SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)" .PP -Dumps the list of errors in a config file to an output location. If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.Definition at line 896 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 916 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -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 } +917 { +918 if (bail) +919 { +920 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +921 exit(0); +922 } +923 else +924 { +925 char dataline[1024]; +926 if (user) +927 { +928 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +929 while (!errorlog->eof()) +930 { +931 errorlog->getline(dataline,1024); +932 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +933 } +934 } +935 else +936 { +937 WriteOpers('There were errors in the configuration file:',user->nick); +938 while (!errorlog->eof()) +939 { +940 errorlog->getline(dataline,1024); +941 WriteOpers(dataline); +942 } +943 } +944 return; +945 } +946 } .fi .SS "int ConfigReader::Enumerate (std::string tag)" .PP -Counts the number of times a given tag appears in the config file. This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 929 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 949 of file modules.cpp. .PP References cache. .PP .nf -930 { -931 return EnumConf(cache,tag.c_str()); -932 } +950 { +951 return EnumConf(cache,tag.c_str()); +952 } .fi .SS "int ConfigReader::EnumerateValues (std::string tag, int index)" .PP -Returns the number of items within a tag. For example if the tag was <test tag='blah' data='foo'> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 934 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 954 of file modules.cpp. .PP References cache. .PP .nf -935 { -936 return EnumValues(cache, tag.c_str(), index); -937 } +955 { +956 return EnumValues(cache, tag.c_str(), index); +957 } .fi .SS "long ConfigReader::GetError ()" .PP -Returns the last error to occur. Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 889 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 909 of file modules.cpp. .PP References error. .PP .nf -890 { -891 long olderr = this->error; -892 this->error = 0; -893 return olderr; -894 } +910 { +911 long olderr = this->error; +912 this->error = 0; +913 return olderr; +914 } .fi .SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)" .PP -Retrieves a boolean value from the config file. This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.Definition at line 843 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 863 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -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 } +864 { +865 char val[MAXBUF]; +866 char t[MAXBUF]; +867 char n[MAXBUF]; +868 strlcpy(t,tag.c_str(),MAXBUF); +869 strlcpy(n,name.c_str(),MAXBUF); +870 int res = ReadConf(cache,t,n,index,val); +871 if (!res) +872 { +873 this->error = CONF_VALUE_NOT_FOUND; +874 return false; +875 } +876 std::string s = val; +877 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +878 } .fi .SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)" .PP -Retrieves an integer value from the config file. This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 860 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 880 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -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 } +881 { +882 char val[MAXBUF]; +883 char t[MAXBUF]; +884 char n[MAXBUF]; +885 strlcpy(t,tag.c_str(),MAXBUF); +886 strlcpy(n,name.c_str(),MAXBUF); +887 int res = ReadConf(cache,t,n,index,val); +888 if (!res) +889 { +890 this->error = CONF_VALUE_NOT_FOUND; +891 return 0; +892 } +893 for (int i = 0; i < strlen(val); i++) +894 { +895 if (!isdigit(val[i])) +896 { +897 this->error = CONF_NOT_A_NUMBER; +898 return 0; +899 } +900 } +901 if ((needs_unsigned) && (atoi(val)<0)) +902 { +903 this->error = CONF_NOT_UNSIGNED; +904 return 0; +905 } +906 return atoi(val); +907 } .fi .SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)" .PP -Retrieves a value from the config file. This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.Definition at line 827 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 847 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -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 } +848 { +849 char val[MAXBUF]; +850 char t[MAXBUF]; +851 char n[MAXBUF]; +852 strlcpy(t,tag.c_str(),MAXBUF); +853 strlcpy(n,name.c_str(),MAXBUF); +854 int res = ReadConf(cache,t,n,index,val); +855 if (!res) +856 { +857 this->error = CONF_VALUE_NOT_FOUND; +858 return ''; +859 } +860 return val; +861 } .fi .SS "bool ConfigReader::Verify ()" .PP -Returns true if a config file is valid. This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 939 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 959 of file modules.cpp. .PP References readerror. .PP .nf -940 { -941 return this->readerror; -942 } +960 { +961 return this->readerror; +962 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index c71050d3c..23662d063 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index f70f13979..f5b6d1c9d 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index cf223c4a7..b68821320 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Event.3 b/docs/man/man3/Event.3 index 249e9bcba..66edc1d3d 100644 --- a/docs/man/man3/Event.3 +++ b/docs/man/man3/Event.3 @@ -1,4 +1,4 @@ -.TH "Event" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Event" 3 "24 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 269 of file modules.cpp. +Create a new Event. Definition at line 278 of file modules.cpp. .PP .nf -269 : data(anydata), source(src), id(eventid) { }; +278 : data(anydata), source(src), id(eventid) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Event::GetData ()" .PP -Get the Event data. Definition at line 271 of file modules.cpp. +Get the Event data. Definition at line 280 of file modules.cpp. .PP References data. .PP .nf -272 { -273 return this->data; -274 } +281 { +282 return this->data; +283 } .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 287 of file modules.cpp. +Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 296 of file modules.cpp. .PP References id. .PP .nf -288 { -289 return this->id; -290 } +297 { +298 return this->id; +299 } .fi .SS "\fBModule\fP * Event::GetSource ()" .PP -Get the event Source. Definition at line 276 of file modules.cpp. +Get the event Source. Definition at line 285 of file modules.cpp. .PP References source. .PP .nf -277 { -278 return this->source; -279 } +286 { +287 return this->source; +288 } .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 281 of file modules.cpp. +Definition at line 290 of file modules.cpp. .PP References FOREACH_MOD. .PP .nf -282 { -283 FOREACH_MOD OnEvent(this); -284 return NULL; -285 } +291 { +292 FOREACH_MOD OnEvent(this); +293 return NULL; +294 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index b30ba6601..aa5258002 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index 353b17ce3..236e8cd8a 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "24 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 136 of file modules.cpp. +Definition at line 145 of file modules.cpp. .PP References modechar, needsoper, params_when_off, params_when_on, and type. .PP .nf -136 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +145 : 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 135 of file modules.cpp. +Definition at line 144 of file modules.cpp. .SS "char \fBExtMode::modechar\fP" .PP -Definition at line 130 of file modules.cpp. +Definition at line 139 of file modules.cpp. .PP Referenced by ExtMode(). .SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 134 of file modules.cpp. +Definition at line 143 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 133 of file modules.cpp. +Definition at line 142 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 132 of file modules.cpp. +Definition at line 141 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::type\fP" .PP -Definition at line 131 of file modules.cpp. +Definition at line 140 of file modules.cpp. .PP Referenced by ExtMode(). diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index 46a699705..d36912f60 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 1df4ff063..f791a880e 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -62,89 +62,89 @@ Definition at line 1239 of file modules.h. .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 952 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 972 of file modules.cpp. .PP .nf -953 { -954 } +973 { +974 } .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 945 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 965 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -946 { -947 file_cache c; -948 readfile(c,filename.c_str()); -949 this->fc = c; -950 } +966 { +967 file_cache c; +968 readfile(c,filename.c_str()); +969 this->fc = c; +970 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 964 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 984 of file modules.cpp. .PP .nf -965 { -966 } +985 { +986 } .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 968 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 988 of file modules.cpp. .PP References fc. .PP .nf -969 { -970 if (fc.size() == 0) -971 { -972 return(false); -973 } -974 else -975 { -976 return(true); -977 } -978 } +989 { +990 if (fc.size() == 0) +991 { +992 return(false); +993 } +994 else +995 { +996 return(true); +997 } +998 } .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 987 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 1007 of file modules.cpp. .PP References fc. .PP .nf -988 { -989 return fc.size(); -990 } +1008 { +1009 return fc.size(); +1010 } .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 980 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 1000 of file modules.cpp. .PP References fc. .PP .nf -981 { -982 if ((x<0) || (x>fc.size())) -983 return ''; -984 return fc[x]; -985 } +1001 { +1002 if ((x<0) || (x>fc.size())) +1003 return ''; +1004 return fc[x]; +1005 } .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 956 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 976 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -957 { -958 file_cache c; -959 readfile(c,filename.c_str()); -960 this->fc = c; -961 } +977 { +978 file_cache c; +979 readfile(c,filename.c_str()); +980 this->fc = c; +981 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index e781013fa..8a8523190 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index 37b11a714..7d151b18d 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 50608345f..a38f1bd5f 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index e09d4d9b5..87fb6a718 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index ed73e3e15..076be1032 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 2a85198db..bd6f50b0e 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index b33e933cd..eab4669bb 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "24 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 294 of file modules.cpp. +Default constructor creates a module class. Definition at line 303 of file modules.cpp. .PP .nf -294 { } +303 { } .fi .SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class. Definition at line 295 of file modules.cpp. +Default destructor destroys a module class. Definition at line 304 of file modules.cpp. .PP .nf -295 { } +304 { } .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 307 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 316 of file modules.cpp. .PP References VF_VENDOR. .PP .nf -307 { return Version(1,0,0,0,VF_VENDOR); } +316 { 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 319 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 328 of file modules.cpp. .PP .nf -319 { }; +328 { }; .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 316 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 325 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -316 { return ACR_DEFAULT; }; +325 { 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 344 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 353 of file modules.cpp. .PP .nf -344 { return 0; }; +353 { 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 322 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 331 of file modules.cpp. .PP .nf -322 { }; +331 { }; .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 336 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 345 of file modules.cpp. .PP .nf -336 { return 0; }; +345 { 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 335 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 344 of file modules.cpp. .PP .nf -335 { return 0; }; +344 { 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 318 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 327 of file modules.cpp. .PP References string_list. .PP .nf -318 { string_list empty; return empty; } +327 { 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 333 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 342 of file modules.cpp. .PP .nf -333 { return 0; }; +342 { 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 330 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 339 of file modules.cpp. .PP .nf -330 { return 0; }; +339 { 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 331 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 340 of file modules.cpp. .PP .nf -331 { return 0; }; +340 { 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 332 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 341 of file modules.cpp. .PP .nf -332 { return 0; }; +341 { 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 325 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 334 of file modules.cpp. .PP .nf -325 { return true; }; +334 { 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 345 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 354 of file modules.cpp. .PP .nf -345 { return 0; }; +354 { 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 339 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 348 of file modules.cpp. .PP .nf -339 { return; }; +348 { 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 306 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 315 of file modules.cpp. .PP .nf -306 { return false; } +315 { 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 343 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 352 of file modules.cpp. .PP .nf -343 { }; +352 { }; .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 342 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 351 of file modules.cpp. .PP .nf -342 { }; +351 { }; .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 309 of file modules.cpp. +<nick> :information hereDefinition at line 318 of file modules.cpp. .PP .nf -309 { }; +318 { }; .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 320 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 329 of file modules.cpp. .PP .nf -320 { return 0; }; +329 { 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 321 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 330 of file modules.cpp. .PP .nf -321 { }; +330 { }; .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 337 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 346 of file modules.cpp. .PP .nf -337 { return 0; }; +346 { 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 338 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 347 of file modules.cpp. .PP .nf -338 { return 0; }; +347 { 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 308 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 317 of file modules.cpp. .PP .nf -308 { }; +317 { }; .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 341 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 350 of file modules.cpp. .PP .nf -341 { return 0; }; +350 { 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 302 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 311 of file modules.cpp. .PP .nf -302 { } +311 { } .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 301 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 310 of file modules.cpp. .PP .nf -301 { } +310 { } .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 324 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 333 of file modules.cpp. .PP .nf -324 { return 0; }; +333 { 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 329 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 338 of file modules.cpp. .PP .nf -329 { return 0; }; +338 { 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 346 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 355 of file modules.cpp. .PP .nf -346 { }; +355 { }; .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 348 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 357 of file modules.cpp. .PP .nf -348 { }; +357 { }; .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 349 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 358 of file modules.cpp. .PP .nf -349 { return 0; }; +358 { 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 347 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 356 of file modules.cpp. .PP .nf -347 { return 0; }; +356 { 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 303 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 312 of file modules.cpp. .PP .nf -303 { } +312 { } .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 340 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 349 of file modules.cpp. .PP Referenced by Request::Send(). .PP .nf -340 { return NULL; }; +349 { 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 323 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 332 of file modules.cpp. .PP .nf -323 { }; +332 { }; .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 304 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 313 of file modules.cpp. .PP .nf -304 { } +313 { } .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 334 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 343 of file modules.cpp. .PP .nf -334 { }; +343 { }; .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 296 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 305 of file modules.cpp. .PP .nf -296 { } +305 { } .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 298 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 307 of file modules.cpp. .PP .nf -298 { } +307 { } .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 299 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 308 of file modules.cpp. .PP .nf -299 { } +308 { } .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 328 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 337 of file modules.cpp. .PP .nf -328 { }; +337 { }; .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 300 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 309 of file modules.cpp. .PP .nf -300 { } +309 { } .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 315 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 324 of file modules.cpp. .PP .nf -315 { }; +324 { }; .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 311 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 320 of file modules.cpp. .PP .nf -311 { return 0; }; +320 { 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 305 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 314 of file modules.cpp. .PP .nf -305 { return 0; } +314 { 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 327 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 336 of file modules.cpp. .PP .nf -327 { return 0; }; +336 { 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 312 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 321 of file modules.cpp. .PP .nf -312 { return 0; }; +321 { 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 314 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 323 of file modules.cpp. .PP .nf -314 { return 0; }; +323 { 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 313 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 322 of file modules.cpp. .PP .nf -313 { return 0; }; +322 { 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 297 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 306 of file modules.cpp. .PP .nf -297 { } +306 { } .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 326 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 335 of file modules.cpp. .PP .nf -326 { }; +335 { }; .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 317 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 326 of file modules.cpp. .PP References string_list. .PP .nf -317 { string_list empty; return empty; } +326 { 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 310 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 319 of file modules.cpp. .PP .nf -310 { }; +319 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index be57b64c8..779bd0e86 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModuleMessage.3 b/docs/man/man3/ModuleMessage.3 index 63b7dba85..4d4080144 100644 --- a/docs/man/man3/ModuleMessage.3 +++ b/docs/man/man3/ModuleMessage.3 @@ -1,4 +1,4 @@ -.TH "ModuleMessage" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleMessage" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index 3d9dbdc20..9e71ad7a0 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Request.3 b/docs/man/man3/Request.3 index 2f7487d15..f836f2662 100644 --- a/docs/man/man3/Request.3 +++ b/docs/man/man3/Request.3 @@ -1,4 +1,4 @@ -.TH "Request" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Request" 3 "24 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 240 of file modules.cpp. +Create a new Request. Definition at line 249 of file modules.cpp. .PP .nf -240 : data(anydata), source(src), dest(dst) { }; +249 : data(anydata), source(src), dest(dst) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Request::GetData ()" .PP -Fetch the Request data. Definition at line 242 of file modules.cpp. +Fetch the Request data. Definition at line 251 of file modules.cpp. .PP References data. .PP .nf -243 { -244 return this->data; -245 } +252 { +253 return this->data; +254 } .fi .SS "\fBModule\fP * Request::GetDest ()" .PP -Fetch the request destination (should be 'this' in the receiving module). Definition at line 252 of file modules.cpp. +Fetch the request destination (should be 'this' in the receiving module). Definition at line 261 of file modules.cpp. .PP References dest. .PP .nf -253 { -254 return this->dest; -255 } +262 { +263 return this->dest; +264 } .fi .SS "\fBModule\fP * Request::GetSource ()" .PP -Fetch the request source. Definition at line 247 of file modules.cpp. +Fetch the request source. Definition at line 256 of file modules.cpp. .PP References source. .PP .nf -248 { -249 return this->source; -250 } +257 { +258 return this->source; +259 } .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 257 of file modules.cpp. +Definition at line 266 of file modules.cpp. .PP References dest, and Module::OnRequest(). .PP .nf -258 { -259 if (this->dest) -260 { -261 return dest->OnRequest(this); -262 } -263 else -264 { -265 return NULL; -266 } -267 } +267 { +268 if (this->dest) +269 { +270 return dest->OnRequest(this); +271 } +272 else +273 { +274 return NULL; +275 } +276 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 93daa2cc9..87891e19e 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -271,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 355 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 364 of file modules.cpp. .PP .nf -356 { -357 } +365 { +366 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 359 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 368 of file modules.cpp. .PP .nf -360 { -361 } +369 { +370 } .fi .SH "Member Function Documentation" .PP @@ -293,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 428 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 437 of file modules.cpp. .PP References createcommand(). .PP .nf -429 { -430 createcommand(cmd,f,flags,minparams,source); -431 } +438 { +439 createcommand(cmd,f,flags,minparams,source); +440 } .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 679 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 699 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf -680 { -681 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -682 } +700 { +701 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +702 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -325,549 +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 596 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 605 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -597 { -598 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -599 if (res) -600 ModeMakeList(modechar); -601 return res; -602 } +606 { +607 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +608 if (res) +609 ModeMakeList(modechar); +610 return res; +611 } .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 568 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 577 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -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 } +578 { +579 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) +580 { +581 if (type == MT_SERVER) +582 { +583 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +584 return false; +585 } +586 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +587 { +588 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +589 return false; +590 } +591 if ((params_when_on>1) || (params_when_off>1)) +592 { +593 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +594 return false; +595 } +596 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +597 } +598 else +599 { +600 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); +601 } +602 return false; +603 } .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 659 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 679 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf -660 { -661 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -662 } +680 { +681 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +682 } .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 674 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 694 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf -675 { -676 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -677 } +695 { +696 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +697 } .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 664 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 684 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf -665 { -666 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -667 } +685 { +686 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +687 } .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 669 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 689 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf -670 { -671 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -672 } +690 { +691 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +692 } .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 709 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 729 of file modules.cpp. .PP References duration(). .PP .nf -710 { -711 return duration(delta.c_str()); -712 } +730 { +731 return duration(delta.c_str()); +732 } .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 418 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 427 of file modules.cpp. .PP .nf -419 { -420 call_handler(commandname.c_str(),parameters,pcnt,user); -421 } +428 { +429 call_handler(commandname.c_str(),parameters,pcnt,user); +430 } .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 511 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 520 of file modules.cpp. .PP References ChangeName(). .PP .nf -512 { -513 ChangeName(user,gecos.c_str()); -514 } +521 { +522 ChangeName(user,gecos.c_str()); +523 } .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 506 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 515 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -507 { -508 ChangeDisplayedHost(user,host.c_str()); -509 } +516 { +517 ChangeDisplayedHost(user,host.c_str()); +518 } .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 403 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 412 of file modules.cpp. .PP .nf -404 { -405 force_nickchange(user,nickname.c_str()); -406 } +413 { +414 force_nickchange(user,nickname.c_str()); +415 } .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 536 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 545 of file modules.cpp. .PP References cmode(). .PP .nf -537 { -538 return cmode(User,Chan); -539 } +546 { +547 return cmode(User,Chan); +548 } .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 484 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 493 of file modules.cpp. .PP References common_channels(). .PP .nf -485 { -486 return (common_channels(u1,u2) != 0); -487 } +494 { +495 return (common_channels(u1,u2) != 0); +496 } .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 604 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 613 of file modules.cpp. .PP .nf -605 { -606 return usercount(c); -607 } +614 { +615 return usercount(c); +616 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local E-Line. Definition at line 704 of file modules.cpp. +Deletes a local E-Line. Definition at line 724 of file modules.cpp. .PP References del_eline(). .PP .nf -705 { -706 del_eline(hostmask.c_str()); -707 } +725 { +726 del_eline(hostmask.c_str()); +727 } .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 684 of file modules.cpp. +Deletes a G-Line from all servers on the mesh. Definition at line 704 of file modules.cpp. .PP References del_gline(). .PP .nf -685 { -686 del_gline(hostmask.c_str()); -687 } +705 { +706 del_gline(hostmask.c_str()); +707 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local K-Line. Definition at line 699 of file modules.cpp. +Deletes a local K-Line. Definition at line 719 of file modules.cpp. .PP References del_kline(). .PP .nf -700 { -701 del_kline(hostmask.c_str()); -702 } +720 { +721 del_kline(hostmask.c_str()); +722 } .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 689 of file modules.cpp. +Deletes a Q-Line from all servers on the mesh. Definition at line 709 of file modules.cpp. .PP References del_qline(). .PP .nf -690 { -691 del_qline(nickname.c_str()); -692 } +710 { +711 del_qline(nickname.c_str()); +712 } .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 694 of file modules.cpp. +Deletes a Z-Line from all servers on the mesh. Definition at line 714 of file modules.cpp. .PP References del_zline(). .PP .nf -695 { -696 del_zline(ipaddr.c_str()); -697 } +715 { +716 del_zline(ipaddr.c_str()); +717 } .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 531 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 540 of file modules.cpp. .PP .nf -532 { -533 return FindChan(channel.c_str()); -534 } +541 { +542 return FindChan(channel.c_str()); +543 } .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 526 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 535 of file modules.cpp. .PP References fd_ref_table. .PP .nf -527 { -528 return (socket < 65536 ? fd_ref_table[socket] : NULL); -529 } +536 { +537 return (socket < 65536 ? fd_ref_table[socket] : NULL); +538 } .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 787 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 807 of file modules.cpp. .PP References MODCOUNT, module_names, and modules. .PP .nf -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 } +808 { +809 for (int i = 0; i <= MODCOUNT; i++) +810 { +811 if (module_names[i] == name) +812 { +813 return modules[i]; +814 } +815 } +816 return NULL; +817 } .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 521 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 530 of file modules.cpp. .PP .nf -522 { -523 return Find(nick); -524 } +531 { +532 return Find(nick); +533 } .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 561 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 570 of file modules.cpp. .PP .nf -562 { -563 return Admin(getadminname(),getadminemail(),getadminnick()); -564 } +571 { +572 return Admin(getadminname(),getadminemail(),getadminnick()); +573 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 551 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 560 of file modules.cpp. .PP .nf -552 { -553 return getnetworkname(); -554 } +561 { +562 return getnetworkname(); +563 } .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. +Returns the server description string of the local server. Definition at line 565 of file modules.cpp. .PP .nf -557 { -558 return getserverdesc(); -559 } +566 { +567 return getserverdesc(); +568 } .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 546 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 555 of file modules.cpp. .PP .nf -547 { -548 return getservername(); -549 } +556 { +557 return getservername(); +558 } .fi .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 391 of file modules.cpp. +Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 400 of file modules.cpp. .PP References chanuserlist, chanrec::GetUsers(), and list. .PP .nf -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 } +401 { +402 chanuserlist userl; +403 userl.clear(); +404 std::vector<char*> *list = chan->GetUsers(); +405 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) +406 { +407 char* o = *i; +408 userl.push_back((userrec*)o); +409 } +410 return userl; +411 } .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 516 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 525 of file modules.cpp. .PP References isnick(). .PP .nf -517 { -518 return (isnick(nick.c_str()) != 0); -519 } +526 { +527 return (isnick(nick.c_str()) != 0); +528 } .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 541 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 550 of file modules.cpp. .PP References has_channel(). .PP .nf -542 { -543 return has_channel(User,Chan); -544 } +551 { +552 return has_channel(User,Chan); +553 } .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 413 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 422 of file modules.cpp. .PP References is_uline(). .PP .nf -414 { -415 return is_uline(server.c_str()); -416 } +423 { +424 return is_uline(server.c_str()); +425 } .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 714 of file modules.cpp. +Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 734 of file modules.cpp. .PP .nf -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) +735 { +736 const char* dest = mask.c_str(); +737 if (strchr(dest,'!')==0) 738 return false; -739 -740 return true; -741 } +739 if (strchr(dest,'@')==0) +740 return false; +741 for (int i = 0; i < strlen(dest); i++) +742 if (dest[i] < 32) +743 return false; +744 for (int i = 0; i < strlen(dest); i++) +745 if (dest[i] > 126) +746 return false; +747 int c = 0; +748 for (int i = 0; i < strlen(dest); i++) +749 if (dest[i] == '!') +750 c++; +751 if (c>1) +752 return false; +753 c = 0; +754 for (int i = 0; i < strlen(dest); i++) +755 if (dest[i] == '@') +756 c++; +757 if (c>1) +758 return false; +759 +760 return true; +761 } .fi .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP" .PP -Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 381 of file modules.cpp. +Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 390 of file modules.cpp. .PP .nf -382 { -383 return add_channel(user,cname.c_str(),key.c_str(),false); -384 } +391 { +392 return add_channel(user,cname.c_str(),key.c_str(),false); +393 } .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 423 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 432 of file modules.cpp. .PP .nf -424 { -425 log(level,'%s',s.c_str()); -426 } +433 { +434 log(level,'%s',s.c_str()); +435 } .fi .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP" .PP -Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 368 of file modules.cpp. +Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 377 of file modules.cpp. .PP .nf -369 { -370 char literal[MAXBUF],pattern[MAXBUF]; -371 strlcpy(literal,sliteral.c_str(),MAXBUF); -372 strlcpy(pattern,spattern.c_str(),MAXBUF); -373 return match(literal,pattern); -374 } +378 { +379 char literal[MAXBUF],pattern[MAXBUF]; +380 strlcpy(literal,sliteral.c_str(),MAXBUF); +381 strlcpy(pattern,spattern.c_str(),MAXBUF); +382 return match(literal,pattern); +383 } .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 769 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 789 of file modules.cpp. .PP .nf -770 { -771 if (c) -772 { -773 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -774 } -775 else return false; -776 } +790 { +791 if (c) +792 { +793 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +794 } +795 else return false; +796 } .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 778 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 798 of file modules.cpp. .PP .nf -779 { -780 if (u) -781 { -782 return CommonOnThisServer(u,(char*)servername.c_str()); -783 } -784 else return false; -785 } +799 { +800 if (u) +801 { +802 return CommonOnThisServer(u,(char*)servername.c_str()); +803 } +804 else return false; +805 } .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 743 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 763 of file modules.cpp. .PP .nf -744 { -745 NetSendToAll((char*)text.c_str()); -746 } +764 { +765 NetSendToAll((char*)text.c_str()); +766 } .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 754 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 774 of file modules.cpp. .PP .nf -755 { -756 NetSendToAllAlive((char*)text.c_str()); -757 } +775 { +776 NetSendToAllAlive((char*)text.c_str()); +777 } .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 764 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 784 of file modules.cpp. .PP .nf -765 { -766 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -767 } +785 { +786 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); +787 } .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 748 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 768 of file modules.cpp. .PP .nf -749 { -750 if (user) -751 NetSendToCommon(user,(char*)text.c_str()); -752 } +769 { +770 if (user) +771 NetSendToCommon(user,(char*)text.c_str()); +772 } .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 759 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 779 of file modules.cpp. .PP .nf -760 { -761 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -762 } +780 { +781 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +782 } .fi .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP" .PP -Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 386 of file modules.cpp. +Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 395 of file modules.cpp. .PP .nf -387 { -388 return del_channel(user,cname.c_str(),reason.c_str(),false); -389 } +396 { +397 return del_channel(user,cname.c_str(),reason.c_str(),false); +398 } .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 629 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 649 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 -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 } +650 { +651 zombie->fd = alive->fd; +652 alive->fd = FD_MAGIC_NUMBER; +653 alive->ClearBuffer(); +654 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +655 kill_link(alive,message.c_str()); +656 fd_ref_table[zombie->fd] = zombie; +657 for (int i = 0; i != MAXCHANS; i++) +658 { +659 if (zombie->chans[i].channel != NULL) +660 { +661 if (zombie->chans[i].channel->name) +662 { +663 chanrec* Ptr = zombie->chans[i].channel; +664 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +665 if (Ptr->topicset) +666 { +667 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +668 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +669 } +670 userlist(zombie,Ptr); +671 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +672 +673 } +674 } +675 } +676 +677 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -875,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 408 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 417 of file modules.cpp. .PP .nf -409 { -410 kill_link(user,reason.c_str()); -411 } +418 { +419 kill_link(user,reason.c_str()); +420 } .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 438 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 447 of file modules.cpp. .PP .nf -439 { -440 Write(Socket,'%s',s.c_str()); -441 } +448 { +449 Write(Socket,'%s',s.c_str()); +450 } .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 472 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 481 of file modules.cpp. .PP .nf -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 } +482 { +483 if (IncludeSender) +484 { +485 WriteChannel(Channel,User,'%s',s.c_str()); +486 } +487 else +488 { +489 ChanExceptSender(Channel,User,'%s',s.c_str()); +490 } +491 } .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 467 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 476 of file modules.cpp. .PP .nf -468 { -469 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); -470 } +477 { +478 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); +479 } .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 489 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 498 of file modules.cpp. .PP .nf -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 } +499 { +500 if (IncludeSender) +501 { +502 WriteCommon(User,'%s',text.c_str()); +503 } +504 else +505 { +506 WriteCommonExcept(User,'%s',text.c_str()); +507 } +508 } .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 448 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 457 of file modules.cpp. .PP .nf -449 { -450 WriteFrom(Socket,User,'%s',s.c_str()); -451 } +458 { +459 WriteFrom(Socket,User,'%s',s.c_str()); +460 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -957,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 433 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 442 of file modules.cpp. .PP References server_mode(). .PP .nf -434 { -435 server_mode(parameters,pcnt,user); -436 } +443 { +444 server_mode(parameters,pcnt,user); +445 } .fi .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP" .PP -Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 363 of file modules.cpp. +Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 372 of file modules.cpp. .PP .nf -364 { -365 WriteOpers('%s',s.c_str()); -366 } +373 { +374 WriteOpers('%s',s.c_str()); +375 } .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 443 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 452 of file modules.cpp. .PP .nf -444 { -445 WriteServ(Socket,'%s',s.c_str()); -446 } +453 { +454 WriteServ(Socket,'%s',s.c_str()); +455 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -994,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 453 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 462 of file modules.cpp. .PP References connection::fd. .PP .nf -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 } +463 { +464 if (!Source) +465 { +466 // if source is NULL, then the message originates from the local server +467 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +468 } +469 else +470 { +471 // otherwise it comes from the user specified +472 WriteTo(Source,Dest,'%s',s.c_str()); +473 } +474 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -1018,46 +1018,57 @@ Sends to all users matching a mode mask You must specify one or more usermodes a .PP Serv->SendToModeMask('xi', WM_OR, 'm00'); .PP -Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 376 of file modules.cpp. +Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 385 of file modules.cpp. .PP .nf -377 { -378 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -379 } +386 { +387 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +388 } .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 501 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 510 of file modules.cpp. .PP .nf -502 { -503 WriteWallOps(User,false,'%s',text.c_str()); -504 } +511 { +512 WriteWallOps(User,false,'%s',text.c_str()); +513 } .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 610 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 619 of file modules.cpp. .PP References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf -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 } +620 { +621 unsigned int old_fd = user->fd; +622 user->fd = FD_MAGIC_NUMBER; +623 user->ClearBuffer(); +624 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +625 #ifdef USE_KQUEUE +626 struct kevent ke; +627 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); +628 int i = kevent(kq, &ke, 1, 0, 0, NULL); +629 if (i == -1) +630 { +631 log(DEBUG,'kqueue: Failed to remove user from queue!'); +632 } +633 #endif +634 #ifdef USE_EPOLL +635 struct epoll_event ev; +636 ev.events = EPOLLIN | EPOLLET; +637 ev.data.fd = old_fd; +638 int i = epoll_ctl(ep, EPOLL_CTL_DEL, old_fd, &ev); +639 if (i < 0) +640 { +641 log(DEBUG,'epoll: List deletion failure!'); +642 } +643 #endif +644 +645 shutdown(old_fd,2); +646 close(old_fd); +647 } .fi diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index b553e9e20..aeea8964f 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "24 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 234 of file modules.cpp. +Definition at line 243 of file modules.cpp. .PP .nf -234 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; +243 : 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 a6d45973f..8e60d5b21 100644 --- a/docs/man/man3/WhoWasUser.3 +++ b/docs/man/man3/WhoWasUser.3 @@ -1,4 +1,4 @@ -.TH "WhoWasUser" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "WhoWasUser" 3 "24 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 318 of file users.h. +A lightweight userrec used by WHOWAS. Definition at line 326 of file users.h. .SH "Member Data Documentation" .PP .SS "char \fBWhoWasUser::dhost\fP[160]" .PP -Definition at line 323 of file users.h. +Definition at line 331 of file users.h. .SS "char \fBWhoWasUser::fullname\fP[128]" .PP -Definition at line 325 of file users.h. +Definition at line 333 of file users.h. .SS "char \fBWhoWasUser::host\fP[160]" .PP -Definition at line 324 of file users.h. +Definition at line 332 of file users.h. .SS "char \fBWhoWasUser::ident\fP[16]" .PP -Definition at line 322 of file users.h. +Definition at line 330 of file users.h. .SS "char \fBWhoWasUser::nick\fP[NICKMAX]" .PP -Definition at line 321 of file users.h. +Definition at line 329 of file users.h. .SS "char \fBWhoWasUser::server\fP[256]" .PP -Definition at line 326 of file users.h. +Definition at line 334 of file users.h. .SS "time_t \fBWhoWasUser::signon\fP" .PP -Definition at line 327 of file users.h. +Definition at line 335 of file users.h. .SH "Author" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 8cd21fa0c..3745f1f06 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 916e3681f..9a0d1a77a 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "24 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 d3d7d4065..cab63c1bb 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "24 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 1b0bc51c5..dfcb792ac 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -156,9 +156,6 @@ channels.cpp \- .RI "time_t \fBnb_start\fP" .br .ti -1c -.RI "std::vector< int > \fBfd_reap\fP" -.br -.ti -1c .RI "std::vector< std::string > \fBmodule_names\fP" .br .ti -1c @@ -199,7 +196,7 @@ channels.cpp \- .PP .SS "#define nspace std" .PP -Definition at line 53 of file channels.cpp. +Definition at line 55 of file channels.cpp. .SH "Variable Documentation" .PP .SS "char \fBAdminEmail\fP[MAXBUF]" @@ -213,18 +210,18 @@ Definition at line 66 of file channels.cpp. Definition at line 68 of file channels.cpp. .SS "std::vector<long> \fBauth_cookies\fP" .PP -Definition at line 95 of file channels.cpp. +Definition at line 94 of file channels.cpp. .SS "int \fBboundPortCount\fP" .PP -Definition at line 89 of file channels.cpp. +Definition at line 88 of file channels.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 96 of file channels.cpp. +Definition at line 95 of file channels.cpp. .PP Referenced by userrec::HasPermission(). .SS "std::vector<\fBModeParameter\fP> \fBcustom_mode_params\fP" .PP -Definition at line 106 of file channels.cpp. +Definition at line 105 of file channels.cpp. .PP Referenced by chanrec::GetModeParameter(), and chanrec::SetCustomModeParam(). .SS "int \fBdebugging\fP" @@ -232,7 +229,7 @@ Referenced by chanrec::GetModeParameter(), and chanrec::SetCustomModeParam(). Definition at line 77 of file channels.cpp. .SS "int \fBdefaultRoute\fP" .PP -Definition at line 93 of file channels.cpp. +Definition at line 92 of file channels.cpp. .SS "int \fBDieDelay\fP" .PP Definition at line 80 of file channels.cpp. @@ -245,9 +242,6 @@ Definition at line 75 of file channels.cpp. .SS "std::vector<\fBircd_module\fP*> factory" .PP Definition at line 60 of file channels.cpp. -.SS "std::vector<int> \fBfd_reap\fP" -.PP -Definition at line 86 of file channels.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP Definition at line 73 of file channels.cpp. @@ -255,7 +249,7 @@ Definition at line 73 of file channels.cpp. Referenced by Server::GetUsers(). .SS "FILE* \fBlog_file\fP" .PP -Definition at line 100 of file channels.cpp. +Definition at line 99 of file channels.cpp. .SS "int \fBLogLevel\fP" .PP Definition at line 62 of file channels.cpp. @@ -264,15 +258,15 @@ Definition at line 62 of file channels.cpp. Definition at line 83 of file channels.cpp. .SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 98 of file channels.cpp. +Definition at line 97 of file channels.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 996 of file modules.cpp. +Definition at line 1016 of file modules.cpp. .PP Referenced by Server::FindModule(). .SS "std::vector<std::string> \fBmodule_names\fP" .PP -Definition at line 87 of file channels.cpp. +Definition at line 86 of file channels.cpp. .PP Referenced by Server::FindModule(). .SS "std::vector<\fBModule\fP*> modules" @@ -294,10 +288,10 @@ Definition at line 82 of file channels.cpp. Definition at line 64 of file channels.cpp. .SS "int \fBportCount\fP" .PP -Definition at line 90 of file channels.cpp. +Definition at line 89 of file channels.cpp. .SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 92 of file channels.cpp. +Definition at line 91 of file channels.cpp. .SS "char \fBPrefixQuit\fP[MAXBUF]" .PP Definition at line 74 of file channels.cpp. @@ -315,13 +309,13 @@ Definition at line 65 of file channels.cpp. Definition at line 63 of file channels.cpp. .SS "int \fBSERVERportCount\fP" .PP -Definition at line 91 of file channels.cpp. +Definition at line 90 of file channels.cpp. .SS "time_t \fBstartup_time\fP" .PP Definition at line 81 of file channels.cpp. .SS "time_t \fBTIME\fP" .PP -Definition at line 102 of file channels.cpp. +Definition at line 101 of file channels.cpp. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "int \fBWHOWAS_MAX\fP" diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index 0609a03e6..66b0c8044 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 0831e46b3..69ac8c35d 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "24 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 108 of file channels.cpp. +Creates a channel record and initialises it with default values. Definition at line 107 of file channels.cpp. .PP References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset. .PP .nf -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 } +108 { +109 strcpy(name,''); +110 strcpy(custom_modes,''); +111 strcpy(topic,''); +112 strcpy(setby,''); +113 strcpy(key,''); +114 created = topicset = limit = 0; +115 binarymodes = 0; +116 internal_userlist.clear(); +117 } .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 202 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 201 of file channels.cpp. .PP References DEBUG, and internal_userlist. .PP .nf -203 { -204 internal_userlist.push_back(castuser); -205 log(DEBUG,'Added casted user to channel's internal list'); -206 } +202 { +203 internal_userlist.push_back(castuser); +204 log(DEBUG,'Added casted user to channel's internal list'); +205 } .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 208 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 207 of file channels.cpp. .PP References DEBUG, internal_userlist, and name. .PP .nf -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 } +208 { +209 for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) +210 { +211 if (*a == castuser) +212 { +213 log(DEBUG,'Removed casted user from channel's internal list'); +214 internal_userlist.erase(a); +215 return; +216 } +217 } +218 log(DEBUG,'BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!',name); +219 } .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 182 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 181 of file channels.cpp. .PP References custom_mode_params. .PP .nf -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 } +182 { +183 if (custom_mode_params.size()) +184 { +185 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +186 { +187 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +188 { +189 return i->parameter; +190 } +191 } +192 } +193 return ''; +194 } .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 197 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 196 of file channels.cpp. .PP References internal_userlist. .PP .nf -198 { -199 return (this->internal_userlist.size()); -200 } +197 { +198 return (this->internal_userlist.size()); +199 } .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 222 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 221 of file channels.cpp. .PP References internal_userlist. .PP Referenced by Server::GetUsers(). .PP .nf -223 { -224 return &internal_userlist; -225 } +222 { +223 return &internal_userlist; +224 } .fi .SS "bool chanrec::IsCustomModeSet (char mode)" .PP -Returns true if a custom mode is set on a channel. Definition at line 176 of file channels.cpp. +Returns true if a custom mode is set on a channel. Definition at line 175 of file channels.cpp. .PP References DEBUG. .PP .nf -177 { -178 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); -179 return (strchr(this->custom_modes,mode) != 0); -180 } +176 { +177 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); +178 return (strchr(this->custom_modes,mode) != 0); +179 } .fi .SS "void chanrec::SetCustomMode (char mode, bool mode_on)" .PP -Sets or unsets a custom mode in the channels info. Definition at line 120 of file channels.cpp. +Sets or unsets a custom mode in the channels info. Definition at line 119 of file channels.cpp. .PP References custom_modes, DEBUG, and SetCustomModeParam(). .PP .nf -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 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes); -140 this->SetCustomModeParam(mode,'',false); -141 } -142 } +120 { +121 if (mode_on) { +122 static char m[3]; +123 m[0] = mode; +124 m[1] = '\0'; +125 if (!strchr(this->custom_modes,mode)) +126 { +127 strlcat(custom_modes,m,MAXMODES); +128 } +129 log(DEBUG,'Custom mode %c set',mode); +130 } +131 else { +132 +133 std::string a = this->custom_modes; +134 int pos = a.find(mode); +135 a.erase(pos,1); +136 strncpy(this->custom_modes,a.c_str(),MAXMODES); +137 +138 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes); +139 this->SetCustomModeParam(mode,'',false); +140 } +141 } .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 145 of file channels.cpp. +Sets or unsets the parameters for a custom mode in a channels info. Definition at line 144 of file channels.cpp. .PP References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter. .PP Referenced by SetCustomMode(). .PP .nf -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 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 } +145 { +146 +147 log(DEBUG,'SetCustomModeParam called'); +148 ModeParameter M; +149 M.mode = mode; +150 strlcpy(M.channel,this->name,CHANMAX); +151 strlcpy(M.parameter,parameter,MAXBUF); +152 if (mode_on) +153 { +154 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter); +155 custom_mode_params.push_back(M); +156 } +157 else +158 { +159 if (custom_mode_params.size()) +160 { +161 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +162 { +163 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +164 { +165 log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter); +166 custom_mode_params.erase(i); +167 return; +168 } +169 } +170 } +171 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!'); +172 } +173 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index 9530bb7c8..bdadeea07 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "24 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 8309583b7..17e768025 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "24 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 c13b7bd21..5b95d45a8 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -178,6 +178,9 @@ commands.h \- .RI "void \fBhandle_unloadmodule\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br .ti -1c +.RI "void \fBhandle_commands\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, char *tcp_sum)" .br .RI "\fISpecial functions for processing server to server traffic. \fP" @@ -278,6 +281,8 @@ These are the handlers for server commands (tokens). .PP .SS "void handle_b (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host, char * tcp_sum)" .PP +.SS "void handle_commands (char ** parameters, int pcnt, \fBuserrec\fP * user)" +.PP .SS "void handle_connect (char ** parameters, int pcnt, \fBuserrec\fP * user)" .PP .SS "void handle_die (char ** parameters, int pcnt, \fBuserrec\fP * user)" diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index e21a84b8d..e492e0b8b 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -21,38 +21,6 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .RI "\fBconnection\fP ()" .br .RI "\fIDefault constructor. \fP" -.ti -1c -.RI "bool \fBCreateListener\fP (char *\fBhost\fP, int p)" -.br -.RI "\fICreate a listening socket on 'host' using port number 'p'. \fP" -.ti -1c -.RI "bool \fBBeginLink\fP (char *targethost, int \fBport\fP, char *password, char *servername, int myport)" -.br -.RI "\fIBegin an outbound link to another ircd at targethost. \fP" -.ti -1c -.RI "bool \fBMeshCookie\fP (char *targethost, int \fBport\fP, unsigned long cookie, char *servername)" -.br -.RI "\fIBegin an outbound mesh link to another ircd on a network you are already an authenticated member of. \fP" -.ti -1c -.RI "void \fBTerminateLink\fP (char *targethost)" -.br -.RI "\fITerminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method. \fP" -.ti -1c -.RI "bool \fBSendPacket\fP (char *message, const char *\fBhost\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, std::deque< std::string > &sums)" -.br -.RI "\fIReturns the next available packet and returns true if data is available. \fP" -.ti -1c -.RI "\fBircd_connector\fP * \fBFindHost\fP (std::string \fBhost\fP)" -.br -.RI "\fIFind the \fBircd_connector\fP oject related to a certain servername given in 'host'. \fP" -.ti -1c -.RI "bool \fBAddIncoming\fP (int \fBfd\fP, char *targethost, int sourceport)" -.br -.RI "\fIAdd an incoming connection to the connection pool. \fP" .in -1c .SS "Public Attributes" @@ -70,19 +38,19 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .br .RI "\fIIP of connection. \fP" .ti -1c -.RI "long \fBbytes_in\fP" +.RI "int \fBbytes_in\fP" .br .RI "\fIStats counter for bytes inbound. \fP" .ti -1c -.RI "long \fBbytes_out\fP" +.RI "int \fBbytes_out\fP" .br .RI "\fIStats counter for bytes outbound. \fP" .ti -1c -.RI "long \fBcmds_in\fP" +.RI "int \fBcmds_in\fP" .br .RI "\fIStats counter for commands inbound. \fP" .ti -1c -.RI "long \fBcmds_out\fP" +.RI "int \fBcmds_out\fP" .br .RI "\fIStats counter for commands outbound. \fP" .ti -1c @@ -113,118 +81,85 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .RI "time_t \fBnping\fP" .br .RI "\fIUsed by PING checks with clients. \fP" -.ti -1c -.RI "std::vector< \fBircd_connector\fP > \fBconnectors\fP" -.br -.RI "\fIWith a serverrec, this is a list of all established server connections. \fP" .in -1c .SH "Detailed Description" .PP -Please note: classes serverrec and userrec both inherit from class connection. Definition at line 212 of file connection.h. +Please note: classes serverrec and userrec both inherit from class connection. Definition at line 261 of file connection.h. .SH "Constructor & Destructor Documentation" .PP .SS "connection::connection ()" .PP Default constructor. -.SH "Member Function Documentation" -.PP -.SS "bool connection::AddIncoming (int fd, char * targethost, int sourceport)" -.PP -Add an incoming connection to the connection pool. (reserved for core use) -.SS "bool connection::BeginLink (char * targethost, int port, char * password, char * servername, int myport)" -.PP -Begin an outbound link to another ircd at targethost. -.SS "bool connection::CreateListener (char * host, int p)" -.PP -Create a listening socket on 'host' using port number 'p'. -.SS "\fBircd_connector\fP* connection::FindHost (std::string host)" -.PP -Find the \fBircd_connector\fP oject related to a certain servername given in 'host'. -.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, 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)" -.PP -Send 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. -.SS "void connection::TerminateLink (char * targethost)" -.PP -Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method. .SH "Member Data Documentation" .PP -.SS "long \fBconnection::bytes_in\fP" +.SS "int \fBconnection::bytes_in\fP" .PP -Stats counter for bytes inbound. Definition at line 229 of file connection.h. +Stats counter for bytes inbound. Definition at line 278 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "long \fBconnection::bytes_out\fP" +.SS "int \fBconnection::bytes_out\fP" .PP -Stats counter for bytes outbound. Definition at line 233 of file connection.h. +Stats counter for bytes outbound. Definition at line 282 of file connection.h. .PP Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). -.SS "long \fBconnection::cmds_in\fP" +.SS "int \fBconnection::cmds_in\fP" .PP -Stats counter for commands inbound. Definition at line 237 of file connection.h. +Stats counter for commands inbound. Definition at line 286 of file connection.h. .PP Referenced by userrec::userrec(). -.SS "long \fBconnection::cmds_out\fP" +.SS "int \fBconnection::cmds_out\fP" .PP -Stats counter for commands outbound. Definition at line 241 of file connection.h. +Stats counter for commands outbound. Definition at line 290 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 276 of file connection.h. .SS "int \fBconnection::fd\fP" .PP -File descriptor of the connection. Definition at line 217 of file connection.h. +File descriptor of the connection. Definition at line 266 of file connection.h. .PP -Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). +Referenced by serverrec::BeginLink(), serverrec::CreateListener(), ConfigReader::DumpErrors(), serverrec::MeshCookie(), Server::PseudoToUser(), userrec::ReadData(), 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 245 of file connection.h. +True if server/user has authenticated, false if otherwise. Definition at line 294 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 221 of file connection.h. +Hostname of connection. Not used if this is a serverrecDefinition at line 270 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 267 of file connection.h. +Time that the connection last sent data, used to calculate idle time. Definition at line 316 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::ip\fP[16]" .PP -IP of connection. Definition at line 225 of file connection.h. +IP of connection. Definition at line 274 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 259 of file connection.h. +Time the connection was last pinged. Definition at line 308 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 271 of file connection.h. +Used by PING checks with clients. Definition at line 320 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 251 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 300 of file connection.h. .PP -Referenced by userrec::userrec(). +Referenced by serverrec::CreateListener(), and userrec::userrec(). .SS "char \fBconnection::registered\fP" .PP -Used by userrec to indicate the registration status of the connection. Definition at line 255 of file connection.h. +Used by userrec to indicate the registration status of the connection. Definition at line 304 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 263 of file connection.h. +Time the connection was created, set in the constructor. Definition at line 312 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 2bd9c858a..b8ddeddf6 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -81,15 +81,23 @@ connection.h \- .SS "#define STATE_CONNECTED 1" .PP Definition at line 36 of file connection.h. +.PP +Referenced by serverrec::MeshCookie(). .SS "#define STATE_DISCONNECTED 0" .PP Definition at line 35 of file connection.h. +.PP +Referenced by serverrec::BeginLink(), serverrec::FlushWriteBuffers(), serverrec::MeshCookie(), serverrec::RecvPacket(), and serverrec::SendPacket(). .SS "#define STATE_NOAUTH_INBOUND 3" .PP Definition at line 38 of file connection.h. +.PP +Referenced by serverrec::AddIncoming(). .SS "#define STATE_NOAUTH_OUTBOUND 4" .PP Definition at line 39 of file connection.h. +.PP +Referenced by serverrec::BeginLink(), and serverrec::MeshCookie(). .SS "#define STATE_SERVICES 5" .PP Definition at line 40 of file connection.h. diff --git a/docs/man/man3/ctables.h.3 b/docs/man/man3/ctables.h.3 index 2d7eb05c9..c13d28638 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "24 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 aca6fe856..a570c881a 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "24 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 a3835ec7f..00ed1737e 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "24 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 index 91b45a530..6fe823fe7 100644 --- a/docs/man/man3/hashcomp.h.3 +++ b/docs/man/man3/hashcomp.h.3 @@ -1,4 +1,4 @@ -.TH "hashcomp.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "hashcomp.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -32,7 +32,7 @@ hashcomp.h \- .PP .SS "#define nspace __gnu_cxx" .PP -Definition at line 29 of file hashcomp.h. +Definition at line 44 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 index c1bcb5dfc..2431dfda3 100644 --- a/docs/man/man3/irc.3 +++ b/docs/man/man3/irc.3 @@ -1,4 +1,4 @@ -.TH "irc" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "irc" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -38,7 +38,7 @@ The irc namespace contains a number of helper classes. .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 114 of file hashcomp.h. +This typedef declares \fBirc::string\fP based upon \fBirc_char_traits\fP. Definition at line 129 of file hashcomp.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/irc_InAddr_HashComp.3 b/docs/man/man3/irc_InAddr_HashComp.3 index 5127b013b..cf5d69b5a 100644 --- a/docs/man/man3/irc_InAddr_HashComp.3 +++ b/docs/man/man3/irc_InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "irc::InAddr_HashComp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "irc::InAddr_HashComp" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -24,7 +24,7 @@ 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 77 of file hashcomp.h. +Definition at line 92 of file hashcomp.h. .SH "Member Function Documentation" .PP .SS "bool irc::InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const" diff --git a/docs/man/man3/irc_StrHashComp.3 b/docs/man/man3/irc_StrHashComp.3 index a6b8036e1..316b5ee4e 100644 --- a/docs/man/man3/irc_StrHashComp.3 +++ b/docs/man/man3/irc_StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "irc::StrHashComp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "irc::StrHashComp" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -24,7 +24,7 @@ This class returns true if two strings match. Case sensitivity is ignored, and the RFC 'character set' is adhered to .PP -Definition at line 65 of file hashcomp.h. +Definition at line 80 of file hashcomp.h. .SH "Member Function Documentation" .PP .SS "bool irc::StrHashComp::operator() (const std::string & s1, const std::string & s2) const" diff --git a/docs/man/man3/irc_irc_char_traits.3 b/docs/man/man3/irc_irc_char_traits.3 index d9ea0b512..037a35707 100644 --- a/docs/man/man3/irc_irc_char_traits.3 +++ b/docs/man/man3/irc_irc_char_traits.3 @@ -1,4 +1,4 @@ -.TH "irc::irc_char_traits" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "irc::irc_char_traits" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -42,7 +42,7 @@ 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 89 of file hashcomp.h. +Definition at line 104 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" diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index 226b6797e..aae366a68 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -16,6 +16,10 @@ Inherits \fBExtensible\fP. .in +1c .ti -1c +.RI "\fBircd_connector\fP ()" +.br +.RI "\fIConstructor clears the sendq and initialises the fd to -1. \fP" +.ti -1c .RI "bool \fBMakeOutboundConnection\fP (char *newhost, int newport)" .br .RI "\fICreate an outbound connection to a listening socket. \fP" @@ -72,9 +76,9 @@ Inherits \fBExtensible\fP. .br .RI "\fIClose the connection by calling close() on its file descriptor This function call updates no other data. \fP" .ti -1c -.RI "void \fBAddBuffer\fP (std::string a)" +.RI "bool \fBAddBuffer\fP (std::string a)" .br -.RI "\fIThis method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer. \fP" +.RI "\fIThis method adds text to the ircd connection's buffer This buffer's maximum size is one megabyte, the method returning false if the buffer is full. \fP" .ti -1c .RI "bool \fBBufferIsComplete\fP ()" .br @@ -95,6 +99,34 @@ Inherits \fBExtensible\fP. .RI "std::string \fBGetVersionString\fP ()" .br .RI "\fIThis method returns the version string of the remote server. \fP" +.ti -1c +.RI "bool \fBAddWriteBuf\fP (std::string data)" +.br +.RI "\fIAdds data to the connection's sendQ to be flushed later Fails if there is an error pending on the connection. \fP" +.ti -1c +.RI "bool \fBFlushWriteBuf\fP ()" +.br +.RI "\fIFlushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. \fP" +.ti -1c +.RI "void \fBSetWriteError\fP (std::string error)" +.br +.RI "\fISets the error string for this connection. \fP" +.ti -1c +.RI "std::string \fBGetWriteError\fP ()" +.br +.RI "\fIGets the error string for this connection. \fP" +.ti -1c +.RI "bool \fBHasBufferedOutput\fP ()" +.br +.RI "\fIReturns true if there is data to be written that hasn't been sent yet. \fP" +.ti -1c +.RI "bool \fBCheckPing\fP ()" +.br +.RI "\fIChecks if the connection replied to its last ping, and if it did sends another and returns true, if not, returns false. \fP" +.ti -1c +.RI "void \fBResetPing\fP ()" +.br +.RI "\fIResets the ping counter. \fP" .in -1c .SS "Public Attributes" @@ -153,6 +185,22 @@ Inherits \fBExtensible\fP. .RI "std::string \fBversion\fP" .br .RI "\fIThis string holds the ircd's version response. \fP" +.ti -1c +.RI "std::string \fBsendq\fP" +.br +.RI "\fISendQ of the outbound connector, does not have a limit. \fP" +.ti -1c +.RI "std::string \fBWriteError\fP" +.br +.RI "\fIWrite error of connection. \fP" +.ti -1c +.RI "time_t \fBnextping\fP" +.br +.RI "\fITime this connection was last pinged. \fP" +.ti -1c +.RI "bool \fBreplied\fP" +.br +.RI "\fIDid this connection reply to its last ping? \fP" .in -1c .SH "Detailed Description" .PP @@ -161,20 +209,34 @@ 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 56 of file connection.h. +.SH "Constructor & Destructor Documentation" +.PP +.SS "ircd_connector::ircd_connector ()" +.PP +Constructor clears the sendq and initialises the fd to -1. .SH "Member Function Documentation" .PP -.SS "void ircd_connector::AddBuffer (std::string a)" +.SS "bool ircd_connector::AddBuffer (std::string a)" .PP -This method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer. It is the sending server's responsibility to ensure sent data is kept within reasonable quanities. +This method adds text to the ircd connection's buffer This buffer's maximum size is one megabyte, the method returning false if the buffer is full. +.SS "bool ircd_connector::AddWriteBuf (std::string data)" +.PP +Adds data to the connection's sendQ to be flushed later Fails if there is an error pending on the connection. Referenced by serverrec::SendPacket(). .SS "bool ircd_connector::BufferIsComplete ()" .PP This method returns true if the buffer contains at least one carriage return character, e.g. one line can be read from the buffer successfully. +.SS "bool ircd_connector::CheckPing ()" +.PP +Checks if the connection replied to its last ping, and if it did sends another and returns true, if not, returns false. .SS "void ircd_connector::ClearBuffer ()" .PP This method clears the server's buffer by setting it to an empty string. .SS "void ircd_connector::CloseConnection ()" .PP -Close the connection by calling close() on its file descriptor This function call updates no other data. +Close the connection by calling close() on its file descriptor This function call updates no other data. Referenced by serverrec::SendPacket(). +.SS "bool ircd_connector::FlushWriteBuf ()" +.PP +Flushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. Referenced by serverrec::SendPacket(). .SS "std::string ircd_connector::GetBuffer ()" .PP This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok(). @@ -189,43 +251,55 @@ Get the file descriptor associated with this connection. Get the ip address (not servername) associated with this connection. .SS "std::string ircd_connector::GetServerName ()" .PP -Return the servername on this established connection. +Return the servername on this established connection. Referenced by serverrec::SendPacket(). .SS "int ircd_connector::GetServerPort ()" .PP Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in \fBGetServerIP()\fP. .SS "int ircd_connector::GetState ()" .PP -Get the state flags for this connection. +Get the state flags for this connection. Referenced by serverrec::SendPacket(). .SS "std::string ircd_connector::GetVersionString ()" .PP This method returns the version string of the remote server. If the server has no version string an empty string is returned. +.SS "std::string ircd_connector::GetWriteError ()" +.PP +Gets the error string for this connection. Referenced by serverrec::SendPacket(). +.SS "bool ircd_connector::HasBufferedOutput ()" +.PP +Returns true if there is data to be written that hasn't been sent yet. .SS "bool ircd_connector::MakeOutboundConnection (char * newhost, int newport)" .PP -Create an outbound connection to a listening socket. +Create an outbound connection to a listening socket. Referenced by serverrec::BeginLink(), and serverrec::MeshCookie(). +.SS "void ircd_connector::ResetPing ()" +.PP +Resets the ping counter. .SS "void ircd_connector::SetDescription (std::string desc)" .PP Set the server description of this connection. .SS "void ircd_connector::SetDescriptor (int fd)" .PP -Set the file descriptor for this connection. +Set the file descriptor for this connection. Referenced by serverrec::AddIncoming(). .SS "bool ircd_connector::SetHostAddress (char * host, int port)\fC [private]\fP" .PP PRIVATE function to set the host address and port to connect to. .SS "bool ircd_connector::SetHostAndPort (char * newhost, int newport)" .PP -Set both the host and the port in one operation for this connection. +Set both the host and the port in one operation for this connection. Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), and serverrec::MeshCookie(). .SS "void ircd_connector::SetServerName (std::string serv)" .PP -Set the server name of this connection. +Set the server name of this connection. Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), and serverrec::MeshCookie(). .SS "void ircd_connector::SetServerPort (int p)" .PP Set the port used by this connection. .SS "void ircd_connector::SetState (int state)" .PP -Set the state flags for this connection. +Set the state flags for this connection. Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), serverrec::MeshCookie(), and serverrec::SendPacket(). .SS "void ircd_connector::SetVersionString (std::string newversion)" .PP This method sets the version string of the remote server. +.SS "void ircd_connector::SetWriteError (std::string error)" +.PP +Sets the error string for this connection. .SH "Member Data Documentation" .PP .SS "sockaddr_in \fBircd_connector::addr\fP\fC [private]\fP" @@ -239,18 +313,27 @@ Sockaddr of the outbound ip and port. Definition at line 61 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 101 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 117 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 94 of file connection.h. + seperator. Definition at line 110 of file connection.h. +.SS "time_t \fBircd_connector::nextping\fP\fC [private]\fP" +.PP +Time this connection was last pinged. Definition at line 98 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 107 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 123 of file connection.h. +.SS "bool \fBircd_connector::replied\fP\fC [private]\fP" +.PP +Did this connection reply to its last ping? Definition at line 102 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 113 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 129 of file connection.h. +.SS "std::string \fBircd_connector::sendq\fP\fC [private]\fP" +.PP +SendQ of the outbound connector, does not have a limit. Definition at line 90 of file connection.h. .SS "std::string \fBircd_connector::servername\fP\fC [private]\fP" .PP \fBServer\fP name. Definition at line 69 of file connection.h. @@ -260,6 +343,9 @@ State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTE .SS "std::string \fBircd_connector::version\fP\fC [private]\fP" .PP This string holds the ircd's version response. Definition at line 86 of file connection.h. +.SS "std::string \fBircd_connector::WriteError\fP\fC [private]\fP" +.PP +Write error of connection. Definition at line 94 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 5b7529f6c..9d9feb812 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -36,12 +36,6 @@ message.h \- .RI "void \fBtidystring\fP (char *str)" .br .ti -1c -.RI "void \fBsafedelete\fP (\fBchanrec\fP *p)" -.br -.ti -1c -.RI "void \fBsafedelete\fP (\fBuserrec\fP *p)" -.br -.ti -1c .RI "void \fBBlocking\fP (int s)" .br .ti -1c @@ -125,10 +119,6 @@ Referenced by Server::IsOnChannel(). Referenced by Server::IsNick(). .SS "void NonBlocking (int s)" .PP -.SS "void safedelete (\fBuserrec\fP * p)" -.PP -.SS "void safedelete (\fBchanrec\fP * p)" -.PP .SS "void send_network_quit (const char * nick, const char * reason)" .PP .SS "void TidyBan (char * ban)" diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index 51981f20d..fdf3e5628 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "24 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 1c92ebe6c..1048e84e1 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -208,9 +208,6 @@ modules.cpp \- .RI "time_t \fBnb_start\fP" .br .ti -1c -.RI "std::vector< int > \fBfd_reap\fP" -.br -.ti -1c .RI "std::vector< std::string > \fBmodule_names\fP" .br .ti -1c @@ -272,160 +269,160 @@ modules.cpp \- .PP .SS "typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, \fBirc::InAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 111 of file modules.cpp. +Definition at line 120 of file modules.cpp. .SS "typedef nspace::hash_map<std::string, \fBchanrec\fP*, nspace::hash<string>, \fBirc::StrHashComp\fP> \fBchan_hash\fP" .PP -Definition at line 110 of file modules.cpp. +Definition at line 119 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 113 of file modules.cpp. +Definition at line 122 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 139 of file modules.cpp. +Definition at line 148 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 140 of file modules.cpp. +Definition at line 149 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>, \fBirc::StrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 109 of file modules.cpp. +Definition at line 118 of file modules.cpp. .SS "typedef nspace::hash_map<std::string, \fBWhoWasUser\fP*, nspace::hash<string>, \fBirc::StrHashComp\fP> \fBwhowas_hash\fP" .PP -Definition at line 112 of file modules.cpp. +Definition at line 121 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 209 of file modules.cpp. +Definition at line 218 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -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 } +219 { +220 if (ModeDefined(modechar,type)) { +221 return false; +222 } +223 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +224 return true; +225 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 146 of file modules.cpp. +Definition at line 155 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -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 } +156 { +157 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +158 { +159 if ((i->modechar == modechar) && (i->type == type)) +160 { +161 return true; +162 } +163 } +164 return false; +165 } .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 196 of file modules.cpp. +Definition at line 205 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -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 } +206 { +207 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +208 { +209 if ((i->modechar == modechar) && (i->type == type)) +210 { +211 return i->params_when_off; +212 } +213 } +214 return 0; +215 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 183 of file modules.cpp. +Definition at line 192 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -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 } +193 { +194 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +195 { +196 if ((i->modechar == modechar) && (i->type == type)) +197 { +198 return i->params_when_on; +199 } +200 } +201 return 0; +202 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 170 of file modules.cpp. +Definition at line 179 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -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 } +180 { +181 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +182 { +183 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +184 { +185 return true; +186 } +187 } +188 return false; +189 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP -Definition at line 158 of file modules.cpp. +Definition at line 167 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -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 } +168 { +169 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +170 { +171 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +172 { +173 return true; +174 } +175 } +176 return false; +177 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 219 of file modules.cpp. +Definition at line 228 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -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 } +229 { +230 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +231 { +232 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +233 { +234 i->list = true; +235 return; +236 } +237 } +238 return; +239 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -433,146 +430,143 @@ Referenced by Server::AddExtendedListMode(). .PP .SS "char \fBAdminEmail\fP[MAXBUF]" .PP -Definition at line 72 of file modules.cpp. +Definition at line 82 of file modules.cpp. .SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 71 of file modules.cpp. +Definition at line 81 of file modules.cpp. .SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 73 of file modules.cpp. +Definition at line 83 of file modules.cpp. .SS "std::vector<long> \fBauth_cookies\fP" .PP -Definition at line 100 of file modules.cpp. +Definition at line 109 of file modules.cpp. .SS "int \fBboundPortCount\fP" .PP -Definition at line 94 of file modules.cpp. +Definition at line 103 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 117 of file modules.cpp. +Definition at line 126 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 116 of file modules.cpp. +Definition at line 125 of file modules.cpp. .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 119 of file modules.cpp. +Definition at line 128 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 101 of file modules.cpp. +Definition at line 110 of file modules.cpp. .SS "int \fBdebugging\fP" .PP -Definition at line 82 of file modules.cpp. +Definition at line 92 of file modules.cpp. .SS "int \fBdefaultRoute\fP" .PP -Definition at line 98 of file modules.cpp. +Definition at line 107 of file modules.cpp. .SS "int \fBDieDelay\fP" .PP -Definition at line 85 of file modules.cpp. +Definition at line 95 of file modules.cpp. .SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 74 of file modules.cpp. +Definition at line 84 of file modules.cpp. .SS "char \fBDieValue\fP[MAXBUF]" .PP -Definition at line 80 of file modules.cpp. +Definition at line 90 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 143 of file modules.cpp. +Definition at line 152 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 63 of file modules.cpp. -.SS "std::vector<int> \fBfd_reap\fP" -.PP -Definition at line 91 of file modules.cpp. +Definition at line 73 of file modules.cpp. .SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]" .PP -Definition at line 107 of file modules.cpp. +Definition at line 116 of file modules.cpp. .PP Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 122 of file modules.cpp. +Definition at line 131 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 78 of file modules.cpp. +Definition at line 88 of file modules.cpp. .SS "FILE* \fBlog_file\fP" .PP -Definition at line 105 of file modules.cpp. +Definition at line 114 of file modules.cpp. .SS "int \fBLogLevel\fP" .PP -Definition at line 67 of file modules.cpp. +Definition at line 77 of file modules.cpp. .SS "int \fBMaxWhoResults\fP" .PP -Definition at line 88 of file modules.cpp. +Definition at line 98 of file modules.cpp. .SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 103 of file modules.cpp. +Definition at line 112 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 996 of file modules.cpp. +Definition at line 1016 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP -Definition at line 92 of file modules.cpp. +Definition at line 101 of file modules.cpp. .SS "std::vector<\fBModule\fP*> modules" .PP -Definition at line 62 of file modules.cpp. +Definition at line 72 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 120 of file modules.cpp. +Definition at line 129 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 76 of file modules.cpp. +Definition at line 86 of file modules.cpp. .SS "time_t \fBnb_start\fP" .PP -Definition at line 89 of file modules.cpp. +Definition at line 99 of file modules.cpp. .SS "int \fBNetBufferSize\fP" .PP -Definition at line 87 of file modules.cpp. +Definition at line 97 of file modules.cpp. .SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 69 of file modules.cpp. +Definition at line 79 of file modules.cpp. .SS "int \fBportCount\fP" .PP -Definition at line 95 of file modules.cpp. +Definition at line 104 of file modules.cpp. .SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 97 of file modules.cpp. +Definition at line 106 of file modules.cpp. .SS "char \fBPrefixQuit\fP[MAXBUF]" .PP -Definition at line 79 of file modules.cpp. +Definition at line 89 of file modules.cpp. .SS "char \fBrestartpass\fP[MAXBUF]" .PP -Definition at line 75 of file modules.cpp. +Definition at line 85 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 121 of file modules.cpp. +Definition at line 130 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP -Definition at line 77 of file modules.cpp. +Definition at line 87 of file modules.cpp. .SS "char \fBServerDesc\fP[MAXBUF]" .PP -Definition at line 70 of file modules.cpp. +Definition at line 80 of file modules.cpp. .SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 68 of file modules.cpp. +Definition at line 78 of file modules.cpp. .SS "int \fBSERVERportCount\fP" .PP -Definition at line 96 of file modules.cpp. +Definition at line 105 of file modules.cpp. .SS "time_t \fBstartup_time\fP" .PP -Definition at line 86 of file modules.cpp. +Definition at line 96 of file modules.cpp. .SS "time_t \fBTIME\fP" .PP -Definition at line 65 of file modules.cpp. +Definition at line 75 of file modules.cpp. .SS "\fBwhowas_hash\fP \fBwhowas\fP" .PP -Definition at line 118 of file modules.cpp. +Definition at line 127 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP -Definition at line 84 of file modules.cpp. +Definition at line 94 of file modules.cpp. .SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 83 of file modules.cpp. +Definition at line 93 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 38bf3733a..d33285313 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -252,7 +252,7 @@ Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigR .PP Definition at line 23 of file modules.h. .PP -Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), chanrec::SetCustomModeParam(), userrec::SetWriteError(), and Server::UserToPseudo(). +Referenced by Server::AddExtendedMode(), serverrec::AddIncoming(), chanrec::AddUser(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IsCustomModeSet(), serverrec::RecvPacket(), userrec::RemoveInvite(), serverrec::SendPacket(), chanrec::SetCustomMode(), chanrec::SetCustomModeParam(), userrec::SetWriteError(), and Server::UserToPseudo(). .SS "#define DEFAULT 30" .PP Definition at line 25 of file modules.h. diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index cbe375840..ef0f57177 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "24 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 a21b8fa75..3cb96ec0c 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 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index 58c32c257..4821ed0a5 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 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 6dd9d4387..128d70f37 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -27,6 +27,42 @@ Inherits \fBconnection\fP. .RI "\fB~serverrec\fP ()" .br .RI "\fIDestructor. \fP" +.ti -1c +.RI "bool \fBCreateListener\fP (char *\fBhost\fP, int p)" +.br +.RI "\fICreate a listening socket on 'host' using port number 'p'. \fP" +.ti -1c +.RI "bool \fBBeginLink\fP (char *targethost, int \fBport\fP, char *password, char *servername, int myport)" +.br +.RI "\fIBegin an outbound link to another ircd at targethost. \fP" +.ti -1c +.RI "bool \fBMeshCookie\fP (char *targethost, int \fBport\fP, unsigned long cookie, char *servername)" +.br +.RI "\fIBegin an outbound mesh link to another ircd on a network you are already an authenticated member of. \fP" +.ti -1c +.RI "void \fBTerminateLink\fP (char *targethost)" +.br +.RI "\fITerminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method. \fP" +.ti -1c +.RI "bool \fBSendPacket\fP (char *message, const char *\fBhost\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, std::deque< std::string > &sums)" +.br +.RI "\fIReturns the next available packet and returns true if data is available. \fP" +.ti -1c +.RI "\fBircd_connector\fP * \fBFindHost\fP (std::string \fBhost\fP)" +.br +.RI "\fIFind the \fBircd_connector\fP oject related to a certain servername given in 'host'. \fP" +.ti -1c +.RI "bool \fBAddIncoming\fP (int \fBfd\fP, char *targethost, int sourceport)" +.br +.RI "\fIAdd an incoming connection to the connection pool. \fP" +.ti -1c +.RI "void \fBFlushWriteBuffers\fP ()" +.br +.RI "\fIFlushes all data waiting to be written for all of this server's connections. \fP" .in -1c .SS "Public Attributes" @@ -74,6 +110,10 @@ Inherits \fBconnection\fP. .ti -1c .RI "bool \fBsync_soon\fP" .br +.ti -1c +.RI "std::vector< \fBircd_connector\fP > \fBconnectors\fP" +.br +.RI "\fIWith a serverrec, this is a list of all established server connections. \fP" .in -1c .SH "Detailed Description" .PP @@ -82,54 +122,476 @@ A class that defines the local server or a remote server. Definition at line 30 .PP .SS "serverrec::serverrec ()" .PP -Constructor. Definition at line 27 of file servers.cpp. +Constructor. Definition at line 42 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. +References connectors, connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, TIME, usercount, usercount_i, and version. .PP .nf -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 } +43 { +44 strlcpy(name,'',256); +45 pingtime = 0; +46 lastping = TIME; +47 usercount_i = usercount = opercount = version = 0; +48 hops_away = 1; +49 signon = TIME; +50 jupiter = false; +51 fd = 0; +52 sync_soon = false; +53 strlcpy(nickserv,'',NICKMAX); +54 connectors.clear(); +55 } .fi .SS "serverrec::serverrec (char * n, long ver, bool jupe)" .PP -Constructor which initialises some of the main variables. Definition at line 46 of file servers.cpp. +Constructor which initialises some of the main variables. Definition at line 62 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. +References connectors, connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, TIME, usercount, usercount_i, and version. .PP .nf -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 } +63 { +64 strlcpy(name,n,256); +65 lastping = TIME; +66 usercount_i = usercount = opercount = 0; +67 version = ver; +68 hops_away = 1; +69 signon = TIME; +70 jupiter = jupe; +71 fd = 0; +72 sync_soon = false; +73 strlcpy(nickserv,'',NICKMAX); +74 connectors.clear(); +75 } .fi .SS "serverrec::~\fBserverrec\fP ()" .PP -Destructor. Definition at line 42 of file servers.cpp. +Destructor. Definition at line 58 of file servers.cpp. .PP .nf -43 { -44 } +59 { +60 } +.fi +.SH "Member Function Documentation" +.PP +.SS "bool serverrec::AddIncoming (int fd, char * targethost, int sourceport)" +.PP +Add an incoming connection to the connection pool. (reserved for core use) Definition at line 207 of file servers.cpp. +.PP +References connectors, DEBUG, ircd_connector::SetDescriptor(), ircd_connector::SetHostAndPort(), ircd_connector::SetServerName(), ircd_connector::SetState(), and STATE_NOAUTH_INBOUND. +.PP +.nf +208 { +209 ircd_connector connector; +210 +211 // targethost has been turned into an ip... +212 // we dont want this as the server name. +213 connector.SetServerName(targethost); +214 connector.SetDescriptor(newfd); +215 connector.SetState(STATE_NOAUTH_INBOUND); +216 int flags = fcntl(newfd, F_GETFL, 0); +217 fcntl(newfd, F_SETFL, flags | O_NONBLOCK); +218 int sendbuf = 32768; +219 int recvbuf = 32768; +220 setsockopt(newfd,SOL_SOCKET,SO_SNDBUF,(const void *)&sendbuf,sizeof(sendbuf)); +221 setsockopt(newfd,SOL_SOCKET,SO_RCVBUF,(const void *)&recvbuf,sizeof(sendbuf)); +222 connector.SetHostAndPort(targethost, sourceport); +223 connector.SetState(STATE_NOAUTH_INBOUND); +224 log(DEBUG,'serverrec::AddIncoming() Added connection: %s:%d',targethost,sourceport); +225 this->connectors.push_back(connector); +226 return true; +227 } +.fi +.SS "bool serverrec::BeginLink (char * targethost, int port, char * password, char * servername, int myport)" +.PP +Begin an outbound link to another ircd at targethost. Definition at line 138 of file servers.cpp. +.PP +References connectors, connection::fd, FindHost(), ircd_connector::MakeOutboundConnection(), SendPacket(), ircd_connector::SetHostAndPort(), ircd_connector::SetServerName(), ircd_connector::SetState(), STATE_DISCONNECTED, and STATE_NOAUTH_OUTBOUND. +.PP +.nf +139 { +140 char connect[MAXBUF]; +141 +142 ircd_connector connector; +143 ircd_connector *cn = this->FindHost(servername); +144 +145 +146 if (cn) +147 { +148 WriteOpers('CONNECT aborted: Server %s already exists',servername); +149 return false; +150 } +151 +152 +153 if (this->fd) +154 { +155 if (connector.MakeOutboundConnection(targethost,newport)) +156 { +157 // targethost has been turned into an ip... +158 // we dont want this as the server name. +159 connector.SetServerName(servername); +160 snprintf(connect,MAXBUF,'S %s %s %lu %s :%s',getservername().c_str(),password,(unsigned long)myport,GetRevision().c_str(),getserverdesc().c_str()); +161 connector.SetState(STATE_NOAUTH_OUTBOUND); +162 connector.SetHostAndPort(targethost, newport); +163 this->connectors.push_back(connector); +164 return this->SendPacket(connect, servername); +165 } +166 else +167 { +168 connector.SetState(STATE_DISCONNECTED); +169 WriteOpers('Could not create outbound connection to %s:%d',targethost,newport); +170 } +171 } +172 return false; +173 } +.fi +.SS "bool serverrec::CreateListener (char * host, int p)" +.PP +Create a listening socket on 'host' using port number 'p'. Definition at line 77 of file servers.cpp. +.PP +References connection::fd, MaxConn, and connection::port. +.PP +.nf +78 { +79 sockaddr_in host_address; +80 int flags; +81 in_addr addy; +82 int on = 0; +83 struct linger linger = { 0 }; +84 +85 this->port = p; +86 +87 fd = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); +88 if (fd <= 0) +89 { +90 return false; +91 } +92 +93 setsockopt(fd,SOL_SOCKET,SO_REUSEADDR,(const char*)&on,sizeof(on)); +94 linger.l_onoff = 1; +95 linger.l_linger = 1; +96 setsockopt(fd,SOL_SOCKET,SO_LINGER,(const char*)&linger,sizeof(linger)); +97 +98 // attempt to increase socket sendq and recvq as high as its possible +99 // to get them on linux. +100 int sendbuf = 32768; +101 int recvbuf = 32768; +102 setsockopt(fd,SOL_SOCKET,SO_SNDBUF,(const void *)&sendbuf,sizeof(sendbuf)); +103 setsockopt(fd,SOL_SOCKET,SO_RCVBUF,(const void *)&recvbuf,sizeof(sendbuf)); +104 +105 memset((void*)&host_address, 0, sizeof(host_address)); +106 +107 host_address.sin_family = AF_INET; +108 +109 if (!strcmp(newhost,'')) +110 { +111 host_address.sin_addr.s_addr = htonl(INADDR_ANY); +112 } +113 else +114 { +115 inet_aton(newhost,&addy); +116 host_address.sin_addr = addy; +117 } +118 +119 host_address.sin_port = htons(p); +120 +121 if (bind(fd,(sockaddr*)&host_address,sizeof(host_address))<0) +122 { +123 return false; +124 } +125 +126 // make the socket non-blocking +127 flags = fcntl(fd, F_GETFL, 0); +128 fcntl(fd, F_SETFL, flags | O_NONBLOCK); +129 +130 this->port = p; +131 +132 listen(this->fd, MaxConn); +133 +134 return true; +135 } +.fi +.SS "\fBircd_connector\fP * serverrec::FindHost (std::string host)" +.PP +Find the \fBircd_connector\fP oject related to a certain servername given in 'host'. Definition at line 237 of file servers.cpp. +.PP +References connectors. +.PP +Referenced by BeginLink(), and SendPacket(). +.PP +.nf +238 { +239 for (int i = 0; i < this->connectors.size(); i++) +240 { +241 if (this->connectors[i].GetServerName() == findhost) +242 { +243 return &this->connectors[i]; +244 } +245 } +246 return NULL; +247 } +.fi +.SS "void serverrec::FlushWriteBuffers ()" +.PP +Flushes all data waiting to be written for all of this server's connections. Definition at line 249 of file servers.cpp. +.PP +References connectors, and STATE_DISCONNECTED. +.PP +.nf +250 { +251 for (int i = 0; i < this->connectors.size(); i++) +252 { +253 if (this->connectors[i].GetState() != STATE_DISCONNECTED) +254 { +255 if (!this->connectors[i].CheckPing()) +256 { +257 WriteOpers('*** Lost single connection to %s: Ping timeout',this->connectors[i].GetServerName().c_str()); +258 this->connectors[i].CloseConnection(); +259 this->connectors[i].SetState(STATE_DISCONNECTED); +260 } +261 } +262 if (this->connectors[i].HasBufferedOutput()) +263 { +264 if (!this->connectors[i].FlushWriteBuf()) +265 { +266 // if we're here the write() caused an error, we cannot proceed +267 WriteOpers('*** Lost single connection to %s, link inactive and retrying: %s',this->connectors[i].GetServerName().c_str(),this->connectors[i].GetWriteError().c_str()); +268 this->connectors[i].CloseConnection(); +269 this->connectors[i].SetState(STATE_DISCONNECTED); +270 } +271 } +272 } +273 } +.fi +.SS "bool serverrec::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. Definition at line 176 of file servers.cpp. +.PP +References connectors, connection::fd, ircd_connector::MakeOutboundConnection(), SendPacket(), ircd_connector::SetHostAndPort(), ircd_connector::SetServerName(), ircd_connector::SetState(), STATE_CONNECTED, STATE_DISCONNECTED, and STATE_NOAUTH_OUTBOUND. +.PP +.nf +177 { +178 char connect[MAXBUF]; +179 +180 ircd_connector connector; +181 +182 WriteOpers('Establishing meshed link to %s:%d',servername,newport); +183 +184 if (this->fd) +185 { +186 if (connector.MakeOutboundConnection(targethost,newport)) +187 { +188 // targethost has been turned into an ip... +189 // we dont want this as the server name. +190 connector.SetServerName(servername); +191 snprintf(connect,MAXBUF,'- %lu %s :%s',cookie,getservername().c_str(),getserverdesc().c_str()); +192 connector.SetState(STATE_NOAUTH_OUTBOUND); +193 connector.SetHostAndPort(targethost, newport); +194 connector.SetState(STATE_CONNECTED); +195 this->connectors.push_back(connector); +196 return this->SendPacket(connect, servername); +197 } +198 else +199 { +200 connector.SetState(STATE_DISCONNECTED); +201 WriteOpers('Could not create outbound connection to %s:%d',targethost,newport); +202 } +203 } +204 return false; +205 } +.fi +.SS "bool serverrec::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. Definition at line 370 of file servers.cpp. +.PP +References already_have_sum(), connectors, DEBUG, and STATE_DISCONNECTED. +.PP +.nf +371 { +372 char data[65536]; +373 memset(data, 0, 65536); +374 for (int i = 0; i < this->connectors.size(); i++) +375 { +376 if (this->connectors[i].GetState() != STATE_DISCONNECTED) +377 { +378 // returns false if the packet could not be sent (e.g. target host down) +379 int rcvsize = 0; +380 +381 // check if theres any data on this socket +382 // if not, continue onwards to the next. +383 pollfd polls; +384 polls.fd = this->connectors[i].GetDescriptor(); +385 polls.events = POLLIN; +386 int ret = poll(&polls,1,1); +387 if (ret <= 0) continue; +388 +389 rcvsize = recv(this->connectors[i].GetDescriptor(),data,65000,0); +390 data[rcvsize] = '\0'; +391 if (rcvsize == -1) +392 { +393 if (errno != EAGAIN) +394 { +395 log(DEBUG,'recv() failed for serverrec::RecvPacket(): %s',strerror(errno)); +396 log(DEBUG,'Disabling connector: %s',this->connectors[i].GetServerName().c_str()); +397 this->connectors[i].CloseConnection(); +398 this->connectors[i].SetState(STATE_DISCONNECTED); +399 } +400 } +401 int pushed = 0; +402 if (rcvsize > 0) +403 { +404 if (!this->connectors[i].AddBuffer(data)) +405 { +406 WriteOpers('*** Read buffer for %s exceeds maximum, closing connection!',this->connectors[i].GetServerName().c_str()); +407 this->connectors[i].CloseConnection(); +408 this->connectors[i].SetState(STATE_DISCONNECTED); +409 } +410 if (this->connectors[i].BufferIsComplete()) +411 { +412 this->connectors[i].ResetPing(); +413 while (this->connectors[i].BufferIsComplete()) +414 { +415 std::string text = this->connectors[i].GetBuffer(); +416 if (text != '') +417 { +418 if ((text[0] == ':') && (text.find(' ') != std::string::npos)) +419 { +420 std::string orig = text; +421 log(DEBUG,'Original: %s',text.c_str()); +422 std::string sum = text.substr(1,text.find(' ')-1); +423 text = text.substr(text.find(' ')+1,text.length()); +424 std::string possible_token = text.substr(1,text.find(' ')-1); +425 if (possible_token.length() > 1) +426 { +427 sums.push_back('*'); +428 text = orig; +429 log(DEBUG,'Non-mesh, non-tokenized string passed up the chain'); +430 } +431 else +432 { +433 log(DEBUG,'Packet sum: '%s'',sum.c_str()); +434 if ((already_have_sum(sum)) && (sum != '*')) +435 { +436 // we don't accept dupes +437 continue; +438 } +439 sums.push_back(sum.c_str()); +440 } +441 } +442 else sums.push_back('*'); +443 messages.push_back(text.c_str()); +444 strlcpy(recvhost,this->connectors[i].GetServerName().c_str(),160); +445 log(DEBUG,'serverrec::RecvPacket() %d:%s->%s',pushed++,recvhost,text.c_str()); +446 } +447 } +448 return true; +449 } +450 } +451 } +452 } +453 // nothing new yet -- message and host will be undefined +454 return false; +455 } +.fi +.SS "bool serverrec::SendPacket (char * message, const char * host)" +.PP +Send 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. Definition at line 275 of file servers.cpp. +.PP +References ircd_connector::AddWriteBuf(), ircd_connector::CloseConnection(), connectors, DEBUG, FindHost(), ircd_connector::FlushWriteBuf(), ircd_connector::GetServerName(), ircd_connector::GetState(), ircd_connector::GetWriteError(), ircd_connector::SetState(), and STATE_DISCONNECTED. +.PP +Referenced by BeginLink(), and MeshCookie(). +.PP +.nf +276 { +277 if ((!message) || (!sendhost)) +278 return true; +279 +280 ircd_connector* cn = this->FindHost(sendhost); +281 +282 if (!strchr(message,'\n')) +283 { +284 strlcat(message,'\n',MAXBUF); +285 } +286 +287 if (cn) +288 { +289 log(DEBUG,'main: serverrec::SendPacket() sent '%s' to %s',message,cn->GetServerName().c_str()); +290 +291 if (cn->GetState() == STATE_DISCONNECTED) +292 { +293 // fix: can only route one hop to avoid a loop +294 if (strncmp(message,'R ',2)) +295 { +296 log(DEBUG,'Not a double reroute'); +297 // this route is down, we must re-route the packet through an available point in the mesh. +298 for (int k = 0; k < this->connectors.size(); k++) +299 { +300 log(DEBUG,'Check connector %d: %s',k,this->connectors[k].GetServerName().c_str()); +301 // search for another point in the mesh which can 'reach' where we want to go +302 for (int m = 0; m < this->connectors[k].routes.size(); m++) +303 { +304 if (!strcasecmp(this->connectors[k].routes[m].c_str(),sendhost)) +305 { +306 log(DEBUG,'Found alternative route for packet: %s',this->connectors[k].GetServerName().c_str()); +307 char buffer[MAXBUF]; +308 snprintf(buffer,MAXBUF,'R %s %s',sendhost,message); +309 this->SendPacket(buffer,this->connectors[k].GetServerName().c_str()); +310 return true; +311 } +312 } +313 } +314 } +315 char buffer[MAXBUF]; +316 snprintf(buffer,MAXBUF,'& %s',sendhost); +317 WriteOpers('*** All connections to %s lost.',sendhost); +318 NetSendToAllExcept(sendhost,buffer); +319 DoSplit(sendhost); +320 return false; +321 } +322 +323 // returns false if the packet could not be sent (e.g. target host down) +324 if (!cn->AddWriteBuf(message)) +325 { +326 // if we're here, there was an error pending, and the send cannot proceed +327 log(DEBUG,'cn->AddWriteBuf() failed for serverrec::SendPacket(): %s',cn->GetWriteError().c_str()); +328 log(DEBUG,'Disabling connector: %s',cn->GetServerName().c_str()); +329 cn->CloseConnection(); +330 cn->SetState(STATE_DISCONNECTED); +331 WriteOpers('*** Lost single connection to %s, link inactive and retrying: %s',cn->GetServerName().c_str(),cn->GetWriteError().c_str()); +332 // retry the packet along a new route so either arrival OR failure are gauranteed (bugfix) +333 return this->SendPacket(message,sendhost); +334 } +335 if (!cn->FlushWriteBuf()) +336 { +337 // if we're here the write() caused an error, we cannot proceed +338 log(DEBUG,'cn->FlushWriteBuf() failed for serverrec::SendPacket(): %s',cn->GetWriteError().c_str()); +339 log(DEBUG,'Disabling connector: %s',cn->GetServerName().c_str()); +340 cn->CloseConnection(); +341 cn->SetState(STATE_DISCONNECTED); +342 WriteOpers('*** Lost single connection to %s, link inactive and retrying: %s',cn->GetServerName().c_str(),cn->GetWriteError().c_str()); +343 // retry the packet along a new route so either arrival OR failure are gauranteed +344 return this->SendPacket(message,sendhost); +345 } +346 return true; +347 } +348 } +.fi +.SS "void serverrec::TerminateLink (char * targethost)" +.PP +Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnection\fP method. Definition at line 229 of file servers.cpp. +.PP +.nf +230 { +231 // this locates the targethost in the serverrec::connectors vector of the class, +232 // and terminates it by sending it an SQUIT token and closing its descriptor. +233 // TerminateLink with a null string causes a terminate of ALL links +234 } .fi .SH "Member Data Documentation" .PP +.SS "std::vector<\fBircd_connector\fP> \fBserverrec::connectors\fP" +.PP +With a serverrec, this is a list of all established server connections. Definition at line 81 of file servers.h. +.PP +Referenced by AddIncoming(), BeginLink(), FindHost(), FlushWriteBuffers(), MeshCookie(), RecvPacket(), SendPacket(), and serverrec(). .SS "char \fBserverrec::description\fP[MAXBUF]" .PP Description of the server. Definition at line 61 of file servers.h. diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index af036f7c6..02500d311 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -12,7 +12,25 @@ servers.cpp \- .br \fC#include 'inspircd.h'\fP .br -\fC#include <stdio.h>\fP +\fC#include <unistd.h>\fP +.br +\fC#include <fcntl.h>\fP +.br +\fC#include <poll.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 <vector>\fP +.br +\fC#include <string>\fP +.br +\fC#include <deque>\fP +.br +\fC#include <sstream>\fP .br \fC#include <map>\fP .br @@ -20,19 +38,71 @@ servers.cpp \- .br \fC#include 'helperfuncs.h'\fP .br +\fC#include 'connection.h'\fP +.br + +.SS "Functions" +.in +1c +.ti -1c +.RI "bool \fBalready_have_sum\fP (std::string sum)" +.br +.in -1c .SS "Variables" .in +1c .ti -1c .RI "time_t \fBTIME\fP" .br +.ti -1c +.RI "int \fBMaxConn\fP" +.br +.ti -1c +.RI "std::deque< std::string > \fBxsums\fP" +.br .in -1c +.SH "Function Documentation" +.PP +.SS "bool already_have_sum (std::string sum)" +.PP +Definition at line 350 of file servers.cpp. +.PP +References xsums. +.PP +Referenced by serverrec::RecvPacket(). +.PP +.nf +351 { +352 for (int i = 0; i < xsums.size(); i++) +353 { +354 if (xsums[i] == sum) +355 { +356 return true; +357 } +358 } +359 if (xsums.size() >= 128) +360 { +361 xsums.pop_front(); +362 } +363 xsums.push_back(sum); +364 return false; +365 } +.fi .SH "Variable Documentation" .PP +.SS "int \fBMaxConn\fP" +.PP +Definition at line 38 of file servers.cpp. +.PP +Referenced by serverrec::CreateListener(). .SS "time_t \fBTIME\fP" .PP -Definition at line 25 of file servers.cpp. +Definition at line 37 of file servers.cpp. +.SS "std::deque<std::string> \fBxsums\fP" +.PP +Definition at line 40 of file servers.cpp. +.PP +Referenced by already_have_sum(). .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 a048d2a6e..19096a747 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 6d1a2ae72..3299bba05 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "24 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 index 64a98bafc..b53703016 100644 --- a/docs/man/man3/std_char_traits.3 +++ b/docs/man/man3/std_char_traits.3 @@ -1,4 +1,4 @@ -.TH "std::char_traits" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "std::char_traits" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index efe396234..7a868658d 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 61e70f590..427011fd8 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -46,6 +46,10 @@ Inherits \fBconnection\fP. .br .RI "\fIReturns true or false for if a user can execute a privilaged oper command. \fP" .ti -1c +.RI "int \fBReadData\fP (void *buffer, size_t size)" +.br +.RI "\fICalls read() to read some data for this user using their fd. \fP" +.ti -1c .RI "bool \fBAddBuffer\fP (std::string a)" .br .RI "\fIThis method adds data to the buffer of the user. \fP" @@ -81,6 +85,10 @@ Inherits \fBconnection\fP. .RI "\fBInvitedList\fP * \fBGetInviteList\fP ()" .br .RI "\fIReturns the list of channels this user has been invited to but has not yet joined. \fP" +.ti -1c +.RI "void \fBCloseSocket\fP ()" +.br +.RI "\fIShuts down and closes the user's socket. \fP" .in -1c .SS "Public Attributes" @@ -193,40 +201,40 @@ Definition at line 108 of file users.h. .PP .SS "userrec::userrec ()" .PP -Definition at line 29 of file users.cpp. +Definition at line 31 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 -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 } +32 { +33 // the PROPER way to do it, AVOID bzero at *ALL* costs +34 strcpy(nick,''); +35 strcpy(ip,'127.0.0.1'); +36 timeout = 0; +37 strcpy(ident,''); +38 strcpy(host,''); +39 strcpy(dhost,''); +40 strcpy(fullname,''); +41 strcpy(modes,''); +42 strcpy(server,''); +43 strcpy(awaymsg,''); +44 strcpy(oper,''); +45 reset_due = TIME; +46 lines_in = 0; +47 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +48 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +49 haspassed = false; +50 dns_done = false; +51 recvq = ''; +52 sendq = ''; +53 strcpy(result,''); +54 for (int i = 0; i < MAXCHANS; i++) +55 { +56 this->chans[i].channel = NULL; +57 this->chans[i].uc_modes = 0; +58 } +59 invites.clear(); +60 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP @@ -239,316 +247,341 @@ 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 175 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 190 of file users.cpp. .PP References recvq, recvqmax, and SetWriteError(). .PP .nf -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 } +191 { +192 std::string b = ''; +193 for (int i = 0; i < a.length(); i++) +194 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) +195 b = b + a[i]; +196 std::stringstream stream(recvq); +197 stream << b; +198 recvq = stream.str(); +199 int i = 0; +200 // count the size of the first line in the buffer. +201 while (i < recvq.length()) +202 { +203 if (recvq[i++] == '\n') +204 break; +205 } +206 if (recvq.length() > this->recvqmax) +207 { +208 this->SetWriteError('RecvQ exceeded'); +209 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax); +210 } +211 // return false if we've had more than 600 characters WITHOUT +212 // a carriage return (this is BAD, drop the socket) +213 return (i < 600); +214 } .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 231 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 246 of file users.cpp. .PP References GetWriteError(), sendq, sendqmax, and SetWriteError(). .PP .nf -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 } +247 { +248 if (this->GetWriteError() != '') +249 return; +250 if (sendq.length() + data.length() > this->sendqmax) +251 { +252 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax); +253 this->SetWriteError('SendQ exceeded'); +254 return; +255 } +256 std::stringstream stream; +257 stream << sendq << data; +258 sendq = stream.str(); +259 } .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 201 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 216 of file users.cpp. .PP References recvq. .PP .nf -202 { -203 for (int i = 0; i < recvq.length(); i++) -204 if (recvq[i] == '\n') -205 return true; -206 return false; -207 } +217 { +218 for (int i = 0; i < recvq.length(); i++) +219 if (recvq[i] == '\n') +220 return true; +221 return false; +222 } .fi .SS "void userrec::ClearBuffer ()" .PP -This function clears the entire buffer by setting it to an empty string. Definition at line 209 of file users.cpp. +This function clears the entire buffer by setting it to an empty string. Definition at line 224 of file users.cpp. .PP References recvq. .PP Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). .PP .nf -210 { -211 recvq = ''; -212 } +225 { +226 recvq = ''; +227 } +.fi +.SS "void userrec::CloseSocket ()" +.PP +Shuts down and closes the user's socket. Definition at line 62 of file users.cpp. +.PP +.nf +63 { +64 shutdown(this->fd,2); +65 close(this->fd); +66 } .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 247 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 262 of file users.cpp. .PP References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). .PP .nf -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 } +263 { +264 if (sendq.length()) +265 { +266 char* tb = (char*)this->sendq.c_str(); +267 int n_sent = write(this->fd,tb,this->sendq.length()); +268 if (n_sent == -1) +269 { +270 this->SetWriteError(strerror(errno)); +271 } +272 else +273 { +274 // advance the queue +275 tb += n_sent; +276 this->sendq = tb; +277 // update the user's stats counters +278 this->bytes_out += n_sent; +279 this->cmds_out++; +280 } +281 } +282 } .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 214 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 229 of file users.cpp. .PP References recvq. .PP .nf -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 } +230 { +231 if (recvq == '') +232 return ''; +233 char* line = (char*)recvq.c_str(); +234 std::string ret = ''; +235 while ((*line != '\n') && (strlen(line))) +236 { +237 ret = ret + *line; +238 line++; +239 } +240 if ((*line == '\n') || (*line == '\r')) +241 line++; +242 recvq = line; +243 return ret; +244 } .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 62 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 68 of file users.cpp. .PP References dhost, ident, nick, and result. .PP .nf -63 { -64 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -65 return result; -66 } +69 { +70 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +71 return result; +72 } .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 69 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 84 of file users.cpp. .PP References connection::host, ident, nick, and result. .PP .nf -70 { -71 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -72 return result; -73 } +85 { +86 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +87 return result; +88 } .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. +Returns the list of channels this user has been invited to but has not yet joined. Definition at line 104 of file users.cpp. .PP References InvitedList, and invites. .PP .nf -90 { -91 return &invites; -92 } +105 { +106 return &invites; +107 } .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 277 of file users.cpp. +Returns the write error which last occured on this connection or an empty string if none occured. Definition at line 292 of file users.cpp. .PP References WriteError. .PP Referenced by AddWriteBuf(). .PP .nf -278 { -279 return this->WriteError; -280 } +293 { +294 return this->WriteError; +295 } .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 123 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 138 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -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 } +139 { +140 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +141 char* mycmd; +142 char* savept; +143 char* savept2; +144 +145 // are they even an oper at all? +146 if (strchr(this->modes,'o')) +147 { +148 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +149 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +150 { +151 ConfValue('type','name',j,TypeName,&config_f); +152 if (!strcmp(TypeName,this->oper)) +153 { +154 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +155 ConfValue('type','classes',j,Classes,&config_f); +156 char* myclass = strtok_r(Classes,' ',&savept); +157 while (myclass) +158 { +159 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +160 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +161 { +162 ConfValue('class','name',k,ClassName,&config_f); +163 if (!strcmp(ClassName,myclass)) +164 { +165 ConfValue('class','commands',k,CommandList,&config_f); +166 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); +167 +168 +169 mycmd = strtok_r(CommandList,' ',&savept2); +170 while (mycmd) +171 { +172 if (!strcasecmp(mycmd,command)) +173 { +174 log(DEBUG,'*** Command %s found, returning true',command); +175 return true; +176 } +177 mycmd = strtok_r(NULL,' ',&savept2); +178 } +179 } +180 } +181 myclass = strtok_r(NULL,' ',&savept); +182 } +183 } +184 } +185 } +186 return false; +187 } .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 94 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 109 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -95 { -96 Invited i; -97 strlcpy(i.channel,channel,CHANMAX); -98 invites.push_back(i); -99 } +110 { +111 Invited i; +112 strlcpy(i.channel,channel,CHANMAX); +113 invites.push_back(i); +114 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 75 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 90 of file users.cpp. .PP References invites. .PP .nf -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 } +91 { +92 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +93 { +94 if (i->channel) { +95 if (!strcasecmp(i->channel,channel)) +96 { +97 return true; +98 } +99 } +100 } +101 return false; +102 } +.fi +.SS "int userrec::ReadData (void * buffer, size_t size)" +.PP +Calls read() to read some data for this user using their fd. Definition at line 74 of file users.cpp. +.PP +References connection::fd. +.PP +.nf +75 { +76 if (this->fd > -1) +77 { +78 return read(this->fd, buffer, size); +79 } +80 else return 0; +81 } .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 101 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 116 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -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 } +117 { +118 log(DEBUG,'Removing invites'); +119 if (channel) +120 { +121 if (invites.size()) +122 { +123 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +124 { +125 if (i->channel) +126 { +127 if (!strcasecmp(i->channel,channel)) +128 { +129 invites.erase(i); +130 return; +131 } +132 } +133 } +134 } +135 } +136 } .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 269 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 284 of file users.cpp. .PP References DEBUG, and WriteError. .PP Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf(). .PP .nf -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 } +285 { +286 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str()); +287 // don't try to set the error twice, its already set take the first string. +288 if (this->WriteError == '') +289 this->WriteError = error; +290 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index e8d74655d..e8d42c52b 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -35,10 +35,10 @@ users.cpp \- .PP .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 25 of file users.cpp. +Definition at line 27 of file users.cpp. .SS "time_t \fBTIME\fP" .PP -Definition at line 27 of file users.cpp. +Definition at line 29 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 234320343..99912b9fe 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 65e55d871..3320bdcb6 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "24 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME |