diff options
Diffstat (limited to 'docs/man')
57 files changed, 1335 insertions, 1072 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 6e414dc78..55e088419 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "7 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 306 of file modules.cpp. +Definition at line 304 of file modules.cpp. .PP .nf -306 : Name(name), Email(email), Nick(nick) { }; +304 : 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 5a7e51df0..c1b9d2b62 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 294eec961..303fdf0d9 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -84,239 +84,239 @@ Allows reading of values from configuration files This class allows a module to It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read. .PP -Definition at line 1097 of file modules.h. +Definition at line 1147 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ConfigReader::ConfigReader ()" .PP -Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 835 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 851 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -836 { -837 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -838 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -839 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -840 if (!this->readerror) -841 this->error = CONF_FILE_NOT_FOUND; -842 } +852 { +853 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +854 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +855 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +856 if (!this->readerror) +857 this->error = CONF_FILE_NOT_FOUND; +858 } .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 854 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 870 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -855 { -856 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -857 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -858 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -859 if (!this->readerror) -860 this->error = CONF_FILE_NOT_FOUND; -861 }; +871 { +872 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +873 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +874 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +875 if (!this->readerror) +876 this->error = CONF_FILE_NOT_FOUND; +877 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 845 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 861 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -846 { -847 if (this->cache) -848 delete this->cache; -849 if (this->errorlog) -850 delete this->errorlog; -851 } +862 { +863 if (this->cache) +864 delete this->cache; +865 if (this->errorlog) +866 delete this->errorlog; +867 } .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 932 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 948 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -933 { -934 if (bail) -935 { -936 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -937 exit(0); -938 } -939 else -940 { -941 char dataline[1024]; -942 if (user) -943 { -944 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -945 while (!errorlog->eof()) -946 { -947 errorlog->getline(dataline,1024); -948 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -949 } -950 } -951 else -952 { -953 WriteOpers('There were errors in the configuration file:',user->nick); -954 while (!errorlog->eof()) -955 { -956 errorlog->getline(dataline,1024); -957 WriteOpers(dataline); -958 } -959 } -960 return; -961 } -962 } +949 { +950 if (bail) +951 { +952 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +953 exit(0); +954 } +955 else +956 { +957 char dataline[1024]; +958 if (user) +959 { +960 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +961 while (!errorlog->eof()) +962 { +963 errorlog->getline(dataline,1024); +964 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +965 } +966 } +967 else +968 { +969 WriteOpers('There were errors in the configuration file:',user->nick); +970 while (!errorlog->eof()) +971 { +972 errorlog->getline(dataline,1024); +973 WriteOpers(dataline); +974 } +975 } +976 return; +977 } +978 } .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 965 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 981 of file modules.cpp. .PP References cache. .PP .nf -966 { -967 return EnumConf(cache,tag.c_str()); -968 } +982 { +983 return EnumConf(cache,tag.c_str()); +984 } .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 970 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 986 of file modules.cpp. .PP References cache. .PP .nf -971 { -972 return EnumValues(cache, tag.c_str(), index); -973 } +987 { +988 return EnumValues(cache, tag.c_str(), index); +989 } .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 925 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 941 of file modules.cpp. .PP References error. .PP .nf -926 { -927 long olderr = this->error; -928 this->error = 0; -929 return olderr; -930 } +942 { +943 long olderr = this->error; +944 this->error = 0; +945 return olderr; +946 } .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 879 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 895 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -880 { -881 char val[MAXBUF]; -882 char t[MAXBUF]; -883 char n[MAXBUF]; -884 strlcpy(t,tag.c_str(),MAXBUF); -885 strlcpy(n,name.c_str(),MAXBUF); -886 int res = ReadConf(cache,t,n,index,val); -887 if (!res) -888 { -889 this->error = CONF_VALUE_NOT_FOUND; -890 return false; -891 } -892 std::string s = val; -893 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -894 } +896 { +897 char val[MAXBUF]; +898 char t[MAXBUF]; +899 char n[MAXBUF]; +900 strlcpy(t,tag.c_str(),MAXBUF); +901 strlcpy(n,name.c_str(),MAXBUF); +902 int res = ReadConf(cache,t,n,index,val); +903 if (!res) +904 { +905 this->error = CONF_VALUE_NOT_FOUND; +906 return false; +907 } +908 std::string s = val; +909 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +910 } .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 896 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 912 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -897 { -898 char val[MAXBUF]; -899 char t[MAXBUF]; -900 char n[MAXBUF]; -901 strlcpy(t,tag.c_str(),MAXBUF); -902 strlcpy(n,name.c_str(),MAXBUF); -903 int res = ReadConf(cache,t,n,index,val); -904 if (!res) -905 { -906 this->error = CONF_VALUE_NOT_FOUND; -907 return 0; -908 } -909 for (int i = 0; i < strlen(val); i++) -910 { -911 if (!isdigit(val[i])) -912 { -913 this->error = CONF_NOT_A_NUMBER; -914 return 0; -915 } -916 } -917 if ((needs_unsigned) && (atoi(val)<0)) -918 { -919 this->error = CONF_NOT_UNSIGNED; -920 return 0; -921 } -922 return atoi(val); -923 } +913 { +914 char val[MAXBUF]; +915 char t[MAXBUF]; +916 char n[MAXBUF]; +917 strlcpy(t,tag.c_str(),MAXBUF); +918 strlcpy(n,name.c_str(),MAXBUF); +919 int res = ReadConf(cache,t,n,index,val); +920 if (!res) +921 { +922 this->error = CONF_VALUE_NOT_FOUND; +923 return 0; +924 } +925 for (int i = 0; i < strlen(val); i++) +926 { +927 if (!isdigit(val[i])) +928 { +929 this->error = CONF_NOT_A_NUMBER; +930 return 0; +931 } +932 } +933 if ((needs_unsigned) && (atoi(val)<0)) +934 { +935 this->error = CONF_NOT_UNSIGNED; +936 return 0; +937 } +938 return atoi(val); +939 } .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 863 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 879 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -864 { -865 char val[MAXBUF]; -866 char t[MAXBUF]; -867 char n[MAXBUF]; -868 strlcpy(t,tag.c_str(),MAXBUF); -869 strlcpy(n,name.c_str(),MAXBUF); -870 int res = ReadConf(cache,t,n,index,val); -871 if (!res) -872 { -873 this->error = CONF_VALUE_NOT_FOUND; -874 return ''; -875 } -876 return std::string(val); -877 } +880 { +881 char val[MAXBUF]; +882 char t[MAXBUF]; +883 char n[MAXBUF]; +884 strlcpy(t,tag.c_str(),MAXBUF); +885 strlcpy(n,name.c_str(),MAXBUF); +886 int res = ReadConf(cache,t,n,index,val); +887 if (!res) +888 { +889 this->error = CONF_VALUE_NOT_FOUND; +890 return ''; +891 } +892 return std::string(val); +893 } .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 975 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 991 of file modules.cpp. .PP References readerror. .PP .nf -976 { -977 return this->readerror; -978 } +992 { +993 return this->readerror; +994 } .fi .SH "Member Data Documentation" .PP .SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP" .PP -The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 1105 of file modules.h. +The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 1155 of file modules.h. .PP Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader(). .SS "long \fBConfigReader::error\fP\fC [protected]\fP" .PP -Definition at line 1110 of file modules.h. +Definition at line 1160 of file modules.h. .PP Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP" .PP -Definition at line 1106 of file modules.h. +Definition at line 1156 of file modules.h. .PP Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader(). .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP" .PP -Used to store errors. Definition at line 1109 of file modules.h. +Used to store errors. Definition at line 1159 of file modules.h. .PP Referenced by ConfigReader(), and Verify(). diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index 563c7368c..0721962c6 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -46,6 +46,10 @@ Inherits \fBclassbase\fP. .RI "char \fBpass\fP [MAXBUF]" .br .RI "\fI(Optional) Password for this line \fP" +.ti -1c +.RI "long \fBthreshold\fP" +.br +.RI "\fIThreshold value for flood disconnect. \fP" .in -1c .SH "Detailed Description" .PP @@ -54,18 +58,19 @@ Holds information relevent to <connect allow> and <connect deny> tags in the con .PP .SS "ConnectClass::ConnectClass ()\fC [inline]\fP" .PP -Definition at line 67 of file users.h. +Definition at line 71 of file users.h. .PP -References flood, host, pass, pingtime, and registration_timeout. +References flood, host, pass, pingtime, registration_timeout, and threshold. .PP .nf -68 { -69 registration_timeout = 0; -70 flood = 0; -71 pingtime = 0; -72 strlcpy(host,'',MAXBUF); -73 strlcpy(pass,'',MAXBUF); -74 } +72 { +73 registration_timeout = 0; +74 flood = 0; +75 pingtime = 0; +76 threshold = 0; +77 strlcpy(host,'',MAXBUF); +78 strlcpy(pass,'',MAXBUF); +79 } .fi .SH "Member Data Documentation" .PP @@ -94,6 +99,11 @@ Referenced by ConnectClass(). Max time to register the connection in seconds. Definition at line 53 of file users.h. .PP Referenced by ConnectClass(). +.SS "long \fBConnectClass::threshold\fP" +.PP +Threshold value for flood disconnect. Definition at line 69 of file users.h. +.PP +Referenced by ConnectClass(). .SS "int \fBConnectClass::type\fP" .PP Type of line, either CC_ALLOW or CC_DENY. Definition at line 50 of file users.h. diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index 8ca9f17b4..cb54283c9 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index dac7540a1..1dbd2376f 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Event.3 b/docs/man/man3/Event.3 index 40a9d4ea8..0c5e83e40 100644 --- a/docs/man/man3/Event.3 +++ b/docs/man/man3/Event.3 @@ -1,4 +1,4 @@ -.TH "Event" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Event" 3 "7 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 337 of file modules.cpp. +Create a new Event. Definition at line 335 of file modules.cpp. .PP .nf -337 : data(anydata), source(src), id(eventid) { }; +335 : data(anydata), source(src), id(eventid) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Event::GetData ()" .PP -Get the Event data. Definition at line 339 of file modules.cpp. +Get the Event data. Definition at line 337 of file modules.cpp. .PP References data. .PP .nf -340 { -341 return this->data; -342 } +338 { +339 return this->data; +340 } .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 355 of file modules.cpp. +Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 353 of file modules.cpp. .PP References id. .PP .nf -356 { -357 return this->id; -358 } +354 { +355 return this->id; +356 } .fi .SS "\fBModule\fP * Event::GetSource ()" .PP -Get the event Source. Definition at line 344 of file modules.cpp. +Get the event Source. Definition at line 342 of file modules.cpp. .PP References source. .PP .nf -345 { -346 return this->source; -347 } +343 { +344 return this->source; +345 } .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 349 of file modules.cpp. +Definition at line 347 of file modules.cpp. .PP References FOREACH_MOD. .PP .nf -350 { -351 FOREACH_MOD OnEvent(this); -352 return NULL; -353 } +348 { +349 FOREACH_MOD OnEvent(this); +350 return NULL; +351 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index e8ca07eea..4985ca640 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index 3c225024c..5b17a22cb 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "7 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 201 of file modules.cpp. +Definition at line 202 of file modules.cpp. .PP References modechar, needsoper, params_when_off, params_when_on, and type. .PP .nf -201 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +202 : 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 200 of file modules.cpp. +Definition at line 201 of file modules.cpp. .SS "char \fBExtMode::modechar\fP" .PP -Definition at line 195 of file modules.cpp. +Definition at line 196 of file modules.cpp. .PP Referenced by ExtMode(). .SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 199 of file modules.cpp. +Definition at line 200 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 198 of file modules.cpp. +Definition at line 199 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 197 of file modules.cpp. +Definition at line 198 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::type\fP" .PP -Definition at line 196 of file modules.cpp. +Definition at line 197 of file modules.cpp. .PP Referenced by ExtMode(). diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index cd2180659..b58890fb7 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index a69617742..8373506b9 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -57,100 +57,100 @@ Caches a text file into memory and can be used to retrieve lines from it. This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. .PP -Definition at line 1186 of file modules.h. +Definition at line 1236 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" .PP -Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 988 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 1004 of file modules.cpp. .PP .nf -989 { -990 } +1005 { +1006 } .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 981 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 997 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -982 { -983 file_cache c; -984 readfile(c,filename.c_str()); -985 this->fc = c; -986 } +998 { +999 file_cache c; +1000 readfile(c,filename.c_str()); +1001 this->fc = c; +1002 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 1000 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 1016 of file modules.cpp. .PP .nf -1001 { -1002 } +1017 { +1018 } .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 1004 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 1020 of file modules.cpp. .PP References fc. .PP .nf -1005 { -1006 if (fc.size() == 0) -1007 { -1008 return(false); -1009 } -1010 else -1011 { -1012 return(true); -1013 } -1014 } +1021 { +1022 if (fc.size() == 0) +1023 { +1024 return(false); +1025 } +1026 else +1027 { +1028 return(true); +1029 } +1030 } .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 1023 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 1039 of file modules.cpp. .PP References fc. .PP .nf -1024 { -1025 return fc.size(); -1026 } +1040 { +1041 return fc.size(); +1042 } .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 1016 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 1032 of file modules.cpp. .PP References fc. .PP .nf -1017 { -1018 if ((x<0) || (x>fc.size())) -1019 return ''; -1020 return fc[x]; -1021 } +1033 { +1034 if ((x<0) || (x>fc.size())) +1035 return ''; +1036 return fc[x]; +1037 } .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 992 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 1008 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -993 { -994 file_cache c; -995 readfile(c,filename.c_str()); -996 this->fc = c; -997 } +1009 { +1010 file_cache c; +1011 readfile(c,filename.c_str()); +1012 this->fc = c; +1013 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 1188 of file modules.h. +Definition at line 1238 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index 118afd97b..155dffeb0 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index cbb5e7b2d..b61539767 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InAddr_HashComp.3 b/docs/man/man3/InAddr_HashComp.3 index ab6cd4563..70c1be8df 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,18 +17,18 @@ InAddr_HashComp \- .PP .SS "bool InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const\fC [inline]\fP" .PP -Definition at line 161 of file modules.cpp. +Definition at line 162 of file modules.cpp. .PP .nf -162 { -163 size_t q; -164 size_t p; -165 -166 memcpy(&q,&s1,sizeof(size_t)); -167 memcpy(&p,&s2,sizeof(size_t)); -168 -169 return (q == p); -170 } +163 { +164 size_t q; +165 size_t p; +166 +167 memcpy(&q,&s1,sizeof(size_t)); +168 memcpy(&p,&s2,sizeof(size_t)); +169 +170 return (q == p); +171 } .fi diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 9ce27dd83..595b9a85e 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index b0268a92e..cdb965a47 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index 211bfefb1..4fa82add2 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 41ce3695a..3868a5d81 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 486b10e2f..079f8b674 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -215,6 +215,30 @@ Inherits \fBclassbase\fP. .RI "virtual void \fBOnGlobalConnect\fP (\fBuserrec\fP *user)" .br .RI "\fICalled whenever a user connects, anywhere on the network. \fP" +.ti -1c +.RI "virtual int \fBOnAddBan\fP (\fBuserrec\fP *source, \fBchanrec\fP *channel, std::string banmask)" +.br +.RI "\fICalled whenever a ban is added to a channel's list. \fP" +.ti -1c +.RI "virtual int \fBOnDelBan\fP (\fBuserrec\fP *source, \fBchanrec\fP *channel, std::string banmask)" +.br +.RI "\fICalled whenever a ban is removed from a channel's list. \fP" +.ti -1c +.RI "virtual void \fBOnRawSocketAccept\fP (int fd, std::string ip, int localport)" +.br +.RI "\fICalled immediately after any connection is accepted. \fP" +.ti -1c +.RI "virtual int \fBOnRawSocketWrite\fP (int fd, char *buffer, int count)" +.br +.RI "\fICalled immediately before any write() operation on a user's socket in the core. \fP" +.ti -1c +.RI "virtual void \fBOnRawSocketClose\fP (int fd)" +.br +.RI "\fICalled immediately before any socket is closed. \fP" +.ti -1c +.RI "virtual int \fBOnRawSocketRead\fP (int fd, char *buffer, unsigned int count, int &readresult)" +.br +.RI "\fICalled immediately before any read() operation on a client socket in the core. \fP" .in -1c .SH "Detailed Description" .PP @@ -227,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 361 of file modules.cpp. +Default constructor creates a module class. Definition at line 360 of file modules.cpp. .PP .nf -361 { } +360 { } .fi .SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class. Definition at line 362 of file modules.cpp. +Default destructor destroys a module class. Definition at line 361 of file modules.cpp. .PP .nf -362 { } +361 { } .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 374 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 373 of file modules.cpp. .PP References VF_VENDOR. .PP .nf -374 { return Version(1,0,0,0,VF_VENDOR); } +373 { 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 386 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 385 of file modules.cpp. .PP .nf -386 { }; +385 { }; .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP @@ -283,270 +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 383 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 382 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -383 { return ACR_DEFAULT; }; +382 { 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 410 of file modules.cpp. +.PP +.nf +410 { 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 389 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 388 of file modules.cpp. .PP .nf -389 { }; +388 { }; .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 403 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 402 of file modules.cpp. .PP .nf -403 { return 0; }; +402 { 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 402 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 401 of file modules.cpp. .PP .nf -402 { return 0; }; +401 { 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 385 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 384 of file modules.cpp. .PP References string_list. .PP .nf -385 { string_list empty; return empty; } +384 { 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 400 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 399 of file modules.cpp. .PP .nf -400 { return 0; }; +399 { 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 397 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 396 of file modules.cpp. .PP .nf -397 { return 0; }; +396 { 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 398 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 397 of file modules.cpp. .PP .nf -398 { return 0; }; +397 { 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 399 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 398 of file modules.cpp. .PP .nf -399 { return 0; }; +398 { 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 392 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 391 of file modules.cpp. +.PP +.nf +391 { 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 411 of file modules.cpp. .PP .nf -392 { return true; }; +411 { 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 406 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 405 of file modules.cpp. .PP .nf -406 { return; }; +405 { 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 373 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 372 of file modules.cpp. .PP .nf -373 { return false; } +372 { 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 410 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 409 of file modules.cpp. .PP .nf -410 { }; +409 { }; .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 409 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 408 of file modules.cpp. .PP .nf -409 { }; +408 { }; .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 376 of file modules.cpp. +<nick> :information hereDefinition at line 375 of file modules.cpp. .PP .nf -376 { }; +375 { }; .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 387 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 386 of file modules.cpp. .PP .nf -387 { return 0; }; +386 { 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 388 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 387 of file modules.cpp. .PP .nf -388 { }; +387 { }; .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 404 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 403 of file modules.cpp. .PP .nf -404 { return 0; }; +403 { 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 405 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 404 of file modules.cpp. .PP .nf -405 { return 0; }; +404 { 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 375 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 374 of file modules.cpp. .PP .nf -375 { }; +374 { }; .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 408 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 407 of file modules.cpp. .PP .nf -408 { return 0; }; +407 { 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 369 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 368 of file modules.cpp. .PP .nf -369 { } +368 { } .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 368 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 367 of file modules.cpp. .PP .nf -368 { } +367 { } .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 391 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 390 of file modules.cpp. .PP .nf -391 { return 0; }; +390 { 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 396 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 395 of file modules.cpp. .PP .nf -396 { return 0; }; +395 { 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 412 of file modules.cpp. +.PP +.nf +412 { }; +.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 414 of file modules.cpp. +.PP +.nf +414 { }; +.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 415 of file modules.cpp. +.PP +.nf +415 { 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 413 of file modules.cpp. +.PP +.nf +413 { 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 370 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 369 of file modules.cpp. .PP .nf -370 { } +369 { } .fi .SS "char * Module::OnRequest (\fBRequest\fP * request)\fC [virtual]\fP" .PP -Called whenever a \fBRequest\fP class is sent to your module by another module. Please see the documentation of \fBRequest::Send()\fP for further information. The \fBRequest\fP sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).Definition at line 407 of file modules.cpp. +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 406 of file modules.cpp. .PP Referenced by Request::Send(). .PP .nf -407 { return NULL; }; +406 { 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 390 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 389 of file modules.cpp. .PP .nf -390 { }; +389 { }; .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 371 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 370 of file modules.cpp. .PP .nf -371 { } +370 { } .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 401 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 400 of file modules.cpp. .PP .nf -401 { }; +400 { }; .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 363 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 362 of file modules.cpp. .PP .nf -363 { } +362 { } .fi .SS "void Module::OnUserDisconnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user's socket is closed. The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.Definition at line 365 of file modules.cpp. +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 364 of file modules.cpp. .PP .nf -365 { } +364 { } .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 366 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 365 of file modules.cpp. .PP .nf -366 { } +365 { } .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 395 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 394 of file modules.cpp. .PP .nf -395 { }; +394 { }; .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 367 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 366 of file modules.cpp. .PP .nf -367 { } +366 { } .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 382 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 381 of file modules.cpp. .PP .nf -382 { }; +381 { }; .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 378 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 377 of file modules.cpp. .PP .nf -378 { return 0; }; +377 { return 0; }; .fi .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP" .PP @@ -554,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 372 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 371 of file modules.cpp. .PP .nf -372 { return 0; } +371 { 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 394 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 393 of file modules.cpp. .PP .nf -394 { return 0; }; +393 { 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 379 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 378 of file modules.cpp. .PP .nf -379 { return 0; }; +378 { 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 381 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 380 of file modules.cpp. .PP .nf -381 { return 0; }; +380 { 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 380 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 379 of file modules.cpp. .PP .nf -380 { return 0; }; +379 { 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 364 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 363 of file modules.cpp. .PP .nf -364 { } +363 { } .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 393 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 392 of file modules.cpp. .PP .nf -393 { }; +392 { }; .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 384 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 383 of file modules.cpp. .PP References string_list. .PP .nf -384 { string_list empty; return empty; } +383 { 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 377 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 376 of file modules.cpp. .PP .nf -377 { }; +376 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index 5e8420840..8ab598e32 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -32,22 +32,22 @@ Instantiates classes inherited from \fBModule\fP This class creates a class inhe This is to allow for modules to create many different variants of \fBModule\fP, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules. .PP -Definition at line 1241 of file modules.h. +Definition at line 1291 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 1244 of file modules.h. +Definition at line 1294 of file modules.h. .PP .nf -1244 { } +1294 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 1245 of file modules.h. +Definition at line 1295 of file modules.h. .PP .nf -1245 { } +1295 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/ModuleMessage.3 b/docs/man/man3/ModuleMessage.3 index 3b04d034a..bcc6a69e0 100644 --- a/docs/man/man3/ModuleMessage.3 +++ b/docs/man/man3/ModuleMessage.3 @@ -1,4 +1,4 @@ -.TH "ModuleMessage" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleMessage" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index a8a1adf0b..8558748e9 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Request.3 b/docs/man/man3/Request.3 index 28a518bc5..e3bc31498 100644 --- a/docs/man/man3/Request.3 +++ b/docs/man/man3/Request.3 @@ -1,4 +1,4 @@ -.TH "Request" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Request" 3 "7 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 308 of file modules.cpp. +Create a new Request. Definition at line 306 of file modules.cpp. .PP .nf -308 : data(anydata), source(src), dest(dst) { }; +306 : data(anydata), source(src), dest(dst) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Request::GetData ()" .PP -Fetch the Request data. Definition at line 310 of file modules.cpp. +Fetch the Request data. Definition at line 308 of file modules.cpp. .PP References data. .PP .nf -311 { -312 return this->data; -313 } +309 { +310 return this->data; +311 } .fi .SS "\fBModule\fP * Request::GetDest ()" .PP -Fetch the request destination (should be 'this' in the receiving module). Definition at line 320 of file modules.cpp. +Fetch the request destination (should be 'this' in the receiving module). Definition at line 318 of file modules.cpp. .PP References dest. .PP .nf -321 { -322 return this->dest; -323 } +319 { +320 return this->dest; +321 } .fi .SS "\fBModule\fP * Request::GetSource ()" .PP -Fetch the request source. Definition at line 315 of file modules.cpp. +Fetch the request source. Definition at line 313 of file modules.cpp. .PP References source. .PP .nf -316 { -317 return this->source; -318 } +314 { +315 return this->source; +316 } .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 325 of file modules.cpp. +Definition at line 323 of file modules.cpp. .PP References dest, and Module::OnRequest(). .PP .nf -326 { -327 if (this->dest) -328 { -329 return dest->OnRequest(this); -330 } -331 else -332 { -333 return NULL; -334 } -335 } +324 { +325 if (this->dest) +326 { +327 return dest->OnRequest(this); +328 } +329 else +330 { +331 return NULL; +332 } +333 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 47253deec..739987c2a 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -40,6 +40,10 @@ Inherits \fBclassbase\fP. .br .RI "\fISends text from the server to a socket. \fP" .ti -1c +.RI "virtual void \fBSendChannelServerNotice\fP (std::string ServName, \fBchanrec\fP *Channel, std::string text)" +.br +.RI "\fIWrites text to a channel, but from a server, including all. \fP" +.ti -1c .RI "virtual void \fBSendFrom\fP (int Socket, \fBuserrec\fP *User, std::string s)" .br .RI "\fISends text from a user to a socket. \fP" @@ -76,6 +80,10 @@ Inherits \fBclassbase\fP. .br .RI "\fIAttempts to look up a nick and return a pointer to it. \fP" .ti -1c +.RI "virtual \fBuserrec\fP * \fBFindDescriptor\fP (int socket)" +.br +.RI "\fIAttempts to look up a nick using the file descriptor associated with that nick. \fP" +.ti -1c .RI "virtual \fBchanrec\fP * \fBFindChannel\fP (std::string channel)" .br .RI "\fIAttempts to look up a channel and return a pointer to it. \fP" @@ -254,24 +262,24 @@ Allows server output and query functions This class contains methods which allow All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. .PP -Definition at line 652 of file modules.h. +Definition at line 694 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 416 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 421 of file modules.cpp. .PP .nf -417 { -418 } +422 { +423 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 420 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 425 of file modules.cpp. .PP .nf -421 { -422 } +426 { +427 } .fi .SH "Member Function Documentation" .PP @@ -281,25 +289,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 497 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 494 of file modules.cpp. .PP References createcommand(). .PP .nf -498 { -499 createcommand(cmd,f,flags,minparams,source); -500 } +495 { +496 createcommand(cmd,f,flags,minparams,source); +497 } .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 715 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 731 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf -716 { -717 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -718 } +732 { +733 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +734 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -313,528 +321,540 @@ 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 642 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 657 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -643 { -644 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -645 if (res) -646 ModeMakeList(modechar); -647 return res; -648 } +658 { +659 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +660 if (res) +661 ModeMakeList(modechar); +662 return res; +663 } .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 622 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 629 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -623 { -624 if (type == MT_SERVER) -625 { -626 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -627 return false; -628 } -629 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -630 { -631 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -632 return false; -633 } -634 if ((params_when_on>1) || (params_when_off>1)) -635 { -636 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -637 return false; -638 } -639 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -640 } +630 { +631 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) +632 { +633 if (type == MT_SERVER) +634 { +635 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +636 return false; +637 } +638 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +639 { +640 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +641 return false; +642 } +643 if ((params_when_on>1) || (params_when_off>1)) +644 { +645 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +646 return false; +647 } +648 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +649 } +650 else +651 { +652 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); +653 } +654 return false; +655 } .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 695 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 711 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf -696 { -697 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -698 } +712 { +713 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +714 } .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 710 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 726 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf -711 { -712 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -713 } +727 { +728 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +729 } .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 700 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 716 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf -701 { -702 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -703 } +717 { +718 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +719 } .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 705 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 721 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf -706 { -707 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -708 } +722 { +723 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +724 } .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 745 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 761 of file modules.cpp. .PP References duration(). .PP .nf -746 { -747 return duration(delta.c_str()); -748 } +762 { +763 return duration(delta.c_str()); +764 } .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 487 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 484 of file modules.cpp. .PP .nf -488 { -489 call_handler(commandname.c_str(),parameters,pcnt,user); -490 } +485 { +486 call_handler(commandname.c_str(),parameters,pcnt,user); +487 } .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 575 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 577 of file modules.cpp. .PP References ChangeName(). .PP .nf -576 { -577 ChangeName(user,gecos.c_str()); -578 } +578 { +579 ChangeName(user,gecos.c_str()); +580 } .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 570 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 572 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -571 { -572 ChangeDisplayedHost(user,host.c_str()); -573 } +573 { +574 ChangeDisplayedHost(user,host.c_str()); +575 } .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 471 of file modules.cpp. +Forces a user nickchange. This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 469 of file modules.cpp. .PP .nf -472 { -473 force_nickchange(user,nickname.c_str()); -474 } +470 { +471 force_nickchange(user,nickname.c_str()); +472 } .fi .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP -Attempts to look up a user's privilages on a channel. This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 595 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 602 of file modules.cpp. .PP References cmode(). .PP .nf -596 { -597 return cmode(User,Chan); -598 } +603 { +604 return cmode(User,Chan); +605 } .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 548 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 550 of file modules.cpp. .PP References common_channels(). .PP .nf -549 { -550 return (common_channels(u1,u2) != 0); -551 } +551 { +552 return (common_channels(u1,u2) != 0); +553 } .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 650 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 665 of file modules.cpp. .PP .nf -651 { -652 return usercount(c); -653 } +666 { +667 return usercount(c); +668 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local E-Line. Definition at line 740 of file modules.cpp. +Deletes a local E-Line. Definition at line 756 of file modules.cpp. .PP References del_eline(). .PP .nf -741 { -742 del_eline(hostmask.c_str()); -743 } +757 { +758 del_eline(hostmask.c_str()); +759 } .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 720 of file modules.cpp. +Deletes a G-Line from all servers on the mesh. Definition at line 736 of file modules.cpp. .PP References del_gline(). .PP .nf -721 { -722 del_gline(hostmask.c_str()); -723 } +737 { +738 del_gline(hostmask.c_str()); +739 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local K-Line. Definition at line 735 of file modules.cpp. +Deletes a local K-Line. Definition at line 751 of file modules.cpp. .PP References del_kline(). .PP .nf -736 { -737 del_kline(hostmask.c_str()); -738 } +752 { +753 del_kline(hostmask.c_str()); +754 } .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 725 of file modules.cpp. +Deletes a Q-Line from all servers on the mesh. Definition at line 741 of file modules.cpp. .PP References del_qline(). .PP .nf -726 { -727 del_qline(nickname.c_str()); -728 } +742 { +743 del_qline(nickname.c_str()); +744 } .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 730 of file modules.cpp. +Deletes a Z-Line from all servers on the mesh. Definition at line 746 of file modules.cpp. .PP References del_zline(). .PP .nf -731 { -732 del_zline(ipaddr.c_str()); -733 } +747 { +748 del_zline(ipaddr.c_str()); +749 } .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 590 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 597 of file modules.cpp. .PP .nf -591 { -592 return FindChan(channel.c_str()); -593 } +598 { +599 return FindChan(channel.c_str()); +600 } +.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 592 of file modules.cpp. +.PP +References fd_ref_table. +.PP +.nf +593 { +594 return (socket < 65536 ? fd_ref_table[socket] : NULL); +595 } .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 823 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 839 of file modules.cpp. .PP References MODCOUNT, module_names, and modules. .PP .nf -824 { -825 for (int i = 0; i <= MODCOUNT; i++) -826 { -827 if (module_names[i] == name) -828 { -829 return modules[i]; -830 } -831 } -832 return NULL; -833 } +840 { +841 for (int i = 0; i <= MODCOUNT; i++) +842 { +843 if (module_names[i] == name) +844 { +845 return modules[i]; +846 } +847 } +848 return NULL; +849 } .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 585 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 587 of file modules.cpp. .PP .nf -586 { -587 return Find(nick); -588 } +588 { +589 return Find(nick); +590 } .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 615 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 622 of file modules.cpp. .PP .nf -616 { -617 return Admin(getadminname(),getadminemail(),getadminnick()); -618 } +623 { +624 return Admin(getadminname(),getadminemail(),getadminnick()); +625 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 610 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 617 of file modules.cpp. .PP .nf -611 { -612 return getnetworkname(); -613 } +618 { +619 return getnetworkname(); +620 } .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 605 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 612 of file modules.cpp. .PP .nf -606 { -607 return getservername(); -608 } +613 { +614 return getservername(); +615 } .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 452 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 457 of file modules.cpp. .PP -References chanuserlist, clientlist, has_channel(), and isnick(). +References chanuserlist, chanrec::GetUsers(), and list. .PP .nf -453 { -454 chanuserlist userl; -455 userl.clear(); -456 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) -457 { -458 if (i->second) -459 { -460 if (has_channel(i->second,chan)) -461 { -462 if (isnick(i->second->nick)) -463 { -464 userl.push_back(i->second); -465 } -466 } -467 } -468 } -469 return userl; -470 } +458 { +459 chanuserlist userl; +460 userl.clear(); +461 std::vector<char*> *list = chan->GetUsers(); +462 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) +463 { +464 char* o = *i; +465 userl.push_back((userrec*)o); +466 } +467 return userl; +468 } .fi .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP" .PP -Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 580 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 582 of file modules.cpp. .PP References isnick(). .PP .nf -581 { -582 return (isnick(nick.c_str()) != 0); -583 } +583 { +584 return (isnick(nick.c_str()) != 0); +585 } .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 600 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 607 of file modules.cpp. .PP References has_channel(). .PP .nf -601 { -602 return has_channel(User,Chan); -603 } +608 { +609 return has_channel(User,Chan); +610 } .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 482 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 479 of file modules.cpp. .PP References is_uline(). .PP .nf -483 { -484 return is_uline(server.c_str()); -485 } +480 { +481 return is_uline(server.c_str()); +482 } .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 750 of file modules.cpp. -.PP -.nf -751 { -752 const char* dest = mask.c_str(); -753 if (strchr(dest,'!')==0) -754 return false; -755 if (strchr(dest,'@')==0) -756 return false; -757 for (int i = 0; i < strlen(dest); i++) -758 if (dest[i] < 32) -759 return false; -760 for (int i = 0; i < strlen(dest); i++) -761 if (dest[i] > 126) -762 return false; -763 int c = 0; -764 for (int i = 0; i < strlen(dest); i++) -765 if (dest[i] == '!') -766 c++; -767 if (c>1) -768 return false; -769 c = 0; -770 for (int i = 0; i < strlen(dest); i++) -771 if (dest[i] == '@') -772 c++; -773 if (c>1) -774 return false; -775 -776 return true; -777 } +Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 766 of file modules.cpp. +.PP +.nf +767 { +768 const char* dest = mask.c_str(); +769 if (strchr(dest,'!')==0) +770 return false; +771 if (strchr(dest,'@')==0) +772 return false; +773 for (int i = 0; i < strlen(dest); i++) +774 if (dest[i] < 32) +775 return false; +776 for (int i = 0; i < strlen(dest); i++) +777 if (dest[i] > 126) +778 return false; +779 int c = 0; +780 for (int i = 0; i < strlen(dest); i++) +781 if (dest[i] == '!') +782 c++; +783 if (c>1) +784 return false; +785 c = 0; +786 for (int i = 0; i < strlen(dest); i++) +787 if (dest[i] == '@') +788 c++; +789 if (c>1) +790 return false; +791 +792 return true; +793 } .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 442 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 447 of file modules.cpp. .PP .nf -443 { -444 return add_channel(user,cname.c_str(),key.c_str(),true); -445 } +448 { +449 return add_channel(user,cname.c_str(),key.c_str(),false); +450 } .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 492 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 489 of file modules.cpp. .PP .nf -493 { -494 log(level,'%s',s.c_str()); -495 } +490 { +491 log(level,'%s',s.c_str()); +492 } .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 429 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 434 of file modules.cpp. .PP .nf -430 { -431 char literal[MAXBUF],pattern[MAXBUF]; -432 strlcpy(literal,sliteral.c_str(),MAXBUF); -433 strlcpy(pattern,spattern.c_str(),MAXBUF); -434 return match(literal,pattern); -435 } +435 { +436 char literal[MAXBUF],pattern[MAXBUF]; +437 strlcpy(literal,sliteral.c_str(),MAXBUF); +438 strlcpy(pattern,spattern.c_str(),MAXBUF); +439 return match(literal,pattern); +440 } .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 805 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 821 of file modules.cpp. .PP .nf -806 { -807 if (c) -808 { -809 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -810 } -811 else return false; -812 } +822 { +823 if (c) +824 { +825 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +826 } +827 else return false; +828 } .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 814 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 830 of file modules.cpp. .PP .nf -815 { -816 if (u) -817 { -818 return CommonOnThisServer(u,(char*)servername.c_str()); -819 } -820 else return false; -821 } +831 { +832 if (u) +833 { +834 return CommonOnThisServer(u,(char*)servername.c_str()); +835 } +836 else return false; +837 } .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 779 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 795 of file modules.cpp. .PP .nf -780 { -781 NetSendToAll((char*)text.c_str()); -782 } +796 { +797 NetSendToAll((char*)text.c_str()); +798 } .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 790 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 806 of file modules.cpp. .PP .nf -791 { -792 NetSendToAllAlive((char*)text.c_str()); -793 } +807 { +808 NetSendToAllAlive((char*)text.c_str()); +809 } .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 800 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 816 of file modules.cpp. .PP .nf -801 { -802 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -803 } +817 { +818 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); +819 } .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 784 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 800 of file modules.cpp. .PP .nf -785 { -786 if (user) -787 NetSendToCommon(user,(char*)text.c_str()); -788 } +801 { +802 if (user) +803 NetSendToCommon(user,(char*)text.c_str()); +804 } .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 795 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 811 of file modules.cpp. .PP .nf -796 { -797 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -798 } +812 { +813 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +814 } .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 447 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 452 of file modules.cpp. .PP .nf -448 { -449 return del_channel(user,cname.c_str(),reason.c_str(),false); -450 } +453 { +454 return del_channel(user,cname.c_str(),reason.c_str(),false); +455 } .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 665 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 681 of file modules.cpp. .PP -References ucrec::channel, userrec::chans, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. +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 -666 { -667 zombie->fd = alive->fd; -668 alive->fd = FD_MAGIC_NUMBER; -669 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); -670 kill_link(alive,message.c_str()); -671 for (int i = 0; i != MAXCHANS; i++) -672 { -673 if (zombie->chans[i].channel != NULL) -674 { -675 if (zombie->chans[i].channel->name) -676 { -677 chanrec* Ptr = zombie->chans[i].channel; -678 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); -679 if (Ptr->topicset) -680 { -681 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); -682 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); -683 } -684 userlist(zombie,Ptr); -685 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); -686 //WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr)); -687 //WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created); -688 -689 } -690 } -691 } -692 -693 } +682 { +683 zombie->fd = alive->fd; +684 alive->fd = FD_MAGIC_NUMBER; +685 alive->ClearBuffer(); +686 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +687 kill_link(alive,message.c_str()); +688 fd_ref_table[zombie->fd] = zombie; +689 for (int i = 0; i != MAXCHANS; i++) +690 { +691 if (zombie->chans[i].channel != NULL) +692 { +693 if (zombie->chans[i].channel->name) +694 { +695 chanrec* Ptr = zombie->chans[i].channel; +696 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +697 if (Ptr->topicset) +698 { +699 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +700 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +701 } +702 userlist(zombie,Ptr); +703 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +704 +705 } +706 } +707 } +708 +709 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -842,65 +862,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 476 of file modules.cpp. -.PP -References userrec::nick, and send_network_quit(). +Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 474 of file modules.cpp. .PP .nf -477 { -478 send_network_quit(user->nick,reason.c_str()); -479 kill_link(user,reason.c_str()); -480 } +475 { +476 kill_link(user,reason.c_str()); +477 } .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 507 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 504 of file modules.cpp. .PP .nf -508 { -509 Write(Socket,'%s',s.c_str()); -510 } +505 { +506 Write(Socket,'%s',s.c_str()); +507 } .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 536 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 538 of file modules.cpp. +.PP +.nf +539 { +540 if (IncludeSender) +541 { +542 WriteChannel(Channel,User,'%s',s.c_str()); +543 } +544 else +545 { +546 ChanExceptSender(Channel,User,'%s',s.c_str()); +547 } +548 } +.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 533 of file modules.cpp. .PP .nf -537 { -538 if (IncludeSender) -539 { -540 WriteChannel(Channel,User,'%s',s.c_str()); -541 } -542 else -543 { -544 ChanExceptSender(Channel,User,'%s',s.c_str()); -545 } -546 } +534 { +535 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); +536 } .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 553 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 555 of file modules.cpp. .PP .nf -554 { -555 if (IncludeSender) -556 { -557 WriteCommon(User,'%s',text.c_str()); -558 } -559 else -560 { -561 WriteCommonExcept(User,'%s',text.c_str()); -562 } -563 } +556 { +557 if (IncludeSender) +558 { +559 WriteCommon(User,'%s',text.c_str()); +560 } +561 else +562 { +563 WriteCommonExcept(User,'%s',text.c_str()); +564 } +565 } .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 517 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 514 of file modules.cpp. .PP .nf -518 { -519 WriteFrom(Socket,User,'%s',s.c_str()); -520 } +515 { +516 WriteFrom(Socket,User,'%s',s.c_str()); +517 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -918,32 +944,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 502 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 499 of file modules.cpp. .PP References server_mode(). .PP .nf -503 { -504 server_mode(parameters,pcnt,user); -505 } +500 { +501 server_mode(parameters,pcnt,user); +502 } .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 424 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 429 of file modules.cpp. .PP .nf -425 { -426 WriteOpers('%s',s.c_str()); -427 } +430 { +431 WriteOpers('%s',s.c_str()); +432 } .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 512 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 509 of file modules.cpp. .PP .nf -513 { -514 WriteServ(Socket,'%s',s.c_str()); -515 } +510 { +511 WriteServ(Socket,'%s',s.c_str()); +512 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -955,23 +981,23 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 522 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 519 of file modules.cpp. .PP References connection::fd. .PP .nf -523 { -524 if (!Source) -525 { -526 // if source is NULL, then the message originates from the local server -527 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -528 } -529 else -530 { -531 // otherwise it comes from the user specified -532 WriteTo(Source,Dest,'%s',s.c_str()); -533 } -534 } +520 { +521 if (!Source) +522 { +523 // if source is NULL, then the message originates from the local server +524 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +525 } +526 else +527 { +528 // otherwise it comes from the user specified +529 WriteTo(Source,Dest,'%s',s.c_str()); +530 } +531 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -979,36 +1005,37 @@ 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 437 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 442 of file modules.cpp. .PP .nf -438 { -439 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -440 } +443 { +444 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +445 } .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 565 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 567 of file modules.cpp. .PP .nf -566 { -567 WriteWallOps(User,false,'%s',text.c_str()); -568 } +568 { +569 WriteWallOps(User,false,'%s',text.c_str()); +570 } .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 656 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 671 of file modules.cpp. .PP -References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. +References userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf -657 { -658 unsigned int old_fd = user->fd; -659 user->fd = FD_MAGIC_NUMBER; -660 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); -661 close(old_fd); -662 shutdown (old_fd,2); -663 } +672 { +673 unsigned int old_fd = user->fd; +674 user->fd = FD_MAGIC_NUMBER; +675 user->ClearBuffer(); +676 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +677 shutdown(old_fd,2); +678 close(old_fd); +679 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index bcdf74124..77581534f 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,17 +17,17 @@ StrHashComp \- .PP .SS "bool StrHashComp::operator() (const string & s1, const string & s2) const\fC [inline]\fP" .PP -Definition at line 146 of file modules.cpp. +Definition at line 147 of file modules.cpp. .PP .nf -147 { -148 char a[MAXBUF],b[MAXBUF]; -149 strlcpy(a,s1.c_str(),MAXBUF); -150 strlcpy(b,s2.c_str(),MAXBUF); -151 strlower(a); -152 strlower(b); -153 return (strcasecmp(a,b) == 0); -154 } +148 { +149 char a[MAXBUF],b[MAXBUF]; +150 strlcpy(a,s1.c_str(),MAXBUF); +151 strlcpy(b,s2.c_str(),MAXBUF); +152 strlower(a); +153 strlower(b); +154 return (strcasecmp(a,b) == 0); +155 } .fi diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index 2c0ed2ead..a6a4e7a22 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "7 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 302 of file modules.cpp. +Definition at line 300 of file modules.cpp. .PP .nf -302 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; +300 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index caad829bc..9bf0c83b7 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index e350adf0e..4dba12a85 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "7 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 bceb6d795..2b198832a 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "7 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 c1cbe6acb..2d62f95bc 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -257,6 +257,8 @@ Definition at line 91 of file channels.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP Definition at line 78 of file channels.cpp. +.PP +Referenced by Server::GetUsers(). .SS "FILE* \fBlog_file\fP" .PP Definition at line 105 of file channels.cpp. @@ -271,7 +273,7 @@ Definition at line 88 of file channels.cpp. Definition at line 103 of file channels.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1032 of file modules.cpp. +Definition at line 1048 of file modules.cpp. .PP Referenced by Server::FindModule(). .SS "std::vector<std::string> \fBmodule_names\fP" @@ -324,7 +326,7 @@ Definition at line 86 of file channels.cpp. .PP Definition at line 107 of file channels.cpp. .PP -Referenced by serverrec::serverrec(). +Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "int \fBUDPportCount\fP" .PP Definition at line 96 of file channels.cpp. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index 5d6c7051e..77dd2caea 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 80b5db18d..8dcd2fade 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -254,6 +254,8 @@ Obrain the internal reference list The internal reference list contains a list o .PP References internal_userlist. .PP +Referenced by Server::GetUsers(). +.PP .nf 241 { 242 return &internal_userlist; @@ -292,7 +294,7 @@ References custom_modes, DEBUG, and SetCustomModeParam(). .nf 126 { 127 if (mode_on) { -128 char m[3]; +128 static char m[3]; 129 m[0] = mode; 130 m[1] = '\0'; 131 if (!strchr(this->custom_modes,mode)) diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index aa5dbd61e..da70de3fc 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "7 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 b826865e6..9fa5a044c 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "7 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 7f72427e7..ac7a2a429 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index ca2a69951..7b1f51029 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -53,10 +53,6 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .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 "long \fBGenKey\fP ()" -.br -.RI "\fIThis function is deprecated and may be removed in a later alpha/beta. \fP" .in -1c .SS "Public Attributes" @@ -140,7 +136,7 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .in -1c .SH "Detailed Description" .PP -Please note: classes serverrec and userrec both inherit from class connection. Definition at line 178 of file connection.h. +Please note: classes serverrec and userrec both inherit from class connection. Definition at line 210 of file connection.h. .SH "Constructor & Destructor Documentation" .PP .SS "connection::connection ()" @@ -160,9 +156,6 @@ 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 "long connection::GenKey ()" -.PP -This function is deprecated and may be removed in a later alpha/beta. .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. @@ -179,91 +172,91 @@ Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnecti .PP .SS "long \fBconnection::bytes_in\fP" .PP -Stats counter for bytes inbound. Definition at line 199 of file connection.h. +Stats counter for bytes inbound. Definition at line 231 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::bytes_out\fP" .PP -Stats counter for bytes outbound. Definition at line 203 of file connection.h. +Stats counter for bytes outbound. Definition at line 235 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::cmds_in\fP" .PP -Stats counter for commands inbound. Definition at line 207 of file connection.h. +Stats counter for commands inbound. Definition at line 239 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::cmds_out\fP" .PP -Stats counter for commands outbound. Definition at line 211 of file connection.h. +Stats counter for commands outbound. Definition at line 243 of file connection.h. .PP Referenced by 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 258 of file connection.h. +With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 290 of file connection.h. .SS "int \fBconnection::fd\fP" .PP -File descriptor of the connection. Definition at line 183 of file connection.h. +File descriptor of the connection. Definition at line 215 of file connection.h. .PP Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). .SS "bool \fBconnection::haspassed\fP" .PP -True if server/user has authenticated, false if otherwise. Definition at line 215 of file connection.h. +True if server/user has authenticated, false if otherwise. Definition at line 247 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::host\fP[256]" .PP -Hostname of connection. Not used if this is a serverrecDefinition at line 187 of file connection.h. +Hostname of connection. Not used if this is a serverrecDefinition at line 219 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 241 of file connection.h. +Time that the connection last sent data, used to calculate idle time. Definition at line 273 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::inbuf\fP[MAXBUF]" .PP -Inbuf of connection. Only used for userrecDefinition at line 195 of file connection.h. +Inbuf of connection. Only used for userrecDefinition at line 227 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::internal_addr\fP[MAXBUF]" .PP -Unused, will be removed in a future alpha/beta. Definition at line 249 of file connection.h. +Unused, will be removed in a future alpha/beta. Definition at line 281 of file connection.h. .SS "int \fBconnection::internal_port\fP" .PP -Unused, will be removed in a future alpha/beta. Definition at line 253 of file connection.h. +Unused, will be removed in a future alpha/beta. Definition at line 285 of file connection.h. .SS "char \fBconnection::ip\fP[32]" .PP -IP of connection. Reserved for future use.Definition at line 191 of file connection.h. +IP of connection. Reserved for future use.Definition at line 223 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 233 of file connection.h. +Time the connection was last pinged. Definition at line 265 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 245 of file connection.h. +Used by PING checks with clients. Definition at line 277 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 221 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 253 of file connection.h. .PP Referenced by userrec::userrec(). .SS "int \fBconnection::registered\fP" .PP -Used by userrec to indicate the registration status of the connection. Definition at line 225 of file connection.h. +Used by userrec to indicate the registration status of the connection. Definition at line 257 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 237 of file connection.h. +Time the connection was created, set in the constructor. Definition at line 269 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "short int \fBconnection::state\fP" .PP -Reserved for future use. Definition at line 229 of file connection.h. +Reserved for future use. Definition at line 261 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index b0d6374fc..492693091 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ctables.h.3 b/docs/man/man3/ctables.h.3 index 6541dbb1a..194ed71d7 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "7 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 3b7155194..1f6765422 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "7 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 f850d584a..eeb799dea 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index 5c9e3016b..7e39dd73d 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -74,15 +74,27 @@ Inherits \fBExtensible\fP. .ti -1c .RI "void \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" .ti -1c .RI "bool \fBBufferIsComplete\fP ()" .br +.RI "\fIThis method returns true if the buffer contains at least one carriage return character, e.g. \fP" .ti -1c .RI "void \fBClearBuffer\fP ()" .br +.RI "\fIThis method clears the server's buffer by setting it to an empty string. \fP" .ti -1c .RI "std::string \fBGetBuffer\fP ()" .br +.RI "\fIThis 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(). \fP" +.ti -1c +.RI "void \fBSetVersionString\fP (std::string newversion)" +.br +.RI "\fIThis method sets the version string of the remote server. \fP" +.ti -1c +.RI "std::string \fBGetVersionString\fP ()" +.br +.RI "\fIThis method returns the version string of the remote server. \fP" .in -1c .SS "Public Attributes" @@ -90,7 +102,9 @@ Inherits \fBExtensible\fP. .ti -1c .RI "std::string \fBircdbuffer\fP" .br -.RI "\fIIRCD Buffer for input characters, holds one line. \fP" +.RI "\fIIRCD 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. \fP" .ti -1c .RI "char \fBhost\fP [MAXBUF]" .br @@ -135,6 +149,10 @@ Inherits \fBExtensible\fP. .RI "int \fBstate\fP" .br .RI "\fIState. \fP" +.ti -1c +.RI "std::string \fBversion\fP" +.br +.RI "\fIThis string holds the ircd's version response. \fP" .in -1c .SH "Detailed Description" .PP @@ -147,15 +165,19 @@ Definition at line 54 of file connection.h. .PP .SS "void 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. .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 "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. .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(). .SS "std::string ircd_connector::GetDescription ()" .PP Get the server description of this connection. @@ -174,6 +196,9 @@ Get the port number being used for this connection If the connection is outbound .SS "int ircd_connector::GetState ()" .PP Get the state flags for this connection. +.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 "bool ircd_connector::MakeOutboundConnection (char * newhost, int newport)" .PP Create an outbound connection to a listening socket. @@ -198,6 +223,9 @@ Set the port used by this connection. .SS "void ircd_connector::SetState (int state)" .PP Set the state flags for this connection. +.SS "void ircd_connector::SetVersionString (std::string newversion)" +.PP +This method sets the version string of the remote server. .SH "Member Data Documentation" .PP .SS "sockaddr_in \fBircd_connector::addr\fP\fC [private]\fP" @@ -211,22 +239,27 @@ Sockaddr of the outbound ip and port. Definition at line 59 of file connection.h File descriptor of the connection. Definition at line 63 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 94 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 99 of file connection.h. .SS "std::string \fBircd_connector::ircdbuffer\fP" .PP -IRCD Buffer for input characters, holds one line. Definition at line 87 of file connection.h. +IRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a +.br + seperator. Definition at line 92 of file connection.h. .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 100 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 105 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 106 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 111 of file connection.h. .SS "std::string \fBircd_connector::servername\fP\fC [private]\fP" .PP \fBServer\fP name. Definition at line 67 of file connection.h. .SS "int \fBircd_connector::state\fP\fC [private]\fP" .PP State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTEDDefinition at line 76 of file connection.h. +.SS "std::string \fBircd_connector::version\fP\fC [private]\fP" +.PP +This string holds the ircd's version response. Definition at line 84 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 127926d3e..21aa67806 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -81,7 +81,7 @@ message.h \- .RI "void \fBTidyBan\fP (char *ban)" .br .ti -1c -.RI "char * \fBchlist\fP (\fBuserrec\fP *user)" +.RI "char * \fBchlist\fP (\fBuserrec\fP *user, \fBuserrec\fP *source)" .br .ti -1c .RI "void \fBsend_network_quit\fP (const char *nick, const char *reason)" @@ -99,7 +99,7 @@ Referenced by Server::ChangeHost(). .SS "void ChangeName (\fBuserrec\fP * user, const char * gecos)" .PP Referenced by Server::ChangeGECOS(). -.SS "char* chlist (\fBuserrec\fP * user)" +.SS "char* chlist (\fBuserrec\fP * user, \fBuserrec\fP * source)" .PP .SS "void chop (char * str)" .PP @@ -115,14 +115,14 @@ Referenced by Server::CommonChannels(). .PP .SS "int has_channel (\fBuserrec\fP * u, \fBchanrec\fP * c)" .PP -Referenced by Server::GetUsers(), and Server::IsOnChannel(). +Referenced by Server::IsOnChannel(). .SS "bool hasumode (\fBuserrec\fP * user, char mode)" .PP .SS "int isident (const char * n)" .PP .SS "int isnick (const char * n)" .PP -Referenced by Server::GetUsers(), and Server::IsNick(). +Referenced by Server::IsNick(). .SS "void NonBlocking (int s)" .PP .SS "void safedelete (\fBuserrec\fP * p)" @@ -131,7 +131,6 @@ Referenced by Server::GetUsers(), and Server::IsNick(). .PP .SS "void send_network_quit (const char * nick, const char * reason)" .PP -Referenced by Server::QuitUser(). .SS "void TidyBan (char * ban)" .PP .SS "void tidystring (char * str)" diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index e6a1628c1..f4a8d3254 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "7 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 cde9a3b91..2bfbe387e 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -266,6 +266,9 @@ modules.cpp \- .RI "FILE * \fBlog_file\fP" .br .ti -1c +.RI "\fBuserrec\fP * \fBfd_ref_table\fP [65536]" +.br +.ti -1c .RI "\fBuser_hash\fP \fBclientlist\fP" .br .ti -1c @@ -299,56 +302,55 @@ Definition at line 59 of file modules.cpp. .PP .SS "typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 177 of file modules.cpp. +Definition at line 178 of file modules.cpp. .SS "typedef nspace::hash_map<std::string, \fBchanrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBchan_hash\fP" .PP -Definition at line 176 of file modules.cpp. +Definition at line 177 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 178 of file modules.cpp. +Definition at line 179 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 204 of file modules.cpp. +Definition at line 205 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 205 of file modules.cpp. +Definition at line 206 of file modules.cpp. .PP Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "typedef nspace::hash_map<std::string, \fBuserrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 175 of file modules.cpp. +Definition at line 176 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 277 of file modules.cpp. +Definition at line 275 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -278 { -279 if (ModeDefined(modechar,type)) { -280 return false; -281 } -282 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -283 return true; -284 } +276 { +277 if (ModeDefined(modechar,type)) { +278 return false; +279 } +280 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +281 return true; +282 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 211 of file modules.cpp. +Definition at line 212 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -212 { -213 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +213 { 214 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) 215 { 216 if ((i->modechar == modechar) && (i->type == type)) @@ -361,98 +363,96 @@ Referenced by DoAddExtendedMode(). .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 264 of file modules.cpp. +Definition at line 262 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -265 { -266 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -267 { -268 if ((i->modechar == modechar) && (i->type == type)) -269 { -270 return i->params_when_off; -271 } -272 } -273 return 0; -274 } +263 { +264 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +265 { +266 if ((i->modechar == modechar) && (i->type == type)) +267 { +268 return i->params_when_off; +269 } +270 } +271 return 0; +272 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 251 of file modules.cpp. +Definition at line 249 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -252 { -253 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -254 { -255 if ((i->modechar == modechar) && (i->type == type)) -256 { -257 return i->params_when_on; -258 } -259 } -260 return 0; -261 } +250 { +251 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +252 { +253 if ((i->modechar == modechar) && (i->type == type)) +254 { +255 return i->params_when_on; +256 } +257 } +258 return 0; +259 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 237 of file modules.cpp. +Definition at line 236 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP .nf -238 { -239 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -240 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -241 { -242 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) -243 { -244 return true; -245 } -246 } -247 return false; -248 } +237 { +238 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +239 { +240 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +241 { +242 return true; +243 } +244 } +245 return false; +246 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP Definition at line 224 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP .nf 225 { -226 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -227 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -228 { -229 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) -230 { -231 return true; -232 } -233 } -234 return false; -235 } +226 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +227 { +228 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +229 { +230 return true; +231 } +232 } +233 return false; +234 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 287 of file modules.cpp. +Definition at line 285 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -288 { -289 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -290 { -291 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -292 { -293 i->list = true; -294 return; -295 } -296 } -297 return; -298 } +286 { +287 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +288 { +289 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +290 { +291 i->list = true; +292 return; +293 } +294 } +295 return; +296 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -475,15 +475,13 @@ Definition at line 103 of file modules.cpp. Definition at line 97 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 182 of file modules.cpp. +Definition at line 183 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 181 of file modules.cpp. -.PP -Referenced by Server::GetUsers(). +Definition at line 182 of file modules.cpp. .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 184 of file modules.cpp. +Definition at line 185 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP Definition at line 104 of file modules.cpp. @@ -504,7 +502,7 @@ Definition at line 77 of file modules.cpp. Definition at line 83 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 208 of file modules.cpp. +Definition at line 209 of file modules.cpp. .PP Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "std::vector<\fBircd_module\fP*> factory" @@ -513,9 +511,14 @@ Definition at line 66 of file modules.cpp. .SS "std::vector<int> \fBfd_reap\fP" .PP Definition at line 94 of file modules.cpp. +.SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]" +.PP +Definition at line 110 of file modules.cpp. +.PP +Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 187 of file modules.cpp. +Definition at line 188 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP Definition at line 81 of file modules.cpp. @@ -533,7 +536,7 @@ Definition at line 91 of file modules.cpp. Definition at line 106 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1032 of file modules.cpp. +Definition at line 1048 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP Definition at line 95 of file modules.cpp. @@ -542,7 +545,7 @@ Definition at line 95 of file modules.cpp. Definition at line 65 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 185 of file modules.cpp. +Definition at line 186 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP Definition at line 79 of file modules.cpp. @@ -569,7 +572,7 @@ Definition at line 82 of file modules.cpp. Definition at line 78 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 186 of file modules.cpp. +Definition at line 187 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP Definition at line 80 of file modules.cpp. @@ -590,7 +593,7 @@ Definition at line 68 of file modules.cpp. Definition at line 99 of file modules.cpp. .SS "\fBuser_hash\fP \fBwhowas\fP" .PP -Definition at line 183 of file modules.cpp. +Definition at line 184 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP Definition at line 87 of file modules.cpp. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index 5b3be2f2a..4be3d09c9 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -230,29 +230,29 @@ Referenced by Module::OnAccessCheck(). Definition at line 38 of file modules.h. .SS "#define CONF_FILE_NOT_FOUND 0x000200" .PP -Definition at line 1088 of file modules.h. +Definition at line 1138 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 1085 of file modules.h. +Definition at line 1135 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 1086 of file modules.h. +Definition at line 1136 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 1087 of file modules.h. +Definition at line 1137 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" .PP Definition at line 23 of file modules.h. .PP -Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DecUserCounter(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IncUserCounter(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). +Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DecUserCounter(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IncUserCounter(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). .SS "#define DEFAULT 30" .PP Definition at line 25 of file modules.h. @@ -333,7 +333,7 @@ Low level definition of a \fBFileReader\fP classes file cache area. Definition a Referenced by FileReader::FileReader(), and FileReader::LoadFile(). .SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP" .PP -Definition at line 1254 of file modules.h. +Definition at line 1304 of file modules.h. .SS "typedef \fBfile_cache\fP \fBstring_list\fP" .PP Definition at line 68 of file modules.h. diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index 7cfff7689..c0b5d7ec0 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "7 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 2f257e697..f4d292abd 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 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,14 +20,14 @@ nspace::nspace::hash< in_addr > \- .PP .SS "size_t nspace::hash< in_addr >::operator() (const struct in_addr & a) const\fC [inline]\fP" .PP -Definition at line 119 of file modules.cpp. +Definition at line 120 of file modules.cpp. .PP .nf -120 { -121 size_t q; -122 memcpy(&q,&a,sizeof(size_t)); -123 return q; -124 } +121 { +122 size_t q; +123 memcpy(&q,&a,sizeof(size_t)); +124 return q; +125 } .fi diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index dce6079d6..2ed553162 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 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,16 +20,16 @@ nspace::nspace::hash< string > \- .PP .SS "size_t nspace::hash< string >::operator() (const string & s) const\fC [inline]\fP" .PP -Definition at line 132 of file modules.cpp. +Definition at line 133 of file modules.cpp. .PP .nf -133 { -134 char a[MAXBUF]; -135 static struct hash<const char *> strhash; -136 strlcpy(a,s.c_str(),MAXBUF); -137 strlower(a); -138 return strhash(a); -139 } +134 { +135 char a[MAXBUF]; +136 static struct hash<const char *> strhash; +137 strlcpy(a,s.c_str(),MAXBUF); +138 strlower(a); +139 return strhash(a); +140 } .fi diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 3517dc84d..c5b428a4a 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index ef1e28d83..41fd8df92 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.h.3 b/docs/man/man3/servers.h.3 index 13cf46371..b486aef53 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 107c01c59..dd1a4d72e 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 5f9098e25..168036a35 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 2e78c5206..7e5c3ea11 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -45,6 +45,22 @@ Inherits \fBconnection\fP. .RI "bool \fBHasPermission\fP (char *command)" .br .RI "\fIReturns true or false for if a user can execute a privilaged oper command. \fP" +.ti -1c +.RI "bool \fBAddBuffer\fP (std::string a)" +.br +.RI "\fIThis method adds data to the buffer of the user. \fP" +.ti -1c +.RI "bool \fBBufferIsReady\fP ()" +.br +.RI "\fIThis method returns true if the buffer contains at least one carriage return character (e.g. \fP" +.ti -1c +.RI "void \fBClearBuffer\fP ()" +.br +.RI "\fIThis function clears the entire buffer by setting it to an empty string. \fP" +.ti -1c +.RI "std::string \fBGetBuffer\fP ()" +.br +.RI "\fIThis method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. \fP" .in -1c .SS "Public Attributes" @@ -108,6 +124,20 @@ Inherits \fBconnection\fP. .RI "char \fBpassword\fP [MAXBUF]" .br .RI "\fIPassword specified by the user when they registered. \fP" +.ti -1c +.RI "std::string \fBrecvq\fP" +.br +.RI "\fIUser's receive queue. \fP" +.ti -1c +.RI "long \fBlines_in\fP" +.br +.RI "\fIFlood counters. \fP" +.ti -1c +.RI "time_t \fBreset_due\fP" +.br +.ti -1c +.RI "long \fBthreshold\fP" +.br .in -1c .SS "Private Attributes" @@ -123,14 +153,14 @@ Holds all information about a user This class stores all information about a use Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname. .PP -Definition at line 93 of file users.h. +Definition at line 98 of file users.h. .SH "Constructor & Destructor Documentation" .PP .SS "userrec::userrec ()" .PP Definition at line 28 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, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. +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, connection::inbuf, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, result, server, connection::signon, TIME, timeout, and ucrec::uc_modes. .PP .nf 29 { @@ -147,246 +177,344 @@ References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, 40 strcpy(server,''); 41 strcpy(awaymsg,''); 42 strcpy(oper,''); -43 fd = lastping = signon = idle_lastmsg = nping = registered = 0; -44 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; -45 haspassed = false; -46 dns_done = false; -47 strcpy(result,''); -48 for (int i = 0; i < MAXCHANS; i++) -49 { -50 this->chans[i].channel = NULL; -51 this->chans[i].uc_modes = 0; -52 } -53 invites.clear(); -54 } +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 strcpy(result,''); +51 for (int i = 0; i < MAXCHANS; i++) +52 { +53 this->chans[i].channel = NULL; +54 this->chans[i].uc_modes = 0; +55 } +56 invites.clear(); +57 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 178 of file users.h. +Definition at line 195 of file users.h. .PP .nf -178 { } +195 { } .fi .SH "Member Function Documentation" .PP +.SS "bool userrec::AddBuffer (std::string a)" +.PP +This method adds data to the buffer of the user. The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted.Definition at line 169 of file users.cpp. +.PP +References recvq. +.PP +.nf +170 { +171 std::string b = ''; +172 for (int i = 0; i < a.length(); i++) +173 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) +174 b = b + a[i]; +175 std::stringstream stream(recvq); +176 stream << b; +177 recvq = stream.str(); +178 int i = 0; +179 // count the size of the first line in the buffer. +180 while (i < recvq.length()) +181 { +182 if (recvq[i++] == '\n') +183 break; +184 } +185 // return false if we've had more than 600 characters WITHOUT +186 // a carriage return (this is BAD, drop the socket) +187 return (i < 600); +188 } +.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 190 of file users.cpp. +.PP +References recvq. +.PP +.nf +191 { +192 for (int i = 0; i < recvq.length(); i++) +193 if (recvq[i] == '\n') +194 return true; +195 return false; +196 } +.fi +.SS "void userrec::ClearBuffer ()" +.PP +This function clears the entire buffer by setting it to an empty string. Definition at line 198 of file users.cpp. +.PP +References recvq. +.PP +Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). +.PP +.nf +199 { +200 recvq = ''; +201 } +.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 203 of file users.cpp. +.PP +References recvq. +.PP +.nf +204 { +205 if (recvq == '') +206 return ''; +207 char* line = (char*)recvq.c_str(); +208 std::string ret = ''; +209 while ((*line != '\n') && (strlen(line))) +210 { +211 ret = ret + *line; +212 line++; +213 } +214 if ((*line == '\n') || (*line == '\r')) +215 line++; +216 recvq = line; +217 return ret; +218 } +.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 58 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 61 of file users.cpp. .PP References dhost, ident, nick, and result. .PP .nf -59 { -60 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -61 return result; -62 } +62 { +63 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +64 return result; +65 } .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 65 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 68 of file users.cpp. .PP References connection::host, ident, nick, and result. .PP .nf -66 { -67 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -68 return result; -69 } +69 { +70 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +71 return result; +72 } .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 114 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 117 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -115 { -116 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -117 char* mycmd; -118 char* savept; -119 char* savept2; -120 -121 // are they even an oper at all? -122 if (strchr(this->modes,'o')) -123 { -124 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -125 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -126 { -127 ConfValue('type','name',j,TypeName,&config_f); -128 if (!strcmp(TypeName,this->oper)) -129 { -130 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -131 ConfValue('type','classes',j,Classes,&config_f); -132 char* myclass = strtok_r(Classes,' ',&savept); -133 while (myclass) -134 { -135 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -136 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -137 { -138 ConfValue('class','name',k,ClassName,&config_f); -139 if (!strcmp(ClassName,myclass)) -140 { -141 ConfValue('class','commands',k,CommandList,&config_f); -142 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -143 -144 -145 mycmd = strtok_r(CommandList,' ',&savept2); -146 while (mycmd) -147 { -148 if (!strcasecmp(mycmd,command)) -149 { -150 log(DEBUG,'*** Command %s found, returning true',command); -151 return true; -152 } -153 mycmd = strtok_r(NULL,' ',&savept2); -154 } -155 } -156 } -157 myclass = strtok_r(NULL,' ',&savept); -158 } -159 } -160 } -161 } -162 return false; -163 } +118 { +119 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +120 char* mycmd; +121 char* savept; +122 char* savept2; +123 +124 // are they even an oper at all? +125 if (strchr(this->modes,'o')) +126 { +127 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +128 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +129 { +130 ConfValue('type','name',j,TypeName,&config_f); +131 if (!strcmp(TypeName,this->oper)) +132 { +133 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +134 ConfValue('type','classes',j,Classes,&config_f); +135 char* myclass = strtok_r(Classes,' ',&savept); +136 while (myclass) +137 { +138 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +139 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +140 { +141 ConfValue('class','name',k,ClassName,&config_f); +142 if (!strcmp(ClassName,myclass)) +143 { +144 ConfValue('class','commands',k,CommandList,&config_f); +145 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); +146 +147 +148 mycmd = strtok_r(CommandList,' ',&savept2); +149 while (mycmd) +150 { +151 if (!strcasecmp(mycmd,command)) +152 { +153 log(DEBUG,'*** Command %s found, returning true',command); +154 return true; +155 } +156 mycmd = strtok_r(NULL,' ',&savept2); +157 } +158 } +159 } +160 myclass = strtok_r(NULL,' ',&savept); +161 } +162 } +163 } +164 } +165 return false; +166 } .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 85 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 88 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -86 { -87 Invited i; -88 strlcpy(i.channel,channel,CHANMAX); -89 invites.push_back(i); -90 } +89 { +90 Invited i; +91 strlcpy(i.channel,channel,CHANMAX); +92 invites.push_back(i); +93 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 71 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 74 of file users.cpp. .PP References invites. .PP .nf -72 { -73 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -74 { -75 if (i->channel) { -76 if (!strcasecmp(i->channel,channel)) -77 { -78 return true; -79 } -80 } -81 } -82 return false; -83 } +75 { +76 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +77 { +78 if (i->channel) { +79 if (!strcasecmp(i->channel,channel)) +80 { +81 return true; +82 } +83 } +84 } +85 return false; +86 } .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 92 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 95 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -93 { -94 log(DEBUG,'Removing invites'); -95 if (channel) -96 { -97 if (invites.size()) -98 { -99 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -100 { -101 if (i->channel) -102 { -103 if (!strcasecmp(i->channel,channel)) -104 { -105 invites.erase(i); -106 return; -107 } -108 } -109 } -110 } -111 } -112 } +96 { +97 log(DEBUG,'Removing invites'); +98 if (channel) +99 { +100 if (invites.size()) +101 { +102 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +103 { +104 if (i->channel) +105 { +106 if (!strcasecmp(i->channel,channel)) +107 { +108 invites.erase(i); +109 return; +110 } +111 } +112 } +113 } +114 } +115 } .fi .SH "Member Data Documentation" .PP .SS "char \fBuserrec::awaymsg\fP[512]" .PP -The user's away message. If this string is empty, the user is not marked as away.Definition at line 136 of file users.h. +The user's away message. If this string is empty, the user is not marked as away.Definition at line 141 of file users.h. .PP Referenced by userrec(). .SS "\fBucrec\fP \fBuserrec::chans\fP[MAXCHANS]" .PP -Definition at line 127 of file users.h. +Definition at line 132 of file users.h. .PP Referenced by Server::PseudoToUser(), and userrec(). .SS "char \fBuserrec::dhost\fP[256]" .PP -The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 115 of file users.h. +The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 120 of file users.h. .PP Referenced by GetFullHost(), and userrec(). .SS "bool \fBuserrec::dns_done\fP" .PP -True when \fBDNS\fP lookups are completed. Definition at line 164 of file users.h. +True when \fBDNS\fP lookups are completed. Definition at line 169 of file users.h. .PP Referenced by userrec(). .SS "int \fBuserrec::flood\fP" .PP -Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 147 of file users.h. +Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 152 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::fullname\fP[128]" .PP -The users full name. Definition at line 119 of file users.h. +The users full name. Definition at line 124 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::ident\fP[64]" .PP -The users ident reply. Definition at line 110 of file users.h. +The users ident reply. Definition at line 115 of file users.h. .PP Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo(). .SS "\fBInvitedList\fP \fBuserrec::invites\fP\fC [private]\fP" .PP -A list of channels the user has a pending invite to. Definition at line 99 of file users.h. +A list of channels the user has a pending invite to. Definition at line 104 of file users.h. .PP Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). +.SS "long \fBuserrec::lines_in\fP" +.PP +Flood counters. Definition at line 189 of file users.h. +.PP +Referenced by userrec(). .SS "char \fBuserrec::modes\fP[MAXBUF]" .PP -The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 125 of file users.h. +The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 130 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::nick\fP[NICKMAX]" .PP -The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 106 of file users.h. +The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 111 of file users.h. .PP -Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), Server::QuitUser(), and userrec(). +Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec(). .SS "char \fBuserrec::oper\fP[NICKMAX]" .PP -The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 160 of file users.h. +The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 165 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::password\fP[MAXBUF]" .PP -Password specified by the user when they registered. This is stored even if the block doesnt need a password, so that modules may check it.Definition at line 174 of file users.h. +Password specified by the user when they registered. This is stored even if the block doesnt need a password, so that modules may check it.Definition at line 179 of file users.h. .SS "unsigned long \fBuserrec::pingmax\fP" .PP -Number of seconds between PINGs for this user (set from <connect:allow> tag. Definition at line 168 of file users.h. +Number of seconds between PINGs for this user (set from <connect:allow> tag. Definition at line 173 of file users.h. +.SS "std::string \fBuserrec::recvq\fP" +.PP +User's receive queue. Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.Definition at line 185 of file users.h. +.PP +Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec(). +.SS "time_t \fBuserrec::reset_due\fP" +.PP +Definition at line 190 of file users.h. +.PP +Referenced by userrec(). .SS "char \fBuserrec::result\fP[256]" .PP -Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 141 of file users.h. +Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 146 of file users.h. .PP Referenced by GetFullHost(), GetFullRealHost(), and userrec(). .SS "char \fBuserrec::server\fP[256]" .PP -The server the user is connected to. Definition at line 131 of file users.h. +The server the user is connected to. Definition at line 136 of file users.h. .PP Referenced by userrec(). +.SS "long \fBuserrec::threshold\fP" +.PP +Definition at line 191 of file users.h. .SS "unsigned long \fBuserrec::timeout\fP" .PP -Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 153 of file users.h. +Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 158 of file users.h. .PP Referenced by userrec(). diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index 614228ad2..0416d8dc5 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/users.h.3 b/docs/man/man3/users.h.3 index 09eb0ae89..21e2e3b0d 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -91,10 +91,10 @@ Definition at line 28 of file users.h. .PP .SS "typedef std::vector<\fBConnectClass\fP> \fBClassVector\fP" .PP -Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 85 of file users.h. +Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 90 of file users.h. .SS "typedef std::vector<\fBInvited\fP> \fBInvitedList\fP" .PP -Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 79 of file users.h. +Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 84 of file users.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 8a3263c2f..8006488c5 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME |