From a266dadd1351d10b56ec187c7b6f7af75350ed68 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 12 May 2005 02:26:05 +0000 Subject: Documented new recvq and sendq stuff git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1367 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/man/man3/Admin.3 | 6 +- docs/man/man3/BanItem.3 | 2 +- docs/man/man3/ConfigReader.3 | 264 +-- docs/man/man3/ConnectClass.3 | 42 +- docs/man/man3/DNS.3 | 2 +- docs/man/man3/ELine.3 | 2 +- docs/man/man3/Event.3 | 40 +- docs/man/man3/ExemptItem.3 | 2 +- docs/man/man3/ExtMode.3 | 18 +- docs/man/man3/Extensible.3 | 2 +- docs/man/man3/FileReader.3 | 80 +- docs/man/man3/GLine.3 | 2 +- docs/man/man3/HostItem.3 | 2 +- docs/man/man3/InAddr_HashComp.3 | 22 +- docs/man/man3/InviteItem.3 | 2 +- docs/man/man3/Invited.3 | 2 +- docs/man/man3/KLine.3 | 2 +- docs/man/man3/ModeParameter.3 | 2 +- docs/man/man3/Module.3 | 226 +-- docs/man/man3/ModuleFactory.3 | 2 +- docs/man/man3/ModuleMessage.3 | 2 +- docs/man/man3/QLine.3 | 2 +- docs/man/man3/Request.3 | 52 +- docs/man/man3/Server.3 | 747 ++++---- docs/man/man3/StrHashComp.3 | 20 +- docs/man/man3/Version.3 | 6 +- docs/man/man3/XLine.3 | 2 +- docs/man/man3/ZLine.3 | 2 +- docs/man/man3/base.h.3 | 2 +- docs/man/man3/channels.cpp.3 | 12 +- docs/man/man3/channels.h.3 | 2 +- docs/man/man3/chanrec.3 | 83 +- docs/man/man3/classbase.3 | 2 +- docs/man/man3/command_t.3 | 2 +- docs/man/man3/commands.h.3 | 6 +- docs/man/man3/connection.3 | 6 +- docs/man/man3/connection.h.3 | 2 +- docs/man/man3/ctables.h.3 | 2 +- docs/man/man3/dns.h.3 | 2 +- docs/man/man3/dns_ip4list.3 | 2 +- docs/man/man3/ircd_connector.3 | 2 +- docs/man/man3/message.h.3 | 2 +- docs/man/man3/mode.h.3 | 2 +- docs/man/man3/modules.cpp.3 | 264 +-- docs/man/man3/modules.h.3 | 4 +- docs/man/man3/nspace.3 | 2 +- docs/man/man3/nspace_nspace_hash_ in_addr _.3 | 14 +- docs/man/man3/nspace_nspace_hash_ string _.3 | 18 +- docs/man/man3/serverrec.3 | 2 +- docs/man/man3/servers.cpp.3 | 2 +- docs/man/man3/servers.h.3 | 2 +- docs/man/man3/std.3 | 2 +- docs/man/man3/ucrec.3 | 2 +- docs/man/man3/userrec.3 | 495 +++-- docs/man/man3/users.cpp.3 | 2 +- docs/man/man3/users.h.3 | 6 +- docs/man/man3/xline.h.3 | 2 +- docs/module-doc/annotated.html | 2 +- docs/module-doc/base_8h-source.html | 2 +- docs/module-doc/base_8h.html | 2 +- docs/module-doc/channels_8cpp-source.html | 75 +- docs/module-doc/channels_8cpp.html | 38 +- docs/module-doc/channels_8h-source.html | 2 +- docs/module-doc/channels_8h.html | 2 +- docs/module-doc/classAdmin-members.html | 2 +- docs/module-doc/classAdmin.html | 6 +- docs/module-doc/classBanItem-members.html | 2 +- docs/module-doc/classBanItem.html | 2 +- docs/module-doc/classConfigReader-members.html | 2 +- docs/module-doc/classConfigReader.html | 278 +-- docs/module-doc/classConnectClass-members.html | 4 +- docs/module-doc/classConnectClass.html | 98 +- docs/module-doc/classDNS-members.html | 2 +- docs/module-doc/classDNS.html | 2 +- docs/module-doc/classELine-members.html | 2 +- docs/module-doc/classELine.html | 2 +- docs/module-doc/classEvent-members.html | 2 +- docs/module-doc/classEvent.html | 46 +- docs/module-doc/classExemptItem-members.html | 2 +- docs/module-doc/classExemptItem.html | 2 +- docs/module-doc/classExtMode-members.html | 2 +- docs/module-doc/classExtMode.html | 30 +- docs/module-doc/classExtensible-members.html | 2 +- docs/module-doc/classExtensible.html | 2 +- docs/module-doc/classFileReader-members.html | 2 +- docs/module-doc/classFileReader.html | 82 +- docs/module-doc/classGLine-members.html | 2 +- docs/module-doc/classGLine.html | 2 +- docs/module-doc/classHostItem-members.html | 2 +- docs/module-doc/classHostItem.html | 2 +- docs/module-doc/classInviteItem-members.html | 2 +- docs/module-doc/classInviteItem.html | 2 +- docs/module-doc/classInvited-members.html | 2 +- docs/module-doc/classInvited.html | 4 +- docs/module-doc/classKLine-members.html | 2 +- docs/module-doc/classKLine.html | 2 +- docs/module-doc/classModeParameter-members.html | 2 +- docs/module-doc/classModeParameter.html | 2 +- docs/module-doc/classModule-members.html | 2 +- docs/module-doc/classModule.html | 228 +-- docs/module-doc/classModuleFactory-members.html | 2 +- docs/module-doc/classModuleFactory.html | 2 +- docs/module-doc/classModuleMessage-members.html | 2 +- docs/module-doc/classModuleMessage.html | 2 +- docs/module-doc/classQLine-members.html | 2 +- docs/module-doc/classQLine.html | 2 +- docs/module-doc/classRequest-members.html | 2 +- docs/module-doc/classRequest.html | 60 +- docs/module-doc/classServer-members.html | 2 +- docs/module-doc/classServer.html | 781 ++++---- docs/module-doc/classVersion-members.html | 2 +- docs/module-doc/classVersion.html | 6 +- docs/module-doc/classXLine-members.html | 2 +- docs/module-doc/classXLine.html | 2 +- docs/module-doc/classZLine-members.html | 2 +- docs/module-doc/classZLine.html | 2 +- docs/module-doc/classchanrec-members.html | 2 +- docs/module-doc/classchanrec.html | 91 +- docs/module-doc/classclassbase-members.html | 2 +- docs/module-doc/classclassbase.html | 2 +- docs/module-doc/classcommand__t-members.html | 2 +- docs/module-doc/classcommand__t.html | 2 +- docs/module-doc/classconnection-members.html | 2 +- docs/module-doc/classconnection.html | 10 +- docs/module-doc/classes.html | 2 +- docs/module-doc/classircd__connector-members.html | 2 +- docs/module-doc/classircd__connector.html | 2 +- docs/module-doc/classserverrec-members.html | 2 +- docs/module-doc/classserverrec.html | 2 +- docs/module-doc/classucrec-members.html | 2 +- docs/module-doc/classucrec.html | 4 +- docs/module-doc/classuserrec-members.html | 16 +- docs/module-doc/classuserrec.html | 759 +++++--- docs/module-doc/commands_8h-source.html | 4 +- docs/module-doc/commands_8h.html | 10 +- docs/module-doc/connection_8h-source.html | 2 +- docs/module-doc/connection_8h.html | 2 +- docs/module-doc/ctables_8h-source.html | 2 +- docs/module-doc/ctables_8h.html | 2 +- docs/module-doc/dns_8h-source.html | 2 +- docs/module-doc/dns_8h.html | 2 +- docs/module-doc/files.html | 2 +- docs/module-doc/functions.html | 45 +- docs/module-doc/functions_func.html | 14 +- docs/module-doc/functions_vars.html | 27 +- docs/module-doc/globals.html | 8 +- docs/module-doc/globals_defs.html | 2 +- docs/module-doc/globals_func.html | 2 +- docs/module-doc/globals_type.html | 2 +- docs/module-doc/globals_vars.html | 11 +- docs/module-doc/hierarchy.html | 2 +- docs/module-doc/main.html | 2 +- docs/module-doc/message_8h-source.html | 2 +- docs/module-doc/message_8h.html | 14 +- docs/module-doc/mode_8h-source.html | 2 +- docs/module-doc/mode_8h.html | 2 +- docs/module-doc/modules_8cpp-source.html | 2016 ++++++++++---------- docs/module-doc/modules_8cpp.html | 298 +-- docs/module-doc/modules_8h-source.html | 2 +- docs/module-doc/modules_8h.html | 36 +- docs/module-doc/namespacenspace.html | 2 +- docs/module-doc/namespaces.html | 2 +- docs/module-doc/namespacestd.html | 2 +- docs/module-doc/servers_8cpp-source.html | 2 +- docs/module-doc/servers_8cpp.html | 2 +- docs/module-doc/servers_8h-source.html | 2 +- docs/module-doc/servers_8h.html | 2 +- .../module-doc/structInAddr__HashComp-members.html | 2 +- docs/module-doc/structInAddr__HashComp.html | 22 +- docs/module-doc/structStrHashComp-members.html | 2 +- docs/module-doc/structStrHashComp.html | 20 +- docs/module-doc/structdns__ip4list-members.html | 2 +- docs/module-doc/structdns__ip4list.html | 2 +- ..._1nspace_1_1hash_3_01in__addr_01_4-members.html | 2 +- ...nspace_1_1nspace_1_1hash_3_01in__addr_01_4.html | 14 +- ..._1_1nspace_1_1hash_3_01string_01_4-members.html | 2 +- ...ctnspace_1_1nspace_1_1hash_3_01string_01_4.html | 18 +- docs/module-doc/users_8cpp-source.html | 394 ++-- docs/module-doc/users_8cpp.html | 2 +- docs/module-doc/users_8h-source.html | 192 +- docs/module-doc/users_8h.html | 6 +- docs/module-doc/xline_8h-source.html | 2 +- docs/module-doc/xline_8h.html | 22 +- include/users.h | 12 + 184 files changed, 4580 insertions(+), 3896 deletions(-) diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 55e088419..b9b9f25c6 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "12 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 304 of file modules.cpp. +Definition at line 313 of file modules.cpp. .PP .nf -304 : Name(name), Email(email), Nick(nick) { }; +313 : 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 c1b9d2b62..79b82b66d 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 303fdf0d9..6d130dd79 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -89,213 +89,213 @@ Definition at line 1147 of file modules.h. .PP .SS "ConfigReader::ConfigReader ()" .PP -Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 851 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 869 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -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 } +870 { +871 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +872 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +873 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +874 if (!this->readerror) +875 this->error = CONF_FILE_NOT_FOUND; +876 } .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 870 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 888 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -871 { -872 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -873 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -874 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -875 if (!this->readerror) -876 this->error = CONF_FILE_NOT_FOUND; -877 }; +889 { +890 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +891 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +892 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +893 if (!this->readerror) +894 this->error = CONF_FILE_NOT_FOUND; +895 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 861 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 879 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -862 { -863 if (this->cache) -864 delete this->cache; -865 if (this->errorlog) -866 delete this->errorlog; -867 } +880 { +881 if (this->cache) +882 delete this->cache; +883 if (this->errorlog) +884 delete this->errorlog; +885 } .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 948 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 966 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -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 } +967 { +968 if (bail) +969 { +970 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +971 exit(0); +972 } +973 else +974 { +975 char dataline[1024]; +976 if (user) +977 { +978 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +979 while (!errorlog->eof()) +980 { +981 errorlog->getline(dataline,1024); +982 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +983 } +984 } +985 else +986 { +987 WriteOpers('There were errors in the configuration file:',user->nick); +988 while (!errorlog->eof()) +989 { +990 errorlog->getline(dataline,1024); +991 WriteOpers(dataline); +992 } +993 } +994 return; +995 } +996 } .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 981 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 999 of file modules.cpp. .PP References cache. .PP .nf -982 { -983 return EnumConf(cache,tag.c_str()); -984 } +1000 { +1001 return EnumConf(cache,tag.c_str()); +1002 } .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 then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 986 of file modules.cpp. +Returns the number of items within a tag. For example if the tag was then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 1004 of file modules.cpp. .PP References cache. .PP .nf -987 { -988 return EnumValues(cache, tag.c_str(), index); -989 } +1005 { +1006 return EnumValues(cache, tag.c_str(), index); +1007 } .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 941 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 959 of file modules.cpp. .PP References error. .PP .nf -942 { -943 long olderr = this->error; -944 this->error = 0; -945 return olderr; -946 } +960 { +961 long olderr = this->error; +962 this->error = 0; +963 return olderr; +964 } .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 895 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 913 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -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 } +914 { +915 char val[MAXBUF]; +916 char t[MAXBUF]; +917 char n[MAXBUF]; +918 strlcpy(t,tag.c_str(),MAXBUF); +919 strlcpy(n,name.c_str(),MAXBUF); +920 int res = ReadConf(cache,t,n,index,val); +921 if (!res) +922 { +923 this->error = CONF_VALUE_NOT_FOUND; +924 return false; +925 } +926 std::string s = val; +927 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +928 } .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 912 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 930 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -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 } +931 { +932 char val[MAXBUF]; +933 char t[MAXBUF]; +934 char n[MAXBUF]; +935 strlcpy(t,tag.c_str(),MAXBUF); +936 strlcpy(n,name.c_str(),MAXBUF); +937 int res = ReadConf(cache,t,n,index,val); +938 if (!res) +939 { +940 this->error = CONF_VALUE_NOT_FOUND; +941 return 0; +942 } +943 for (int i = 0; i < strlen(val); i++) +944 { +945 if (!isdigit(val[i])) +946 { +947 this->error = CONF_NOT_A_NUMBER; +948 return 0; +949 } +950 } +951 if ((needs_unsigned) && (atoi(val)<0)) +952 { +953 this->error = CONF_NOT_UNSIGNED; +954 return 0; +955 } +956 return atoi(val); +957 } .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 879 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 897 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 ''; -891 } -892 return std::string(val); -893 } +898 { +899 char val[MAXBUF]; +900 char t[MAXBUF]; +901 char n[MAXBUF]; +902 strlcpy(t,tag.c_str(),MAXBUF); +903 strlcpy(n,name.c_str(),MAXBUF); +904 int res = ReadConf(cache,t,n,index,val); +905 if (!res) +906 { +907 this->error = CONF_VALUE_NOT_FOUND; +908 return ''; +909 } +910 return val; +911 } .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 991 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 1009 of file modules.cpp. .PP References readerror. .PP .nf -992 { -993 return this->readerror; -994 } +1010 { +1011 return this->readerror; +1012 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index 0721962c6..fd38a4afe 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -50,6 +50,14 @@ Inherits \fBclassbase\fP. .RI "long \fBthreshold\fP" .br .RI "\fIThreshold value for flood disconnect. \fP" +.ti -1c +.RI "long \fBsendqmax\fP" +.br +.RI "\fIMaximum size of sendq for users in this class (bytes). \fP" +.ti -1c +.RI "long \fBrecvqmax\fP" +.br +.RI "\fIMaximum size of recvq for users in this class (bytes). \fP" .in -1c .SH "Detailed Description" .PP @@ -58,19 +66,21 @@ Holds information relevent to and tags in the con .PP .SS "ConnectClass::ConnectClass ()\fC [inline]\fP" .PP -Definition at line 71 of file users.h. +Definition at line 79 of file users.h. .PP -References flood, host, pass, pingtime, registration_timeout, and threshold. +References flood, host, pass, pingtime, recvqmax, registration_timeout, sendqmax, and threshold. .PP .nf -72 { -73 registration_timeout = 0; -74 flood = 0; -75 pingtime = 0; -76 threshold = 0; -77 strlcpy(host,'',MAXBUF); -78 strlcpy(pass,'',MAXBUF); -79 } +80 { +81 registration_timeout = 0; +82 flood = 0; +83 pingtime = 0; +84 threshold = 0; +85 sendqmax = 0; +86 recvqmax = 0; +87 strlcpy(host,'',MAXBUF); +88 strlcpy(pass,'',MAXBUF); +89 } .fi .SH "Member Data Documentation" .PP @@ -94,11 +104,21 @@ Referenced by ConnectClass(). Number of seconds between pings for this line. Definition at line 62 of file users.h. .PP Referenced by ConnectClass(). +.SS "long \fBConnectClass::recvqmax\fP" +.PP +Maximum size of recvq for users in this class (bytes). Definition at line 77 of file users.h. +.PP +Referenced by ConnectClass(). .SS "int \fBConnectClass::registration_timeout\fP" .PP Max time to register the connection in seconds. Definition at line 53 of file users.h. .PP Referenced by ConnectClass(). +.SS "long \fBConnectClass::sendqmax\fP" +.PP +Maximum size of sendq for users in this class (bytes). Definition at line 73 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. diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index cb54283c9..01d015245 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index 1dbd2376f..b0cec0b21 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Event.3 b/docs/man/man3/Event.3 index 0c5e83e40..1f24c87ef 100644 --- a/docs/man/man3/Event.3 +++ b/docs/man/man3/Event.3 @@ -1,4 +1,4 @@ -.TH "Event" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Event" 3 "12 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 335 of file modules.cpp. +Create a new Event. Definition at line 344 of file modules.cpp. .PP .nf -335 : data(anydata), source(src), id(eventid) { }; +344 : data(anydata), source(src), id(eventid) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Event::GetData ()" .PP -Get the Event data. Definition at line 337 of file modules.cpp. +Get the Event data. Definition at line 346 of file modules.cpp. .PP References data. .PP .nf -338 { -339 return this->data; -340 } +347 { +348 return this->data; +349 } .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 353 of file modules.cpp. +Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 362 of file modules.cpp. .PP References id. .PP .nf -354 { -355 return this->id; -356 } +363 { +364 return this->id; +365 } .fi .SS "\fBModule\fP * Event::GetSource ()" .PP -Get the event Source. Definition at line 342 of file modules.cpp. +Get the event Source. Definition at line 351 of file modules.cpp. .PP References source. .PP .nf -343 { -344 return this->source; -345 } +352 { +353 return this->source; +354 } .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 347 of file modules.cpp. +Definition at line 356 of file modules.cpp. .PP References FOREACH_MOD. .PP .nf -348 { -349 FOREACH_MOD OnEvent(this); -350 return NULL; -351 } +357 { +358 FOREACH_MOD OnEvent(this); +359 return NULL; +360 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index 4985ca640..a0cbb2205 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index 5b17a22cb..7e19955b6 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "12 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 202 of file modules.cpp. +Definition at line 211 of file modules.cpp. .PP References modechar, needsoper, params_when_off, params_when_on, and type. .PP .nf -202 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +211 : 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 201 of file modules.cpp. +Definition at line 210 of file modules.cpp. .SS "char \fBExtMode::modechar\fP" .PP -Definition at line 196 of file modules.cpp. +Definition at line 205 of file modules.cpp. .PP Referenced by ExtMode(). .SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 200 of file modules.cpp. +Definition at line 209 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 199 of file modules.cpp. +Definition at line 208 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 198 of file modules.cpp. +Definition at line 207 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::type\fP" .PP -Definition at line 197 of file modules.cpp. +Definition at line 206 of file modules.cpp. .PP Referenced by ExtMode(). diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index b58890fb7..1e7f0d1be 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 8373506b9..cf62c2546 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -62,89 +62,89 @@ Definition at line 1236 of file modules.h. .PP .SS "FileReader::FileReader ()" .PP -Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 1004 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 1022 of file modules.cpp. .PP .nf -1005 { -1006 } +1023 { +1024 } .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 997 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 1015 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -998 { -999 file_cache c; -1000 readfile(c,filename.c_str()); -1001 this->fc = c; -1002 } +1016 { +1017 file_cache c; +1018 readfile(c,filename.c_str()); +1019 this->fc = c; +1020 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 1016 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 1034 of file modules.cpp. .PP .nf -1017 { -1018 } +1035 { +1036 } .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 1020 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 1038 of file modules.cpp. .PP References fc. .PP .nf -1021 { -1022 if (fc.size() == 0) -1023 { -1024 return(false); -1025 } -1026 else -1027 { -1028 return(true); -1029 } -1030 } +1039 { +1040 if (fc.size() == 0) +1041 { +1042 return(false); +1043 } +1044 else +1045 { +1046 return(true); +1047 } +1048 } .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 1039 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 1057 of file modules.cpp. .PP References fc. .PP .nf -1040 { -1041 return fc.size(); -1042 } +1058 { +1059 return fc.size(); +1060 } .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 1032 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 1050 of file modules.cpp. .PP References fc. .PP .nf -1033 { -1034 if ((x<0) || (x>fc.size())) -1035 return ''; -1036 return fc[x]; -1037 } +1051 { +1052 if ((x<0) || (x>fc.size())) +1053 return ''; +1054 return fc[x]; +1055 } .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 1008 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 1026 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -1009 { -1010 file_cache c; -1011 readfile(c,filename.c_str()); -1012 this->fc = c; -1013 } +1027 { +1028 file_cache c; +1029 readfile(c,filename.c_str()); +1030 this->fc = c; +1031 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index 155dffeb0..6d305802e 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index b61539767..8add954a4 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "12 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 70c1be8df..a0b2fcee6 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "12 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 162 of file modules.cpp. +Definition at line 171 of file modules.cpp. .PP .nf -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 } +172 { +173 size_t q; +174 size_t p; +175 +176 memcpy(&q,&s1,sizeof(size_t)); +177 memcpy(&p,&s2,sizeof(size_t)); +178 +179 return (q == p); +180 } .fi diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 595b9a85e..105d7a1b6 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index cdb965a47..144c18aeb 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index 4fa82add2..9c7ef5e29 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 3868a5d81..89a3a3247 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 079f8b674..d83fa9e0f 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -251,35 +251,35 @@ Definition at line 236 of file modules.h. .PP .SS "Module::Module ()" .PP -Default constructor creates a module class. Definition at line 360 of file modules.cpp. +Default constructor creates a module class. Definition at line 369 of file modules.cpp. .PP .nf -360 { } +369 { } .fi .SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class. Definition at line 361 of file modules.cpp. +Default destructor destroys a module class. Definition at line 370 of file modules.cpp. .PP .nf -361 { } +370 { } .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 373 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 382 of file modules.cpp. .PP References VF_VENDOR. .PP .nf -373 { return Version(1,0,0,0,VF_VENDOR); } +382 { 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 385 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 394 of file modules.cpp. .PP .nf -385 { }; +394 { }; .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP @@ -307,312 +307,312 @@ Called before an action which requires a channel privilage check. This function .br .br - Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 382 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 391 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -382 { return ACR_DEFAULT; }; +391 { 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. +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 419 of file modules.cpp. .PP .nf -410 { return 0; }; +419 { 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 388 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 397 of file modules.cpp. .PP .nf -388 { }; +397 { }; .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 402 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 411 of file modules.cpp. .PP .nf -402 { return 0; }; +411 { 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 401 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 410 of file modules.cpp. .PP .nf -401 { return 0; }; +410 { 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 384 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 393 of file modules.cpp. .PP References string_list. .PP .nf -384 { string_list empty; return empty; } +393 { 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 399 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 408 of file modules.cpp. .PP .nf -399 { return 0; }; +408 { 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 396 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 405 of file modules.cpp. .PP .nf -396 { return 0; }; +405 { 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 397 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 406 of file modules.cpp. .PP .nf -397 { return 0; }; +406 { 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 398 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 407 of file modules.cpp. .PP .nf -398 { return 0; }; +407 { 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 391 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 400 of file modules.cpp. .PP .nf -391 { return true; }; +400 { 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. +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 420 of file modules.cpp. .PP .nf -411 { return 0; }; +420 { 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 405 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 414 of file modules.cpp. .PP .nf -405 { return; }; +414 { 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 372 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 381 of file modules.cpp. .PP .nf -372 { return false; } +381 { 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 409 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 418 of file modules.cpp. .PP .nf -409 { }; +418 { }; .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 408 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 417 of file modules.cpp. .PP .nf -408 { }; +417 { }; .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 - :information hereDefinition at line 375 of file modules.cpp. + :information hereDefinition at line 384 of file modules.cpp. .PP .nf -375 { }; +384 { }; .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 386 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 395 of file modules.cpp. .PP .nf -386 { return 0; }; +395 { 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 387 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 396 of file modules.cpp. .PP .nf -387 { }; +396 { }; .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 403 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 412 of file modules.cpp. .PP .nf -403 { return 0; }; +412 { 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 404 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 413 of file modules.cpp. .PP .nf -404 { return 0; }; +413 { 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 374 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 383 of file modules.cpp. .PP .nf -374 { }; +383 { }; .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 407 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 416 of file modules.cpp. .PP .nf -407 { return 0; }; +416 { 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 368 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 377 of file modules.cpp. .PP .nf -368 { } +377 { } .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 367 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 376 of file modules.cpp. .PP .nf -367 { } +376 { } .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 390 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 399 of file modules.cpp. .PP .nf -390 { return 0; }; +399 { 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 395 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 404 of file modules.cpp. .PP .nf -395 { return 0; }; +404 { 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. +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 421 of file modules.cpp. .PP .nf -412 { }; +421 { }; .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. +Called immediately before any socket is closed. When this event is called, shutdown() has not yet been called on the socket.Definition at line 423 of file modules.cpp. .PP .nf -414 { }; +423 { }; .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. +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 424 of file modules.cpp. .PP .nf -415 { return 0; }; +424 { 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. +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 422 of file modules.cpp. .PP .nf -413 { return 0; }; +422 { 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 369 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 378 of file modules.cpp. .PP .nf -369 { } +378 { } .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 406 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 415 of file modules.cpp. .PP Referenced by Request::Send(). .PP .nf -406 { return NULL; }; +415 { 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 389 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 398 of file modules.cpp. .PP .nf -389 { }; +398 { }; .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 370 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 379 of file modules.cpp. .PP .nf -370 { } +379 { } .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 400 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 409 of file modules.cpp. .PP .nf -400 { }; +409 { }; .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 362 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 371 of file modules.cpp. .PP .nf -362 { } +371 { } .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 364 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 373 of file modules.cpp. .PP .nf -364 { } +373 { } .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 365 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 374 of file modules.cpp. .PP .nf -365 { } +374 { } .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 394 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 403 of file modules.cpp. .PP .nf -394 { }; +403 { }; .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 366 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 375 of file modules.cpp. .PP .nf -366 { } +375 { } .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 381 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 390 of file modules.cpp. .PP .nf -381 { }; +390 { }; .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 377 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 386 of file modules.cpp. .PP .nf -377 { return 0; }; +386 { return 0; }; .fi .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP" .PP @@ -620,68 +620,68 @@ Called whenever a user is about to join a channel, before any processing is done .PP IMPORTANT NOTE! .PP -If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 371 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 380 of file modules.cpp. .PP .nf -371 { return 0; } +380 { 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 393 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 402 of file modules.cpp. .PP .nf -393 { return 0; }; +402 { 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 378 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 387 of file modules.cpp. .PP .nf -378 { return 0; }; +387 { 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 380 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 389 of file modules.cpp. .PP .nf -380 { return 0; }; +389 { 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 379 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 388 of file modules.cpp. .PP .nf -379 { return 0; }; +388 { 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 363 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 372 of file modules.cpp. .PP .nf -363 { } +372 { } .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 392 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 401 of file modules.cpp. .PP .nf -392 { }; +401 { }; .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 383 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 392 of file modules.cpp. .PP References string_list. .PP .nf -383 { string_list empty; return empty; } +392 { 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 376 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 385 of file modules.cpp. .PP .nf -376 { }; +385 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index 8ab598e32..923a7c29c 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModuleMessage.3 b/docs/man/man3/ModuleMessage.3 index bcc6a69e0..e2d06c5d8 100644 --- a/docs/man/man3/ModuleMessage.3 +++ b/docs/man/man3/ModuleMessage.3 @@ -1,4 +1,4 @@ -.TH "ModuleMessage" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleMessage" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index 8558748e9..6a299acae 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Request.3 b/docs/man/man3/Request.3 index e3bc31498..dbee6d6fc 100644 --- a/docs/man/man3/Request.3 +++ b/docs/man/man3/Request.3 @@ -1,4 +1,4 @@ -.TH "Request" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Request" 3 "12 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 306 of file modules.cpp. +Create a new Request. Definition at line 315 of file modules.cpp. .PP .nf -306 : data(anydata), source(src), dest(dst) { }; +315 : data(anydata), source(src), dest(dst) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Request::GetData ()" .PP -Fetch the Request data. Definition at line 308 of file modules.cpp. +Fetch the Request data. Definition at line 317 of file modules.cpp. .PP References data. .PP .nf -309 { -310 return this->data; -311 } +318 { +319 return this->data; +320 } .fi .SS "\fBModule\fP * Request::GetDest ()" .PP -Fetch the request destination (should be 'this' in the receiving module). Definition at line 318 of file modules.cpp. +Fetch the request destination (should be 'this' in the receiving module). Definition at line 327 of file modules.cpp. .PP References dest. .PP .nf -319 { -320 return this->dest; -321 } +328 { +329 return this->dest; +330 } .fi .SS "\fBModule\fP * Request::GetSource ()" .PP -Fetch the request source. Definition at line 313 of file modules.cpp. +Fetch the request source. Definition at line 322 of file modules.cpp. .PP References source. .PP .nf -314 { -315 return this->source; -316 } +323 { +324 return this->source; +325 } .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 323 of file modules.cpp. +Definition at line 332 of file modules.cpp. .PP References dest, and Module::OnRequest(). .PP .nf -324 { -325 if (this->dest) -326 { -327 return dest->OnRequest(this); -328 } -329 else -330 { -331 return NULL; -332 } -333 } +333 { +334 if (this->dest) +335 { +336 return dest->OnRequest(this); +337 } +338 else +339 { +340 return NULL; +341 } +342 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 739987c2a..67345f2cc 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -267,19 +267,19 @@ Definition at line 694 of file modules.h. .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 421 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 430 of file modules.cpp. .PP .nf -422 { -423 } +431 { +432 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 425 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 434 of file modules.cpp. .PP .nf -426 { -427 } +435 { +436 } .fi .SH "Member Function Documentation" .PP @@ -289,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 494 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 503 of file modules.cpp. .PP References createcommand(). .PP .nf -495 { -496 createcommand(cmd,f,flags,minparams,source); -497 } +504 { +505 createcommand(cmd,f,flags,minparams,source); +506 } .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 731 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 749 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf -732 { -733 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -734 } +750 { +751 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +752 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -321,540 +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 657 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 666 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -658 { -659 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -660 if (res) -661 ModeMakeList(modechar); -662 return res; -663 } +667 { +668 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +669 if (res) +670 ModeMakeList(modechar); +671 return res; +672 } .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 629 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 638 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -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 } +639 { +640 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) +641 { +642 if (type == MT_SERVER) +643 { +644 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +645 return false; +646 } +647 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +648 { +649 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +650 return false; +651 } +652 if ((params_when_on>1) || (params_when_off>1)) +653 { +654 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +655 return false; +656 } +657 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +658 } +659 else +660 { +661 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); +662 } +663 return false; +664 } .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 711 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 729 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf -712 { -713 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -714 } +730 { +731 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +732 } .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 726 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 744 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf -727 { -728 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -729 } +745 { +746 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +747 } .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 716 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 734 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf -717 { -718 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -719 } +735 { +736 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +737 } .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 721 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 739 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf -722 { -723 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -724 } +740 { +741 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +742 } .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 761 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 779 of file modules.cpp. .PP References duration(). .PP .nf -762 { -763 return duration(delta.c_str()); -764 } +780 { +781 return duration(delta.c_str()); +782 } .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 484 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 493 of file modules.cpp. .PP .nf -485 { -486 call_handler(commandname.c_str(),parameters,pcnt,user); -487 } +494 { +495 call_handler(commandname.c_str(),parameters,pcnt,user); +496 } .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 577 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 586 of file modules.cpp. .PP References ChangeName(). .PP .nf -578 { -579 ChangeName(user,gecos.c_str()); -580 } +587 { +588 ChangeName(user,gecos.c_str()); +589 } .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 572 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 581 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -573 { -574 ChangeDisplayedHost(user,host.c_str()); -575 } +582 { +583 ChangeDisplayedHost(user,host.c_str()); +584 } .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 469 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 478 of file modules.cpp. .PP .nf -470 { -471 force_nickchange(user,nickname.c_str()); -472 } +479 { +480 force_nickchange(user,nickname.c_str()); +481 } .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 602 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 611 of file modules.cpp. .PP References cmode(). .PP .nf -603 { -604 return cmode(User,Chan); -605 } +612 { +613 return cmode(User,Chan); +614 } .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 550 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 559 of file modules.cpp. .PP References common_channels(). .PP .nf -551 { -552 return (common_channels(u1,u2) != 0); -553 } +560 { +561 return (common_channels(u1,u2) != 0); +562 } .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 665 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 674 of file modules.cpp. .PP .nf -666 { -667 return usercount(c); -668 } +675 { +676 return usercount(c); +677 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local E-Line. Definition at line 756 of file modules.cpp. +Deletes a local E-Line. Definition at line 774 of file modules.cpp. .PP References del_eline(). .PP .nf -757 { -758 del_eline(hostmask.c_str()); -759 } +775 { +776 del_eline(hostmask.c_str()); +777 } .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 736 of file modules.cpp. +Deletes a G-Line from all servers on the mesh. Definition at line 754 of file modules.cpp. .PP References del_gline(). .PP .nf -737 { -738 del_gline(hostmask.c_str()); -739 } +755 { +756 del_gline(hostmask.c_str()); +757 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local K-Line. Definition at line 751 of file modules.cpp. +Deletes a local K-Line. Definition at line 769 of file modules.cpp. .PP References del_kline(). .PP .nf -752 { -753 del_kline(hostmask.c_str()); -754 } +770 { +771 del_kline(hostmask.c_str()); +772 } .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 741 of file modules.cpp. +Deletes a Q-Line from all servers on the mesh. Definition at line 759 of file modules.cpp. .PP References del_qline(). .PP .nf -742 { -743 del_qline(nickname.c_str()); -744 } +760 { +761 del_qline(nickname.c_str()); +762 } .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 746 of file modules.cpp. +Deletes a Z-Line from all servers on the mesh. Definition at line 764 of file modules.cpp. .PP References del_zline(). .PP .nf -747 { -748 del_zline(ipaddr.c_str()); -749 } +765 { +766 del_zline(ipaddr.c_str()); +767 } .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 597 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 606 of file modules.cpp. .PP .nf -598 { -599 return FindChan(channel.c_str()); -600 } +607 { +608 return FindChan(channel.c_str()); +609 } .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. +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 601 of file modules.cpp. .PP References fd_ref_table. .PP .nf -593 { -594 return (socket < 65536 ? fd_ref_table[socket] : NULL); -595 } +602 { +603 return (socket < 65536 ? fd_ref_table[socket] : NULL); +604 } .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 839 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 857 of file modules.cpp. .PP References MODCOUNT, module_names, and modules. .PP .nf -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 } +858 { +859 for (int i = 0; i <= MODCOUNT; i++) +860 { +861 if (module_names[i] == name) +862 { +863 return modules[i]; +864 } +865 } +866 return NULL; +867 } .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 587 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 596 of file modules.cpp. .PP .nf -588 { -589 return Find(nick); -590 } +597 { +598 return Find(nick); +599 } .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 622 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 631 of file modules.cpp. .PP .nf -623 { -624 return Admin(getadminname(),getadminemail(),getadminnick()); -625 } +632 { +633 return Admin(getadminname(),getadminemail(),getadminnick()); +634 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 617 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 626 of file modules.cpp. .PP .nf -618 { -619 return getnetworkname(); -620 } +627 { +628 return getnetworkname(); +629 } .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 612 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 621 of file modules.cpp. .PP .nf -613 { -614 return getservername(); -615 } +622 { +623 return getservername(); +624 } .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 457 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 466 of file modules.cpp. .PP References chanuserlist, chanrec::GetUsers(), and list. .PP .nf -458 { -459 chanuserlist userl; -460 userl.clear(); -461 std::vector *list = chan->GetUsers(); -462 for (std::vector::iterator i = list->begin(); i != list->end(); i++) -463 { -464 char* o = *i; -465 userl.push_back((userrec*)o); -466 } -467 return userl; -468 } +467 { +468 chanuserlist userl; +469 userl.clear(); +470 std::vector *list = chan->GetUsers(); +471 for (std::vector::iterator i = list->begin(); i != list->end(); i++) +472 { +473 char* o = *i; +474 userl.push_back((userrec*)o); +475 } +476 return userl; +477 } .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 582 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 591 of file modules.cpp. .PP References isnick(). .PP .nf -583 { -584 return (isnick(nick.c_str()) != 0); -585 } +592 { +593 return (isnick(nick.c_str()) != 0); +594 } .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 607 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 616 of file modules.cpp. .PP References has_channel(). .PP .nf -608 { -609 return has_channel(User,Chan); -610 } +617 { +618 return has_channel(User,Chan); +619 } .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 479 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 488 of file modules.cpp. .PP References is_uline(). .PP .nf -480 { -481 return is_uline(server.c_str()); -482 } +489 { +490 return is_uline(server.c_str()); +491 } .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 766 of file modules.cpp. +Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 784 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) +785 { +786 const char* dest = mask.c_str(); +787 if (strchr(dest,'!')==0) +788 return false; +789 if (strchr(dest,'@')==0) 790 return false; -791 -792 return true; -793 } +791 for (int i = 0; i < strlen(dest); i++) +792 if (dest[i] < 32) +793 return false; +794 for (int i = 0; i < strlen(dest); i++) +795 if (dest[i] > 126) +796 return false; +797 int c = 0; +798 for (int i = 0; i < strlen(dest); i++) +799 if (dest[i] == '!') +800 c++; +801 if (c>1) +802 return false; +803 c = 0; +804 for (int i = 0; i < strlen(dest); i++) +805 if (dest[i] == '@') +806 c++; +807 if (c>1) +808 return false; +809 +810 return true; +811 } .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 447 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 456 of file modules.cpp. .PP .nf -448 { -449 return add_channel(user,cname.c_str(),key.c_str(),false); -450 } +457 { +458 return add_channel(user,cname.c_str(),key.c_str(),false); +459 } .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 489 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 498 of file modules.cpp. .PP .nf -490 { -491 log(level,'%s',s.c_str()); -492 } +499 { +500 log(level,'%s',s.c_str()); +501 } .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 434 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 443 of file modules.cpp. .PP .nf -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 } +444 { +445 char literal[MAXBUF],pattern[MAXBUF]; +446 strlcpy(literal,sliteral.c_str(),MAXBUF); +447 strlcpy(pattern,spattern.c_str(),MAXBUF); +448 return match(literal,pattern); +449 } .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 821 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 839 of file modules.cpp. .PP .nf -822 { -823 if (c) -824 { -825 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -826 } -827 else return false; -828 } +840 { +841 if (c) +842 { +843 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +844 } +845 else return false; +846 } .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 830 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 848 of file modules.cpp. .PP .nf -831 { -832 if (u) -833 { -834 return CommonOnThisServer(u,(char*)servername.c_str()); -835 } -836 else return false; -837 } +849 { +850 if (u) +851 { +852 return CommonOnThisServer(u,(char*)servername.c_str()); +853 } +854 else return false; +855 } .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 795 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 813 of file modules.cpp. .PP .nf -796 { -797 NetSendToAll((char*)text.c_str()); -798 } +814 { +815 NetSendToAll((char*)text.c_str()); +816 } .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 806 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 824 of file modules.cpp. .PP .nf -807 { -808 NetSendToAllAlive((char*)text.c_str()); -809 } +825 { +826 NetSendToAllAlive((char*)text.c_str()); +827 } .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 816 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 834 of file modules.cpp. .PP .nf -817 { -818 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -819 } +835 { +836 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); +837 } .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 800 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 818 of file modules.cpp. .PP .nf -801 { -802 if (user) -803 NetSendToCommon(user,(char*)text.c_str()); -804 } +819 { +820 if (user) +821 NetSendToCommon(user,(char*)text.c_str()); +822 } .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 811 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 829 of file modules.cpp. .PP .nf -812 { -813 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -814 } +830 { +831 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +832 } .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 452 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 461 of file modules.cpp. .PP .nf -453 { -454 return del_channel(user,cname.c_str(),reason.c_str(),false); -455 } +462 { +463 return del_channel(user,cname.c_str(),reason.c_str(),false); +464 } .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 681 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 699 of file modules.cpp. .PP References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. .PP .nf -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 } +700 { +701 zombie->fd = alive->fd; +702 alive->fd = FD_MAGIC_NUMBER; +703 alive->ClearBuffer(); +704 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +705 kill_link(alive,message.c_str()); +706 fd_ref_table[zombie->fd] = zombie; +707 for (int i = 0; i != MAXCHANS; i++) +708 { +709 if (zombie->chans[i].channel != NULL) +710 { +711 if (zombie->chans[i].channel->name) +712 { +713 chanrec* Ptr = zombie->chans[i].channel; +714 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +715 if (Ptr->topicset) +716 { +717 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +718 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +719 } +720 userlist(zombie,Ptr); +721 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +722 +723 } +724 } +725 } +726 +727 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -862,71 +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 474 of file modules.cpp. +Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 483 of file modules.cpp. .PP .nf -475 { -476 kill_link(user,reason.c_str()); -477 } +484 { +485 kill_link(user,reason.c_str()); +486 } .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 504 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 513 of file modules.cpp. .PP .nf -505 { -506 Write(Socket,'%s',s.c_str()); -507 } +514 { +515 Write(Socket,'%s',s.c_str()); +516 } .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 538 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 547 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 } +548 { +549 if (IncludeSender) +550 { +551 WriteChannel(Channel,User,'%s',s.c_str()); +552 } +553 else +554 { +555 ChanExceptSender(Channel,User,'%s',s.c_str()); +556 } +557 } .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. +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 542 of file modules.cpp. .PP .nf -534 { -535 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); -536 } +543 { +544 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); +545 } .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 555 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 564 of file modules.cpp. .PP .nf -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 } +565 { +566 if (IncludeSender) +567 { +568 WriteCommon(User,'%s',text.c_str()); +569 } +570 else +571 { +572 WriteCommonExcept(User,'%s',text.c_str()); +573 } +574 } .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 514 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 523 of file modules.cpp. .PP .nf -515 { -516 WriteFrom(Socket,User,'%s',s.c_str()); -517 } +524 { +525 WriteFrom(Socket,User,'%s',s.c_str()); +526 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -944,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 499 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 508 of file modules.cpp. .PP References server_mode(). .PP .nf -500 { -501 server_mode(parameters,pcnt,user); -502 } +509 { +510 server_mode(parameters,pcnt,user); +511 } .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 429 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 438 of file modules.cpp. .PP .nf -430 { -431 WriteOpers('%s',s.c_str()); -432 } +439 { +440 WriteOpers('%s',s.c_str()); +441 } .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 509 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 518 of file modules.cpp. .PP .nf -510 { -511 WriteServ(Socket,'%s',s.c_str()); -512 } +519 { +520 WriteServ(Socket,'%s',s.c_str()); +521 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -981,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 519 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 528 of file modules.cpp. .PP References connection::fd. .PP .nf -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 } +529 { +530 if (!Source) +531 { +532 // if source is NULL, then the message originates from the local server +533 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +534 } +535 else +536 { +537 // otherwise it comes from the user specified +538 WriteTo(Source,Dest,'%s',s.c_str()); +539 } +540 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -1005,37 +1005,46 @@ Sends to all users matching a mode mask You must specify one or more usermodes a .PP Serv->SendToModeMask('xi', WM_OR, 'm00'); .PP -Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 442 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 451 of file modules.cpp. .PP .nf -443 { -444 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -445 } +452 { +453 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +454 } .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 567 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 576 of file modules.cpp. .PP .nf -568 { -569 WriteWallOps(User,false,'%s',text.c_str()); -570 } +577 { +578 WriteWallOps(User,false,'%s',text.c_str()); +579 } .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 671 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 680 of file modules.cpp. .PP -References userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. +References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf -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 } +681 { +682 unsigned int old_fd = user->fd; +683 user->fd = FD_MAGIC_NUMBER; +684 user->ClearBuffer(); +685 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +686 #ifdef USE_KQUEUE +687 struct kevent ke; +688 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); +689 int i = kevent(kq, &ke, 1, 0, 0, NULL); +690 if (i == -1) +691 { +692 log(DEBUG,'kqueue: Failed to remove user from queue!'); +693 } +694 #endif +695 shutdown(old_fd,2); +696 close(old_fd); +697 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 77581534f..11917dc9e 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "12 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 147 of file modules.cpp. +Definition at line 156 of file modules.cpp. .PP .nf -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 } +157 { +158 char a[MAXBUF],b[MAXBUF]; +159 strlcpy(a,s1.c_str(),MAXBUF); +160 strlcpy(b,s2.c_str(),MAXBUF); +161 strlower(a); +162 strlower(b); +163 return (strcasecmp(a,b) == 0); +164 } .fi diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index a6a4e7a22..3b845ffd7 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "12 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 300 of file modules.cpp. +Definition at line 309 of file modules.cpp. .PP .nf -300 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; +309 : 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 9bf0c83b7..17f34ffc1 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 4dba12a85..0aac4c787 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "12 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 2b198832a..a99a43e13 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "12 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 2d62f95bc..a0eaaabdc 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -174,7 +174,7 @@ channels.cpp \- .RI "int \fBportCount\fP" .br .ti -1c -.RI "int \fBUDPportCount\fP" +.RI "int \fBSERVERportCount\fP" .br .ti -1c .RI "int \fBports\fP [MAXSOCKS]" @@ -273,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 1048 of file modules.cpp. +Definition at line 1066 of file modules.cpp. .PP Referenced by Server::FindModule(). .SS "std::vector \fBmodule_names\fP" @@ -319,6 +319,9 @@ Definition at line 70 of file channels.cpp. .SS "char \fBServerName\fP[MAXBUF]" .PP Definition at line 68 of file channels.cpp. +.SS "int \fBSERVERportCount\fP" +.PP +Definition at line 96 of file channels.cpp. .SS "time_t \fBstartup_time\fP" .PP Definition at line 86 of file channels.cpp. @@ -327,9 +330,6 @@ Definition at line 86 of file channels.cpp. Definition at line 107 of file channels.cpp. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). -.SS "int \fBUDPportCount\fP" -.PP -Definition at line 96 of file channels.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP Definition at line 84 of file channels.cpp. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index 77dd2caea..675c0dcb8 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 8dcd2fade..532b54825 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -173,48 +173,43 @@ Definition at line 240 of file channels.h. .PP .SS "void chanrec::AddUser (char * castuser)" .PP -Add a user pointer to the internal reference list The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 220 of file channels.cpp. +Add a user pointer to the internal reference list The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 215 of file channels.cpp. .PP References DEBUG, and internal_userlist. .PP .nf -221 { -222 internal_userlist.push_back(castuser); -223 log(DEBUG,'Added casted user to channel's internal list'); -224 } +216 { +217 internal_userlist.push_back(castuser); +218 log(DEBUG,'Added casted user to channel's internal list'); +219 } .fi .SS "void chanrec::DecUserCounter ()" .PP -Decrement the channel 'user counter' The channel user counter is a reference counter which holds the number of users on the channel. If it decremented to 0 then the channel is removed from the system. Modules may alter the reference count to hold channels open which have no users and would normally be deleted once empty.Definition at line 208 of file channels.cpp. -.PP -References DEBUG, name, and users. +Decrement the channel 'user counter' The channel user counter is a reference counter which holds the number of users on the channel. If it decremented to 0 then the channel is removed from the system. Modules may alter the reference count to hold channels open which have no users and would normally be deleted once empty.Definition at line 206 of file channels.cpp. .PP .nf -209 { -210 if (this->users > 0) -211 this->users--; -212 log(DEBUG,'Decremented channel user count for %s to %lu',name,(unsigned long)users); -213 } +207 { +208 } .fi .SS "void chanrec::DelUser (char * castuser)" .PP -Delete a user pointer to the internal reference list The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 226 of file channels.cpp. +Delete a user pointer to the internal reference list The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 221 of file channels.cpp. .PP References DEBUG, internal_userlist, and name. .PP .nf -227 { -228 for (std::vector::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) -229 { -230 if (*a == castuser) -231 { -232 log(DEBUG,'Removed casted user from channel's internal list'); -233 internal_userlist.erase(a); -234 return; -235 } -236 } -237 log(DEBUG,'BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!',name); -238 } +222 { +223 for (std::vector::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) +224 { +225 if (*a == castuser) +226 { +227 log(DEBUG,'Removed casted user from channel's internal list'); +228 internal_userlist.erase(a); +229 return; +230 } +231 } +232 log(DEBUG,'BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!',name); +233 } .fi .SS "std::string chanrec::GetModeParameter (char mode)" .PP @@ -230,48 +225,44 @@ References custom_mode_params. 192 { 193 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) 194 { -195 return std::string(i->parameter); +195 return i->parameter; 196 } 197 } 198 } -199 return std::string(''); +199 return ''; 200 } .fi .SS "long chanrec::GetUserCounter ()" .PP -Obtain the channel 'user counter' This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks. Definition at line 215 of file channels.cpp. +Obtain the channel 'user counter' This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks. Definition at line 210 of file channels.cpp. .PP -References users. +References internal_userlist. .PP .nf -216 { -217 return (this->users); -218 } +211 { +212 return (this->internal_userlist.size()); +213 } .fi .SS "std::vector< char * > * chanrec::GetUsers ()" .PP -Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*. These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.Definition at line 240 of file channels.cpp. +Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*. These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.Definition at line 235 of file channels.cpp. .PP References internal_userlist. .PP Referenced by Server::GetUsers(). .PP .nf -241 { -242 return &internal_userlist; -243 } +236 { +237 return &internal_userlist; +238 } .fi .SS "void chanrec::IncUserCounter ()" .PP Increment the channel 'user counter' The channel user counter is a reference counter which holds the number of users on the channel. If it decremented to 0 then the channel is removed from the system.Definition at line 202 of file channels.cpp. .PP -References DEBUG, name, and users. -.PP .nf 203 { -204 this->users++; -205 log(DEBUG,'Incremented channel user count for %s to %lu',name,(unsigned long)users); -206 } +204 } .fi .SS "bool chanrec::IsCustomModeSet (char mode)" .PP @@ -378,7 +369,7 @@ Referenced by chanrec(), and SetCustomMode(). .PP User list (casted to char*'s to stop forward declaration stuff) (chicken and egg scenario!). Definition at line 112 of file channels.h. .PP -Referenced by AddUser(), chanrec(), DelUser(), and GetUsers(). +Referenced by AddUser(), chanrec(), DelUser(), GetUserCounter(), and GetUsers(). .SS "short int \fBchanrec::inviteonly\fP" .PP Nonzero if the mode +i is set. Definition at line 150 of file channels.h. @@ -403,7 +394,7 @@ Referenced by chanrec(). .PP The channels name. Definition at line 99 of file channels.h. .PP -Referenced by chanrec(), DecUserCounter(), DelUser(), IncUserCounter(), and Server::PseudoToUser(). +Referenced by chanrec(), DelUser(), and Server::PseudoToUser(). .SS "short int \fBchanrec::noexternal\fP" .PP Nonzero if the mode +n is set. Definition at line 146 of file channels.h. @@ -438,7 +429,7 @@ Referenced by chanrec(), and Server::PseudoToUser(). .PP Count of users on the channel used for fast user counting. Definition at line 107 of file channels.h. .PP -Referenced by chanrec(), DecUserCounter(), GetUserCounter(), and IncUserCounter(). +Referenced by chanrec(). .SH "Author" .PP diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index da70de3fc..d3883c280 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "12 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 9fa5a044c..73fb0d567 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "12 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 ac7a2a429..b7ddb1900 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -178,7 +178,7 @@ commands.h \- .RI "void \fBhandle_unloadmodule\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br .ti -1c -.RI "void \fBhandle_link_packet\fP (char *udp_msg, char *tcp_host, \fBserverrec\fP *serv)" +.RI "void \fBhandle_link_packet\fP (char *tcp_msg, char *tcp_host, \fBserverrec\fP *serv)" .br .RI "\fISpecial functions for processing server to server traffic. \fP" .ti -1c @@ -315,7 +315,7 @@ These are the handlers for user commands. .PP .SS "void handle_L (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" .PP -.SS "void handle_link_packet (char * udp_msg, char * tcp_host, \fBserverrec\fP * serv)" +.SS "void handle_link_packet (char * tcp_msg, char * tcp_host, \fBserverrec\fP * serv)" .PP Special functions for processing server to server traffic. .SS "void handle_links (char ** parameters, int pcnt, \fBuserrec\fP * user)" diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index 7b1f51029..ce72610f8 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -179,7 +179,7 @@ Referenced by userrec::userrec(). .PP Stats counter for bytes outbound. Definition at line 235 of file connection.h. .PP -Referenced by userrec::userrec(). +Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). .SS "long \fBconnection::cmds_in\fP" .PP Stats counter for commands inbound. Definition at line 239 of file connection.h. @@ -189,7 +189,7 @@ Referenced by userrec::userrec(). .PP Stats counter for commands outbound. Definition at line 243 of file connection.h. .PP -Referenced by userrec::userrec(). +Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). .SS "std::vector<\fBircd_connector\fP> \fBconnection::connectors\fP" .PP With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 290 of file connection.h. diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index 492693091..173b6a511 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "12 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 194ed71d7..ad716bbfd 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "12 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 1f6765422..67317c948 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "12 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 eeb799dea..4f34c0ccb 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "12 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 7e39dd73d..ba180d210 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 21aa67806..7112fdcb5 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index f4a8d3254..9fc1b3c85 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "12 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 2bfbe387e..680c95da6 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -245,7 +245,7 @@ modules.cpp \- .RI "int \fBportCount\fP" .br .ti -1c -.RI "int \fBUDPportCount\fP" +.RI "int \fBSERVERportCount\fP" .br .ti -1c .RI "int \fBports\fP [MAXSOCKS]" @@ -297,162 +297,162 @@ modules.cpp \- .PP .SS "#define nspace std" .PP -Definition at line 59 of file modules.cpp. +Definition at line 64 of file modules.cpp. .SH "Typedef Documentation" .PP .SS "typedef nspace::hash_map, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 178 of file modules.cpp. +Definition at line 187 of file modules.cpp. .SS "typedef nspace::hash_map, \fBStrHashComp\fP> \fBchan_hash\fP" .PP -Definition at line 177 of file modules.cpp. +Definition at line 186 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 179 of file modules.cpp. +Definition at line 188 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 205 of file modules.cpp. +Definition at line 214 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 206 of file modules.cpp. +Definition at line 215 of file modules.cpp. .PP Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "typedef nspace::hash_map, \fBStrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 176 of file modules.cpp. +Definition at line 185 of file modules.cpp. .SH "Function Documentation" .PP .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)" .PP -Definition at line 275 of file modules.cpp. +Definition at line 284 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -276 { -277 if (ModeDefined(modechar,type)) { -278 return false; -279 } -280 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -281 return true; -282 } +285 { +286 if (ModeDefined(modechar,type)) { +287 return false; +288 } +289 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +290 return true; +291 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 212 of file modules.cpp. +Definition at line 221 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -213 { -214 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -215 { -216 if ((i->modechar == modechar) && (i->type == type)) -217 { -218 return true; -219 } -220 } -221 return false; -222 } +222 { +223 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +224 { +225 if ((i->modechar == modechar) && (i->type == type)) +226 { +227 return true; +228 } +229 } +230 return false; +231 } .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 262 of file modules.cpp. +Definition at line 271 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -263 { -264 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -265 { -266 if ((i->modechar == modechar) && (i->type == type)) -267 { -268 return i->params_when_off; -269 } -270 } -271 return 0; -272 } +272 { +273 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +274 { +275 if ((i->modechar == modechar) && (i->type == type)) +276 { +277 return i->params_when_off; +278 } +279 } +280 return 0; +281 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 249 of file modules.cpp. +Definition at line 258 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -250 { -251 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -252 { -253 if ((i->modechar == modechar) && (i->type == type)) -254 { -255 return i->params_when_on; -256 } -257 } -258 return 0; -259 } +259 { +260 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +261 { +262 if ((i->modechar == modechar) && (i->type == type)) +263 { +264 return i->params_when_on; +265 } +266 } +267 return 0; +268 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 236 of file modules.cpp. +Definition at line 245 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -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 } +246 { +247 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +248 { +249 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +250 { +251 return true; +252 } +253 } +254 return false; +255 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP -Definition at line 224 of file modules.cpp. +Definition at line 233 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -225 { -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 } +234 { +235 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +236 { +237 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +238 { +239 return true; +240 } +241 } +242 return false; +243 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 285 of file modules.cpp. +Definition at line 294 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -286 { -287 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -288 { -289 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -290 { -291 i->list = true; -292 return; -293 } -294 } -295 return; -296 } +295 { +296 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +297 { +298 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +299 { +300 i->list = true; +301 return; +302 } +303 } +304 return; +305 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -460,146 +460,146 @@ Referenced by Server::AddExtendedListMode(). .PP .SS "char \fBAdminEmail\fP[MAXBUF]" .PP -Definition at line 75 of file modules.cpp. +Definition at line 84 of file modules.cpp. .SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 74 of file modules.cpp. +Definition at line 83 of file modules.cpp. .SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 76 of file modules.cpp. +Definition at line 85 of file modules.cpp. .SS "std::vector \fBauth_cookies\fP" .PP -Definition at line 103 of file modules.cpp. +Definition at line 112 of file modules.cpp. .SS "int \fBboundPortCount\fP" .PP -Definition at line 97 of file modules.cpp. +Definition at line 106 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 183 of file modules.cpp. +Definition at line 192 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 182 of file modules.cpp. +Definition at line 191 of file modules.cpp. .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 185 of file modules.cpp. +Definition at line 194 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 104 of file modules.cpp. +Definition at line 113 of file modules.cpp. .SS "int \fBdebugging\fP" .PP -Definition at line 85 of file modules.cpp. +Definition at line 94 of file modules.cpp. .SS "int \fBdefaultRoute\fP" .PP -Definition at line 101 of file modules.cpp. +Definition at line 110 of file modules.cpp. .SS "int \fBDieDelay\fP" .PP -Definition at line 88 of file modules.cpp. +Definition at line 97 of file modules.cpp. .SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 77 of file modules.cpp. +Definition at line 86 of file modules.cpp. .SS "char \fBDieValue\fP[MAXBUF]" .PP -Definition at line 83 of file modules.cpp. +Definition at line 92 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 209 of file modules.cpp. +Definition at line 218 of file modules.cpp. .PP Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "std::vector<\fBircd_module\fP*> factory" .PP -Definition at line 66 of file modules.cpp. +Definition at line 75 of file modules.cpp. .SS "std::vector \fBfd_reap\fP" .PP -Definition at line 94 of file modules.cpp. +Definition at line 103 of file modules.cpp. .SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]" .PP -Definition at line 110 of file modules.cpp. +Definition at line 119 of file modules.cpp. .PP Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 188 of file modules.cpp. +Definition at line 197 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 81 of file modules.cpp. +Definition at line 90 of file modules.cpp. .SS "FILE* \fBlog_file\fP" .PP -Definition at line 108 of file modules.cpp. +Definition at line 117 of file modules.cpp. .SS "int \fBLogLevel\fP" .PP -Definition at line 70 of file modules.cpp. +Definition at line 79 of file modules.cpp. .SS "int \fBMaxWhoResults\fP" .PP -Definition at line 91 of file modules.cpp. +Definition at line 100 of file modules.cpp. .SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 106 of file modules.cpp. +Definition at line 115 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1048 of file modules.cpp. +Definition at line 1066 of file modules.cpp. .SS "std::vector \fBmodule_names\fP" .PP -Definition at line 95 of file modules.cpp. +Definition at line 104 of file modules.cpp. .SS "std::vector<\fBModule\fP*> modules" .PP -Definition at line 65 of file modules.cpp. +Definition at line 74 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 186 of file modules.cpp. +Definition at line 195 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 79 of file modules.cpp. +Definition at line 88 of file modules.cpp. .SS "time_t \fBnb_start\fP" .PP -Definition at line 92 of file modules.cpp. +Definition at line 101 of file modules.cpp. .SS "int \fBNetBufferSize\fP" .PP -Definition at line 90 of file modules.cpp. +Definition at line 99 of file modules.cpp. .SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 72 of file modules.cpp. +Definition at line 81 of file modules.cpp. .SS "int \fBportCount\fP" .PP -Definition at line 98 of file modules.cpp. +Definition at line 107 of file modules.cpp. .SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 100 of file modules.cpp. +Definition at line 109 of file modules.cpp. .SS "char \fBPrefixQuit\fP[MAXBUF]" .PP -Definition at line 82 of file modules.cpp. +Definition at line 91 of file modules.cpp. .SS "char \fBrestartpass\fP[MAXBUF]" .PP -Definition at line 78 of file modules.cpp. +Definition at line 87 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 187 of file modules.cpp. +Definition at line 196 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP -Definition at line 80 of file modules.cpp. +Definition at line 89 of file modules.cpp. .SS "char \fBServerDesc\fP[MAXBUF]" .PP -Definition at line 73 of file modules.cpp. +Definition at line 82 of file modules.cpp. .SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 71 of file modules.cpp. +Definition at line 80 of file modules.cpp. +.SS "int \fBSERVERportCount\fP" +.PP +Definition at line 108 of file modules.cpp. .SS "time_t \fBstartup_time\fP" .PP -Definition at line 89 of file modules.cpp. +Definition at line 98 of file modules.cpp. .SS "time_t \fBTIME\fP" .PP -Definition at line 68 of file modules.cpp. -.SS "int \fBUDPportCount\fP" -.PP -Definition at line 99 of file modules.cpp. +Definition at line 77 of file modules.cpp. .SS "\fBuser_hash\fP \fBwhowas\fP" .PP -Definition at line 184 of file modules.cpp. +Definition at line 193 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP -Definition at line 87 of file modules.cpp. +Definition at line 96 of file modules.cpp. .SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 86 of file modules.cpp. +Definition at line 95 of file modules.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index 4be3d09c9..1984b3535 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -252,7 +252,7 @@ Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigR .PP Definition at line 23 of file modules.h. .PP -Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DecUserCounter(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IncUserCounter(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). +Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), chanrec::SetCustomModeParam(), userrec::SetWriteError(), and Server::UserToPseudo(). .SS "#define DEFAULT 30" .PP Definition at line 25 of file modules.h. diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index c0b5d7ec0..988ea4876 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "12 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 f4d292abd..f08aba5aa 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 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "12 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 120 of file modules.cpp. +Definition at line 129 of file modules.cpp. .PP .nf -121 { -122 size_t q; -123 memcpy(&q,&a,sizeof(size_t)); -124 return q; -125 } +130 { +131 size_t q; +132 memcpy(&q,&a,sizeof(size_t)); +133 return q; +134 } .fi diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index 2ed553162..e80d304e4 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 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "12 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 133 of file modules.cpp. +Definition at line 142 of file modules.cpp. .PP .nf -134 { -135 char a[MAXBUF]; -136 static struct hash strhash; -137 strlcpy(a,s.c_str(),MAXBUF); -138 strlower(a); -139 return strhash(a); -140 } +143 { +144 char a[MAXBUF]; +145 static struct hash strhash; +146 strlcpy(a,s.c_str(),MAXBUF); +147 strlower(a); +148 return strhash(a); +149 } .fi diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index c5b428a4a..2ef264c76 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "12 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 41fd8df92..13dd38cae 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "12 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 b486aef53..c1f48b32d 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index dd1a4d72e..b5a32c75a 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 168036a35..941107fdd 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 7e5c3ea11..e1951f22a 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -61,6 +61,22 @@ Inherits \fBconnection\fP. .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" +.ti -1c +.RI "void \fBSetWriteError\fP (std::string error)" +.br +.RI "\fISets the write error for a connection. \fP" +.ti -1c +.RI "std::string \fBGetWriteError\fP ()" +.br +.RI "\fIReturns the write error which last occured on this connection or an empty string if none occured. \fP" +.ti -1c +.RI "void \fBAddWriteBuf\fP (std::string data)" +.br +.RI "\fIAdds to the user's write buffer. \fP" +.ti -1c +.RI "void \fBFlushWriteBuf\fP ()" +.br +.RI "\fIFlushes as much of the user's buffer to the file descriptor as possible. \fP" .in -1c .SS "Public Attributes" @@ -129,6 +145,10 @@ Inherits \fBconnection\fP. .br .RI "\fIUser's receive queue. \fP" .ti -1c +.RI "std::string \fBsendq\fP" +.br +.RI "\fIUser's send queue. \fP" +.ti -1c .RI "long \fBlines_in\fP" .br .RI "\fIFlood counters. \fP" @@ -138,6 +158,17 @@ Inherits \fBconnection\fP. .ti -1c .RI "long \fBthreshold\fP" .br +.ti -1c +.RI "std::string \fBWriteError\fP" +.br +.ti -1c +.RI "long \fBsendqmax\fP" +.br +.RI "\fIMaximum size this user's sendq can become. \fP" +.ti -1c +.RI "long \fBrecvqmax\fP" +.br +.RI "\fIMaximum size this user's recvq can become. \fP" .in -1c .SS "Private Attributes" @@ -153,14 +184,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 98 of file users.h. +Definition at line 108 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, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, result, server, connection::signon, TIME, 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, sendq, server, connection::signon, TIME, timeout, and ucrec::uc_modes. .PP .nf 29 { @@ -184,339 +215,443 @@ References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, 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 } +50 sendq = ''; +51 strcpy(result,''); +52 for (int i = 0; i < MAXCHANS; i++) +53 { +54 this->chans[i].channel = NULL; +55 this->chans[i].uc_modes = 0; +56 } +57 invites.clear(); +58 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 195 of file users.h. +Definition at line 222 of file users.h. .PP .nf -195 { } +222 { } .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. +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 170 of file users.cpp. .PP -References recvq. +References recvq, recvqmax, and SetWriteError(). +.PP +.nf +171 { +172 std::string b = ''; +173 for (int i = 0; i < a.length(); i++) +174 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) +175 b = b + a[i]; +176 std::stringstream stream(recvq); +177 stream << b; +178 recvq = stream.str(); +179 int i = 0; +180 // count the size of the first line in the buffer. +181 while (i < recvq.length()) +182 { +183 if (recvq[i++] == '\n') +184 break; +185 } +186 if (recvq.length() > this->recvqmax) +187 { +188 this->SetWriteError('RecvQ exceeded'); +189 WriteOpers('*** User %s RecvQ of %d exceeds connect class maximum of %d',this->nick,recvq.length(),this->recvqmax); +190 } +191 // return false if we've had more than 600 characters WITHOUT +192 // a carriage return (this is BAD, drop the socket) +193 return (i < 600); +194 } +.fi +.SS "void userrec::AddWriteBuf (std::string data)" +.PP +Adds to the user's write buffer. You may add any amount of text up to this users sendq value, if you exceed the sendq value, \fBSetWriteError()\fP will be called to set the users error string to 'SendQ exceeded', and further buffer adds will be dropped.Definition at line 226 of file users.cpp. +.PP +References GetWriteError(), sendq, sendqmax, and SetWriteError(). .PP .nf -170 { -171 std::string b = ''; -172 for (int i = 0; i < a.length(); i++) -173 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) -174 b = b + a[i]; -175 std::stringstream stream(recvq); -176 stream << b; -177 recvq = stream.str(); -178 int i = 0; -179 // count the size of the first line in the buffer. -180 while (i < recvq.length()) -181 { -182 if (recvq[i++] == '\n') -183 break; -184 } -185 // 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 } +227 { +228 if (this->GetWriteError() != '') +229 return; +230 if (sendq.length() + data.length() > this->sendqmax) +231 { +232 WriteOpers('*** User %s SendQ of %d exceeds connect class maximum of %d',this->nick,sendq.length() + data.length(),this->sendqmax); +233 this->SetWriteError('SendQ exceeded'); +234 return; +235 } +236 std::stringstream stream; +237 stream << sendq << data; +238 sendq = stream.str(); +239 } .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. +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 196 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 } +197 { +198 for (int i = 0; i < recvq.length(); i++) +199 if (recvq[i] == '\n') +200 return true; +201 return false; +202 } .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. +This function clears the entire buffer by setting it to an empty string. Definition at line 204 of file users.cpp. .PP References recvq. .PP Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). .PP .nf -199 { -200 recvq = ''; -201 } +205 { +206 recvq = ''; +207 } +.fi +.SS "void userrec::FlushWriteBuf ()" +.PP +Flushes as much of the user's buffer to the file descriptor as possible. This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method.Definition at line 242 of file users.cpp. +.PP +References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError(). +.PP +.nf +243 { +244 if (sendq.length()) +245 { +246 char* tb = (char*)this->sendq.c_str(); +247 int n_sent = write(this->fd,tb,this->sendq.length()); +248 if (n_sent == -1) +249 { +250 this->SetWriteError(strerror(errno)); +251 } +252 else +253 { +254 // advance the queue +255 tb += n_sent; +256 this->sendq = tb; +257 // update the user's stats counters +258 this->bytes_out += n_sent; +259 this->cmds_out++; +260 } +261 } +262 } .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. +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 209 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 } +210 { +211 if (recvq == '') +212 return ''; +213 char* line = (char*)recvq.c_str(); +214 std::string ret = ''; +215 while ((*line != '\n') && (strlen(line))) +216 { +217 ret = ret + *line; +218 line++; +219 } +220 if ((*line == '\n') || (*line == '\r')) +221 line++; +222 recvq = line; +223 return ret; +224 } .fi .SS "char * userrec::GetFullHost ()\fC [virtual]\fP" .PP -Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 61 of file users.cpp. +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 62 of file users.cpp. .PP References dhost, ident, nick, and result. .PP .nf -62 { -63 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -64 return result; -65 } +63 { +64 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +65 return result; +66 } .fi .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP" .PP -Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 68 of file users.cpp. +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 69 of file users.cpp. .PP References connection::host, ident, nick, and result. .PP .nf -69 { -70 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -71 return result; -72 } +70 { +71 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +72 return result; +73 } +.fi +.SS "std::string userrec::GetWriteError ()" +.PP +Returns the write error which last occured on this connection or an empty string if none occured. Definition at line 272 of file users.cpp. +.PP +References WriteError. +.PP +Referenced by AddWriteBuf(). +.PP +.nf +273 { +274 return this->WriteError; +275 } .fi .SS "bool userrec::HasPermission (char * command)" .PP -Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 117 of file users.cpp. +Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 118 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -118 { -119 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -120 char* mycmd; -121 char* savept; -122 char* savept2; -123 -124 // are they even an oper at all? -125 if (strchr(this->modes,'o')) -126 { -127 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -128 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -129 { -130 ConfValue('type','name',j,TypeName,&config_f); -131 if (!strcmp(TypeName,this->oper)) -132 { -133 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -134 ConfValue('type','classes',j,Classes,&config_f); -135 char* myclass = strtok_r(Classes,' ',&savept); -136 while (myclass) -137 { -138 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -139 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -140 { -141 ConfValue('class','name',k,ClassName,&config_f); -142 if (!strcmp(ClassName,myclass)) -143 { -144 ConfValue('class','commands',k,CommandList,&config_f); -145 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -146 +119 { +120 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +121 char* mycmd; +122 char* savept; +123 char* savept2; +124 +125 // are they even an oper at all? +126 if (strchr(this->modes,'o')) +127 { +128 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +129 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +130 { +131 ConfValue('type','name',j,TypeName,&config_f); +132 if (!strcmp(TypeName,this->oper)) +133 { +134 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +135 ConfValue('type','classes',j,Classes,&config_f); +136 char* myclass = strtok_r(Classes,' ',&savept); +137 while (myclass) +138 { +139 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +140 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +141 { +142 ConfValue('class','name',k,ClassName,&config_f); +143 if (!strcmp(ClassName,myclass)) +144 { +145 ConfValue('class','commands',k,CommandList,&config_f); +146 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); 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 } +148 +149 mycmd = strtok_r(CommandList,' ',&savept2); +150 while (mycmd) +151 { +152 if (!strcasecmp(mycmd,command)) +153 { +154 log(DEBUG,'*** Command %s found, returning true',command); +155 return true; +156 } +157 mycmd = strtok_r(NULL,' ',&savept2); +158 } +159 } +160 } +161 myclass = strtok_r(NULL,' ',&savept); +162 } +163 } +164 } +165 } +166 return false; +167 } .fi .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP" .PP -Adds a channel to a users invite list (invites them to a channel). Definition at line 88 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 89 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -89 { -90 Invited i; -91 strlcpy(i.channel,channel,CHANMAX); -92 invites.push_back(i); -93 } +90 { +91 Invited i; +92 strlcpy(i.channel,channel,CHANMAX); +93 invites.push_back(i); +94 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 74 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 75 of file users.cpp. .PP References invites. .PP .nf -75 { -76 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -77 { -78 if (i->channel) { -79 if (!strcasecmp(i->channel,channel)) -80 { -81 return true; -82 } -83 } -84 } -85 return false; -86 } +76 { +77 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +78 { +79 if (i->channel) { +80 if (!strcasecmp(i->channel,channel)) +81 { +82 return true; +83 } +84 } +85 } +86 return false; +87 } .fi .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP" .PP -Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 95 of file users.cpp. +Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 96 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -96 { -97 log(DEBUG,'Removing invites'); -98 if (channel) -99 { -100 if (invites.size()) -101 { -102 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -103 { -104 if (i->channel) -105 { -106 if (!strcasecmp(i->channel,channel)) -107 { -108 invites.erase(i); -109 return; -110 } -111 } -112 } -113 } -114 } -115 } +97 { +98 log(DEBUG,'Removing invites'); +99 if (channel) +100 { +101 if (invites.size()) +102 { +103 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +104 { +105 if (i->channel) +106 { +107 if (!strcasecmp(i->channel,channel)) +108 { +109 invites.erase(i); +110 return; +111 } +112 } +113 } +114 } +115 } +116 } +.fi +.SS "void userrec::SetWriteError (std::string error)" +.PP +Sets the write error for a connection. This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged.Definition at line 264 of file users.cpp. +.PP +References DEBUG, and WriteError. +.PP +Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf(). +.PP +.nf +265 { +266 log(DEBUG,'Setting error string for %s to '%s'',this->nick,error.c_str()); +267 // don't try to set the error twice, its already set take the first string. +268 if (this->WriteError == '') +269 this->WriteError = error; +270 } .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 141 of file users.h. +The user's away message. If this string is empty, the user is not marked as away.Definition at line 151 of file users.h. .PP Referenced by userrec(). .SS "\fBucrec\fP \fBuserrec::chans\fP[MAXCHANS]" .PP -Definition at line 132 of file users.h. +Definition at line 142 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 120 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 130 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 169 of file users.h. +True when \fBDNS\fP lookups are completed. Definition at line 179 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 152 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 162 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::fullname\fP[128]" .PP -The users full name. Definition at line 124 of file users.h. +The users full name. Definition at line 134 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::ident\fP[64]" .PP -The users ident reply. Definition at line 115 of file users.h. +The users ident reply. Definition at line 125 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 104 of file users.h. +A list of channels the user has a pending invite to. Definition at line 114 of file users.h. .PP Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). .SS "long \fBuserrec::lines_in\fP" .PP -Flood counters. Definition at line 189 of file users.h. +Flood counters. Definition at line 204 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 130 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 140 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 111 of file users.h. +The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 121 of file users.h. .PP 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 165 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 175 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 179 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 189 of file users.h. .SS "unsigned long \fBuserrec::pingmax\fP" .PP -Number of seconds between PINGs for this user (set from tag. Definition at line 173 of file users.h. +Number of seconds between PINGs for this user (set from tag. Definition at line 183 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. +User's receive queue. Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.Definition at line 195 of file users.h. .PP Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec(). +.SS "long \fBuserrec::recvqmax\fP" +.PP +Maximum size this user's recvq can become. Definition at line 218 of file users.h. +.PP +Referenced by AddBuffer(). .SS "time_t \fBuserrec::reset_due\fP" .PP -Definition at line 190 of file users.h. +Definition at line 205 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 146 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 156 of file users.h. .PP Referenced by GetFullHost(), GetFullRealHost(), and userrec(). +.SS "std::string \fBuserrec::sendq\fP" +.PP +User's send queue. Lines waiting to be sent are stored here until their buffer is flushed.Definition at line 200 of file users.h. +.PP +Referenced by AddWriteBuf(), FlushWriteBuf(), and userrec(). +.SS "long \fBuserrec::sendqmax\fP" +.PP +Maximum size this user's sendq can become. Definition at line 214 of file users.h. +.PP +Referenced by AddWriteBuf(). .SS "char \fBuserrec::server\fP[256]" .PP -The server the user is connected to. Definition at line 136 of file users.h. +The server the user is connected to. Definition at line 146 of file users.h. .PP Referenced by userrec(). .SS "long \fBuserrec::threshold\fP" .PP -Definition at line 191 of file users.h. +Definition at line 206 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 158 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 168 of file users.h. .PP Referenced by userrec(). +.SS "std::string \fBuserrec::WriteError\fP" +.PP +Definition at line 210 of file users.h. +.PP +Referenced by GetWriteError(), and SetWriteError(). .SH "Author" .PP diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index 0416d8dc5..8e65da292 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "12 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 21e2e3b0d..ae5250157 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "12 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 90 of file users.h. +Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 100 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 84 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 94 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 8006488c5..0cbf51cfe 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index 05b7ad4af..f88151f06 100644 --- a/docs/module-doc/annotated.html +++ b/docs/module-doc/annotated.html @@ -46,7 +46,7 @@ XLineXLine is the base class for ban lines such as G lines and K lines ZLineZLine class -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:17 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/base_8h-source.html b/docs/module-doc/base_8h-source.html index 4b4b46e2e..647d678c1 100644 --- a/docs/module-doc/base_8h-source.html +++ b/docs/module-doc/base_8h-source.html @@ -55,7 +55,7 @@ 00079 00080 #endif 00081 -
Generated on Sat May 7 15:34:20 2005 for InspIRCd by +
Generated on Thu May 12 02:25:10 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/base_8h.html b/docs/module-doc/base_8h.html index db1420198..5d1b5c598 100644 --- a/docs/module-doc/base_8h.html +++ b/docs/module-doc/base_8h.html @@ -49,7 +49,7 @@ Definition at line 25 of file base.h. -
Generated on Sat May 7 15:34:21 2005 for InspIRCd by +
Generated on Thu May 12 02:25:14 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/channels_8cpp-source.html b/docs/module-doc/channels_8cpp-source.html index ac07b4d77..f91ebef7e 100644 --- a/docs/module-doc/channels_8cpp-source.html +++ b/docs/module-doc/channels_8cpp-source.html @@ -100,7 +100,7 @@ 00093 00094 extern int boundPortCount; 00095 extern int portCount; -00096 extern int UDPportCount; +00096 extern int SERVERportCount; 00097 extern int ports[MAXSOCKS]; 00098 extern int defaultRoute; 00099 @@ -199,56 +199,51 @@ 00192 { 00193 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) 00194 { -00195 return std::string(i->parameter); +00195 return i->parameter; 00196 } 00197 } 00198 } -00199 return std::string(""); +00199 return ""; 00200 } 00201 00202 void chanrec::IncUserCounter() 00203 { -00204 this->users++; -00205 log(DEBUG,"Incremented channel user count for %s to %lu",name,(unsigned long)users); -00206 } -00207 -00208 void chanrec::DecUserCounter() -00209 { -00210 if (this->users > 0) -00211 this->users--; -00212 log(DEBUG,"Decremented channel user count for %s to %lu",name,(unsigned long)users); +00204 } +00205 +00206 void chanrec::DecUserCounter() +00207 { +00208 } +00209 +00210 long chanrec::GetUserCounter() +00211 { +00212 return (this->internal_userlist.size()); 00213 } 00214 -00215 long chanrec::GetUserCounter() +00215 void chanrec::AddUser(char* castuser) 00216 { -00217 return (this->users); -00218 } -00219 -00220 void chanrec::AddUser(char* castuser) -00221 { -00222 internal_userlist.push_back(castuser); -00223 log(DEBUG,"Added casted user to channel's internal list"); -00224 } -00225 -00226 void chanrec::DelUser(char* castuser) -00227 { -00228 for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) -00229 { -00230 if (*a == castuser) -00231 { -00232 log(DEBUG,"Removed casted user from channel's internal list"); -00233 internal_userlist.erase(a); -00234 return; -00235 } -00236 } -00237 log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name); +00217 internal_userlist.push_back(castuser); +00218 log(DEBUG,"Added casted user to channel's internal list"); +00219 } +00220 +00221 void chanrec::DelUser(char* castuser) +00222 { +00223 for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) +00224 { +00225 if (*a == castuser) +00226 { +00227 log(DEBUG,"Removed casted user from channel's internal list"); +00228 internal_userlist.erase(a); +00229 return; +00230 } +00231 } +00232 log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name); +00233 } +00234 +00235 std::vector<char*> *chanrec::GetUsers() +00236 { +00237 return &internal_userlist; 00238 } -00239 -00240 std::vector<char*> *chanrec::GetUsers() -00241 { -00242 return &internal_userlist; -00243 } -
Generated on Sat May 7 15:34:20 2005 for InspIRCd by +
Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/channels_8cpp.html b/docs/module-doc/channels_8cpp.html index 053be42bb..39fc4be67 100644 --- a/docs/module-doc/channels_8cpp.html +++ b/docs/module-doc/channels_8cpp.html @@ -105,7 +105,7 @@ int portCount -int UDPportCount +int SERVERportCount int ports [MAXSOCKS] @@ -293,7 +293,7 @@ Definition at line 94

Definition at line 101 of file channels.cpp.

-Referenced by userrec::HasPermission(). +Referenced by userrec::HasPermission().

@@ -513,7 +513,7 @@ Definition at line 91

Definition at line 78 of file channels.cpp.

-Referenced by Server::GetUsers(). +Referenced by Server::GetUsers().

@@ -633,9 +633,9 @@ Definition at line 103

-Definition at line 1048 of file modules.cpp. +Definition at line 1066 of file modules.cpp.

-Referenced by Server::FindModule(). +Referenced by Server::FindModule().

@@ -661,7 +661,7 @@ Referenced by Server::FindM

Definition at line 92 of file channels.cpp.

-Referenced by Server::FindModule(). +Referenced by Server::FindModule().

@@ -687,7 +687,7 @@ Referenced by Server::FindM

Definition at line 64 of file channels.cpp.

-Referenced by Server::FindModule(). +Referenced by Server::FindModule().

@@ -954,13 +954,13 @@ Definition at line 70 Definition at line 68 of file channels.cpp. -

+

@@ -975,16 +975,16 @@ Definition at line 68

-Definition at line 86 of file channels.cpp. +Definition at line 96 of file channels.cpp.

-
time_t startup_time + int SERVERportCount
-

+

@@ -999,18 +999,16 @@ Definition at line 86

-Definition at line 107 of file channels.cpp. -

-Referenced by serverrec::serverrec(), and userrec::userrec(). +Definition at line 86 of file channels.cpp.

-
time_t TIME + time_t startup_time
-

+

@@ -1025,7 +1023,9 @@ Referenced by serverrec::se

-Definition at line 96 of file channels.cpp. +Definition at line 107 of file channels.cpp. +

+Referenced by serverrec::serverrec(), and userrec::userrec().

-
int UDPportCount + time_t TIME

@@ -1076,7 +1076,7 @@ Definition at line 84 Definition at line 83 of file channels.cpp. -


Generated on Sat May 7 15:34:21 2005 for InspIRCd by +
Generated on Thu May 12 02:25:14 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html index e5b46e8e7..62dfa2ef8 100644 --- a/docs/module-doc/channels_8h-source.html +++ b/docs/module-doc/channels_8h-source.html @@ -155,7 +155,7 @@ 00273 00274 #endif 00275 -
Generated on Sat May 7 15:34:20 2005 for InspIRCd by +
Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/channels_8h.html b/docs/module-doc/channels_8h.html index 3309aacd7..6b6fbdbe0 100644 --- a/docs/module-doc/channels_8h.html +++ b/docs/module-doc/channels_8h.html @@ -258,7 +258,7 @@ Holds a complete invite list. Definition at line 88 of file channels.h. -
Generated on Sat May 7 15:34:21 2005 for InspIRCd by +
Generated on Thu May 12 02:25:14 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classAdmin-members.html b/docs/module-doc/classAdmin-members.html index 77dd3c841..17bf4ca60 100644 --- a/docs/module-doc/classAdmin-members.html +++ b/docs/module-doc/classAdmin-members.html @@ -13,7 +13,7 @@ NameAdmin NickAdmin ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classAdmin.html b/docs/module-doc/classAdmin.html index 019560bc6..46fd7935d 100644 --- a/docs/module-doc/classAdmin.html +++ b/docs/module-doc/classAdmin.html @@ -76,9 +76,9 @@ Definition at line 123 of

-Definition at line 304 of file modules.cpp. +Definition at line 313 of file modules.cpp.

-

00304 : Name(name), Email(email), Nick(nick) { };
+
00313 : Name(name), Email(email), Nick(nick) { };
 
@@ -157,7 +157,7 @@ Definition at line 126 of
The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classBanItem-members.html b/docs/module-doc/classBanItem-members.html index 4e32014a4..f0897a061 100644 --- a/docs/module-doc/classBanItem-members.html +++ b/docs/module-doc/classBanItem-members.html @@ -14,7 +14,7 @@ set_timeHostItem ~classbase()classbase [inline] ~HostItem()HostItem [inline, virtual] -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classBanItem.html b/docs/module-doc/classBanItem.html index fcd2d112e..146df0543 100644 --- a/docs/module-doc/classBanItem.html +++ b/docs/module-doc/classBanItem.html @@ -22,7 +22,7 @@ A subclass of HostItem designed to h

Definition at line 45 of file channels.h.


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classConfigReader-members.html b/docs/module-doc/classConfigReader-members.html index 49f826983..9a52c0733 100644 --- a/docs/module-doc/classConfigReader-members.html +++ b/docs/module-doc/classConfigReader-members.html @@ -24,7 +24,7 @@ Verify()ConfigReader ~classbase()classbase [inline] ~ConfigReader()ConfigReader -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:19 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index b7228f6c1..d47e96452 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -97,17 +97,17 @@ 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. +Definition at line 869 of file modules.cpp.

References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.

-

00852 {
-00853         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00854         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00855         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00856         if (!this->readerror)
-00857                 this->error = CONF_FILE_NOT_FOUND;
-00858 }
+
00870 {
+00871         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00872         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00873         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00874         if (!this->readerror)
+00875                 this->error = CONF_FILE_NOT_FOUND;
+00876 }
 
@@ -141,17 +141,17 @@ Overloaded constructor.

This constructor initialises the ConfigReader class to read a user-specified config file

-Definition at line 870 of file modules.cpp. +Definition at line 888 of file modules.cpp.

References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.

-

00871 {
-00872         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00873         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00874         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00875         if (!this->readerror)
-00876                 this->error = CONF_FILE_NOT_FOUND;
-00877 };
+
00889 {
+00890         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00891         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00892         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00893         if (!this->readerror)
+00894                 this->error = CONF_FILE_NOT_FOUND;
+00895 };
 
@@ -184,16 +184,16 @@ Default destructor.

This method destroys the ConfigReader class.

-Definition at line 861 of file modules.cpp. +Definition at line 879 of file modules.cpp.

References cache, and errorlog.

-

00862 {
-00863         if (this->cache)
-00864                 delete this->cache;
-00865         if (this->errorlog)
-00866                 delete this->errorlog;
-00867 }
+
00880 {
+00881         if (this->cache)
+00882                 delete this->cache;
+00883         if (this->errorlog)
+00884                 delete this->errorlog;
+00885 }
 
@@ -237,40 +237,40 @@ 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. -

-References errorlog, connection::fd, and userrec::nick. -

-

00949 {
-00950         if (bail)
-00951         {
-00952                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00953                 exit(0);
-00954         }
-00955         else
-00956         {
-00957                 char dataline[1024];
-00958                 if (user)
-00959                 {
-00960                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00961                         while (!errorlog->eof())
-00962                         {
-00963                                 errorlog->getline(dataline,1024);
-00964                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00965                         }
-00966                 }
-00967                 else
-00968                 {
-00969                         WriteOpers("There were errors in the configuration file:",user->nick);
-00970                         while (!errorlog->eof())
-00971                         {
-00972                                 errorlog->getline(dataline,1024);
-00973                                 WriteOpers(dataline);
-00974                         }
-00975                 }
-00976                 return;
-00977         }
-00978 }
+Definition at line 966 of file modules.cpp.
+

+References errorlog, connection::fd, and userrec::nick. +

+

00967 {
+00968         if (bail)
+00969         {
+00970                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00971                 exit(0);
+00972         }
+00973         else
+00974         {
+00975                 char dataline[1024];
+00976                 if (user)
+00977                 {
+00978                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00979                         while (!errorlog->eof())
+00980                         {
+00981                                 errorlog->getline(dataline,1024);
+00982                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00983                         }
+00984                 }
+00985                 else
+00986                 {
+00987                         WriteOpers("There were errors in the configuration file:",user->nick);
+00988                         while (!errorlog->eof())
+00989                         {
+00990                                 errorlog->getline(dataline,1024);
+00991                                 WriteOpers(dataline);
+00992                         }
+00993                 }
+00994                 return;
+00995         }
+00996 }
 
@@ -304,13 +304,13 @@ Counts the number of times a given tag appears in the config file.

This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag.

-Definition at line 981 of file modules.cpp. +Definition at line 999 of file modules.cpp.

References cache.

-

00982 {
-00983         return EnumConf(cache,tag.c_str());
-00984 }
+
01000 {
+01001         return EnumConf(cache,tag.c_str());
+01002 }
 
@@ -353,13 +353,13 @@ 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. +Definition at line 1004 of file modules.cpp.

References cache.

-

00987 {
-00988         return EnumValues(cache, tag.c_str(), index);
-00989 }
+
01005 {
+01006         return EnumValues(cache, tag.c_str(), index);
+01007 }
 
@@ -392,15 +392,15 @@ Returns the last error to occur.

Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.

-Definition at line 941 of file modules.cpp. +Definition at line 959 of file modules.cpp.

References error.

-

00942 {
-00943         long olderr = this->error;
-00944         this->error = 0;
-00945         return olderr;
-00946 }
+
00960 {
+00961         long olderr = this->error;
+00962         this->error = 0;
+00963         return olderr;
+00964 }
 
@@ -449,25 +449,25 @@ 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. +Definition at line 913 of file modules.cpp.

References cache, CONF_VALUE_NOT_FOUND, and error.

-

00896 {
-00897         char val[MAXBUF];
-00898         char t[MAXBUF];
-00899         char n[MAXBUF];
-00900         strlcpy(t,tag.c_str(),MAXBUF);
-00901         strlcpy(n,name.c_str(),MAXBUF);
-00902         int res = ReadConf(cache,t,n,index,val);
-00903         if (!res)
-00904         {
-00905                 this->error = CONF_VALUE_NOT_FOUND;
-00906                 return false;
-00907         }
-00908         std::string s = val;
-00909         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00910 }
+
00914 {
+00915         char val[MAXBUF];
+00916         char t[MAXBUF];
+00917         char n[MAXBUF];
+00918         strlcpy(t,tag.c_str(),MAXBUF);
+00919         strlcpy(n,name.c_str(),MAXBUF);
+00920         int res = ReadConf(cache,t,n,index,val);
+00921         if (!res)
+00922         {
+00923                 this->error = CONF_VALUE_NOT_FOUND;
+00924                 return false;
+00925         }
+00926         std::string s = val;
+00927         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00928 }
 
@@ -522,37 +522,37 @@ Retrieves an integer value from the config file.

This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to GetError() will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() will return CONF_NOT_UNSIGNED

-Definition at line 912 of file modules.cpp. +Definition at line 930 of file modules.cpp.

References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.

-

00913 {
-00914         char val[MAXBUF];
-00915         char t[MAXBUF];
-00916         char n[MAXBUF];
-00917         strlcpy(t,tag.c_str(),MAXBUF);
-00918         strlcpy(n,name.c_str(),MAXBUF);
-00919         int res = ReadConf(cache,t,n,index,val);
-00920         if (!res)
-00921         {
-00922                 this->error = CONF_VALUE_NOT_FOUND;
-00923                 return 0;
-00924         }
-00925         for (int i = 0; i < strlen(val); i++)
-00926         {
-00927                 if (!isdigit(val[i]))
-00928                 {
-00929                         this->error = CONF_NOT_A_NUMBER;
-00930                         return 0;
-00931                 }
-00932         }
-00933         if ((needs_unsigned) && (atoi(val)<0))
-00934         {
-00935                 this->error = CONF_NOT_UNSIGNED;
-00936                 return 0;
-00937         }
-00938         return atoi(val);
-00939 }
+
00931 {
+00932         char val[MAXBUF];
+00933         char t[MAXBUF];
+00934         char n[MAXBUF];
+00935         strlcpy(t,tag.c_str(),MAXBUF);
+00936         strlcpy(n,name.c_str(),MAXBUF);
+00937         int res = ReadConf(cache,t,n,index,val);
+00938         if (!res)
+00939         {
+00940                 this->error = CONF_VALUE_NOT_FOUND;
+00941                 return 0;
+00942         }
+00943         for (int i = 0; i < strlen(val); i++)
+00944         {
+00945                 if (!isdigit(val[i]))
+00946                 {
+00947                         this->error = CONF_NOT_A_NUMBER;
+00948                         return 0;
+00949                 }
+00950         }
+00951         if ((needs_unsigned) && (atoi(val)<0))
+00952         {
+00953                 this->error = CONF_NOT_UNSIGNED;
+00954                 return 0;
+00955         }
+00956         return atoi(val);
+00957 }
 
@@ -601,24 +601,24 @@ 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. +Definition at line 897 of file modules.cpp.

References cache, CONF_VALUE_NOT_FOUND, and error.

-

00880 {
-00881         char val[MAXBUF];
-00882         char t[MAXBUF];
-00883         char n[MAXBUF];
-00884         strlcpy(t,tag.c_str(),MAXBUF);
-00885         strlcpy(n,name.c_str(),MAXBUF);
-00886         int res = ReadConf(cache,t,n,index,val);
-00887         if (!res)
-00888         {
-00889                 this->error = CONF_VALUE_NOT_FOUND;
-00890                 return "";
-00891         }
-00892         return std::string(val);
-00893 }
+
00898 {
+00899         char val[MAXBUF];
+00900         char t[MAXBUF];
+00901         char n[MAXBUF];
+00902         strlcpy(t,tag.c_str(),MAXBUF);
+00903         strlcpy(n,name.c_str(),MAXBUF);
+00904         int res = ReadConf(cache,t,n,index,val);
+00905         if (!res)
+00906         {
+00907                 this->error = CONF_VALUE_NOT_FOUND;
+00908                 return "";
+00909         }
+00910         return val;
+00911 }
 
@@ -651,13 +651,13 @@ 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. +Definition at line 1009 of file modules.cpp.

References readerror.

-

00992 {
-00993         return this->readerror;
-00994 }
+
01010 {
+01011         return this->readerror;
+01012 }
 
@@ -687,7 +687,7 @@ It will contain a pointer to the configuration file data with unneeded data (suc

Definition at line 1155 of file modules.h.

-Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader(). +Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().

@@ -713,7 +713,7 @@ Referenced by ConfigReader(

Definition at line 1160 of file modules.h.

-Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). +Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().

@@ -739,7 +739,7 @@ Referenced by ConfigReader(

Definition at line 1156 of file modules.h.

-Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader(). +Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().

@@ -767,12 +767,12 @@ Used to store errors.

Definition at line 1159 of file modules.h.

-Referenced by ConfigReader(), and Verify(). +Referenced by ConfigReader(), and Verify().


The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:19 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classConnectClass-members.html b/docs/module-doc/classConnectClass-members.html index abaf3804f..a4ad32455 100644 --- a/docs/module-doc/classConnectClass-members.html +++ b/docs/module-doc/classConnectClass-members.html @@ -13,11 +13,13 @@ hostConnectClass passConnectClass pingtimeConnectClass + recvqmaxConnectClass registration_timeoutConnectClass + sendqmaxConnectClass thresholdConnectClass typeConnectClass ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:19 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html index e7d958aa8..0b9c4acf8 100644 --- a/docs/module-doc/classConnectClass.html +++ b/docs/module-doc/classConnectClass.html @@ -39,6 +39,12 @@ Inherits classbase. long threshold  Threshold value for flood disconnect.

+long sendqmax + + Maximum size of sendq for users in this class (bytes).


+long recvqmax + + Maximum size of recvq for users in this class (bytes).



Detailed Description

Holds information relevent to <connect allow> and <connect deny> tags in the config file. @@ -73,18 +79,20 @@ Definition at line 45 of fi

-Definition at line 71 of file users.h. +Definition at line 79 of file users.h.

-References flood, host, pass, pingtime, registration_timeout, and threshold. +References flood, host, pass, pingtime, recvqmax, registration_timeout, sendqmax, and threshold.

-

00072         {
-00073                 registration_timeout = 0;
-00074                 flood = 0;
-00075                 pingtime = 0;
-00076                 threshold = 0;
-00077                 strlcpy(host,"",MAXBUF);
-00078                 strlcpy(pass,"",MAXBUF);
-00079         }
+
00080         {
+00081                 registration_timeout = 0;
+00082                 flood = 0;
+00083                 pingtime = 0;
+00084                 threshold = 0;
+00085                 sendqmax = 0;
+00086                 recvqmax = 0;
+00087                 strlcpy(host,"",MAXBUF);
+00088                 strlcpy(pass,"",MAXBUF);
+00089         }
 
@@ -114,7 +122,7 @@ Number of lines in buffer before excess flood is triggered.

Definition at line 56 of file users.h.

-Referenced by ConnectClass(). +Referenced by ConnectClass().

@@ -142,7 +150,7 @@ Host mask for this line.

Definition at line 59 of file users.h.

-Referenced by ConnectClass(). +Referenced by ConnectClass().

@@ -170,7 +178,7 @@ Referenced by ConnectClass() Definition at line 65 of file users.h.

-Referenced by ConnectClass(). +Referenced by ConnectClass().

@@ -198,7 +206,35 @@ Number of seconds between pings for this line.

Definition at line 62 of file users.h.

-Referenced by ConnectClass(). +Referenced by ConnectClass(). + + +

+ + + + +
+ + +
long ConnectClass::recvqmax +
+
+ + + +
+   + + +

+Maximum size of recvq for users in this class (bytes). +

+ +

+Definition at line 77 of file users.h. +

+Referenced by ConnectClass().

@@ -226,7 +262,35 @@ Max time to register the connection in seconds.

Definition at line 53 of file users.h.

-Referenced by ConnectClass(). +Referenced by ConnectClass(). + + +

+ + + + +
+ + +
long ConnectClass::sendqmax +
+
+ + + +
+   + + +

+Maximum size of sendq for users in this class (bytes). +

+ +

+Definition at line 73 of file users.h. +

+Referenced by ConnectClass().

@@ -254,7 +318,7 @@ Threshold value for flood disconnect.

Definition at line 69 of file users.h.

-Referenced by ConnectClass(). +Referenced by ConnectClass().

@@ -285,7 +349,7 @@ Definition at line 50 of fi


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:19 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classDNS-members.html b/docs/module-doc/classDNS-members.html index bd9aff1a9..6c7f3e803 100644 --- a/docs/module-doc/classDNS-members.html +++ b/docs/module-doc/classDNS-members.html @@ -33,7 +33,7 @@ SetNS(std::string dnsserver)DNS tDNS [private] ~DNS()DNS -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classDNS.html b/docs/module-doc/classDNS.html index ea2a87e1b..d444c8013 100644 --- a/docs/module-doc/classDNS.html +++ b/docs/module-doc/classDNS.html @@ -890,7 +890,7 @@ Definition at line 40 of file
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classELine-members.html b/docs/module-doc/classELine-members.html index 2b98f9ea9..15bedac9a 100644 --- a/docs/module-doc/classELine-members.html +++ b/docs/module-doc/classELine-members.html @@ -15,7 +15,7 @@ set_timeXLine sourceXLine ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classELine.html b/docs/module-doc/classELine.html index 4ea2be125..e674ef34f 100644 --- a/docs/module-doc/classELine.html +++ b/docs/module-doc/classELine.html @@ -45,7 +45,7 @@ Definition at line 88 of fi
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classEvent-members.html b/docs/module-doc/classEvent-members.html index 9f1084c4a..861fbfe1f 100644 --- a/docs/module-doc/classEvent-members.html +++ b/docs/module-doc/classEvent-members.html @@ -17,7 +17,7 @@ Send()Event [virtual] sourceEvent [protected] ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classEvent.html b/docs/module-doc/classEvent.html index 980de41c0..63f69b78c 100644 --- a/docs/module-doc/classEvent.html +++ b/docs/module-doc/classEvent.html @@ -94,9 +94,9 @@ Create a new Event.

-Definition at line 335 of file modules.cpp. +Definition at line 344 of file modules.cpp.

-

00335 : data(anydata), source(src), id(eventid) { };
+
00344 : data(anydata), source(src), id(eventid) { };
 
@@ -130,13 +130,13 @@ Get the Event data.

-Definition at line 337 of file modules.cpp. +Definition at line 346 of file modules.cpp.

References data.

-

00338 {
-00339         return this->data;
-00340 }
+
00347 {
+00348         return this->data;
+00349 }
 
@@ -169,13 +169,13 @@ 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. +Definition at line 362 of file modules.cpp.

References id.

-

00354 {
-00355         return this->id;
-00356 }
+
00363 {
+00364         return this->id;
+00365 }
 
@@ -208,13 +208,13 @@ Get the event Source.

-Definition at line 342 of file modules.cpp. +Definition at line 351 of file modules.cpp.

References source.

-

00343 {
-00344         return this->source;
-00345 }
+
00352 {
+00353         return this->source;
+00354 }
 
@@ -249,14 +249,14 @@ The return result of an Event::Send() Implements ModuleMessage.

-Definition at line 347 of file modules.cpp. +Definition at line 356 of file modules.cpp.

References FOREACH_MOD.

-

00348 {
-00349         FOREACH_MOD OnEvent(this);
-00350         return NULL;
-00351 }
+
00357 {
+00358         FOREACH_MOD OnEvent(this);
+00359         return NULL;
+00360 }
 
@@ -286,7 +286,7 @@ This member holds a pointer to arbitary data set by the emitter of the message.

Definition at line 199 of file modules.h.

-Referenced by GetData(). +Referenced by GetData().

@@ -314,7 +314,7 @@ This is arbitary text which should be used to distinguish one type of event from

Definition at line 208 of file modules.h.

-Referenced by GetEventID(). +Referenced by GetEventID().

@@ -342,12 +342,12 @@ This is a pointer to the sender of the message, which can be used to directly tr

Definition at line 203 of file modules.h.

-Referenced by GetSource(). +Referenced by GetSource().


The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExemptItem-members.html b/docs/module-doc/classExemptItem-members.html index 8bd3c1019..aa9268099 100644 --- a/docs/module-doc/classExemptItem-members.html +++ b/docs/module-doc/classExemptItem-members.html @@ -14,7 +14,7 @@ set_timeHostItem ~classbase()classbase [inline] ~HostItem()HostItem [inline, virtual] -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExemptItem.html b/docs/module-doc/classExemptItem.html index 40e24cd97..f4b247d28 100644 --- a/docs/module-doc/classExemptItem.html +++ b/docs/module-doc/classExemptItem.html @@ -22,7 +22,7 @@ A subclass of HostItem designed to h

Definition at line 53 of file channels.h.


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExtMode-members.html b/docs/module-doc/classExtMode-members.html index 8a6a72bcb..50662ef03 100644 --- a/docs/module-doc/classExtMode-members.html +++ b/docs/module-doc/classExtMode-members.html @@ -16,7 +16,7 @@ params_when_onExtMode typeExtMode ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExtMode.html b/docs/module-doc/classExtMode.html index f030e065f..ca994a249 100644 --- a/docs/module-doc/classExtMode.html +++ b/docs/module-doc/classExtMode.html @@ -82,11 +82,11 @@

-Definition at line 202 of file modules.cpp. +Definition at line 211 of file modules.cpp.

-References modechar, needsoper, params_when_off, params_when_on, and type. +References modechar, needsoper, params_when_off, params_when_on, and type.

-

00202 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
+
00211 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
 
@@ -112,7 +112,7 @@ References modechar,

-Definition at line 201 of file modules.cpp. +Definition at line 210 of file modules.cpp.

@@ -136,9 +136,9 @@ Definition at line 201

-Definition at line 196 of file modules.cpp. +Definition at line 205 of file modules.cpp.

-Referenced by ExtMode(). +Referenced by ExtMode().

@@ -162,9 +162,9 @@ Referenced by ExtMode()

-Definition at line 200 of file modules.cpp. +Definition at line 209 of file modules.cpp.

-Referenced by ExtMode(). +Referenced by ExtMode().

@@ -188,9 +188,9 @@ Referenced by ExtMode()

-Definition at line 199 of file modules.cpp. +Definition at line 208 of file modules.cpp.

-Referenced by ExtMode(). +Referenced by ExtMode().

@@ -214,9 +214,9 @@ Referenced by ExtMode()

-Definition at line 198 of file modules.cpp. +Definition at line 207 of file modules.cpp.

-Referenced by ExtMode(). +Referenced by ExtMode().

@@ -240,14 +240,14 @@ Referenced by ExtMode()

-Definition at line 197 of file modules.cpp. +Definition at line 206 of file modules.cpp.

-Referenced by ExtMode(). +Referenced by ExtMode().


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExtensible-members.html b/docs/module-doc/classExtensible-members.html index d459cfcff..9a2f40170 100644 --- a/docs/module-doc/classExtensible-members.html +++ b/docs/module-doc/classExtensible-members.html @@ -13,7 +13,7 @@ GetExt(std::string key)Extensible Shrink(std::string key)Extensible ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index 1c8e993eb..6cd7cf697 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -170,7 +170,7 @@ Definition at line 54 of fil
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classFileReader-members.html b/docs/module-doc/classFileReader-members.html index b13b2bfe9..3e2fa34a8 100644 --- a/docs/module-doc/classFileReader-members.html +++ b/docs/module-doc/classFileReader-members.html @@ -17,7 +17,7 @@ LoadFile(std::string filename)FileReader ~classbase()classbase [inline] ~FileReader()FileReader -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 1319a66e2..1b1d55845 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -77,10 +77,10 @@ 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. +Definition at line 1022 of file modules.cpp.

-

01005 {
-01006 }
+
01023 {
+01024 }
 
@@ -114,15 +114,15 @@ 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, FileReader::FileSize returns 0.

-Definition at line 997 of file modules.cpp. +Definition at line 1015 of file modules.cpp.

References fc, and file_cache.

-

00998 {
-00999         file_cache c;
-01000         readfile(c,filename.c_str());
-01001         this->fc = c;
-01002 }
+
01016 {
+01017         file_cache c;
+01018         readfile(c,filename.c_str());
+01019         this->fc = c;
+01020 }
 
@@ -155,10 +155,10 @@ Default destructor.

This deletes the memory allocated to the file.

-Definition at line 1016 of file modules.cpp. +Definition at line 1034 of file modules.cpp.

-

01017 {
-01018 }
+
01035 {
+01036 }
 
@@ -192,20 +192,20 @@ Returns true if the file exists This function will return false if the file coul

-Definition at line 1020 of file modules.cpp. +Definition at line 1038 of file modules.cpp.

References fc.

-

01021 {
-01022         if (fc.size() == 0)
-01023         {
-01024                 return(false);
-01025         }
-01026         else
-01027         {
-01028                 return(true);
-01029         }
-01030 }
+
01039 {
+01040         if (fc.size() == 0)
+01041         {
+01042                 return(false);
+01043         }
+01044         else
+01045         {
+01046                 return(true);
+01047         }
+01048 }
 
@@ -238,13 +238,13 @@ 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. +Definition at line 1057 of file modules.cpp.

References fc.

-

01040 {
-01041         return fc.size();
-01042 }
+
01058 {
+01059         return fc.size();
+01060 }
 
@@ -278,15 +278,15 @@ 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. +Definition at line 1050 of file modules.cpp.

References fc.

-

01033 {
-01034         if ((x<0) || (x>fc.size()))
-01035                 return "";
-01036         return fc[x];
-01037 }
+
01051 {
+01052         if ((x<0) || (x>fc.size()))
+01053                 return "";
+01054         return fc[x];
+01055 }
 
@@ -320,15 +320,15 @@ 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, FileReader::FileSize returns 0.

-Definition at line 1008 of file modules.cpp. +Definition at line 1026 of file modules.cpp.

References fc, and file_cache.

-

01009 {
-01010         file_cache c;
-01011         readfile(c,filename.c_str());
-01012         this->fc = c;
-01013 }
+
01027 {
+01028         file_cache c;
+01029         readfile(c,filename.c_str());
+01030         this->fc = c;
+01031 }
 
@@ -356,12 +356,12 @@ References fc, and Definition at line 1238 of file modules.h.

-Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). +Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().


The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classGLine-members.html b/docs/module-doc/classGLine-members.html index ca5405af0..220286f71 100644 --- a/docs/module-doc/classGLine-members.html +++ b/docs/module-doc/classGLine-members.html @@ -15,7 +15,7 @@ set_timeXLine sourceXLine ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classGLine.html b/docs/module-doc/classGLine.html index 8dae2d04b..f052997c0 100644 --- a/docs/module-doc/classGLine.html +++ b/docs/module-doc/classGLine.html @@ -53,7 +53,7 @@ Definition at line 79 of fi
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classHostItem-members.html b/docs/module-doc/classHostItem-members.html index 0053dc346..55db2ed47 100644 --- a/docs/module-doc/classHostItem-members.html +++ b/docs/module-doc/classHostItem-members.html @@ -14,7 +14,7 @@ set_timeHostItem ~classbase()classbase [inline] ~HostItem()HostItem [inline, virtual] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classHostItem.html b/docs/module-doc/classHostItem.html index 90237c5f5..45b1515bb 100644 --- a/docs/module-doc/classHostItem.html +++ b/docs/module-doc/classHostItem.html @@ -178,7 +178,7 @@ Definition at line 32 of
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classInviteItem-members.html b/docs/module-doc/classInviteItem-members.html index 7e43a92ad..e63dd952a 100644 --- a/docs/module-doc/classInviteItem-members.html +++ b/docs/module-doc/classInviteItem-members.html @@ -14,7 +14,7 @@ set_timeHostItem ~classbase()classbase [inline] ~HostItem()HostItem [inline, virtual] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classInviteItem.html b/docs/module-doc/classInviteItem.html index db30696d3..4f06a7cfc 100644 --- a/docs/module-doc/classInviteItem.html +++ b/docs/module-doc/classInviteItem.html @@ -22,7 +22,7 @@ A subclass of HostItem designed to h

Definition at line 61 of file channels.h.


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classInvited-members.html b/docs/module-doc/classInvited-members.html index 0e220accf..58b439a5d 100644 --- a/docs/module-doc/classInvited-members.html +++ b/docs/module-doc/classInvited-members.html @@ -10,7 +10,7 @@ channelInvited classbase()classbase [inline] ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classInvited.html b/docs/module-doc/classInvited.html index baeb2dc09..01921ac9f 100644 --- a/docs/module-doc/classInvited.html +++ b/docs/module-doc/classInvited.html @@ -47,12 +47,12 @@ Definition at line 36 of fi

Definition at line 39 of file users.h.

-Referenced by userrec::InviteTo(). +Referenced by userrec::InviteTo().


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classKLine-members.html b/docs/module-doc/classKLine-members.html index 3015be7b7..474de0c9d 100644 --- a/docs/module-doc/classKLine-members.html +++ b/docs/module-doc/classKLine-members.html @@ -15,7 +15,7 @@ set_timeXLine sourceXLine ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:22 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classKLine.html b/docs/module-doc/classKLine.html index 384c57192..f873cb298 100644 --- a/docs/module-doc/classKLine.html +++ b/docs/module-doc/classKLine.html @@ -53,7 +53,7 @@ Definition at line 68 of fi
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:22 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModeParameter-members.html b/docs/module-doc/classModeParameter-members.html index 01fb8b353..4b3e0c49d 100644 --- a/docs/module-doc/classModeParameter-members.html +++ b/docs/module-doc/classModeParameter-members.html @@ -12,7 +12,7 @@ modeModeParameter parameterModeParameter ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:22 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModeParameter.html b/docs/module-doc/classModeParameter.html index 75dc0540a..fdb591606 100644 --- a/docs/module-doc/classModeParameter.html +++ b/docs/module-doc/classModeParameter.html @@ -110,7 +110,7 @@ Referenced by chanrec::Set
The documentation for this class was generated from the following file:
-
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:22 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModule-members.html b/docs/module-doc/classModule-members.html index b748a548b..cb63b848c 100644 --- a/docs/module-doc/classModule-members.html +++ b/docs/module-doc/classModule-members.html @@ -65,7 +65,7 @@ OnWhois(userrec *source, userrec *dest)Module [virtual] ~classbase()classbase [inline] ~Module()Module [virtual] -
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index eec90db64..71644e439 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -221,9 +221,9 @@ Default constructor creates a module class.

-Definition at line 360 of file modules.cpp. +Definition at line 369 of file modules.cpp.

-

00360 { }
+
00369 { }
 
@@ -256,9 +256,9 @@ Default destructor destroys a module class.

-Definition at line 361 of file modules.cpp. +Definition at line 370 of file modules.cpp.

-

00361 { }
+
00370 { }
 
@@ -292,11 +292,11 @@ Returns the version number of a Module.

The method should return a Version object with its version information assigned via Version::Version

-Definition at line 373 of file modules.cpp. +Definition at line 382 of file modules.cpp.

References VF_VENDOR.

-

00373 { return Version(1,0,0,0,VF_VENDOR); }
+
00382 { return Version(1,0,0,0,VF_VENDOR); }
 
@@ -330,9 +330,9 @@ 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. +Definition at line 394 of file modules.cpp.

-

00385 { };
+
00394 { };
 
@@ -399,11 +399,11 @@ This function is called before many functions which check a users status on a ch
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. +Definition at line 391 of file modules.cpp.

References ACR_DEFAULT.

-

00382 { return ACR_DEFAULT; };
+
00391 { return ACR_DEFAULT; };
 
@@ -452,9 +452,9 @@ 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. +Definition at line 419 of file modules.cpp.

-

00410 { return 0; };
+
00419 { return 0; };
 
@@ -488,9 +488,9 @@ 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. +Definition at line 397 of file modules.cpp.

-

00388 { };
+
00397 { };
 
@@ -533,9 +533,9 @@ 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. +Definition at line 411 of file modules.cpp.

-

00402 { return 0; };
+
00411 { return 0; };
 
@@ -578,9 +578,9 @@ 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. +Definition at line 410 of file modules.cpp.

-

00401 { return 0; };
+
00410 { return 0; };
 
@@ -614,11 +614,11 @@ 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. +Definition at line 393 of file modules.cpp.

References string_list.

-

00384 { string_list empty; return empty; }
+
00393 { string_list empty; return empty; }
 
@@ -661,9 +661,9 @@ Called whenever a user joins a channel, to determine if banlist checks should go

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. +Definition at line 408 of file modules.cpp.

-

00399 { return 0; };
+
00408 { return 0; };
 
@@ -706,9 +706,9 @@ Called whenever a user joins a channel, to determine if invite checks should go

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. +Definition at line 405 of file modules.cpp.

-

00396 { return 0; };
+
00405 { return 0; };
 
@@ -757,9 +757,9 @@ Called whenever a user joins a channel, to determine if key checks should go ahe

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. +Definition at line 406 of file modules.cpp.

-

00397 { return 0; };
+
00406 { return 0; };
 
@@ -802,9 +802,9 @@ Called whenever a user joins a channel, to determine if channel limit checks sho

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. +Definition at line 407 of file modules.cpp.

-

00398 { return 0; };
+
00407 { return 0; };
 
@@ -838,9 +838,9 @@ Called to check if a user who is connecting can now be allowed to register If an

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. +Definition at line 400 of file modules.cpp.

-

00391 { return true; };
+
00400 { return true; };
 
@@ -889,9 +889,9 @@ 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. +Definition at line 420 of file modules.cpp.

-

00411 { return 0; };
+
00420 { return 0; };
 
@@ -925,9 +925,9 @@ Called whenever an Event class is sent

Please see the documentation of Event::Send() for further information. The Event sent can always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID() 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. +Definition at line 414 of file modules.cpp.

-

00405 { return; };
+
00414 { return; };
 
@@ -994,9 +994,9 @@ 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 Server::AddExtendedMode 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. +Definition at line 381 of file modules.cpp.

-

00372 { return false; }
+
00381 { return false; }
 
@@ -1030,9 +1030,9 @@ 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. +Definition at line 418 of file modules.cpp.

-

00409 { };
+
00418 { };
 
@@ -1066,9 +1066,9 @@ 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. +Definition at line 417 of file modules.cpp.

-

00408 { };
+
00417 { };
 
@@ -1103,9 +1103,9 @@ 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:

<nick> :information here

-Definition at line 375 of file modules.cpp. +Definition at line 384 of file modules.cpp.

-

00375 { };
+
00384 { };
 
@@ -1154,9 +1154,9 @@ 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. +Definition at line 395 of file modules.cpp.

-

00386 { return 0; };
+
00395 { return 0; };
 
@@ -1199,9 +1199,9 @@ 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. +Definition at line 396 of file modules.cpp.

-

00387 { };
+
00396 { };
 
@@ -1250,9 +1250,9 @@ 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. +Definition at line 412 of file modules.cpp.

-

00403 { return 0; };
+
00412 { return 0; };
 
@@ -1325,9 +1325,9 @@ 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. +Definition at line 413 of file modules.cpp.

-

00404 { return 0; };
+
00413 { return 0; };
 
@@ -1361,9 +1361,9 @@ 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. +Definition at line 383 of file modules.cpp.

-

00374 { };
+
00383 { };
 
@@ -1406,9 +1406,9 @@ 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. +Definition at line 416 of file modules.cpp.

-

00407 { return 0; };
+
00416 { return 0; };
 
@@ -1451,9 +1451,9 @@ 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. +Definition at line 377 of file modules.cpp.

-

00368 { }
+
00377 { }
 
@@ -1496,9 +1496,9 @@ Called before a packet is transmitted across the irc network between two irc ser

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. +Definition at line 376 of file modules.cpp.

-

00367 { }
+
00376 { }
 
@@ -1553,9 +1553,9 @@ 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 Server::QuitUser) 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. +Definition at line 399 of file modules.cpp.

-

00390 { return 0; };
+
00399 { return 0; };
 
@@ -1622,9 +1622,9 @@ 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. +Definition at line 404 of file modules.cpp.

-

00395 { return 0; };
+
00404 { return 0; };
 
@@ -1673,9 +1673,9 @@ 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. +Definition at line 421 of file modules.cpp.

-

00412 { };
+
00421 { };
 
@@ -1709,9 +1709,9 @@ 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. +Definition at line 423 of file modules.cpp.

-

00414 { };
+
00423 { };
 
@@ -1766,9 +1766,9 @@ 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. +Definition at line 424 of file modules.cpp.

-

00415 { return 0; };
+
00424 { return 0; };
 
@@ -1817,9 +1817,9 @@ 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. +Definition at line 422 of file modules.cpp.

-

00413 { return 0; };
+
00422 { return 0; };
 
@@ -1852,9 +1852,9 @@ 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. +Definition at line 378 of file modules.cpp.

-

00369 { }
+
00378 { }
 
@@ -1888,11 +1888,11 @@ Called whenever a Request class is se

Please see the documentation of Request::Send() for further information. The Request 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. +Definition at line 415 of file modules.cpp.

-Referenced by Request::Send(). +Referenced by Request::Send().

-

00406 { return NULL; };
+
00415 { return NULL; };
 
@@ -1941,9 +1941,9 @@ 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. +Definition at line 398 of file modules.cpp.

-

00389 { };
+
00398 { };
 
@@ -1992,9 +1992,9 @@ 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. +Definition at line 379 of file modules.cpp.

-

00370 { }
+
00379 { }
 
@@ -2028,9 +2028,9 @@ Called on all /STATS commands This method is triggered for all /STATS use, inclu

-Definition at line 400 of file modules.cpp. +Definition at line 409 of file modules.cpp.

-

00400 { };
+
00409 { };
 
@@ -2064,9 +2064,9 @@ Called when a user connects.

The details of the connecting user are available to you in the parameter userrec *user

-Definition at line 362 of file modules.cpp. +Definition at line 371 of file modules.cpp.

-

00362 { }
+
00371 { }
 
@@ -2100,9 +2100,9 @@ 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. +Definition at line 373 of file modules.cpp.

-

00364 { }
+
00373 { }
 
@@ -2145,9 +2145,9 @@ 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 *channel

-Definition at line 365 of file modules.cpp. +Definition at line 374 of file modules.cpp.

-

00365 { }
+
00374 { }
 
@@ -2202,9 +2202,9 @@ 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 Module::OnUserPreKick instead of this method.

-Definition at line 394 of file modules.cpp. +Definition at line 403 of file modules.cpp.

-

00394 { };
+
00403 { };
 
@@ -2247,9 +2247,9 @@ 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 *channel

-Definition at line 366 of file modules.cpp. +Definition at line 375 of file modules.cpp.

-

00366 { }
+
00375 { }
 
@@ -2292,9 +2292,9 @@ 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. +Definition at line 390 of file modules.cpp.

-

00381 { };
+
00390 { };
 
@@ -2343,9 +2343,9 @@ Called whenever a user is about to invite another user into a channel, before an

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. +Definition at line 386 of file modules.cpp.

-

00377 { return 0; };
+
00386 { return 0; };
 
@@ -2396,9 +2396,9 @@ Returning a value of 1 from this function stops the process immediately, causing IMPORTANT NOTE!

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. +Definition at line 380 of file modules.cpp.

-

00371 { return 0; }
+
00380 { return 0; }
 
@@ -2453,9 +2453,9 @@ 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. +Definition at line 402 of file modules.cpp.

-

00393 { return 0; };
+
00402 { return 0; };
 
@@ -2510,9 +2510,9 @@ Called whenever a user is about to PRIVMSG A user or a channel, before any proce

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. +Definition at line 387 of file modules.cpp.

-

00378 { return 0; };
+
00387 { return 0; };
 
@@ -2555,9 +2555,9 @@ 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. +Definition at line 389 of file modules.cpp.

-

00380 { return 0; };
+
00389 { return 0; };
 
@@ -2612,9 +2612,9 @@ Called whenever a user is about to NOTICE A user or a channel, before any proces

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. +Definition at line 388 of file modules.cpp.

-

00379 { return 0; };
+
00388 { return 0; };
 
@@ -2648,9 +2648,9 @@ 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. +Definition at line 372 of file modules.cpp.

-

00363 { }
+
00372 { }
 
@@ -2684,9 +2684,9 @@ 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. +Definition at line 401 of file modules.cpp.

-

00392 { };
+
00401 { };
 
@@ -2720,11 +2720,11 @@ 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. +Definition at line 392 of file modules.cpp.

References string_list.

-

00383 { string_list empty; return empty; }
+
00392 { string_list empty; return empty; }
 
@@ -2767,15 +2767,15 @@ 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. +Definition at line 385 of file modules.cpp.

-

00376 { };
+
00385 { };
 

The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModuleFactory-members.html b/docs/module-doc/classModuleFactory-members.html index 91c25da0d..2be6be25a 100644 --- a/docs/module-doc/classModuleFactory-members.html +++ b/docs/module-doc/classModuleFactory-members.html @@ -12,7 +12,7 @@ ModuleFactory()ModuleFactory [inline] ~classbase()classbase [inline] ~ModuleFactory()ModuleFactory [inline, virtual] -
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModuleFactory.html b/docs/module-doc/classModuleFactory.html index 0f89639ee..9f1ef7547 100644 --- a/docs/module-doc/classModuleFactory.html +++ b/docs/module-doc/classModuleFactory.html @@ -130,7 +130,7 @@ Your inherited class of ModuleFactory must return a pointer to your modules.h -
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModuleMessage-members.html b/docs/module-doc/classModuleMessage-members.html index c91b0afcf..7518db946 100644 --- a/docs/module-doc/classModuleMessage-members.html +++ b/docs/module-doc/classModuleMessage-members.html @@ -10,7 +10,7 @@ classbase()classbase [inline] Send()=0ModuleMessage [pure virtual] ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModuleMessage.html b/docs/module-doc/classModuleMessage.html index d99c79411..7982ae626 100644 --- a/docs/module-doc/classModuleMessage.html +++ b/docs/module-doc/classModuleMessage.html @@ -61,7 +61,7 @@ Implemented in Request, and
The documentation for this class was generated from the following file:
-
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classQLine-members.html b/docs/module-doc/classQLine-members.html index 225e085cf..9e7886294 100644 --- a/docs/module-doc/classQLine-members.html +++ b/docs/module-doc/classQLine-members.html @@ -16,7 +16,7 @@ set_timeXLine sourceXLine ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classQLine.html b/docs/module-doc/classQLine.html index 35c91a091..33ac64ba9 100644 --- a/docs/module-doc/classQLine.html +++ b/docs/module-doc/classQLine.html @@ -82,7 +82,7 @@ Definition at line 114 of f
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:26 2005 for InspIRCd by +
Generated on Thu May 12 02:25:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classRequest-members.html b/docs/module-doc/classRequest-members.html index c5e1f0307..594f4ffe1 100644 --- a/docs/module-doc/classRequest-members.html +++ b/docs/module-doc/classRequest-members.html @@ -17,7 +17,7 @@ Send()Request [virtual] sourceRequest [protected] ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:27 2005 for InspIRCd by +
Generated on Thu May 12 02:25:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classRequest.html b/docs/module-doc/classRequest.html index e344bbd81..4703a7638 100644 --- a/docs/module-doc/classRequest.html +++ b/docs/module-doc/classRequest.html @@ -94,9 +94,9 @@ Create a new Request.

-Definition at line 306 of file modules.cpp. +Definition at line 315 of file modules.cpp.

-

00306 : data(anydata), source(src), dest(dst) { };
+
00315 : data(anydata), source(src), dest(dst) { };
 
@@ -130,13 +130,13 @@ Fetch the Request data.

-Definition at line 308 of file modules.cpp. +Definition at line 317 of file modules.cpp.

References data.

-

00309 {
-00310         return this->data;
-00311 }
+
00318 {
+00319         return this->data;
+00320 }
 
@@ -169,13 +169,13 @@ Fetch the request destination (should be 'this' in the receiving module).

-Definition at line 318 of file modules.cpp. +Definition at line 327 of file modules.cpp.

References dest.

-

00319 {
-00320         return this->dest;
-00321 }
+
00328 {
+00329         return this->dest;
+00330 }
 
@@ -208,13 +208,13 @@ Fetch the request source.

-Definition at line 313 of file modules.cpp. +Definition at line 322 of file modules.cpp.

References source.

-

00314 {
-00315         return this->source;
-00316 }
+
00323 {
+00324         return this->source;
+00325 }
 
@@ -249,20 +249,20 @@ Upon returning the result will be arbitary data returned by the module you sent

Implements ModuleMessage.

-Definition at line 323 of file modules.cpp. +Definition at line 332 of file modules.cpp.

-References dest, and Module::OnRequest(). +References dest, and Module::OnRequest().

-

00324 {
-00325         if (this->dest)
-00326         {
-00327                 return dest->OnRequest(this);
-00328         }
-00329         else
-00330         {
-00331                 return NULL;
-00332         }
-00333 }
+
00333 {
+00334         if (this->dest)
+00335         {
+00336                 return dest->OnRequest(this);
+00337         }
+00338         else
+00339         {
+00340                 return NULL;
+00341         }
+00342 }
 
@@ -292,7 +292,7 @@ This member holds a pointer to arbitary data set by the emitter of the message.

Definition at line 159 of file modules.h.

-Referenced by GetData(). +Referenced by GetData().

@@ -320,7 +320,7 @@ The single destination of the Request.

Definition at line 166 of file modules.h.

-Referenced by GetDest(), and Send(). +Referenced by GetDest(), and Send().

@@ -348,12 +348,12 @@ This is a pointer to the sender of the message, which can be used to directly tr

Definition at line 163 of file modules.h.

-Referenced by GetSource(). +Referenced by GetSource().


The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:27 2005 for InspIRCd by +
Generated on Thu May 12 02:25:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classServer-members.html b/docs/module-doc/classServer-members.html index 521e78e89..08ef07e51 100644 --- a/docs/module-doc/classServer-members.html +++ b/docs/module-doc/classServer-members.html @@ -69,7 +69,7 @@ UserToPseudo(userrec *user, std::string message)Server [virtual] ~classbase()classbase [inline] ~Server()Server [virtual] -
Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
Generated on Thu May 12 02:25:27 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index 4a850c16a..5023be91f 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -233,10 +233,10 @@ Default constructor.

Creates a Server object.

-Definition at line 421 of file modules.cpp. +Definition at line 430 of file modules.cpp.

-

00422 {
-00423 }
+
00431 {
+00432 }
 
@@ -269,10 +269,10 @@ Default destructor.

Destroys a Server object.

-Definition at line 425 of file modules.cpp. +Definition at line 434 of file modules.cpp.

-

00426 {
-00427 }
+
00435 {
+00436 }
 
@@ -336,13 +336,13 @@ This allows modules to add extra commands into the command table. You must place typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)

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. +Definition at line 503 of file modules.cpp.

References createcommand().

-

00495 {
-00496         createcommand(cmd,f,flags,minparams,source);
-00497 }
+
00504 {
+00505         createcommand(cmd,f,flags,minparams,source);
+00506 }
 
@@ -397,13 +397,13 @@ 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 Server::CalcDuration 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. +Definition at line 749 of file modules.cpp.

References add_eline(), and duration().

-

00732 {
-00733         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00734 }
+
00750 {
+00751         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00752 }
 
@@ -442,16 +442,16 @@ This call is used to implement modes like +q and +a. The characteristics of thes (4) The mode and its parameter are NOT stored in the channels modes structure

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. +Definition at line 666 of file modules.cpp.

-References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. +References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.

-

00658 {
-00659         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00660         if (res)
-00661                 ModeMakeList(modechar);
-00662         return res;
-00663 }
+
00667 {
+00668         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00669         if (res)
+00670                 ModeMakeList(modechar);
+00671         return res;
+00672 }
 
@@ -512,36 +512,36 @@ 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. -

-References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. -

-

00630 {
-00631         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
-00632         {
-00633                 if (type == MT_SERVER)
-00634                 {
-00635                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00636                         return false;
-00637                 }
-00638                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00639                 {
-00640                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00641                         return false;
-00642                 }
-00643                 if ((params_when_on>1) || (params_when_off>1))
-00644                 {
-00645                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00646                         return false;
-00647                 }
-00648                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00649         }
-00650         else
-00651         {
-00652                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
-00653         }
-00654         return false;
-00655 }
+Definition at line 638 of file modules.cpp.
+

+References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. +

+

00639 {
+00640         if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z')))
+00641         {
+00642                 if (type == MT_SERVER)
+00643                 {
+00644                         log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00645                         return false;
+00646                 }
+00647                 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00648                 {
+00649                         log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00650                         return false;
+00651                 }
+00652                 if ((params_when_on>1) || (params_when_off>1))
+00653                 {
+00654                         log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00655                         return false;
+00656                 }
+00657                 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00658         }
+00659         else
+00660         {
+00661                 log(DEBUG,"*** API ERROR *** Muppet modechar detected.");
+00662         }
+00663         return false;
+00664 }
 
@@ -596,13 +596,13 @@ Adds a G-line The G-line is propogated to all of the servers in the mesh and enf

The duration must be in seconds, however you can use the Server::CalcDuration 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. +Definition at line 729 of file modules.cpp.

References add_gline(), and duration().

-

00712 {
-00713         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00714 }
+
00730 {
+00731         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00732 }
 
@@ -657,13 +657,13 @@ 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 Server::CalcDuration 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. +Definition at line 744 of file modules.cpp.

References add_kline(), and duration().

-

00727 {
-00728         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00729 }
+
00745 {
+00746         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00747 }
 
@@ -718,13 +718,13 @@ Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enf

The duration must be in seconds, however you can use the Server::CalcDuration 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. +Definition at line 734 of file modules.cpp.

References add_qline(), and duration().

-

00717 {
-00718         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00719 }
+
00735 {
+00736         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00737 }
 
@@ -779,13 +779,13 @@ Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enf

The duration must be in seconds, however you can use the Server::CalcDuration 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. +Definition at line 739 of file modules.cpp.

References add_zline(), and duration().

-

00722 {
-00723         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00724 }
+
00740 {
+00741         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00742 }
 
@@ -819,13 +819,13 @@ Calculates a duration This method will take a string containing a formatted dura

"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. +Definition at line 779 of file modules.cpp.

References duration().

-

00762 {
-00763         return duration(delta.c_str());
-00764 }
+
00780 {
+00781         return duration(delta.c_str());
+00782 }
 
@@ -881,11 +881,11 @@ Calls the handler for a command, either implemented by the core or by another mo 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
) 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 AddCommand(). 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. +Definition at line 493 of file modules.cpp.

-

00485 {
-00486         call_handler(commandname.c_str(),parameters,pcnt,user);
-00487 }
+
00494 {
+00495         call_handler(commandname.c_str(),parameters,pcnt,user);
+00496 }
 
@@ -928,13 +928,13 @@ 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. +Definition at line 586 of file modules.cpp.

References ChangeName().

-

00578 {
-00579         ChangeName(user,gecos.c_str());
-00580 }
+
00587 {
+00588         ChangeName(user,gecos.c_str());
+00589 }
 
@@ -977,13 +977,13 @@ 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. +Definition at line 581 of file modules.cpp.

References ChangeDisplayedHost().

-

00573 {
-00574         ChangeDisplayedHost(user,host.c_str());
-00575 }
+
00582 {
+00583         ChangeDisplayedHost(user,host.c_str());
+00584 }
 
@@ -1026,11 +1026,11 @@ 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. +Definition at line 478 of file modules.cpp.

-

00470 {
-00471         force_nickchange(user,nickname.c_str());
-00472 }
+
00479 {
+00480         force_nickchange(user,nickname.c_str());
+00481 }
 
@@ -1073,13 +1073,13 @@ 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. +Definition at line 611 of file modules.cpp.

References cmode().

-

00603 {
-00604         return cmode(User,Chan);
-00605 }
+
00612 {
+00613         return cmode(User,Chan);
+00614 }
 
@@ -1122,13 +1122,13 @@ Returns true if two users share a common channel.

This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.

-Definition at line 550 of file modules.cpp. +Definition at line 559 of file modules.cpp.

References common_channels().

-

00551 {
-00552         return (common_channels(u1,u2) != 0);
-00553 }
+
00560 {
+00561         return (common_channels(u1,u2) != 0);
+00562 }
 
@@ -1162,11 +1162,11 @@ 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. +Definition at line 674 of file modules.cpp.

-

00666 {
-00667         return usercount(c);
-00668 }
+
00675 {
+00676         return usercount(c);
+00677 }
 
@@ -1200,13 +1200,13 @@ Deletes a local E-Line.

-Definition at line 756 of file modules.cpp. +Definition at line 774 of file modules.cpp.

References del_eline().

-

00757 {
-00758         del_eline(hostmask.c_str());
-00759 }
+
00775 {
+00776         del_eline(hostmask.c_str());
+00777 }
 
@@ -1240,13 +1240,13 @@ Deletes a G-Line from all servers on the mesh.

-Definition at line 736 of file modules.cpp. +Definition at line 754 of file modules.cpp.

References del_gline().

-

00737 {
-00738         del_gline(hostmask.c_str());
-00739 }
+
00755 {
+00756         del_gline(hostmask.c_str());
+00757 }
 
@@ -1280,13 +1280,13 @@ Deletes a local K-Line.

-Definition at line 751 of file modules.cpp. +Definition at line 769 of file modules.cpp.

References del_kline().

-

00752 {
-00753         del_kline(hostmask.c_str());
-00754 }
+
00770 {
+00771         del_kline(hostmask.c_str());
+00772 }
 
@@ -1320,13 +1320,13 @@ Deletes a Q-Line from all servers on the mesh.

-Definition at line 741 of file modules.cpp. +Definition at line 759 of file modules.cpp.

References del_qline().

-

00742 {
-00743         del_qline(nickname.c_str());
-00744 }
+
00760 {
+00761         del_qline(nickname.c_str());
+00762 }
 
@@ -1360,13 +1360,13 @@ Deletes a Z-Line from all servers on the mesh.

-Definition at line 746 of file modules.cpp. +Definition at line 764 of file modules.cpp.

References del_zline().

-

00747 {
-00748         del_zline(ipaddr.c_str());
-00749 }
+
00765 {
+00766         del_zline(ipaddr.c_str());
+00767 }
 
@@ -1400,11 +1400,11 @@ 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. +Definition at line 606 of file modules.cpp.

-

00598 {
-00599         return FindChan(channel.c_str());
-00600 }
+
00607 {
+00608         return FindChan(channel.c_str());
+00609 }
 
@@ -1438,13 +1438,13 @@ 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. +Definition at line 601 of file modules.cpp.

-References fd_ref_table. +References fd_ref_table.

-

00593 {
-00594         return (socket < 65536 ? fd_ref_table[socket] : NULL);
-00595 }
+
00602 {
+00603         return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00604 }
 
@@ -1478,20 +1478,20 @@ 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. +Definition at line 857 of file modules.cpp.

-References MODCOUNT, module_names, and modules. +References MODCOUNT, module_names, and modules.

-

00840 {
-00841         for (int i = 0; i <= MODCOUNT; i++)
-00842         {
-00843                 if (module_names[i] == name)
-00844                 {
-00845                         return modules[i];
-00846                 }
-00847         }
-00848         return NULL;
-00849 }
+
00858 {
+00859         for (int i = 0; i <= MODCOUNT; i++)
+00860         {
+00861                 if (module_names[i] == name)
+00862                 {
+00863                         return modules[i];
+00864                 }
+00865         }
+00866         return NULL;
+00867 }
 
@@ -1525,11 +1525,11 @@ 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. +Definition at line 596 of file modules.cpp.

-

00588 {
-00589         return Find(nick);
-00590 }
+
00597 {
+00598         return Find(nick);
+00599 }
 
@@ -1562,11 +1562,11 @@ Returns the information of the server as returned by the /ADMIN command.

See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.

-Definition at line 622 of file modules.cpp. +Definition at line 631 of file modules.cpp.

-

00623 {
-00624         return Admin(getadminname(),getadminemail(),getadminnick());
-00625 }
+
00632 {
+00633         return Admin(getadminname(),getadminemail(),getadminnick());
+00634 }
 
@@ -1599,11 +1599,11 @@ Returns the network name, global to all linked servers.

-Definition at line 617 of file modules.cpp. +Definition at line 626 of file modules.cpp.

-

00618 {
-00619         return getnetworkname();
-00620 }
+
00627 {
+00628         return getnetworkname();
+00629 }
 
@@ -1636,11 +1636,11 @@ Returns the server name of the server where the module is loaded.

-Definition at line 612 of file modules.cpp. +Definition at line 621 of file modules.cpp.

-

00613 {
-00614         return getservername();
-00615 }
+
00622 {
+00623         return getservername();
+00624 }
 
@@ -1674,21 +1674,21 @@ 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. -

-References chanuserlist, chanrec::GetUsers(), and list. -

-

00458 {
-00459         chanuserlist userl;
-00460         userl.clear();
-00461         std::vector<char*> *list = chan->GetUsers();
-00462         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
-00463         {
-00464                 char* o = *i;
-00465                 userl.push_back((userrec*)o);
-00466         }
-00467         return userl;
-00468 }
+Definition at line 466 of file modules.cpp.
+

+References chanuserlist, chanrec::GetUsers(), and list. +

+

00467 {
+00468         chanuserlist userl;
+00469         userl.clear();
+00470         std::vector<char*> *list = chan->GetUsers();
+00471         for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++)
+00472         {
+00473                 char* o = *i;
+00474                 userl.push_back((userrec*)o);
+00475         }
+00476         return userl;
+00477 }
 
@@ -1722,13 +1722,13 @@ Returns true if a nick is valid.

Nicks for unregistered connections will return false.

-Definition at line 582 of file modules.cpp. +Definition at line 591 of file modules.cpp.

References isnick().

-

00583 {
-00584         return (isnick(nick.c_str()) != 0);
-00585 }
+
00592 {
+00593         return (isnick(nick.c_str()) != 0);
+00594 }
 
@@ -1771,13 +1771,13 @@ 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. +Definition at line 616 of file modules.cpp.

References has_channel().

-

00608 {
-00609         return has_channel(User,Chan);
-00610 }
+
00617 {
+00618         return has_channel(User,Chan);
+00619 }
 
@@ -1811,13 +1811,13 @@ 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. +Definition at line 488 of file modules.cpp.

References is_uline().

-

00480 {
-00481         return is_uline(server.c_str());
-00482 }
+
00489 {
+00490         return is_uline(server.c_str());
+00491 }
 
@@ -1851,35 +1851,35 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.

-Definition at line 766 of file modules.cpp. -

-

00767 {
-00768         const char* dest = mask.c_str();
-00769         if (strchr(dest,'!')==0)
-00770                 return false;
-00771         if (strchr(dest,'@')==0)
-00772                 return false;
-00773         for (int i = 0; i < strlen(dest); i++)
-00774                 if (dest[i] < 32)
-00775                         return false;
-00776         for (int i = 0; i < strlen(dest); i++)
-00777                 if (dest[i] > 126)
-00778                         return false;
-00779         int c = 0;
-00780         for (int i = 0; i < strlen(dest); i++)
-00781                 if (dest[i] == '!')
-00782                         c++;
-00783         if (c>1)
-00784                 return false;
-00785         c = 0;
-00786         for (int i = 0; i < strlen(dest); i++)
-00787                 if (dest[i] == '@')
-00788                         c++;
-00789         if (c>1)
+Definition at line 784 of file modules.cpp.
+

+

00785 {
+00786         const char* dest = mask.c_str();
+00787         if (strchr(dest,'!')==0)
+00788                 return false;
+00789         if (strchr(dest,'@')==0)
 00790                 return false;
-00791 
-00792         return true;
-00793 }
+00791         for (int i = 0; i < strlen(dest); i++)
+00792                 if (dest[i] < 32)
+00793                         return false;
+00794         for (int i = 0; i < strlen(dest); i++)
+00795                 if (dest[i] > 126)
+00796                         return false;
+00797         int c = 0;
+00798         for (int i = 0; i < strlen(dest); i++)
+00799                 if (dest[i] == '!')
+00800                         c++;
+00801         if (c>1)
+00802                 return false;
+00803         c = 0;
+00804         for (int i = 0; i < strlen(dest); i++)
+00805                 if (dest[i] == '@')
+00806                         c++;
+00807         if (c>1)
+00808                 return false;
+00809 
+00810         return true;
+00811 }
 
@@ -1928,11 +1928,11 @@ 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. +Definition at line 456 of file modules.cpp.

-

00448 {
-00449         return add_channel(user,cname.c_str(),key.c_str(),false);
-00450 }
+
00457 {
+00458         return add_channel(user,cname.c_str(),key.c_str(),false);
+00459 }
 
@@ -1975,11 +1975,11 @@ 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. +Definition at line 498 of file modules.cpp.

-

00490 {
-00491         log(level,"%s",s.c_str());
-00492 }
+
00499 {
+00500         log(level,"%s",s.c_str());
+00501 }
 
@@ -2022,14 +2022,14 @@ 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. +Definition at line 443 of file modules.cpp.

-

00435 {
-00436         char literal[MAXBUF],pattern[MAXBUF];
-00437         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00438         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00439         return match(literal,pattern);
-00440 }
+
00444 {
+00445         char literal[MAXBUF],pattern[MAXBUF];
+00446         strlcpy(literal,sliteral.c_str(),MAXBUF);
+00447         strlcpy(pattern,spattern.c_str(),MAXBUF);
+00448         return match(literal,pattern);
+00449 }
 
@@ -2072,15 +2072,15 @@ This function is used to check if any users on channel c are on server servernam

This is used internally by PRIVMSG etc. You should not need to use it.

-Definition at line 821 of file modules.cpp. +Definition at line 839 of file modules.cpp.

-

00822 {
-00823         if (c)
-00824         {
-00825                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
-00826         }
-00827         else return false;
-00828 }
+
00840 {
+00841         if (c)
+00842         {
+00843                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
+00844         }
+00845         else return false;
+00846 }
 
@@ -2123,15 +2123,15 @@ This function is used to check if user u has any channels in common with users o

This is used internally by Server::MeshSendCommon. You should very rarely need to use it.

-Definition at line 830 of file modules.cpp. +Definition at line 848 of file modules.cpp.

-

00831 {
-00832         if (u)
-00833         {
-00834                 return CommonOnThisServer(u,(char*)servername.c_str());
-00835         }
-00836         else return false;
-00837 }
+
00849 {
+00850         if (u)
+00851         {
+00852                 return CommonOnThisServer(u,(char*)servername.c_str());
+00853         }
+00854         else return false;
+00855 }
 
@@ -2165,11 +2165,11 @@ 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. +Definition at line 813 of file modules.cpp.

-

00796 {
-00797         NetSendToAll((char*)text.c_str());
-00798 }
+
00814 {
+00815         NetSendToAll((char*)text.c_str());
+00816 }
 
@@ -2203,11 +2203,11 @@ This function is equivalent to Server::MeshSendToAll except it will only route t

-Definition at line 806 of file modules.cpp. +Definition at line 824 of file modules.cpp.

-

00807 {
-00808         NetSendToAllAlive((char*)text.c_str());
-00809 }
+
00825 {
+00826         NetSendToAllAlive((char*)text.c_str());
+00827 }
 
@@ -2250,11 +2250,11 @@ 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. +Definition at line 834 of file modules.cpp.

-

00817 {
-00818         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
-00819 }
+
00835 {
+00836         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
+00837 }
 
@@ -2297,12 +2297,12 @@ This method sends a line of text to all servers who have users which share commo

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. +Definition at line 818 of file modules.cpp.

-

00801 {
-00802         if (user)
-00803                 NetSendToCommon(user,(char*)text.c_str());
-00804 }
+
00819 {
+00820         if (user)
+00821                 NetSendToCommon(user,(char*)text.c_str());
+00822 }
 
@@ -2345,11 +2345,11 @@ 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. +Definition at line 829 of file modules.cpp.

-

00812 {
-00813         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
-00814 }
+
00830 {
+00831         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
+00832 }
 
@@ -2398,11 +2398,11 @@ 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. +Definition at line 461 of file modules.cpp.

-

00453 {
-00454         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00455 }
+
00462 {
+00463         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00464 }
 
@@ -2451,38 +2451,38 @@ This user takes one user, and switches their file descriptor with another user,

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. -

-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. -

-

00682 {
-00683         zombie->fd = alive->fd;
-00684         alive->fd = FD_MAGIC_NUMBER;
-00685         alive->ClearBuffer();
-00686         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00687         kill_link(alive,message.c_str());
-00688         fd_ref_table[zombie->fd] = zombie;
-00689         for (int i = 0; i != MAXCHANS; i++)
-00690         {
-00691                 if (zombie->chans[i].channel != NULL)
-00692                 {
-00693                         if (zombie->chans[i].channel->name)
-00694                         {
-00695                                 chanrec* Ptr = zombie->chans[i].channel;
-00696                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00697                                 if (Ptr->topicset)
-00698                                 {
-00699                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00700                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00701                                 }
-00702                                 userlist(zombie,Ptr);
-00703                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00704 
-00705                         }
-00706                 }
-00707         }
-00708 
-00709 }
+Definition at line 699 of file modules.cpp.
+

+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. +

+

00700 {
+00701         zombie->fd = alive->fd;
+00702         alive->fd = FD_MAGIC_NUMBER;
+00703         alive->ClearBuffer();
+00704         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
+00705         kill_link(alive,message.c_str());
+00706         fd_ref_table[zombie->fd] = zombie;
+00707         for (int i = 0; i != MAXCHANS; i++)
+00708         {
+00709                 if (zombie->chans[i].channel != NULL)
+00710                 {
+00711                         if (zombie->chans[i].channel->name)
+00712                         {
+00713                                 chanrec* Ptr = zombie->chans[i].channel;
+00714                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
+00715                                 if (Ptr->topicset)
+00716                                 {
+00717                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
+00718                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+00719                                 }
+00720                                 userlist(zombie,Ptr);
+00721                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
+00722 
+00723                         }
+00724                 }
+00725         }
+00726 
+00727 }
 
@@ -2527,11 +2527,11 @@ To the user, it will appear as if they typed /QUIT themselves, except for the fa WARNING!

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. +Definition at line 483 of file modules.cpp.

-

00475 {
-00476         kill_link(user,reason.c_str());
-00477 }
+
00484 {
+00485         kill_link(user,reason.c_str());
+00486 }
 
@@ -2574,11 +2574,11 @@ 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. +Definition at line 513 of file modules.cpp.

-

00505 {
-00506         Write(Socket,"%s",s.c_str());
-00507 }
+
00514 {
+00515         Write(Socket,"%s",s.c_str());
+00516 }
 
@@ -2633,18 +2633,18 @@ 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. -

-

00539 {
-00540         if (IncludeSender)
-00541         {
-00542                 WriteChannel(Channel,User,"%s",s.c_str());
-00543         }
-00544         else
-00545         {
-00546                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00547         }
-00548 }
+Definition at line 547 of file modules.cpp.
+

+

00548 {
+00549         if (IncludeSender)
+00550         {
+00551                 WriteChannel(Channel,User,"%s",s.c_str());
+00552         }
+00553         else
+00554         {
+00555                 ChanExceptSender(Channel,User,"%s",s.c_str());
+00556         }
+00557 }
 
@@ -2693,11 +2693,11 @@ 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. +Definition at line 542 of file modules.cpp.

-

00534 {
-00535         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
-00536 }
+
00543 {
+00544         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00545 }
 
@@ -2746,18 +2746,18 @@ 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. -

-

00556 {
-00557         if (IncludeSender)
-00558         {
-00559                 WriteCommon(User,"%s",text.c_str());
-00560         }
-00561         else
-00562         {
-00563                 WriteCommonExcept(User,"%s",text.c_str());
-00564         }
-00565 }
+Definition at line 564 of file modules.cpp.
+

+

00565 {
+00566         if (IncludeSender)
+00567         {
+00568                 WriteCommon(User,"%s",text.c_str());
+00569         }
+00570         else
+00571         {
+00572                 WriteCommonExcept(User,"%s",text.c_str());
+00573         }
+00574 }
 
@@ -2806,11 +2806,11 @@ 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. +Definition at line 523 of file modules.cpp.

-

00515 {
-00516         WriteFrom(Socket,User,"%s",s.c_str());
-00517 }
+
00524 {
+00525         WriteFrom(Socket,User,"%s",s.c_str());
+00526 }
 
@@ -2866,13 +2866,13 @@ modes[2] = user->nick;

Srv->SendMode(modes,3,user);

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. +Definition at line 508 of file modules.cpp.

References server_mode().

-

00500 {
-00501         server_mode(parameters,pcnt,user);
-00502 }
+
00509 {
+00510         server_mode(parameters,pcnt,user);
+00511 }
 
@@ -2906,11 +2906,11 @@ 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. +Definition at line 438 of file modules.cpp.

-

00430 {
-00431         WriteOpers("%s",s.c_str());
-00432 }
+
00439 {
+00440         WriteOpers("%s",s.c_str());
+00441 }
 
@@ -2953,11 +2953,11 @@ 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. +Definition at line 518 of file modules.cpp.

-

00510 {
-00511         WriteServ(Socket,"%s",s.c_str());
-00512 }
+
00519 {
+00520         WriteServ(Socket,"%s",s.c_str());
+00521 }
 
@@ -3010,22 +3010,22 @@ The format will become:

:localserver TEXT

Which is useful for numerics and server notices to single users, etc.

-Definition at line 519 of file modules.cpp. +Definition at line 528 of file modules.cpp.

References connection::fd.

-

00520 {
-00521         if (!Source)
-00522         {
-00523                 // if source is NULL, then the message originates from the local server
-00524                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00525         }
-00526         else
-00527         {
-00528                 // otherwise it comes from the user specified
-00529                 WriteTo(Source,Dest,"%s",s.c_str());
-00530         }
-00531 }
+
00529 {
+00530         if (!Source)
+00531         {
+00532                 // if source is NULL, then the message originates from the local server
+00533                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
+00534         }
+00535         else
+00536         {
+00537                 // otherwise it comes from the user specified
+00538                 WriteTo(Source,Dest,"%s",s.c_str());
+00539         }
+00540 }
 
@@ -3076,11 +3076,11 @@ These can be RFC specified modes such as +i, or module provided modes, including Serv->SendToModeMask("xi", WM_OR, "m00");

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. +Definition at line 451 of file modules.cpp.

-

00443 {
-00444         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00445 }
+
00452 {
+00453         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00454 }
 
@@ -3123,11 +3123,11 @@ 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. +Definition at line 576 of file modules.cpp.

-

00568 {
-00569         WriteWallOps(User,false,"%s",text.c_str());
-00570 }
+
00577 {
+00578         WriteWallOps(User,false,"%s",text.c_str());
+00579 }
 
@@ -3170,24 +3170,33 @@ Remove a user's connection to the irc server, but leave their client in existenc

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. -

-References userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. -

-

00672 {
-00673         unsigned int old_fd = user->fd;
-00674         user->fd = FD_MAGIC_NUMBER;
-00675         user->ClearBuffer();
-00676         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00677         shutdown(old_fd,2);
-00678         close(old_fd);
-00679 }
+Definition at line 680 of file modules.cpp.
+

+References userrec::ClearBuffer(), DEBUG, connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. +

+

00681 {
+00682         unsigned int old_fd = user->fd;
+00683         user->fd = FD_MAGIC_NUMBER;
+00684         user->ClearBuffer();
+00685         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
+00686 #ifdef USE_KQUEUE
+00687         struct kevent ke;
+00688         EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL);
+00689         int i = kevent(kq, &ke, 1, 0, 0, NULL);
+00690         if (i == -1)
+00691         {
+00692                 log(DEBUG,"kqueue: Failed to remove user from queue!");
+00693         }
+00694 #endif
+00695         shutdown(old_fd,2);
+00696         close(old_fd);
+00697 }
 

The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
Generated on Thu May 12 02:25:27 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classVersion-members.html b/docs/module-doc/classVersion-members.html index cf4a60a8a..95c5bdb08 100644 --- a/docs/module-doc/classVersion-members.html +++ b/docs/module-doc/classVersion-members.html @@ -15,7 +15,7 @@ RevisionVersion Version(int major, int minor, int revision, int build, int flags)Version ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classVersion.html b/docs/module-doc/classVersion.html index c792987c2..26f75dbcf 100644 --- a/docs/module-doc/classVersion.html +++ b/docs/module-doc/classVersion.html @@ -92,9 +92,9 @@ Definition at line 111 of

-Definition at line 300 of file modules.cpp. +Definition at line 309 of file modules.cpp.

-

00300 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { };
+
00309 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { };
 
@@ -221,7 +221,7 @@ Definition at line 114 of
The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classXLine-members.html b/docs/module-doc/classXLine-members.html index abb102776..7f6ff7071 100644 --- a/docs/module-doc/classXLine-members.html +++ b/docs/module-doc/classXLine-members.html @@ -14,7 +14,7 @@ set_timeXLine sourceXLine ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classXLine.html b/docs/module-doc/classXLine.html index 8d26c8e3a..933828347 100644 --- a/docs/module-doc/classXLine.html +++ b/docs/module-doc/classXLine.html @@ -171,7 +171,7 @@ Definition at line 48 of fi
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classZLine-members.html b/docs/module-doc/classZLine-members.html index b9d028897..349512e83 100644 --- a/docs/module-doc/classZLine-members.html +++ b/docs/module-doc/classZLine-members.html @@ -16,7 +16,7 @@ set_timeXLine sourceXLine ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classZLine.html b/docs/module-doc/classZLine.html index 07ac0eb8a..f5b1acf92 100644 --- a/docs/module-doc/classZLine.html +++ b/docs/module-doc/classZLine.html @@ -82,7 +82,7 @@ Definition at line 103 of f
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classchanrec-members.html b/docs/module-doc/classchanrec-members.html index 392b35af8..657825362 100644 --- a/docs/module-doc/classchanrec-members.html +++ b/docs/module-doc/classchanrec-members.html @@ -41,7 +41,7 @@ userschanrec ~chanrec()chanrec [inline, virtual] ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index 424fd9ee9..44fde568f 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -221,14 +221,14 @@ Add a user pointer to the internal reference list The data inserted into the ref

-Definition at line 220 of file channels.cpp. +Definition at line 215 of file channels.cpp.

References DEBUG, and internal_userlist.

-

00221 {
-00222         internal_userlist.push_back(castuser);
-00223         log(DEBUG,"Added casted user to channel's internal list");
-00224 }
+
00216 {
+00217         internal_userlist.push_back(castuser);
+00218         log(DEBUG,"Added casted user to channel's internal list");
+00219 }
 
@@ -261,15 +261,10 @@ Decrement the channel "user counter" The channel user counter is a reference cou

If it decremented to 0 then the channel is removed from the system. Modules may alter the reference count to hold channels open which have no users and would normally be deleted once empty.

-Definition at line 208 of file channels.cpp. -

-References DEBUG, name, and users. +Definition at line 206 of file channels.cpp.

-

00209 {
-00210         if (this->users > 0)
-00211                 this->users--;
-00212         log(DEBUG,"Decremented channel user count for %s to %lu",name,(unsigned long)users);
-00213 }
+
00207 {
+00208 }
 
@@ -303,22 +298,22 @@ Delete a user pointer to the internal reference list The data removed from the r

-Definition at line 226 of file channels.cpp. +Definition at line 221 of file channels.cpp.

References DEBUG, internal_userlist, and name.

-

00227 {
-00228         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
-00229         {
-00230                 if (*a == castuser)
-00231                 {
-00232                         log(DEBUG,"Removed casted user from channel's internal list");
-00233                         internal_userlist.erase(a);
-00234                         return;
-00235                 }
-00236         }
-00237         log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name);
-00238 }
+
00222 {
+00223         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
+00224         {
+00225                 if (*a == castuser)
+00226                 {
+00227                         log(DEBUG,"Removed casted user from channel's internal list");
+00228                         internal_userlist.erase(a);
+00229                         return;
+00230                 }
+00231         }
+00232         log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name);
+00233 }
 
@@ -363,11 +358,11 @@ References custom_mode_par 00192 { 00193 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) 00194 { -00195 return std::string(i->parameter); +00195 return i->parameter; 00196 } 00197 } 00198 } -00199 return std::string(""); +00199 return ""; 00200 }
@@ -401,13 +396,13 @@ Obtain the channel "user counter" This returns the channel reference counter, wh

-Definition at line 215 of file channels.cpp. +Definition at line 210 of file channels.cpp.

-References users. +References internal_userlist.

-

00216 {
-00217         return (this->users);
-00218 }
+
00211 {
+00212         return (this->internal_userlist.size());
+00213 }
 
@@ -440,15 +435,15 @@ Obrain the internal reference list The internal reference list contains a list o

These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.

-Definition at line 240 of file channels.cpp. +Definition at line 235 of file channels.cpp.

References internal_userlist.

-Referenced by Server::GetUsers(). +Referenced by Server::GetUsers().

-

00241 {
-00242         return &internal_userlist;
-00243 }
+
00236 {
+00237         return &internal_userlist;
+00238 }
 
@@ -483,12 +478,8 @@ If it decremented to 0 then the channel is removed from the system.

Definition at line 202 of file channels.cpp.

-References DEBUG, name, and users. -

00203 {
-00204         this->users++;
-00205         log(DEBUG,"Incremented channel user count for %s to %lu",name,(unsigned long)users);
-00206 }
+00204 }
 
@@ -820,7 +811,7 @@ User list (casted to char*'s to stop forward declaration stuff) (chicken and egg

Definition at line 112 of file channels.h.

-Referenced by AddUser(), chanrec(), DelUser(), and GetUsers(). +Referenced by AddUser(), chanrec(), DelUser(), GetUserCounter(), and GetUsers().

@@ -960,7 +951,7 @@ The channels name.

Definition at line 99 of file channels.h.

-Referenced by chanrec(), DecUserCounter(), DelUser(), IncUserCounter(), and Server::PseudoToUser(). +Referenced by chanrec(), DelUser(), and Server::PseudoToUser().

@@ -1044,7 +1035,7 @@ If this member is an empty string, no topic was ever set.

Definition at line 128 of file channels.h.

-Referenced by chanrec(), and Server::PseudoToUser(). +Referenced by chanrec(), and Server::PseudoToUser().

@@ -1072,7 +1063,7 @@ If this is an empty string, no channel topic is set.

Definition at line 117 of file channels.h.

-Referenced by chanrec(), and Server::PseudoToUser(). +Referenced by chanrec(), and Server::PseudoToUser().

@@ -1128,7 +1119,7 @@ If no topic was ever set, this will be equal to 124 of file channels.h.

-Referenced by chanrec(), and Server::PseudoToUser(). +Referenced by chanrec(), and Server::PseudoToUser().

@@ -1156,12 +1147,12 @@ Count of users on the channel used for fast user counting.

Definition at line 107 of file channels.h.

-Referenced by chanrec(), DecUserCounter(), GetUserCounter(), and IncUserCounter(). +Referenced by chanrec().


The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classclassbase-members.html b/docs/module-doc/classclassbase-members.html index f135846df..8719bfe9c 100644 --- a/docs/module-doc/classclassbase-members.html +++ b/docs/module-doc/classclassbase-members.html @@ -9,7 +9,7 @@ ageclassbase classbase()classbase [inline] ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classclassbase.html b/docs/module-doc/classclassbase.html index 89c86c19b..26b2e35d1 100644 --- a/docs/module-doc/classclassbase.html +++ b/docs/module-doc/classclassbase.html @@ -132,7 +132,7 @@ Referenced by classbase().
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classcommand__t-members.html b/docs/module-doc/classcommand__t-members.html index 44ffa4ed4..f0d330dbb 100644 --- a/docs/module-doc/classcommand__t-members.html +++ b/docs/module-doc/classcommand__t-members.html @@ -19,7 +19,7 @@ total_bytescommand_t use_countcommand_t ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:19 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classcommand__t.html b/docs/module-doc/classcommand__t.html index 984063bc4..6139dbf21 100644 --- a/docs/module-doc/classcommand__t.html +++ b/docs/module-doc/classcommand__t.html @@ -227,7 +227,7 @@ Definition at line 43 of
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:19 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classconnection-members.html b/docs/module-doc/classconnection-members.html index cad6cfc13..fd2767af3 100644 --- a/docs/module-doc/classconnection-members.html +++ b/docs/module-doc/classconnection-members.html @@ -40,7 +40,7 @@ stateconnection TerminateLink(char *targethost)connection ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classconnection.html b/docs/module-doc/classconnection.html index a02f27de1..784fc69e3 100644 --- a/docs/module-doc/classconnection.html +++ b/docs/module-doc/classconnection.html @@ -532,7 +532,7 @@ Stats counter for bytes outbound.

Definition at line 235 of file connection.h.

-Referenced by userrec::userrec(). +Referenced by userrec::FlushWriteBuf(), and userrec::userrec().

@@ -588,7 +588,7 @@ Stats counter for commands outbound.

Definition at line 243 of file connection.h.

-Referenced by userrec::userrec(). +Referenced by userrec::FlushWriteBuf(), and userrec::userrec().

@@ -642,7 +642,7 @@ File descriptor of the connection.

Definition at line 215 of file connection.h.

-Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). +Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo().

@@ -698,7 +698,7 @@ Not used if this is a serverrec

Definition at line 219 of file connection.h.

-Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo(). +Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo().

@@ -1005,7 +1005,7 @@ Definition at line 261


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classes.html b/docs/module-doc/classes.html index 6899bd21c..1b3c4ae56 100644 --- a/docs/module-doc/classes.html +++ b/docs/module-doc/classes.html @@ -25,7 +25,7 @@
  Z  
connection   
  G  
ModeParameter   Server   ZLine   
  D  
-GLine   Module   
Generated on Sat May 7 15:34:23 2005 for InspIRCd by +GLine   Module   
Generated on Thu May 12 02:25:17 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classircd__connector-members.html b/docs/module-doc/classircd__connector-members.html index a5059edbc..b37048dd8 100644 --- a/docs/module-doc/classircd__connector-members.html +++ b/docs/module-doc/classircd__connector-members.html @@ -43,7 +43,7 @@ stateircd_connector [private] versionircd_connector [private] ~classbase()classbase [inline] -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:22 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classircd__connector.html b/docs/module-doc/classircd__connector.html index b0027cdda..95c580e11 100644 --- a/docs/module-doc/classircd__connector.html +++ b/docs/module-doc/classircd__connector.html @@ -1052,7 +1052,7 @@ Definition at line 84
The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
Generated on Thu May 12 02:25:22 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classserverrec-members.html b/docs/module-doc/classserverrec-members.html index 2c772e794..119f82981 100644 --- a/docs/module-doc/classserverrec-members.html +++ b/docs/module-doc/classserverrec-members.html @@ -54,7 +54,7 @@ versionserverrec ~classbase()classbase [inline] ~serverrec()serverrec -
Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
Generated on Thu May 12 02:25:28 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classserverrec.html b/docs/module-doc/classserverrec.html index 730b8c5e3..872fd6047 100644 --- a/docs/module-doc/classserverrec.html +++ b/docs/module-doc/classserverrec.html @@ -519,7 +519,7 @@ Referenced by serverrec()
The documentation for this class was generated from the following files:
-
Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
Generated on Thu May 12 02:25:28 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classucrec-members.html b/docs/module-doc/classucrec-members.html index dc63998ac..95f7be1c1 100644 --- a/docs/module-doc/classucrec-members.html +++ b/docs/module-doc/classucrec-members.html @@ -13,7 +13,7 @@ ucrec()ucrec [inline] ~classbase()classbase [inline] ~ucrec()ucrec [inline, virtual] -
Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
Generated on Thu May 12 02:25:28 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classucrec.html b/docs/module-doc/classucrec.html index c108eb9de..ad7b1ec0e 100644 --- a/docs/module-doc/classucrec.html +++ b/docs/module-doc/classucrec.html @@ -127,7 +127,7 @@ If the record is not in use, this value will be NULL.

Definition at line 268 of file channels.h.

-Referenced by Server::PseudoToUser(), and userrec::userrec(). +Referenced by Server::PseudoToUser(), and userrec::userrec().

@@ -160,7 +160,7 @@ Referenced by userrec::userre


The documentation for this class was generated from the following file: -
Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
Generated on Thu May 12 02:25:28 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classuserrec-members.html b/docs/module-doc/classuserrec-members.html index b989419b1..57e339772 100644 --- a/docs/module-doc/classuserrec-members.html +++ b/docs/module-doc/classuserrec-members.html @@ -8,6 +8,7 @@

userrec Member List

This is the complete list of members for userrec, including all inherited members. + @@ -28,11 +29,13 @@ + + @@ -46,7 +49,7 @@ - + @@ -57,22 +60,27 @@ + - + + + + - + + -
AddBuffer(std::string a)userrec
AddIncoming(int fd, char *targethost, int sourceport)connection
AddWriteBuf(std::string data)userrec
ageclassbase
awaymsguserrec
BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
fdconnection
FindHost(std::string host)connection
flooduserrec
FlushWriteBuf()userrec
fullnameuserrec
GetBuffer()userrec
GetExt(std::string key)Extensible
GetFullHost()userrec [virtual]
GetFullRealHost()userrec [virtual]
GetWriteError()userrec
haspassedconnection
HasPermission(char *command)userrec
hostconnection
ipconnection
IsInvited(char *channel)userrec [virtual]
lastpingconnection
lines_inuserrec
lines_inuserrec
MeshCookie(char *targethost, int port, unsigned long cookie, char *servername)connection
modesuserrec
nickuserrec
portconnection
RecvPacket(std::deque< std::string > &messages, char *host)connection
recvquserrec
recvqmaxuserrec
registeredconnection
RemoveInvite(char *channel)userrec [virtual]
reset_dueuserrec
reset_dueuserrec
resultuserrec
SendPacket(char *message, const char *host)connection
sendquserrec
sendqmaxuserrec
serveruserrec
SetWriteError(std::string error)userrec
Shrink(std::string key)Extensible
signonconnection
stateconnection
TerminateLink(char *targethost)connection
thresholduserrec
thresholduserrec
timeoutuserrec
userrec()userrec
WriteErroruserrec
~classbase()classbase [inline]
~userrec()userrec [inline, virtual]

Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 16ad17d03..a1d605b1b 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -49,6 +49,18 @@ Inherits connection. std::string GetBuffer ()  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.

+void SetWriteError (std::string error) + + Sets the write error for a connection.


+std::string GetWriteError () + + Returns the write error which last occured on this connection or an empty string if none occured.


+void AddWriteBuf (std::string data) + + Adds to the user's write buffer.


+void FlushWriteBuf () + + Flushes as much of the user's buffer to the file descriptor as possible.



Public Attributes

char nick [NICKMAX] @@ -97,13 +109,24 @@ Inherits connection. std::string recvq  User's receive queue.


-long lines_in +std::string sendq + + User's send queue.


+long lines_in + + Flood counters.


+time_t reset_due + +long threshold + +std::string WriteError - Flood counters.


-time_t reset_due +long sendqmax -long threshold + Maximum size this user's sendq can become.


+long recvqmax + Maximum size this user's recvq can become.



Private Attributes

InvitedList invites @@ -116,7 +139,7 @@ Everything about a connection is stored here primarily, from the user's socket I

-Definition at line 98 of file users.h.


Constructor & Destructor Documentation

+Definition at line 108 of file users.h.

Constructor & Destructor Documentation

@@ -146,7 +169,7 @@ Definition at line 98 of fi

Definition at line 28 of file users.cpp.

-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. +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, sendq, server, connection::signon, TIME, timeout, and ucrec::uc_modes.

00029 {
 00030         // the PROPER way to do it, AVOID bzero at *ALL* costs
@@ -162,21 +185,22 @@ References awaymsg, "");
 00041         strcpy(awaymsg,"");
 00042         strcpy(oper,"");
-00043         reset_due = TIME;
-00044         lines_in = 0;
+00043         reset_due = TIME;
+00044         lines_in = 0;
 00045         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
 00046         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
 00047         haspassed = false;
 00048         dns_done = false;
 00049         recvq = "";
-00050         strcpy(result,"");
-00051         for (int i = 0; i < MAXCHANS; i++)
-00052         {
-00053                 this->chans[i].channel = NULL;
-00054                 this->chans[i].uc_modes = 0;
-00055         }
-00056         invites.clear();
-00057 }
+00050         sendq = "";
+00051         strcpy(result,"");
+00052         for (int i = 0; i < MAXCHANS; i++)
+00053         {
+00054                 this->chans[i].channel = NULL;
+00055                 this->chans[i].uc_modes = 0;
+00056         }
+00057         invites.clear();
+00058 }
 
@@ -207,9 +231,9 @@ References awaymsg,

-Definition at line 195 of file users.h. +Definition at line 222 of file users.h.

-

00195 {  }
+
00222 {  }
 
@@ -244,29 +268,84 @@ 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. -

-References recvq. -

-

00170 {
-00171         std::string b = "";
-00172         for (int i = 0; i < a.length(); i++)
-00173                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
-00174                         b = b + a[i];
-00175         std::stringstream stream(recvq);
-00176         stream << b;
-00177         recvq = stream.str();
-00178         int i = 0;
-00179         // count the size of the first line in the buffer.
-00180         while (i < recvq.length())
-00181         {
-00182                 if (recvq[i++] == '\n')
-00183                         break;
-00184         }
-00185         // return false if we've had more than 600 characters WITHOUT
-00186         // a carriage return (this is BAD, drop the socket)
-00187         return (i < 600);
-00188 }
+Definition at line 170 of file users.cpp.
+

+References recvq, recvqmax, and SetWriteError(). +

+

00171 {
+00172         std::string b = "";
+00173         for (int i = 0; i < a.length(); i++)
+00174                 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7))
+00175                         b = b + a[i];
+00176         std::stringstream stream(recvq);
+00177         stream << b;
+00178         recvq = stream.str();
+00179         int i = 0;
+00180         // count the size of the first line in the buffer.
+00181         while (i < recvq.length())
+00182         {
+00183                 if (recvq[i++] == '\n')
+00184                         break;
+00185         }
+00186         if (recvq.length() > this->recvqmax)
+00187         {
+00188                 this->SetWriteError("RecvQ exceeded");
+00189                 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax);
+00190         }
+00191         // return false if we've had more than 600 characters WITHOUT
+00192         // a carriage return (this is BAD, drop the socket)
+00193         return (i < 600);
+00194 }
+
+ + +

+ + + + +
+ + + + + + + + + + +
void userrec::AddWriteBuf std::string  data  ) 
+
+ + + +
+   + + +

+Adds to the user's write buffer. +

+You may add any amount of text up to this users sendq value, if you exceed the sendq value, SetWriteError() will be called to set the users error string to "SendQ exceeded", and further buffer adds will be dropped. +

+Definition at line 226 of file users.cpp. +

+References GetWriteError(), sendq, sendqmax, and SetWriteError(). +

+

00227 {
+00228         if (this->GetWriteError() != "")
+00229                 return;
+00230         if (sendq.length() + data.length() > this->sendqmax)
+00231         {
+00232                 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax);
+00233                 this->SetWriteError("SendQ exceeded");
+00234                 return;
+00235         }
+00236         std::stringstream stream;
+00237         stream << sendq << data;
+00238         sendq = stream.str();
+00239 }
 
@@ -299,16 +378,16 @@ This method returns true if the buffer contains at least one carriage return cha

one complete line may be read)

-Definition at line 190 of file users.cpp. +Definition at line 196 of file users.cpp.

-References recvq. +References recvq.

-

00191 {
-00192         for (int i = 0; i < recvq.length(); i++)
-00193                 if (recvq[i] == '\n')
-00194                         return true;
-00195         return false;
-00196 }
+
00197 {
+00198         for (int i = 0; i < recvq.length(); i++)
+00199                 if (recvq[i] == '\n')
+00200                         return true;
+00201         return false;
+00202 }
 
@@ -341,15 +420,71 @@ This function clears the entire buffer by setting it to an empty string.

-Definition at line 198 of file users.cpp. +Definition at line 204 of file users.cpp. +

+References recvq. +

+Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). +

+

00205 {
+00206         recvq = "";
+00207 }
+
+ + +

+ + + + +
+ + + + + + + + + +
void userrec::FlushWriteBuf  ) 
+
+ + + +
+   + + +

+Flushes as much of the user's buffer to the file descriptor as possible. +

+This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method.

-References recvq. +Definition at line 242 of file users.cpp.

-Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). +References connection::bytes_out, connection::cmds_out, sendq, and SetWriteError().

-

00199 {
-00200         recvq = "";
-00201 }
+
00243 {
+00244         if (sendq.length())
+00245         {
+00246                 char* tb = (char*)this->sendq.c_str();
+00247                 int n_sent = write(this->fd,tb,this->sendq.length());
+00248                 if (n_sent == -1)
+00249                 {
+00250                         this->SetWriteError(strerror(errno));
+00251                 }
+00252                 else
+00253                 {
+00254                         // advance the queue
+00255                         tb += n_sent;
+00256                         this->sendq = tb;
+00257                         // update the user's stats counters
+00258                         this->bytes_out += n_sent;
+00259                         this->cmds_out++;
+00260                 }
+00261         }
+00262 }
 
@@ -382,25 +517,25 @@ This method returns the first available string at the tail end of the buffer and

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 BufferIsReady() to check if it is ok to read the buffer before calling GetBuffer().

-Definition at line 203 of file users.cpp. -

-References recvq. -

-

00204 {
-00205         if (recvq == "")
-00206                 return "";
-00207         char* line = (char*)recvq.c_str();
-00208         std::string ret = "";
-00209         while ((*line != '\n') && (strlen(line)))
-00210         {
-00211                 ret = ret + *line;
-00212                 line++;
-00213         }
-00214         if ((*line == '\n') || (*line == '\r'))
-00215                 line++;
-00216         recvq = line;
-00217         return ret;
-00218 }
+Definition at line 209 of file users.cpp.
+

+References recvq. +

+

00210 {
+00211         if (recvq == "")
+00212                 return "";
+00213         char* line = (char*)recvq.c_str();
+00214         std::string ret = "";
+00215         while ((*line != '\n') && (strlen(line)))
+00216         {
+00217                 ret = ret + *line;
+00218                 line++;
+00219         }
+00220         if ((*line == '\n') || (*line == '\r'))
+00221                 line++;
+00222         recvq = line;
+00223         return ret;
+00224 }
 
@@ -433,14 +568,14 @@ Returns the full displayed host of the user This member function returns the hos

-Definition at line 61 of file users.cpp. +Definition at line 62 of file users.cpp.

-References dhost, ident, nick, and result. +References dhost, ident, nick, and result.

-

00062 {
-00063         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
-00064         return result;
-00065 }
+
00063 {
+00064         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00065         return result;
+00066 }
 
@@ -473,14 +608,55 @@ Returns the full real host of the user This member function returns the hostname

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. +Definition at line 69 of file users.cpp.

-References connection::host, ident, nick, and result. +References connection::host, ident, nick, and result.

-

00069 {
-00070         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
-00071         return result;
-00072 }
+
00070 {
+00071         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
+00072         return result;
+00073 }
+
+ + +

+ + + + +
+ + + + + + + + + +
std::string userrec::GetWriteError  ) 
+
+ + + +
+   + + +

+Returns the write error which last occured on this connection or an empty string if none occured. +

+ +

+Definition at line 272 of file users.cpp. +

+References WriteError. +

+Referenced by AddWriteBuf(). +

+

00273 {
+00274         return this->WriteError;
+00275 }
 
@@ -514,59 +690,59 @@ Returns true or false for if a user can execute a privilaged oper command.

This is done by looking up their oper type from userrec::oper, then referencing this to their oper classes and checking the commands they can execute.

-Definition at line 117 of file users.cpp. +Definition at line 118 of file users.cpp.

References config_f, and DEBUG.

-

00118 {
-00119         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
-00120         char* mycmd;
-00121         char* savept;
-00122         char* savept2;
-00123         
-00124         // are they even an oper at all?
-00125         if (strchr(this->modes,'o'))
-00126         {
-00127                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
-00128                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
-00129                 {
-00130                         ConfValue("type","name",j,TypeName,&config_f);
-00131                         if (!strcmp(TypeName,this->oper))
-00132                         {
-00133                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
-00134                                 ConfValue("type","classes",j,Classes,&config_f);
-00135                                 char* myclass = strtok_r(Classes," ",&savept);
-00136                                 while (myclass)
-00137                                 {
-00138                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
-00139                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
-00140                                         {
-00141                                                 ConfValue("class","name",k,ClassName,&config_f);
-00142                                                 if (!strcmp(ClassName,myclass))
-00143                                                 {
-00144                                                         ConfValue("class","commands",k,CommandList,&config_f);
-00145                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
-00146                                                         
+
00119 {
+00120         char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
+00121         char* mycmd;
+00122         char* savept;
+00123         char* savept2;
+00124         
+00125         // are they even an oper at all?
+00126         if (strchr(this->modes,'o'))
+00127         {
+00128                 log(DEBUG,"*** HasPermission: %s is an oper",this->nick);
+00129                 for (int j =0; j < ConfValueEnum("type",&config_f); j++)
+00130                 {
+00131                         ConfValue("type","name",j,TypeName,&config_f);
+00132                         if (!strcmp(TypeName,this->oper))
+00133                         {
+00134                                 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper);
+00135                                 ConfValue("type","classes",j,Classes,&config_f);
+00136                                 char* myclass = strtok_r(Classes," ",&savept);
+00137                                 while (myclass)
+00138                                 {
+00139                                         log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass);
+00140                                         for (int k =0; k < ConfValueEnum("class",&config_f); k++)
+00141                                         {
+00142                                                 ConfValue("class","name",k,ClassName,&config_f);
+00143                                                 if (!strcmp(ClassName,myclass))
+00144                                                 {
+00145                                                         ConfValue("class","commands",k,CommandList,&config_f);
+00146                                                         log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList);
 00147                                                         
-00148                                                         mycmd = strtok_r(CommandList," ",&savept2);
-00149                                                         while (mycmd)
-00150                                                         {
-00151                                                                 if (!strcasecmp(mycmd,command))
-00152                                                                 {
-00153                                                                         log(DEBUG,"*** Command %s found, returning true",command);
-00154                                                                         return true;
-00155                                                                 }
-00156                                                                 mycmd = strtok_r(NULL," ",&savept2);
-00157                                                         }
-00158                                                 }
-00159                                         }
-00160                                         myclass = strtok_r(NULL," ",&savept);
-00161                                 }
-00162                         }
-00163                 }
-00164         }
-00165         return false;
-00166 }
+00148                                                         
+00149                                                         mycmd = strtok_r(CommandList," ",&savept2);
+00150                                                         while (mycmd)
+00151                                                         {
+00152                                                                 if (!strcasecmp(mycmd,command))
+00153                                                                 {
+00154                                                                         log(DEBUG,"*** Command %s found, returning true",command);
+00155                                                                         return true;
+00156                                                                 }
+00157                                                                 mycmd = strtok_r(NULL," ",&savept2);
+00158                                                         }
+00159                                                 }
+00160                                         }
+00161                                         myclass = strtok_r(NULL," ",&savept);
+00162                                 }
+00163                         }
+00164                 }
+00165         }
+00166         return false;
+00167 }
 
@@ -600,15 +776,15 @@ Adds a channel to a users invite list (invites them to a channel).

-Definition at line 88 of file users.cpp. +Definition at line 89 of file users.cpp.

-References Invited::channel, and invites. +References Invited::channel, and invites.

-

00089 {
-00090         Invited i;
-00091         strlcpy(i.channel,channel,CHANMAX);
-00092         invites.push_back(i);
-00093 }
+
00090 {
+00091         Invited i;
+00092         strlcpy(i.channel,channel,CHANMAX);
+00093         invites.push_back(i);
+00094 }
 
@@ -642,22 +818,22 @@ Returns true if a user is invited to a channel.

-Definition at line 74 of file users.cpp. +Definition at line 75 of file users.cpp.

-References invites. +References invites.

-

00075 {
-00076         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00077         {
-00078                 if (i->channel) {
-00079                         if (!strcasecmp(i->channel,channel))
-00080                         {
-00081                                 return true;
-00082                         }
-00083                 }
-00084         }
-00085         return false;
-00086 }
+
00076 {
+00077         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00078         {
+00079                 if (i->channel) {
+00080                         if (!strcasecmp(i->channel,channel))
+00081                         {
+00082                                 return true;
+00083                         }
+00084                 }
+00085         }
+00086         return false;
+00087 }
 
@@ -691,30 +867,75 @@ 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. -

-References DEBUG, and invites. -

-

00096 {
-00097         log(DEBUG,"Removing invites");
-00098         if (channel)
-00099         {
-00100                 if (invites.size())
-00101                 {
-00102                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00103                         {
-00104                                 if (i->channel)
-00105                                 {
-00106                                         if (!strcasecmp(i->channel,channel))
-00107                                         {
-00108                                                 invites.erase(i);
-00109                                                 return;
-00110                                         }
-00111                                 }
-00112                         }
-00113                 }
-00114         }
-00115 }
+Definition at line 96 of file users.cpp.
+

+References DEBUG, and invites. +

+

00097 {
+00098         log(DEBUG,"Removing invites");
+00099         if (channel)
+00100         {
+00101                 if (invites.size())
+00102                 {
+00103                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00104                         {
+00105                                 if (i->channel)
+00106                                 {
+00107                                         if (!strcasecmp(i->channel,channel))
+00108                                         {
+00109                                                 invites.erase(i);
+00110                                                 return;
+00111                                         }
+00112                                 }
+00113                         }
+00114                 }
+00115         }
+00116 }
+
+ + +

+ + + + +
+ + + + + + + + + + +
void userrec::SetWriteError std::string  error  ) 
+
+ + + +
+   + + +

+Sets the write error for a connection. +

+This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged. +

+Definition at line 264 of file users.cpp. +

+References DEBUG, and WriteError. +

+Referenced by AddBuffer(), AddWriteBuf(), and FlushWriteBuf(). +

+

00265 {
+00266         log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str());
+00267         // don't try to set the error twice, its already set take the first string.
+00268         if (this->WriteError == "")
+00269                 this->WriteError = error;
+00270 }
 
@@ -742,7 +963,7 @@ 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. +Definition at line 151 of file users.h.

Referenced by userrec(). @@ -768,9 +989,9 @@ Referenced by userrec().

-Definition at line 132 of file users.h. +Definition at line 142 of file users.h.

-Referenced by Server::PseudoToUser(), and userrec(). +Referenced by Server::PseudoToUser(), and userrec().

@@ -796,9 +1017,9 @@ The host displayed to non-opers (used for cloaking etc).

This usually matches the value of userrec::host.

-Definition at line 120 of file users.h. +Definition at line 130 of file users.h.

-Referenced by GetFullHost(), and userrec(). +Referenced by GetFullHost(), and userrec().

@@ -824,7 +1045,7 @@ True when DNS lookups are completed.

-Definition at line 169 of file users.h. +Definition at line 179 of file users.h.

Referenced by userrec(). @@ -852,7 +1073,7 @@ Number of lines the user can place into the buffer (up to the global NetBufferSi

-Definition at line 152 of file users.h. +Definition at line 162 of file users.h.

Referenced by userrec(). @@ -880,7 +1101,7 @@ The users full name.

-Definition at line 124 of file users.h. +Definition at line 134 of file users.h.

Referenced by userrec(). @@ -908,9 +1129,9 @@ The users ident reply.

-Definition at line 115 of file users.h. +Definition at line 125 of file users.h.

-Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo(). +Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo().

@@ -936,18 +1157,18 @@ A list of channels the user has a pending invite to.

-Definition at line 104 of file users.h. +Definition at line 114 of file users.h.

-Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). +Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). -

+

@@ -964,7 +1185,7 @@ Flood counters.

-Definition at line 189 of file users.h. +Definition at line 204 of file users.h.

Referenced by userrec(). @@ -992,7 +1213,7 @@ 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. +Definition at line 140 of file users.h.

Referenced by userrec(). @@ -1020,9 +1241,9 @@ The users nickname.

An invalid nickname indicates an unregistered connection prior to the NICK command.

-Definition at line 111 of file users.h. +Definition at line 121 of file users.h.

-Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec(). +Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec().

-
long userrec::lines_in + long userrec::lines_in

@@ -1048,7 +1269,7 @@ 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. +Definition at line 175 of file users.h.

Referenced by userrec(). @@ -1076,7 +1297,7 @@ 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. +Definition at line 189 of file users.h.

@@ -1102,7 +1323,7 @@ Number of seconds between PINGs for this user (set from <connect:allow> ta

-Definition at line 173 of file users.h. +Definition at line 183 of file users.h.

@@ -1128,18 +1349,18 @@ 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. +Definition at line 195 of file users.h.

-Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec(). +Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec(). -

+

@@ -1152,9 +1373,37 @@ Referenced by AddBuffer() + +
-
time_t userrec::reset_due + long userrec::recvqmax

+Maximum size this user's recvq can become. +

-Definition at line 190 of file users.h. +Definition at line 218 of file users.h. +

+Referenced by AddBuffer().

+

+ + + + +
+ + +
time_t userrec::reset_due +
+
+ + + + @@ -1182,9 +1431,65 @@ 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. +Definition at line 156 of file users.h.

-Referenced by GetFullHost(), GetFullRealHost(), and userrec(). +Referenced by GetFullHost(), GetFullRealHost(), and userrec(). + +

+   + + +

+ +

+Definition at line 205 of file users.h.

Referenced by userrec().

+

+ + + + +
+ + +
std::string userrec::sendq +
+
+ + + + + +
+   + + +

+User's send queue. +

+Lines waiting to be sent are stored here until their buffer is flushed. +

+Definition at line 200 of file users.h. +

+Referenced by AddWriteBuf(), FlushWriteBuf(), and userrec().

+

+ + + + +
+ + +
long userrec::sendqmax +
+
+ + + +
+   + + +

+Maximum size this user's sendq can become. +

+ +

+Definition at line 214 of file users.h. +

+Referenced by AddWriteBuf().

@@ -1210,18 +1515,18 @@ The server the user is connected to.

-Definition at line 136 of file users.h. +Definition at line 146 of file users.h.

Referenced by userrec(). -

+

@@ -1236,7 +1541,7 @@ Referenced by userrec().

-Definition at line 191 of file users.h. +Definition at line 206 of file users.h.

-
long userrec::threshold + long userrec::threshold

@@ -1262,14 +1567,40 @@ Number of seconds this user is given to send USER/NICK If they do not send their

-Definition at line 158 of file users.h. +Definition at line 168 of file users.h.

Referenced by userrec(). +

+ + + + +
+ + +
std::string userrec::WriteError +
+
+ + + + + +
+   + + +

+ +

+Definition at line 210 of file users.h. +

+Referenced by GetWriteError(), and SetWriteError().


The documentation for this class was generated from the following files: -
Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/commands_8h-source.html b/docs/module-doc/commands_8h-source.html index ed4e6e32b..bd2afa087 100644 --- a/docs/module-doc/commands_8h-source.html +++ b/docs/module-doc/commands_8h-source.html @@ -87,7 +87,7 @@ 00082 void handle_loadmodule(char **parameters, int pcnt, userrec *user); 00083 void handle_unloadmodule(char **parameters, int pcnt, userrec *user); 00084 -00087 void handle_link_packet(char* udp_msg, char* tcp_host, serverrec *serv); +00087 void handle_link_packet(char* tcp_msg, char* tcp_host, serverrec *serv); 00088 void process_restricted_commands(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host,char* ipaddr,int port); 00089 00092 void handle_amp(char token,char* params,serverrec* source,serverrec* reply, char* tcp_host); @@ -118,7 +118,7 @@ 00121 long duration(const char* str); 00122 00123 #endif -

Generated on Sat May 7 15:34:20 2005 for InspIRCd by +

Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/commands_8h.html b/docs/module-doc/commands_8h.html index 2ff8ab777..d7be65235 100644 --- a/docs/module-doc/commands_8h.html +++ b/docs/module-doc/commands_8h.html @@ -119,7 +119,7 @@ void handle_unloadmodule (char **parameters, int pcnt, userrec *user) -void handle_link_packet (char *udp_msg, char *tcp_host, serverrec *serv) +void handle_link_packet (char *tcp_msg, char *tcp_host, serverrec *serv)  Special functions for processing server to server traffic.

void process_restricted_commands (char token, char *params, serverrec *source, serverrec *reply, char *tcp_host, char *ipaddr, int port) @@ -207,7 +207,7 @@ Other useful functions.

-Referenced by Server::AddELine(), Server::AddGLine(), Server::AddKLine(), Server::AddQLine(), Server::AddZLine(), and Server::CalcDuration(). +Referenced by Server::AddELine(), Server::AddGLine(), Server::AddKLine(), Server::AddQLine(), Server::AddZLine(), and Server::CalcDuration().

@@ -1411,7 +1411,7 @@ These are the handlers for user commands. void handle_link_packet (  char *  - udp_msg, + tcp_msg, @@ -3722,7 +3722,7 @@ Functions for u:lined servers.

-Referenced by Server::IsUlined(). +Referenced by Server::IsUlined().

@@ -3793,7 +3793,7 @@ Referenced by Server::IsUli -


Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
Generated on Thu May 12 02:25:15 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/connection_8h-source.html b/docs/module-doc/connection_8h-source.html index 279b3b5b7..79c043389 100644 --- a/docs/module-doc/connection_8h-source.html +++ b/docs/module-doc/connection_8h-source.html @@ -180,7 +180,7 @@ 00333 00334 00335 #endif -

Generated on Sat May 7 15:34:20 2005 for InspIRCd by +

Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/connection_8h.html b/docs/module-doc/connection_8h.html index d14420fd2..c8689a50c 100644 --- a/docs/module-doc/connection_8h.html +++ b/docs/module-doc/connection_8h.html @@ -189,7 +189,7 @@ Definition at line 40 Definition at line 37 of file connection.h. -
Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
Generated on Thu May 12 02:25:15 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/ctables_8h-source.html b/docs/module-doc/ctables_8h-source.html index 9f7d60625..b526d691c 100644 --- a/docs/module-doc/ctables_8h-source.html +++ b/docs/module-doc/ctables_8h-source.html @@ -42,7 +42,7 @@ 00051 00052 #endif 00053 -

Generated on Sat May 7 15:34:20 2005 for InspIRCd by +

Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/ctables_8h.html b/docs/module-doc/ctables_8h.html index 054d18eda..92975a456 100644 --- a/docs/module-doc/ctables_8h.html +++ b/docs/module-doc/ctables_8h.html @@ -17,7 +17,7 @@  A structure that defines a command. More...

-
Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
Generated on Thu May 12 02:25:15 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/dns_8h-source.html b/docs/module-doc/dns_8h-source.html index 642c2c910..820de511b 100644 --- a/docs/module-doc/dns_8h-source.html +++ b/docs/module-doc/dns_8h-source.html @@ -70,7 +70,7 @@ 00093 }; 00094 00095 #endif -

Generated on Sat May 7 15:34:20 2005 for InspIRCd by +

Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/dns_8h.html b/docs/module-doc/dns_8h.html index e9b108443..5ce0d54b4 100644 --- a/docs/module-doc/dns_8h.html +++ b/docs/module-doc/dns_8h.html @@ -20,7 +20,7 @@ struct  dns_ip4list -
Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
Generated on Thu May 12 02:25:15 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/files.html b/docs/module-doc/files.html index f2ecaae05..67668e45d 100644 --- a/docs/module-doc/files.html +++ b/docs/module-doc/files.html @@ -23,7 +23,7 @@ users.h [code] xline.h [code] -
Generated on Sat May 7 15:34:19 2005 for InspIRCd by +
Generated on Thu May 12 02:25:10 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/functions.html b/docs/module-doc/functions.html index d35e6dc2f..f22b189e8 100644 --- a/docs/module-doc/functions.html +++ b/docs/module-doc/functions.html @@ -6,7 +6,7 @@ -
a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | ~
+
a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | w | ~

@@ -24,7 +24,8 @@ Here is a list of all class members with links to the classes they belong to:

Server
  • AddQLine() : Server
  • addr : ircd_connector
  • AddUser() -: chanrec
  • AddZLine() +: chanrec
  • AddWriteBuf() +: userrec
  • AddZLine() : Server
  • Admin() : Admin
  • age : classbase
  • awaymsg @@ -129,7 +130,8 @@ Here is a list of all class members with links to the classes they belong to:

    Server
  • Flags : Version
  • flags_needed : command_t
  • flood -: userrec, ConnectClass
  • ForwardLookup() +: userrec, ConnectClass
  • FlushWriteBuf() +: userrec
  • ForwardLookup() : DNS
  • fullname : userrec

    - g - @@ -159,7 +161,8 @@ Here is a list of all class members with links to the classes they belong to:

    chanrec
  • GetUsers() : Server, chanrec
  • GetVersion() : Module
  • GetVersionString() -: ircd_connector +: ircd_connector
  • GetWriteError() +: userrec

    - h -

    @@ -242,9 +245,9 @@ Here is a list of all class members with links to the classes they belong to:

    Admin
  • name : serverrec, chanrec
  • needsoper : ExtMode
  • next -: dns_ip4list
  • nick -: QLine, userrec
  • Nick -: Admin
  • nickserv +: dns_ip4list
  • Nick +: Admin
  • nick +: QLine, userrec
  • nickserv : serverrec
  • noexternal : chanrec
  • nping : connection @@ -333,12 +336,13 @@ Here is a list of all class members with links to the classes they belong to:

    ConfigReader
  • reason : XLine
  • RecvPacket() : connection
  • recvq -: userrec
  • registered +: userrec
  • recvqmax +: userrec, ConnectClass
  • registered : connection
  • registration_timeout : ConnectClass
  • RemoveInvite() : userrec
  • Request() : Request
  • reset_due -: userrec
  • result +: userrec
  • result : userrec, DNS
  • ReverseLookup() : DNS
  • Revision : Version
  • routes @@ -354,7 +358,9 @@ Here is a list of all class members with links to the classes they belong to:

    Server
  • SendMode() : Server
  • SendOpers() : Server
  • SendPacket() -: connection
  • SendServ() +: connection
  • sendq +: userrec
  • sendqmax +: userrec, ConnectClass
  • SendServ() : Server
  • SendTo() : Server
  • SendToModeMask() : Server
  • SendWallops() @@ -376,7 +382,8 @@ Here is a list of all class members with links to the classes they belong to:

    ircd_connector
  • SetServerPort() : ircd_connector
  • SetState() : ircd_connector
  • SetVersionString() -: ircd_connector
  • Shrink() +: ircd_connector
  • SetWriteError() +: userrec
  • Shrink() : Extensible
  • signon : connection
  • source : XLine, Event, Request, command_t
  • state @@ -387,7 +394,7 @@ Here is a list of all class members with links to the classes they belong to:

    t : DNS
  • TerminateLink() : connection
  • threshold -: userrec, ConnectClass
  • timeout +: userrec, ConnectClass
  • timeout : userrec
  • topic : chanrec
  • topiclock : chanrec
  • topicset @@ -408,9 +415,13 @@ Here is a list of all class members with links to the classes they belong to:

    - v -

    +: ConfigReader
  • version +: serverrec, ircd_connector
  • Version() +: Version +

    - w - +

    - ~ -

    • ~chanrec() @@ -426,7 +437,7 @@ Here is a list of all class members with links to the classes they belong to:

      serverrec
    • ~ucrec() : ucrec
    • ~userrec() : userrec
    -
    Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:17 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/functions_func.html b/docs/module-doc/functions_func.html index 48c9b3079..4fbcb8a2d 100644 --- a/docs/module-doc/functions_func.html +++ b/docs/module-doc/functions_func.html @@ -23,7 +23,8 @@ : connection
  • AddKLine() : Server
  • AddQLine() : Server
  • AddUser() -: chanrec
  • AddZLine() +: chanrec
  • AddWriteBuf() +: userrec
  • AddZLine() : Server
  • Admin() : Admin

    - b - @@ -96,7 +97,8 @@ : Server
  • FindHost() : connection
  • FindModule() : Server
  • FindNick() -: Server
  • ForwardLookup() +: Server
  • FlushWriteBuf() +: userrec
  • ForwardLookup() : DNS

    - g -

    +: ircd_connector
  • GetWriteError() +: userrec

    - h -

    - t -

    -
    Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:17 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/functions_vars.html b/docs/module-doc/functions_vars.html index 26917e64b..14a8d9bb8 100644 --- a/docs/module-doc/functions_vars.html +++ b/docs/module-doc/functions_vars.html @@ -6,7 +6,7 @@ -
    a | b | c | d | e | f | h | i | j | k | l | m | n | o | p | r | s | t | u | v
    +
    a | b | c | d | e | f | h | i | j | k | l | m | n | o | p | r | s | t | u | v | w

    @@ -100,7 +100,7 @@

  • lastping : connection
  • limit : chanrec
  • lines_in -: userrec
  • list +: userrec
  • list : ExtMode

    - m -

    @@ -146,17 +146,20 @@
  • readerror : ConfigReader
  • reason : XLine
  • recvq -: userrec
  • registered +: userrec
  • recvqmax +: userrec, ConnectClass
  • registered : connection
  • registration_timeout : ConnectClass
  • reset_due -: userrec
  • result +: userrec
  • result : userrec, DNS
  • Revision : Version
  • routes : ircd_connector

    - s -

  • -
    Generated on Sat May 7 15:34:23 2005 for InspIRCd by +

    - w - +

    +
    Generated on Thu May 12 02:25:18 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/globals.html b/docs/module-doc/globals.html index e748fa3eb..78dbd626c 100644 --- a/docs/module-doc/globals.html +++ b/docs/module-doc/globals.html @@ -275,7 +275,8 @@ Here is a list of all file members with links to the files they belong to:

    message.h
  • server_mode() : modules.h, mode.h
  • ServerDesc : modules.cpp, channels.cpp
  • ServerName -: modules.cpp, channels.cpp
  • SPARSE +: modules.cpp, channels.cpp
  • SERVERportCount +: modules.cpp, channels.cpp
  • SPARSE : modules.h
  • startup_time : modules.cpp, channels.cpp
  • STATE_CONNECTED : connection.h
  • STATE_DISCONNECTED @@ -312,8 +313,7 @@ Here is a list of all file members with links to the files they belong to:

    channels.h
  • UCMODE_OP : channels.h
  • UCMODE_PROTECT : channels.h
  • UCMODE_VOICE -: channels.h
  • UDPportCount -: modules.cpp, channels.cpp
  • user_hash +: channels.h
  • user_hash : modules.cpp

    - v -

    -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/globals_defs.html b/docs/module-doc/globals_defs.html index b673ec510..ccc0c303c 100644 --- a/docs/module-doc/globals_defs.html +++ b/docs/module-doc/globals_defs.html @@ -92,7 +92,7 @@ : modules.h
  • VF_STATIC : modules.h
  • VF_VENDOR : modules.h -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:30 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/globals_func.html b/docs/module-doc/globals_func.html index 1cb50d3ce..6051a5a49 100644 --- a/docs/module-doc/globals_func.html +++ b/docs/module-doc/globals_func.html @@ -211,7 +211,7 @@
  • zline_make_global() : xline.h
  • zline_set_creation_time() : xline.h -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/globals_type.html b/docs/module-doc/globals_type.html index 2ac9ad07d..5cdbf4b78 100644 --- a/docs/module-doc/globals_type.html +++ b/docs/module-doc/globals_type.html @@ -26,7 +26,7 @@ : modules.h
  • user_hash : modules.cpp
  • VoidPointer : base.h -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:30 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/globals_vars.html b/docs/module-doc/globals_vars.html index 36c958b8d..b674bccfc 100644 --- a/docs/module-doc/globals_vars.html +++ b/docs/module-doc/globals_vars.html @@ -6,7 +6,7 @@ -
    a | b | c | d | e | f | i | l | m | n | p | r | s | t | u | w
    +
    a | b | c | d | e | f | i | l | m | n | p | r | s | t | w

    @@ -90,23 +90,20 @@

  • - t -

    -

    - u - -

    - w -

    -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/hierarchy.html b/docs/module-doc/hierarchy.html index 87900e9c9..898e7dea5 100644 --- a/docs/module-doc/hierarchy.html +++ b/docs/module-doc/hierarchy.html @@ -58,7 +58,7 @@
  • nspace::hash< string >
  • StrHashComp -
    Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:17 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/main.html b/docs/module-doc/main.html index 8d7a4d765..cb9903ab4 100644 --- a/docs/module-doc/main.html +++ b/docs/module-doc/main.html @@ -7,7 +7,7 @@

    InspIRCd Documentation

    -


    Generated on Sat May 7 15:34:19 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:10 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/message_8h-source.html b/docs/module-doc/message_8h-source.html index fac1f8833..86c8778ba 100644 --- a/docs/module-doc/message_8h-source.html +++ b/docs/module-doc/message_8h-source.html @@ -57,7 +57,7 @@ 00050 void send_network_quit(const char* nick, const char* reason); 00051 00052 #endif -

  • Generated on Sat May 7 15:34:20 2005 for InspIRCd by +

    Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/message_8h.html b/docs/module-doc/message_8h.html index f33caee98..aa5d628cb 100644 --- a/docs/module-doc/message_8h.html +++ b/docs/module-doc/message_8h.html @@ -155,7 +155,7 @@

    -Referenced by Server::ChangeHost(). +Referenced by Server::ChangeHost().

    @@ -195,7 +195,7 @@ Referenced by Server::Chang

    -Referenced by Server::ChangeGECOS(). +Referenced by Server::ChangeGECOS().

    @@ -340,7 +340,7 @@ Referenced by Server::Chang

    -Referenced by Server::ChanMode(). +Referenced by Server::ChanMode().

    @@ -380,7 +380,7 @@ Referenced by Server::ChanM

    -Referenced by Server::CommonChannels(). +Referenced by Server::CommonChannels().

    @@ -458,7 +458,7 @@ Referenced by Server::Commo

    -Referenced by Server::IsOnChannel(). +Referenced by Server::IsOnChannel().

    @@ -556,7 +556,7 @@ Referenced by Server::IsOnC

    -Referenced by Server::IsNick(). +Referenced by Server::IsNick().

    @@ -742,7 +742,7 @@ Referenced by Server::IsNic -


    Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:15 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/mode_8h-source.html b/docs/module-doc/mode_8h-source.html index b77c7e141..8662cbecc 100644 --- a/docs/module-doc/mode_8h-source.html +++ b/docs/module-doc/mode_8h-source.html @@ -53,7 +53,7 @@ 00046 00047 00048 #endif -

    Generated on Sat May 7 15:34:20 2005 for InspIRCd by +

    Generated on Thu May 12 02:25:11 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/mode_8h.html b/docs/module-doc/mode_8h.html index 86ae533fa..ba2beca0f 100644 --- a/docs/module-doc/mode_8h.html +++ b/docs/module-doc/mode_8h.html @@ -788,7 +788,7 @@ -
    Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:15 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/modules_8cpp-source.html b/docs/module-doc/modules_8cpp-source.html index 79165ee67..9807b4f97 100644 --- a/docs/module-doc/modules_8cpp-source.html +++ b/docs/module-doc/modules_8cpp-source.html @@ -30,1032 +30,1050 @@ 00023 #include <sys/errno.h> 00024 #include <sys/ioctl.h> 00025 #include <sys/utsname.h> -00026 #include <cstdio> -00027 #include <time.h> -00028 #include <string> -00029 #ifdef GCC3 -00030 #include <ext/hash_map> -00031 #else -00032 #include <hash_map> -00033 #endif -00034 #include <map> -00035 #include <sstream> -00036 #include <vector> -00037 #include <errno.h> -00038 #include <deque> -00039 #include <errno.h> -00040 #include <unistd.h> -00041 #include <sched.h> -00042 #include "connection.h" -00043 #include "users.h" -00044 #include "servers.h" -00045 #include "ctables.h" -00046 #include "globals.h" -00047 #include "modules.h" -00048 #include "dynamic.h" -00049 #include "wildcard.h" -00050 #include "message.h" -00051 #include "mode.h" -00052 #include "xline.h" -00053 #include "commands.h" -00054 #include "inspstring.h" -00055 -00056 #ifdef GCC3 -00057 #define nspace __gnu_cxx -00058 #else -00059 #define nspace std -00060 #endif -00061 -00062 using namespace std; -00063 -00064 extern int MODCOUNT; -00065 extern std::vector<Module*> modules; -00066 extern std::vector<ircd_module*> factory; -00067 -00068 extern time_t TIME; -00069 -00070 extern int LogLevel; -00071 extern char ServerName[MAXBUF]; -00072 extern char Network[MAXBUF]; -00073 extern char ServerDesc[MAXBUF]; -00074 extern char AdminName[MAXBUF]; -00075 extern char AdminEmail[MAXBUF]; -00076 extern char AdminNick[MAXBUF]; -00077 extern char diepass[MAXBUF]; -00078 extern char restartpass[MAXBUF]; -00079 extern char motd[MAXBUF]; -00080 extern char rules[MAXBUF]; -00081 extern char list[MAXBUF]; -00082 extern char PrefixQuit[MAXBUF]; -00083 extern char DieValue[MAXBUF]; -00084 -00085 extern int debugging; -00086 extern int WHOWAS_STALE; -00087 extern int WHOWAS_MAX; -00088 extern int DieDelay; -00089 extern time_t startup_time; -00090 extern int NetBufferSize; -00091 extern int MaxWhoResults; -00092 extern time_t nb_start; +00026 #ifdef USE_KQUEUE +00027 #include <sys/types.h> +00028 #include <sys/event.h> +00029 #include <sys/time.h> +00030 #endif +00031 #include <cstdio> +00032 #include <time.h> +00033 #include <string> +00034 #ifdef GCC3 +00035 #include <ext/hash_map> +00036 #else +00037 #include <hash_map> +00038 #endif +00039 #include <map> +00040 #include <sstream> +00041 #include <vector> +00042 #include <errno.h> +00043 #include <deque> +00044 #include <errno.h> +00045 #include <unistd.h> +00046 #include <sched.h> +00047 #include "connection.h" +00048 #include "users.h" +00049 #include "servers.h" +00050 #include "ctables.h" +00051 #include "globals.h" +00052 #include "modules.h" +00053 #include "dynamic.h" +00054 #include "wildcard.h" +00055 #include "message.h" +00056 #include "mode.h" +00057 #include "xline.h" +00058 #include "commands.h" +00059 #include "inspstring.h" +00060 +00061 #ifdef GCC3 +00062 #define nspace __gnu_cxx +00063 #else +00064 #define nspace std +00065 #endif +00066 +00067 using namespace std; +00068 +00069 #ifdef USE_KQUEUE +00070 extern int kq; +00071 #endif +00072 +00073 extern int MODCOUNT; +00074 extern std::vector<Module*> modules; +00075 extern std::vector<ircd_module*> factory; +00076 +00077 extern time_t TIME; +00078 +00079 extern int LogLevel; +00080 extern char ServerName[MAXBUF]; +00081 extern char Network[MAXBUF]; +00082 extern char ServerDesc[MAXBUF]; +00083 extern char AdminName[MAXBUF]; +00084 extern char AdminEmail[MAXBUF]; +00085 extern char AdminNick[MAXBUF]; +00086 extern char diepass[MAXBUF]; +00087 extern char restartpass[MAXBUF]; +00088 extern char motd[MAXBUF]; +00089 extern char rules[MAXBUF]; +00090 extern char list[MAXBUF]; +00091 extern char PrefixQuit[MAXBUF]; +00092 extern char DieValue[MAXBUF]; 00093 -00094 extern std::vector<int> fd_reap; -00095 extern std::vector<std::string> module_names; -00096 -00097 extern int boundPortCount; -00098 extern int portCount; -00099 extern int UDPportCount; -00100 extern int ports[MAXSOCKS]; -00101 extern int defaultRoute; +00094 extern int debugging; +00095 extern int WHOWAS_STALE; +00096 extern int WHOWAS_MAX; +00097 extern int DieDelay; +00098 extern time_t startup_time; +00099 extern int NetBufferSize; +00100 extern int MaxWhoResults; +00101 extern time_t nb_start; 00102 -00103 extern std::vector<long> auth_cookies; -00104 extern std::stringstream config_f; +00103 extern std::vector<int> fd_reap; +00104 extern std::vector<std::string> module_names; 00105 -00106 extern serverrec* me[32]; -00107 -00108 extern FILE *log_file; -00109 -00110 extern userrec* fd_ref_table[65536]; +00106 extern int boundPortCount; +00107 extern int portCount; +00108 extern int SERVERportCount; +00109 extern int ports[MAXSOCKS]; +00110 extern int defaultRoute; 00111 -00112 namespace nspace -00113 { -00114 #ifdef GCC34 -00115 template<> struct hash<in_addr> -00116 #else -00117 template<> struct nspace::hash<in_addr> -00118 #endif -00119 { -00120 size_t operator()(const struct in_addr &a) const -00121 { -00122 size_t q; -00123 memcpy(&q,&a,sizeof(size_t)); -00124 return q; -00125 } -00126 }; -00127 #ifdef GCC34 -00128 template<> struct hash<string> -00129 #else -00130 template<> struct nspace::hash<string> -00131 #endif -00132 { -00133 size_t operator()(const string &s) const -00134 { -00135 char a[MAXBUF]; -00136 static struct hash<const char *> strhash; -00137 strlcpy(a,s.c_str(),MAXBUF); -00138 strlower(a); -00139 return strhash(a); -00140 } -00141 }; -00142 } -00143 -00144 struct StrHashComp -00145 { -00146 -00147 bool operator()(const string& s1, const string& s2) const -00148 { -00149 char a[MAXBUF],b[MAXBUF]; -00150 strlcpy(a,s1.c_str(),MAXBUF); -00151 strlcpy(b,s2.c_str(),MAXBUF); -00152 strlower(a); -00153 strlower(b); -00154 return (strcasecmp(a,b) == 0); -00155 } -00156 -00157 }; -00158 -00159 struct InAddr_HashComp -00160 { -00161 -00162 bool operator()(const in_addr &s1, const in_addr &s2) const -00163 { -00164 size_t q; -00165 size_t p; -00166 -00167 memcpy(&q,&s1,sizeof(size_t)); -00168 memcpy(&p,&s2,sizeof(size_t)); -00169 -00170 return (q == p); -00171 } -00172 -00173 }; -00174 -00175 -00176 typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, StrHashComp> user_hash; -00177 typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, StrHashComp> chan_hash; -00178 typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, InAddr_HashComp> address_cache; -00179 typedef std::deque<command_t> command_table; -00180 +00112 extern std::vector<long> auth_cookies; +00113 extern std::stringstream config_f; +00114 +00115 extern serverrec* me[32]; +00116 +00117 extern FILE *log_file; +00118 +00119 extern userrec* fd_ref_table[65536]; +00120 +00121 namespace nspace +00122 { +00123 #ifdef GCC34 +00124 template<> struct hash<in_addr> +00125 #else +00126 template<> struct nspace::hash<in_addr> +00127 #endif +00128 { +00129 size_t operator()(const struct in_addr &a) const +00130 { +00131 size_t q; +00132 memcpy(&q,&a,sizeof(size_t)); +00133 return q; +00134 } +00135 }; +00136 #ifdef GCC34 +00137 template<> struct hash<string> +00138 #else +00139 template<> struct nspace::hash<string> +00140 #endif +00141 { +00142 size_t operator()(const string &s) const +00143 { +00144 char a[MAXBUF]; +00145 static struct hash<const char *> strhash; +00146 strlcpy(a,s.c_str(),MAXBUF); +00147 strlower(a); +00148 return strhash(a); +00149 } +00150 }; +00151 } +00152 +00153 struct StrHashComp +00154 { +00155 +00156 bool operator()(const string& s1, const string& s2) const +00157 { +00158 char a[MAXBUF],b[MAXBUF]; +00159 strlcpy(a,s1.c_str(),MAXBUF); +00160 strlcpy(b,s2.c_str(),MAXBUF); +00161 strlower(a); +00162 strlower(b); +00163 return (strcasecmp(a,b) == 0); +00164 } +00165 +00166 }; +00167 +00168 struct InAddr_HashComp +00169 { +00170 +00171 bool operator()(const in_addr &s1, const in_addr &s2) const +00172 { +00173 size_t q; +00174 size_t p; +00175 +00176 memcpy(&q,&s1,sizeof(size_t)); +00177 memcpy(&p,&s2,sizeof(size_t)); +00178 +00179 return (q == p); +00180 } 00181 -00182 extern user_hash clientlist; -00183 extern chan_hash chanlist; -00184 extern user_hash whowas; -00185 extern command_table cmdlist; -00186 extern file_cache MOTD; -00187 extern file_cache RULES; -00188 extern address_cache IP; +00182 }; +00183 +00184 +00185 typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, StrHashComp> user_hash; +00186 typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, StrHashComp> chan_hash; +00187 typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, InAddr_HashComp> address_cache; +00188 typedef std::deque<command_t> command_table; 00189 00190 -00191 // class type for holding an extended mode character - internal to core -00192 -00193 class ExtMode : public classbase -00194 { -00195 public: -00196 char modechar; -00197 int type; -00198 int params_when_on; -00199 int params_when_off; -00200 bool needsoper; -00201 bool list; -00202 ExtMode(char mc, int ty, bool oper, int p_on, int p_off) : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; -00203 }; -00204 -00205 typedef std::vector<ExtMode> ExtModeList; -00206 typedef ExtModeList::iterator ExtModeListIter; -00207 -00208 -00209 ExtModeList EMode; -00210 -00211 // returns true if an extended mode character is in use -00212 bool ModeDefined(char modechar, int type) -00213 { -00214 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -00215 { -00216 if ((i->modechar == modechar) && (i->type == type)) -00217 { -00218 return true; -00219 } -00220 } -00221 return false; -00222 } -00223 -00224 bool ModeIsListMode(char modechar, int type) -00225 { -00226 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -00227 { -00228 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) -00229 { -00230 return true; -00231 } -00232 } -00233 return false; -00234 } -00235 -00236 bool ModeDefinedOper(char modechar, int type) -00237 { -00238 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -00239 { -00240 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) -00241 { -00242 return true; -00243 } -00244 } -00245 return false; -00246 } -00247 -00248 // returns number of parameters for a custom mode when it is switched on -00249 int ModeDefinedOn(char modechar, int type) -00250 { -00251 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -00252 { -00253 if ((i->modechar == modechar) && (i->type == type)) -00254 { -00255 return i->params_when_on; -00256 } -00257 } -00258 return 0; -00259 } -00260 -00261 // returns number of parameters for a custom mode when it is switched on -00262 int ModeDefinedOff(char modechar, int type) -00263 { -00264 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -00265 { -00266 if ((i->modechar == modechar) && (i->type == type)) -00267 { -00268 return i->params_when_off; -00269 } -00270 } -00271 return 0; -00272 } -00273 -00274 // returns true if an extended mode character is in use -00275 bool DoAddExtendedMode(char modechar, int type, bool requires_oper, int params_on, int params_off) -00276 { -00277 if (ModeDefined(modechar,type)) { -00278 return false; +00191 extern user_hash clientlist; +00192 extern chan_hash chanlist; +00193 extern user_hash whowas; +00194 extern command_table cmdlist; +00195 extern file_cache MOTD; +00196 extern file_cache RULES; +00197 extern address_cache IP; +00198 +00199 +00200 // class type for holding an extended mode character - internal to core +00201 +00202 class ExtMode : public classbase +00203 { +00204 public: +00205 char modechar; +00206 int type; +00207 int params_when_on; +00208 int params_when_off; +00209 bool needsoper; +00210 bool list; +00211 ExtMode(char mc, int ty, bool oper, int p_on, int p_off) : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +00212 }; +00213 +00214 typedef std::vector<ExtMode> ExtModeList; +00215 typedef ExtModeList::iterator ExtModeListIter; +00216 +00217 +00218 ExtModeList EMode; +00219 +00220 // returns true if an extended mode character is in use +00221 bool ModeDefined(char modechar, int type) +00222 { +00223 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +00224 { +00225 if ((i->modechar == modechar) && (i->type == type)) +00226 { +00227 return true; +00228 } +00229 } +00230 return false; +00231 } +00232 +00233 bool ModeIsListMode(char modechar, int type) +00234 { +00235 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +00236 { +00237 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +00238 { +00239 return true; +00240 } +00241 } +00242 return false; +00243 } +00244 +00245 bool ModeDefinedOper(char modechar, int type) +00246 { +00247 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +00248 { +00249 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +00250 { +00251 return true; +00252 } +00253 } +00254 return false; +00255 } +00256 +00257 // returns number of parameters for a custom mode when it is switched on +00258 int ModeDefinedOn(char modechar, int type) +00259 { +00260 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +00261 { +00262 if ((i->modechar == modechar) && (i->type == type)) +00263 { +00264 return i->params_when_on; +00265 } +00266 } +00267 return 0; +00268 } +00269 +00270 // returns number of parameters for a custom mode when it is switched on +00271 int ModeDefinedOff(char modechar, int type) +00272 { +00273 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +00274 { +00275 if ((i->modechar == modechar) && (i->type == type)) +00276 { +00277 return i->params_when_off; +00278 } 00279 } -00280 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -00281 return true; -00282 } -00283 -00284 // turns a mode into a listmode -00285 void ModeMakeList(char modechar) -00286 { -00287 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -00288 { -00289 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -00290 { -00291 i->list = true; -00292 return; -00293 } -00294 } -00295 return; -00296 } -00297 -00298 // version is a simple class for holding a modules version number -00299 -00300 Version::Version(int major, int minor, int revision, int build, int flags) : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; -00301 -00302 // admin is a simple class for holding a server's administrative info -00303 -00304 Admin::Admin(std::string name, std::string email, std::string nick) : Name(name), Email(email), Nick(nick) { }; -00305 -00306 Request::Request(char* anydata, Module* src, Module* dst) : data(anydata), source(src), dest(dst) { }; -00307 -00308 char* Request::GetData() -00309 { -00310 return this->data; -00311 } +00280 return 0; +00281 } +00282 +00283 // returns true if an extended mode character is in use +00284 bool DoAddExtendedMode(char modechar, int type, bool requires_oper, int params_on, int params_off) +00285 { +00286 if (ModeDefined(modechar,type)) { +00287 return false; +00288 } +00289 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +00290 return true; +00291 } +00292 +00293 // turns a mode into a listmode +00294 void ModeMakeList(char modechar) +00295 { +00296 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +00297 { +00298 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +00299 { +00300 i->list = true; +00301 return; +00302 } +00303 } +00304 return; +00305 } +00306 +00307 // version is a simple class for holding a modules version number +00308 +00309 Version::Version(int major, int minor, int revision, int build, int flags) : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; +00310 +00311 // admin is a simple class for holding a server's administrative info 00312 -00313 Module* Request::GetSource() -00314 { -00315 return this->source; -00316 } -00317 -00318 Module* Request::GetDest() -00319 { -00320 return this->dest; -00321 } -00322 -00323 char* Request::Send() -00324 { -00325 if (this->dest) -00326 { -00327 return dest->OnRequest(this); -00328 } -00329 else -00330 { -00331 return NULL; -00332 } -00333 } -00334 -00335 Event::Event(char* anydata, Module* src, std::string eventid) : data(anydata), source(src), id(eventid) { }; -00336 -00337 char* Event::GetData() -00338 { -00339 return this->data; -00340 } -00341 -00342 Module* Event::GetSource() -00343 { -00344 return this->source; -00345 } -00346 -00347 char* Event::Send() -00348 { -00349 FOREACH_MOD OnEvent(this); -00350 return NULL; -00351 } -00352 -00353 std::string Event::GetEventID() -00354 { -00355 return this->id; -00356 } -00357 -00358 -00359 // These declarations define the behavours of the base class Module (which does nothing at all) -00360 Module::Module() { } -00361 Module::~Module() { } -00362 void Module::OnUserConnect(userrec* user) { } -00363 void Module::OnUserQuit(userrec* user) { } -00364 void Module::OnUserDisconnect(userrec* user) { } -00365 void Module::OnUserJoin(userrec* user, chanrec* channel) { } -00366 void Module::OnUserPart(userrec* user, chanrec* channel) { } -00367 void Module::OnPacketTransmit(std::string &data, std::string serv) { } -00368 void Module::OnPacketReceive(std::string &data, std::string serv) { } -00369 void Module::OnRehash() { } -00370 void Module::OnServerRaw(std::string &raw, bool inbound, userrec* user) { } -00371 int Module::OnUserPreJoin(userrec* user, chanrec* chan, const char* cname) { return 0; } -00372 int Module::OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params) { return false; } -00373 Version Module::GetVersion() { return Version(1,0,0,0,VF_VENDOR); } -00374 void Module::OnOper(userrec* user) { }; -00375 void Module::OnInfo(userrec* user) { }; -00376 void Module::OnWhois(userrec* source, userrec* dest) { }; -00377 int Module::OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel) { return 0; }; -00378 int Module::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text) { return 0; }; -00379 int Module::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text) { return 0; }; -00380 int Module::OnUserPreNick(userrec* user, std::string newnick) { return 0; }; -00381 void Module::OnUserPostNick(userrec* user, std::string oldnick) { }; -00382 int Module::OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type) { return ACR_DEFAULT; }; -00383 string_list Module::OnUserSync(userrec* user) { string_list empty; return empty; } -00384 string_list Module::OnChannelSync(chanrec* chan) { string_list empty; return empty; } -00385 void Module::On005Numeric(std::string &output) { }; -00386 int Module::OnKill(userrec* source, userrec* dest, std::string reason) { return 0; }; -00387 void Module::OnLoadModule(Module* mod,std::string name) { }; -00388 void Module::OnBackgroundTimer(time_t curtime) { }; -00389 void Module::OnSendList(userrec* user, chanrec* channel, char mode) { }; -00390 int Module::OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user) { return 0; }; -00391 bool Module::OnCheckReady(userrec* user) { return true; }; -00392 void Module::OnUserRegister(userrec* user) { }; -00393 int Module::OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason) { return 0; }; -00394 void Module::OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason) { }; -00395 int Module::OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt) { return 0; }; -00396 int Module::OnCheckInvite(userrec* user, chanrec* chan) { return 0; }; -00397 int Module::OnCheckKey(userrec* user, chanrec* chan, std::string keygiven) { return 0; }; -00398 int Module::OnCheckLimit(userrec* user, chanrec* chan) { return 0; }; -00399 int Module::OnCheckBan(userrec* user, chanrec* chan) { return 0; }; -00400 void Module::OnStats(char symbol) { }; -00401 int Module::OnChangeLocalUserHost(userrec* user, std::string newhost) { return 0; }; -00402 int Module::OnChangeLocalUserGECOS(userrec* user, std::string newhost) { return 0; }; -00403 int Module::OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic) { return 0; }; -00404 int Module::OnMeshToken(char token,string_list params,serverrec* source,serverrec* reply, std::string tcp_host,std::string ipaddr,int port) { return 0; }; -00405 void Module::OnEvent(Event* event) { return; }; -00406 char* Module::OnRequest(Request* request) { return NULL; }; -00407 int Module::OnOperCompare(std::string password, std::string input) { return 0; }; -00408 void Module::OnGlobalOper(userrec* user) { }; -00409 void Module::OnGlobalConnect(userrec* user) { }; -00410 int Module::OnAddBan(userrec* source, chanrec* channel,std::string banmask) { return 0; }; -00411 int Module::OnDelBan(userrec* source, chanrec* channel,std::string banmask) { return 0; }; -00412 void Module::OnRawSocketAccept(int fd, std::string ip, int localport) { }; -00413 int Module::OnRawSocketWrite(int fd, char* buffer, int count) { return 0; }; -00414 void Module::OnRawSocketClose(int fd) { }; -00415 int Module::OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult) { return 0; }; -00416 -00417 // server is a wrapper class that provides methods to all of the C-style -00418 // exports in the core -00419 // -00420 -00421 Server::Server() -00422 { -00423 } -00424 -00425 Server::~Server() -00426 { -00427 } -00428 -00429 void Server::SendOpers(std::string s) -00430 { -00431 WriteOpers("%s",s.c_str()); +00313 Admin::Admin(std::string name, std::string email, std::string nick) : Name(name), Email(email), Nick(nick) { }; +00314 +00315 Request::Request(char* anydata, Module* src, Module* dst) : data(anydata), source(src), dest(dst) { }; +00316 +00317 char* Request::GetData() +00318 { +00319 return this->data; +00320 } +00321 +00322 Module* Request::GetSource() +00323 { +00324 return this->source; +00325 } +00326 +00327 Module* Request::GetDest() +00328 { +00329 return this->dest; +00330 } +00331 +00332 char* Request::Send() +00333 { +00334 if (this->dest) +00335 { +00336 return dest->OnRequest(this); +00337 } +00338 else +00339 { +00340 return NULL; +00341 } +00342 } +00343 +00344 Event::Event(char* anydata, Module* src, std::string eventid) : data(anydata), source(src), id(eventid) { }; +00345 +00346 char* Event::GetData() +00347 { +00348 return this->data; +00349 } +00350 +00351 Module* Event::GetSource() +00352 { +00353 return this->source; +00354 } +00355 +00356 char* Event::Send() +00357 { +00358 FOREACH_MOD OnEvent(this); +00359 return NULL; +00360 } +00361 +00362 std::string Event::GetEventID() +00363 { +00364 return this->id; +00365 } +00366 +00367 +00368 // These declarations define the behavours of the base class Module (which does nothing at all) +00369 Module::Module() { } +00370 Module::~Module() { } +00371 void Module::OnUserConnect(userrec* user) { } +00372 void Module::OnUserQuit(userrec* user) { } +00373 void Module::OnUserDisconnect(userrec* user) { } +00374 void Module::OnUserJoin(userrec* user, chanrec* channel) { } +00375 void Module::OnUserPart(userrec* user, chanrec* channel) { } +00376 void Module::OnPacketTransmit(std::string &data, std::string serv) { } +00377 void Module::OnPacketReceive(std::string &data, std::string serv) { } +00378 void Module::OnRehash() { } +00379 void Module::OnServerRaw(std::string &raw, bool inbound, userrec* user) { } +00380 int Module::OnUserPreJoin(userrec* user, chanrec* chan, const char* cname) { return 0; } +00381 int Module::OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params) { return false; } +00382 Version Module::GetVersion() { return Version(1,0,0,0,VF_VENDOR); } +00383 void Module::OnOper(userrec* user) { }; +00384 void Module::OnInfo(userrec* user) { }; +00385 void Module::OnWhois(userrec* source, userrec* dest) { }; +00386 int Module::OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel) { return 0; }; +00387 int Module::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text) { return 0; }; +00388 int Module::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text) { return 0; }; +00389 int Module::OnUserPreNick(userrec* user, std::string newnick) { return 0; }; +00390 void Module::OnUserPostNick(userrec* user, std::string oldnick) { }; +00391 int Module::OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type) { return ACR_DEFAULT; }; +00392 string_list Module::OnUserSync(userrec* user) { string_list empty; return empty; } +00393 string_list Module::OnChannelSync(chanrec* chan) { string_list empty; return empty; } +00394 void Module::On005Numeric(std::string &output) { }; +00395 int Module::OnKill(userrec* source, userrec* dest, std::string reason) { return 0; }; +00396 void Module::OnLoadModule(Module* mod,std::string name) { }; +00397 void Module::OnBackgroundTimer(time_t curtime) { }; +00398 void Module::OnSendList(userrec* user, chanrec* channel, char mode) { }; +00399 int Module::OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user) { return 0; }; +00400 bool Module::OnCheckReady(userrec* user) { return true; }; +00401 void Module::OnUserRegister(userrec* user) { }; +00402 int Module::OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason) { return 0; }; +00403 void Module::OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason) { }; +00404 int Module::OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt) { return 0; }; +00405 int Module::OnCheckInvite(userrec* user, chanrec* chan) { return 0; }; +00406 int Module::OnCheckKey(userrec* user, chanrec* chan, std::string keygiven) { return 0; }; +00407 int Module::OnCheckLimit(userrec* user, chanrec* chan) { return 0; }; +00408 int Module::OnCheckBan(userrec* user, chanrec* chan) { return 0; }; +00409 void Module::OnStats(char symbol) { }; +00410 int Module::OnChangeLocalUserHost(userrec* user, std::string newhost) { return 0; }; +00411 int Module::OnChangeLocalUserGECOS(userrec* user, std::string newhost) { return 0; }; +00412 int Module::OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic) { return 0; }; +00413 int Module::OnMeshToken(char token,string_list params,serverrec* source,serverrec* reply, std::string tcp_host,std::string ipaddr,int port) { return 0; }; +00414 void Module::OnEvent(Event* event) { return; }; +00415 char* Module::OnRequest(Request* request) { return NULL; }; +00416 int Module::OnOperCompare(std::string password, std::string input) { return 0; }; +00417 void Module::OnGlobalOper(userrec* user) { }; +00418 void Module::OnGlobalConnect(userrec* user) { }; +00419 int Module::OnAddBan(userrec* source, chanrec* channel,std::string banmask) { return 0; }; +00420 int Module::OnDelBan(userrec* source, chanrec* channel,std::string banmask) { return 0; }; +00421 void Module::OnRawSocketAccept(int fd, std::string ip, int localport) { }; +00422 int Module::OnRawSocketWrite(int fd, char* buffer, int count) { return 0; }; +00423 void Module::OnRawSocketClose(int fd) { }; +00424 int Module::OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult) { return 0; }; +00425 +00426 // server is a wrapper class that provides methods to all of the C-style +00427 // exports in the core +00428 // +00429 +00430 Server::Server() +00431 { 00432 } 00433 -00434 bool Server::MatchText(std::string sliteral, std::string spattern) +00434 Server::~Server() 00435 { -00436 char literal[MAXBUF],pattern[MAXBUF]; -00437 strlcpy(literal,sliteral.c_str(),MAXBUF); -00438 strlcpy(pattern,spattern.c_str(),MAXBUF); -00439 return match(literal,pattern); -00440 } -00441 -00442 void Server::SendToModeMask(std::string modes, int flags, std::string text) -00443 { -00444 WriteMode(modes.c_str(),flags,"%s",text.c_str()); -00445 } -00446 -00447 chanrec* Server::JoinUserToChannel(userrec* user, std::string cname, std::string key) -00448 { -00449 return add_channel(user,cname.c_str(),key.c_str(),false); -00450 } -00451 -00452 chanrec* Server::PartUserFromChannel(userrec* user, std::string cname, std::string reason) -00453 { -00454 return del_channel(user,cname.c_str(),reason.c_str(),false); -00455 } -00456 -00457 chanuserlist Server::GetUsers(chanrec* chan) -00458 { -00459 chanuserlist userl; -00460 userl.clear(); -00461 std::vector<char*> *list = chan->GetUsers(); -00462 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) -00463 { -00464 char* o = *i; -00465 userl.push_back((userrec*)o); -00466 } -00467 return userl; -00468 } -00469 void Server::ChangeUserNick(userrec* user, std::string nickname) -00470 { -00471 force_nickchange(user,nickname.c_str()); -00472 } -00473 -00474 void Server::QuitUser(userrec* user, std::string reason) -00475 { -00476 kill_link(user,reason.c_str()); +00436 } +00437 +00438 void Server::SendOpers(std::string s) +00439 { +00440 WriteOpers("%s",s.c_str()); +00441 } +00442 +00443 bool Server::MatchText(std::string sliteral, std::string spattern) +00444 { +00445 char literal[MAXBUF],pattern[MAXBUF]; +00446 strlcpy(literal,sliteral.c_str(),MAXBUF); +00447 strlcpy(pattern,spattern.c_str(),MAXBUF); +00448 return match(literal,pattern); +00449 } +00450 +00451 void Server::SendToModeMask(std::string modes, int flags, std::string text) +00452 { +00453 WriteMode(modes.c_str(),flags,"%s",text.c_str()); +00454 } +00455 +00456 chanrec* Server::JoinUserToChannel(userrec* user, std::string cname, std::string key) +00457 { +00458 return add_channel(user,cname.c_str(),key.c_str(),false); +00459 } +00460 +00461 chanrec* Server::PartUserFromChannel(userrec* user, std::string cname, std::string reason) +00462 { +00463 return del_channel(user,cname.c_str(),reason.c_str(),false); +00464 } +00465 +00466 chanuserlist Server::GetUsers(chanrec* chan) +00467 { +00468 chanuserlist userl; +00469 userl.clear(); +00470 std::vector<char*> *list = chan->GetUsers(); +00471 for (std::vector<char*>::iterator i = list->begin(); i != list->end(); i++) +00472 { +00473 char* o = *i; +00474 userl.push_back((userrec*)o); +00475 } +00476 return userl; 00477 } -00478 -00479 bool Server::IsUlined(std::string server) -00480 { -00481 return is_uline(server.c_str()); -00482 } -00483 -00484 void Server::CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user) -00485 { -00486 call_handler(commandname.c_str(),parameters,pcnt,user); -00487 } -00488 -00489 void Server::Log(int level, std::string s) -00490 { -00491 log(level,"%s",s.c_str()); -00492 } -00493 -00494 void Server::AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source) -00495 { -00496 createcommand(cmd,f,flags,minparams,source); -00497 } -00498 -00499 void Server::SendMode(char **parameters, int pcnt, userrec *user) -00500 { -00501 server_mode(parameters,pcnt,user); -00502 } -00503 -00504 void Server::Send(int Socket, std::string s) -00505 { -00506 Write(Socket,"%s",s.c_str()); -00507 } -00508 -00509 void Server::SendServ(int Socket, std::string s) -00510 { -00511 WriteServ(Socket,"%s",s.c_str()); -00512 } -00513 -00514 void Server::SendFrom(int Socket, userrec* User, std::string s) -00515 { -00516 WriteFrom(Socket,User,"%s",s.c_str()); -00517 } -00518 -00519 void Server::SendTo(userrec* Source, userrec* Dest, std::string s) -00520 { -00521 if (!Source) -00522 { -00523 // if source is NULL, then the message originates from the local server -00524 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str()); -00525 } -00526 else -00527 { -00528 // otherwise it comes from the user specified -00529 WriteTo(Source,Dest,"%s",s.c_str()); -00530 } -00531 } -00532 -00533 void Server::SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text) -00534 { -00535 WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str()); -00536 } -00537 -00538 void Server::SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender) -00539 { -00540 if (IncludeSender) -00541 { -00542 WriteChannel(Channel,User,"%s",s.c_str()); -00543 } -00544 else -00545 { -00546 ChanExceptSender(Channel,User,"%s",s.c_str()); -00547 } -00548 } -00549 -00550 bool Server::CommonChannels(userrec* u1, userrec* u2) -00551 { -00552 return (common_channels(u1,u2) != 0); -00553 } -00554 -00555 void Server::SendCommon(userrec* User, std::string text,bool IncludeSender) -00556 { -00557 if (IncludeSender) -00558 { -00559 WriteCommon(User,"%s",text.c_str()); -00560 } -00561 else -00562 { -00563 WriteCommonExcept(User,"%s",text.c_str()); -00564 } -00565 } -00566 -00567 void Server::SendWallops(userrec* User, std::string text) -00568 { -00569 WriteWallOps(User,false,"%s",text.c_str()); -00570 } -00571 -00572 void Server::ChangeHost(userrec* user, std::string host) -00573 { -00574 ChangeDisplayedHost(user,host.c_str()); -00575 } -00576 -00577 void Server::ChangeGECOS(userrec* user, std::string gecos) -00578 { -00579 ChangeName(user,gecos.c_str()); -00580 } -00581 -00582 bool Server::IsNick(std::string nick) -00583 { -00584 return (isnick(nick.c_str()) != 0); -00585 } -00586 -00587 userrec* Server::FindNick(std::string nick) -00588 { -00589 return Find(nick); -00590 } -00591 -00592 userrec* Server::FindDescriptor(int socket) -00593 { -00594 return (socket < 65536 ? fd_ref_table[socket] : NULL); -00595 } -00596 -00597 chanrec* Server::FindChannel(std::string channel) -00598 { -00599 return FindChan(channel.c_str()); -00600 } -00601 -00602 std::string Server::ChanMode(userrec* User, chanrec* Chan) -00603 { -00604 return cmode(User,Chan); -00605 } -00606 -00607 bool Server::IsOnChannel(userrec* User, chanrec* Chan) -00608 { -00609 return has_channel(User,Chan); -00610 } -00611 -00612 std::string Server::GetServerName() -00613 { -00614 return getservername(); -00615 } -00616 -00617 std::string Server::GetNetworkName() -00618 { -00619 return getnetworkname(); -00620 } -00621 -00622 Admin Server::GetAdmin() -00623 { -00624 return Admin(getadminname(),getadminemail(),getadminnick()); -00625 } -00626 -00627 -00628 -00629 bool Server::AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off) -00630 { -00631 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) -00632 { -00633 if (type == MT_SERVER) -00634 { -00635 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"); -00636 return false; -00637 } -00638 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -00639 { -00640 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"); -00641 return false; -00642 } -00643 if ((params_when_on>1) || (params_when_off>1)) -00644 { -00645 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"); -00646 return false; -00647 } -00648 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -00649 } -00650 else -00651 { -00652 log(DEBUG,"*** API ERROR *** Muppet modechar detected."); -00653 } -00654 return false; -00655 } -00656 -00657 bool Server::AddExtendedListMode(char modechar) -00658 { -00659 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -00660 if (res) -00661 ModeMakeList(modechar); -00662 return res; -00663 } -00664 -00665 int Server::CountUsers(chanrec* c) -00666 { -00667 return usercount(c); -00668 } -00669 -00670 -00671 bool Server::UserToPseudo(userrec* user,std::string message) -00672 { -00673 unsigned int old_fd = user->fd; -00674 user->fd = FD_MAGIC_NUMBER; -00675 user->ClearBuffer(); -00676 Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str()); -00677 shutdown(old_fd,2); -00678 close(old_fd); -00679 } -00680 -00681 bool Server::PseudoToUser(userrec* alive,userrec* zombie,std::string message) -00682 { -00683 zombie->fd = alive->fd; -00684 alive->fd = FD_MAGIC_NUMBER; -00685 alive->ClearBuffer(); -00686 Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick); -00687 kill_link(alive,message.c_str()); -00688 fd_ref_table[zombie->fd] = zombie; -00689 for (int i = 0; i != MAXCHANS; i++) -00690 { -00691 if (zombie->chans[i].channel != NULL) -00692 { -00693 if (zombie->chans[i].channel->name) -00694 { -00695 chanrec* Ptr = zombie->chans[i].channel; -00696 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name); -00697 if (Ptr->topicset) -00698 { -00699 WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic); -00700 WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); -00701 } -00702 userlist(zombie,Ptr); -00703 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name); -00704 -00705 } -00706 } -00707 } -00708 -00709 } -00710 -00711 void Server::AddGLine(long duration, std::string source, std::string reason, std::string hostmask) -00712 { -00713 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -00714 } -00715 -00716 void Server::AddQLine(long duration, std::string source, std::string reason, std::string nickname) -00717 { -00718 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -00719 } -00720 -00721 void Server::AddZLine(long duration, std::string source, std::string reason, std::string ipaddr) -00722 { -00723 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -00724 } -00725 -00726 void Server::AddKLine(long duration, std::string source, std::string reason, std::string hostmask) -00727 { -00728 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -00729 } -00730 -00731 void Server::AddELine(long duration, std::string source, std::string reason, std::string hostmask) -00732 { -00733 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -00734 } -00735 -00736 bool Server::DelGLine(std::string hostmask) -00737 { -00738 del_gline(hostmask.c_str()); -00739 } -00740 -00741 bool Server::DelQLine(std::string nickname) -00742 { -00743 del_qline(nickname.c_str()); -00744 } -00745 -00746 bool Server::DelZLine(std::string ipaddr) -00747 { -00748 del_zline(ipaddr.c_str()); -00749 } -00750 -00751 bool Server::DelKLine(std::string hostmask) -00752 { -00753 del_kline(hostmask.c_str()); -00754 } -00755 -00756 bool Server::DelELine(std::string hostmask) -00757 { -00758 del_eline(hostmask.c_str()); -00759 } -00760 -00761 long Server::CalcDuration(std::string delta) -00762 { -00763 return duration(delta.c_str()); -00764 } -00765 -00766 bool Server::IsValidMask(std::string mask) -00767 { -00768 const char* dest = mask.c_str(); -00769 if (strchr(dest,'!')==0) -00770 return false; -00771 if (strchr(dest,'@')==0) -00772 return false; -00773 for (int i = 0; i < strlen(dest); i++) -00774 if (dest[i] < 32) -00775 return false; -00776 for (int i = 0; i < strlen(dest); i++) -00777 if (dest[i] > 126) -00778 return false; -00779 int c = 0; -00780 for (int i = 0; i < strlen(dest); i++) -00781 if (dest[i] == '!') -00782 c++; -00783 if (c>1) -00784 return false; -00785 c = 0; -00786 for (int i = 0; i < strlen(dest); i++) -00787 if (dest[i] == '@') -00788 c++; -00789 if (c>1) +00478 void Server::ChangeUserNick(userrec* user, std::string nickname) +00479 { +00480 force_nickchange(user,nickname.c_str()); +00481 } +00482 +00483 void Server::QuitUser(userrec* user, std::string reason) +00484 { +00485 kill_link(user,reason.c_str()); +00486 } +00487 +00488 bool Server::IsUlined(std::string server) +00489 { +00490 return is_uline(server.c_str()); +00491 } +00492 +00493 void Server::CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user) +00494 { +00495 call_handler(commandname.c_str(),parameters,pcnt,user); +00496 } +00497 +00498 void Server::Log(int level, std::string s) +00499 { +00500 log(level,"%s",s.c_str()); +00501 } +00502 +00503 void Server::AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source) +00504 { +00505 createcommand(cmd,f,flags,minparams,source); +00506 } +00507 +00508 void Server::SendMode(char **parameters, int pcnt, userrec *user) +00509 { +00510 server_mode(parameters,pcnt,user); +00511 } +00512 +00513 void Server::Send(int Socket, std::string s) +00514 { +00515 Write(Socket,"%s",s.c_str()); +00516 } +00517 +00518 void Server::SendServ(int Socket, std::string s) +00519 { +00520 WriteServ(Socket,"%s",s.c_str()); +00521 } +00522 +00523 void Server::SendFrom(int Socket, userrec* User, std::string s) +00524 { +00525 WriteFrom(Socket,User,"%s",s.c_str()); +00526 } +00527 +00528 void Server::SendTo(userrec* Source, userrec* Dest, std::string s) +00529 { +00530 if (!Source) +00531 { +00532 // if source is NULL, then the message originates from the local server +00533 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str()); +00534 } +00535 else +00536 { +00537 // otherwise it comes from the user specified +00538 WriteTo(Source,Dest,"%s",s.c_str()); +00539 } +00540 } +00541 +00542 void Server::SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text) +00543 { +00544 WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str()); +00545 } +00546 +00547 void Server::SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender) +00548 { +00549 if (IncludeSender) +00550 { +00551 WriteChannel(Channel,User,"%s",s.c_str()); +00552 } +00553 else +00554 { +00555 ChanExceptSender(Channel,User,"%s",s.c_str()); +00556 } +00557 } +00558 +00559 bool Server::CommonChannels(userrec* u1, userrec* u2) +00560 { +00561 return (common_channels(u1,u2) != 0); +00562 } +00563 +00564 void Server::SendCommon(userrec* User, std::string text,bool IncludeSender) +00565 { +00566 if (IncludeSender) +00567 { +00568 WriteCommon(User,"%s",text.c_str()); +00569 } +00570 else +00571 { +00572 WriteCommonExcept(User,"%s",text.c_str()); +00573 } +00574 } +00575 +00576 void Server::SendWallops(userrec* User, std::string text) +00577 { +00578 WriteWallOps(User,false,"%s",text.c_str()); +00579 } +00580 +00581 void Server::ChangeHost(userrec* user, std::string host) +00582 { +00583 ChangeDisplayedHost(user,host.c_str()); +00584 } +00585 +00586 void Server::ChangeGECOS(userrec* user, std::string gecos) +00587 { +00588 ChangeName(user,gecos.c_str()); +00589 } +00590 +00591 bool Server::IsNick(std::string nick) +00592 { +00593 return (isnick(nick.c_str()) != 0); +00594 } +00595 +00596 userrec* Server::FindNick(std::string nick) +00597 { +00598 return Find(nick); +00599 } +00600 +00601 userrec* Server::FindDescriptor(int socket) +00602 { +00603 return (socket < 65536 ? fd_ref_table[socket] : NULL); +00604 } +00605 +00606 chanrec* Server::FindChannel(std::string channel) +00607 { +00608 return FindChan(channel.c_str()); +00609 } +00610 +00611 std::string Server::ChanMode(userrec* User, chanrec* Chan) +00612 { +00613 return cmode(User,Chan); +00614 } +00615 +00616 bool Server::IsOnChannel(userrec* User, chanrec* Chan) +00617 { +00618 return has_channel(User,Chan); +00619 } +00620 +00621 std::string Server::GetServerName() +00622 { +00623 return getservername(); +00624 } +00625 +00626 std::string Server::GetNetworkName() +00627 { +00628 return getnetworkname(); +00629 } +00630 +00631 Admin Server::GetAdmin() +00632 { +00633 return Admin(getadminname(),getadminemail(),getadminnick()); +00634 } +00635 +00636 +00637 +00638 bool Server::AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off) +00639 { +00640 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) +00641 { +00642 if (type == MT_SERVER) +00643 { +00644 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"); +00645 return false; +00646 } +00647 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +00648 { +00649 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"); +00650 return false; +00651 } +00652 if ((params_when_on>1) || (params_when_off>1)) +00653 { +00654 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"); +00655 return false; +00656 } +00657 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +00658 } +00659 else +00660 { +00661 log(DEBUG,"*** API ERROR *** Muppet modechar detected."); +00662 } +00663 return false; +00664 } +00665 +00666 bool Server::AddExtendedListMode(char modechar) +00667 { +00668 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +00669 if (res) +00670 ModeMakeList(modechar); +00671 return res; +00672 } +00673 +00674 int Server::CountUsers(chanrec* c) +00675 { +00676 return usercount(c); +00677 } +00678 +00679 +00680 bool Server::UserToPseudo(userrec* user,std::string message) +00681 { +00682 unsigned int old_fd = user->fd; +00683 user->fd = FD_MAGIC_NUMBER; +00684 user->ClearBuffer(); +00685 Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str()); +00686 #ifdef USE_KQUEUE +00687 struct kevent ke; +00688 EV_SET(&ke, old_fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); +00689 int i = kevent(kq, &ke, 1, 0, 0, NULL); +00690 if (i == -1) +00691 { +00692 log(DEBUG,"kqueue: Failed to remove user from queue!"); +00693 } +00694 #endif +00695 shutdown(old_fd,2); +00696 close(old_fd); +00697 } +00698 +00699 bool Server::PseudoToUser(userrec* alive,userrec* zombie,std::string message) +00700 { +00701 zombie->fd = alive->fd; +00702 alive->fd = FD_MAGIC_NUMBER; +00703 alive->ClearBuffer(); +00704 Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick); +00705 kill_link(alive,message.c_str()); +00706 fd_ref_table[zombie->fd] = zombie; +00707 for (int i = 0; i != MAXCHANS; i++) +00708 { +00709 if (zombie->chans[i].channel != NULL) +00710 { +00711 if (zombie->chans[i].channel->name) +00712 { +00713 chanrec* Ptr = zombie->chans[i].channel; +00714 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name); +00715 if (Ptr->topicset) +00716 { +00717 WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic); +00718 WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +00719 } +00720 userlist(zombie,Ptr); +00721 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name); +00722 +00723 } +00724 } +00725 } +00726 +00727 } +00728 +00729 void Server::AddGLine(long duration, std::string source, std::string reason, std::string hostmask) +00730 { +00731 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +00732 } +00733 +00734 void Server::AddQLine(long duration, std::string source, std::string reason, std::string nickname) +00735 { +00736 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +00737 } +00738 +00739 void Server::AddZLine(long duration, std::string source, std::string reason, std::string ipaddr) +00740 { +00741 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +00742 } +00743 +00744 void Server::AddKLine(long duration, std::string source, std::string reason, std::string hostmask) +00745 { +00746 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +00747 } +00748 +00749 void Server::AddELine(long duration, std::string source, std::string reason, std::string hostmask) +00750 { +00751 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +00752 } +00753 +00754 bool Server::DelGLine(std::string hostmask) +00755 { +00756 del_gline(hostmask.c_str()); +00757 } +00758 +00759 bool Server::DelQLine(std::string nickname) +00760 { +00761 del_qline(nickname.c_str()); +00762 } +00763 +00764 bool Server::DelZLine(std::string ipaddr) +00765 { +00766 del_zline(ipaddr.c_str()); +00767 } +00768 +00769 bool Server::DelKLine(std::string hostmask) +00770 { +00771 del_kline(hostmask.c_str()); +00772 } +00773 +00774 bool Server::DelELine(std::string hostmask) +00775 { +00776 del_eline(hostmask.c_str()); +00777 } +00778 +00779 long Server::CalcDuration(std::string delta) +00780 { +00781 return duration(delta.c_str()); +00782 } +00783 +00784 bool Server::IsValidMask(std::string mask) +00785 { +00786 const char* dest = mask.c_str(); +00787 if (strchr(dest,'!')==0) +00788 return false; +00789 if (strchr(dest,'@')==0) 00790 return false; -00791 -00792 return true; -00793 } -00794 -00795 void Server::MeshSendAll(std::string text) -00796 { -00797 NetSendToAll((char*)text.c_str()); -00798 } -00799 -00800 void Server::MeshSendCommon(userrec* user, std::string text) -00801 { -00802 if (user) -00803 NetSendToCommon(user,(char*)text.c_str()); -00804 } -00805 -00806 void Server::MeshSendAllAlive(std::string text) -00807 { -00808 NetSendToAllAlive((char*)text.c_str()); -00809 } -00810 -00811 void Server::MeshSendUnicast(std::string destination, std::string text) -00812 { -00813 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -00814 } -00815 -00816 void Server::MeshSendAllExcept(std::string target, std::string text) -00817 { -00818 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -00819 } -00820 -00821 bool Server::MeshCheckChan(chanrec *c,std::string servername) -00822 { -00823 if (c) -00824 { -00825 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -00826 } -00827 else return false; -00828 } -00829 -00830 bool Server::MeshCheckCommon(userrec* u,std::string servername) -00831 { -00832 if (u) -00833 { -00834 return CommonOnThisServer(u,(char*)servername.c_str()); -00835 } -00836 else return false; +00791 for (int i = 0; i < strlen(dest); i++) +00792 if (dest[i] < 32) +00793 return false; +00794 for (int i = 0; i < strlen(dest); i++) +00795 if (dest[i] > 126) +00796 return false; +00797 int c = 0; +00798 for (int i = 0; i < strlen(dest); i++) +00799 if (dest[i] == '!') +00800 c++; +00801 if (c>1) +00802 return false; +00803 c = 0; +00804 for (int i = 0; i < strlen(dest); i++) +00805 if (dest[i] == '@') +00806 c++; +00807 if (c>1) +00808 return false; +00809 +00810 return true; +00811 } +00812 +00813 void Server::MeshSendAll(std::string text) +00814 { +00815 NetSendToAll((char*)text.c_str()); +00816 } +00817 +00818 void Server::MeshSendCommon(userrec* user, std::string text) +00819 { +00820 if (user) +00821 NetSendToCommon(user,(char*)text.c_str()); +00822 } +00823 +00824 void Server::MeshSendAllAlive(std::string text) +00825 { +00826 NetSendToAllAlive((char*)text.c_str()); +00827 } +00828 +00829 void Server::MeshSendUnicast(std::string destination, std::string text) +00830 { +00831 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +00832 } +00833 +00834 void Server::MeshSendAllExcept(std::string target, std::string text) +00835 { +00836 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); 00837 } 00838 -00839 Module* Server::FindModule(std::string name) +00839 bool Server::MeshCheckChan(chanrec *c,std::string servername) 00840 { -00841 for (int i = 0; i <= MODCOUNT; i++) +00841 if (c) 00842 { -00843 if (module_names[i] == name) -00844 { -00845 return modules[i]; -00846 } -00847 } -00848 return NULL; -00849 } -00850 -00851 ConfigReader::ConfigReader() -00852 { -00853 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -00854 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -00855 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -00856 if (!this->readerror) -00857 this->error = CONF_FILE_NOT_FOUND; -00858 } -00859 -00860 -00861 ConfigReader::~ConfigReader() -00862 { -00863 if (this->cache) -00864 delete this->cache; -00865 if (this->errorlog) -00866 delete this->errorlog; +00843 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +00844 } +00845 else return false; +00846 } +00847 +00848 bool Server::MeshCheckCommon(userrec* u,std::string servername) +00849 { +00850 if (u) +00851 { +00852 return CommonOnThisServer(u,(char*)servername.c_str()); +00853 } +00854 else return false; +00855 } +00856 +00857 Module* Server::FindModule(std::string name) +00858 { +00859 for (int i = 0; i <= MODCOUNT; i++) +00860 { +00861 if (module_names[i] == name) +00862 { +00863 return modules[i]; +00864 } +00865 } +00866 return NULL; 00867 } 00868 -00869 -00870 ConfigReader::ConfigReader(std::string filename) -00871 { -00872 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -00873 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -00874 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -00875 if (!this->readerror) -00876 this->error = CONF_FILE_NOT_FOUND; -00877 }; +00869 ConfigReader::ConfigReader() +00870 { +00871 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +00872 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +00873 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +00874 if (!this->readerror) +00875 this->error = CONF_FILE_NOT_FOUND; +00876 } +00877 00878 -00879 std::string ConfigReader::ReadValue(std::string tag, std::string name, int index) +00879 ConfigReader::~ConfigReader() 00880 { -00881 char val[MAXBUF]; -00882 char t[MAXBUF]; -00883 char n[MAXBUF]; -00884 strlcpy(t,tag.c_str(),MAXBUF); -00885 strlcpy(n,name.c_str(),MAXBUF); -00886 int res = ReadConf(cache,t,n,index,val); -00887 if (!res) -00888 { -00889 this->error = CONF_VALUE_NOT_FOUND; -00890 return ""; -00891 } -00892 return std::string(val); -00893 } -00894 -00895 bool ConfigReader::ReadFlag(std::string tag, std::string name, int index) -00896 { -00897 char val[MAXBUF]; -00898 char t[MAXBUF]; -00899 char n[MAXBUF]; -00900 strlcpy(t,tag.c_str(),MAXBUF); -00901 strlcpy(n,name.c_str(),MAXBUF); -00902 int res = ReadConf(cache,t,n,index,val); -00903 if (!res) -00904 { -00905 this->error = CONF_VALUE_NOT_FOUND; -00906 return false; -00907 } -00908 std::string s = val; -00909 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1")); -00910 } -00911 -00912 long ConfigReader::ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned) -00913 { -00914 char val[MAXBUF]; -00915 char t[MAXBUF]; -00916 char n[MAXBUF]; -00917 strlcpy(t,tag.c_str(),MAXBUF); -00918 strlcpy(n,name.c_str(),MAXBUF); -00919 int res = ReadConf(cache,t,n,index,val); -00920 if (!res) -00921 { -00922 this->error = CONF_VALUE_NOT_FOUND; -00923 return 0; -00924 } -00925 for (int i = 0; i < strlen(val); i++) -00926 { -00927 if (!isdigit(val[i])) -00928 { -00929 this->error = CONF_NOT_A_NUMBER; -00930 return 0; -00931 } -00932 } -00933 if ((needs_unsigned) && (atoi(val)<0)) -00934 { -00935 this->error = CONF_NOT_UNSIGNED; -00936 return 0; -00937 } -00938 return atoi(val); -00939 } -00940 -00941 long ConfigReader::GetError() -00942 { -00943 long olderr = this->error; -00944 this->error = 0; -00945 return olderr; -00946 } -00947 -00948 void ConfigReader::DumpErrors(bool bail, userrec* user) -00949 { -00950 if (bail) -00951 { -00952 printf("There were errors in your configuration:\n%s",errorlog->str().c_str()); -00953 exit(0); -00954 } -00955 else -00956 { -00957 char dataline[1024]; -00958 if (user) -00959 { -00960 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick); -00961 while (!errorlog->eof()) -00962 { -00963 errorlog->getline(dataline,1024); -00964 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline); -00965 } -00966 } -00967 else -00968 { -00969 WriteOpers("There were errors in the configuration file:",user->nick); -00970 while (!errorlog->eof()) -00971 { -00972 errorlog->getline(dataline,1024); -00973 WriteOpers(dataline); -00974 } -00975 } -00976 return; -00977 } -00978 } -00979 -00980 -00981 int ConfigReader::Enumerate(std::string tag) -00982 { -00983 return EnumConf(cache,tag.c_str()); -00984 } -00985 -00986 int ConfigReader::EnumerateValues(std::string tag, int index) -00987 { -00988 return EnumValues(cache, tag.c_str(), index); -00989 } -00990 -00991 bool ConfigReader::Verify() -00992 { -00993 return this->readerror; -00994 } -00995 -00996 -00997 FileReader::FileReader(std::string filename) -00998 { -00999 file_cache c; -01000 readfile(c,filename.c_str()); -01001 this->fc = c; +00881 if (this->cache) +00882 delete this->cache; +00883 if (this->errorlog) +00884 delete this->errorlog; +00885 } +00886 +00887 +00888 ConfigReader::ConfigReader(std::string filename) +00889 { +00890 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +00891 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +00892 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +00893 if (!this->readerror) +00894 this->error = CONF_FILE_NOT_FOUND; +00895 }; +00896 +00897 std::string ConfigReader::ReadValue(std::string tag, std::string name, int index) +00898 { +00899 char val[MAXBUF]; +00900 char t[MAXBUF]; +00901 char n[MAXBUF]; +00902 strlcpy(t,tag.c_str(),MAXBUF); +00903 strlcpy(n,name.c_str(),MAXBUF); +00904 int res = ReadConf(cache,t,n,index,val); +00905 if (!res) +00906 { +00907 this->error = CONF_VALUE_NOT_FOUND; +00908 return ""; +00909 } +00910 return val; +00911 } +00912 +00913 bool ConfigReader::ReadFlag(std::string tag, std::string name, int index) +00914 { +00915 char val[MAXBUF]; +00916 char t[MAXBUF]; +00917 char n[MAXBUF]; +00918 strlcpy(t,tag.c_str(),MAXBUF); +00919 strlcpy(n,name.c_str(),MAXBUF); +00920 int res = ReadConf(cache,t,n,index,val); +00921 if (!res) +00922 { +00923 this->error = CONF_VALUE_NOT_FOUND; +00924 return false; +00925 } +00926 std::string s = val; +00927 return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1")); +00928 } +00929 +00930 long ConfigReader::ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned) +00931 { +00932 char val[MAXBUF]; +00933 char t[MAXBUF]; +00934 char n[MAXBUF]; +00935 strlcpy(t,tag.c_str(),MAXBUF); +00936 strlcpy(n,name.c_str(),MAXBUF); +00937 int res = ReadConf(cache,t,n,index,val); +00938 if (!res) +00939 { +00940 this->error = CONF_VALUE_NOT_FOUND; +00941 return 0; +00942 } +00943 for (int i = 0; i < strlen(val); i++) +00944 { +00945 if (!isdigit(val[i])) +00946 { +00947 this->error = CONF_NOT_A_NUMBER; +00948 return 0; +00949 } +00950 } +00951 if ((needs_unsigned) && (atoi(val)<0)) +00952 { +00953 this->error = CONF_NOT_UNSIGNED; +00954 return 0; +00955 } +00956 return atoi(val); +00957 } +00958 +00959 long ConfigReader::GetError() +00960 { +00961 long olderr = this->error; +00962 this->error = 0; +00963 return olderr; +00964 } +00965 +00966 void ConfigReader::DumpErrors(bool bail, userrec* user) +00967 { +00968 if (bail) +00969 { +00970 printf("There were errors in your configuration:\n%s",errorlog->str().c_str()); +00971 exit(0); +00972 } +00973 else +00974 { +00975 char dataline[1024]; +00976 if (user) +00977 { +00978 WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick); +00979 while (!errorlog->eof()) +00980 { +00981 errorlog->getline(dataline,1024); +00982 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline); +00983 } +00984 } +00985 else +00986 { +00987 WriteOpers("There were errors in the configuration file:",user->nick); +00988 while (!errorlog->eof()) +00989 { +00990 errorlog->getline(dataline,1024); +00991 WriteOpers(dataline); +00992 } +00993 } +00994 return; +00995 } +00996 } +00997 +00998 +00999 int ConfigReader::Enumerate(std::string tag) +01000 { +01001 return EnumConf(cache,tag.c_str()); 01002 } 01003 -01004 FileReader::FileReader() +01004 int ConfigReader::EnumerateValues(std::string tag, int index) 01005 { -01006 } -01007 -01008 void FileReader::LoadFile(std::string filename) -01009 { -01010 file_cache c; -01011 readfile(c,filename.c_str()); -01012 this->fc = c; -01013 } +01006 return EnumValues(cache, tag.c_str(), index); +01007 } +01008 +01009 bool ConfigReader::Verify() +01010 { +01011 return this->readerror; +01012 } +01013 01014 -01015 -01016 FileReader::~FileReader() -01017 { -01018 } -01019 -01020 bool FileReader::Exists() -01021 { -01022 if (fc.size() == 0) -01023 { -01024 return(false); -01025 } -01026 else -01027 { -01028 return(true); -01029 } -01030 } -01031 -01032 std::string FileReader::GetLine(int x) -01033 { -01034 if ((x<0) || (x>fc.size())) -01035 return ""; -01036 return fc[x]; -01037 } -01038 -01039 int FileReader::FileSize() -01040 { -01041 return fc.size(); -01042 } -01043 -01044 -01045 std::vector<Module*> modules(255); -01046 std::vector<ircd_module*> factory(255); -01047 -01048 int MODCOUNT = -1; +01015 FileReader::FileReader(std::string filename) +01016 { +01017 file_cache c; +01018 readfile(c,filename.c_str()); +01019 this->fc = c; +01020 } +01021 +01022 FileReader::FileReader() +01023 { +01024 } +01025 +01026 void FileReader::LoadFile(std::string filename) +01027 { +01028 file_cache c; +01029 readfile(c,filename.c_str()); +01030 this->fc = c; +01031 } +01032 +01033 +01034 FileReader::~FileReader() +01035 { +01036 } +01037 +01038 bool FileReader::Exists() +01039 { +01040 if (fc.size() == 0) +01041 { +01042 return(false); +01043 } +01044 else +01045 { +01046 return(true); +01047 } +01048 } 01049 -01050 -

    Generated on Sat May 7 15:34:21 2005 for InspIRCd by +01050 std::string FileReader::GetLine(int x) +01051 { +01052 if ((x<0) || (x>fc.size())) +01053 return ""; +01054 return fc[x]; +01055 } +01056 +01057 int FileReader::FileSize() +01058 { +01059 return fc.size(); +01060 } +01061 +01062 +01063 std::vector<Module*> modules(255); +01064 std::vector<ircd_module*> factory(255); +01065 +01066 int MODCOUNT = -1; +01067 +01068 +

    Generated on Thu May 12 02:25:12 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/modules_8cpp.html b/docs/module-doc/modules_8cpp.html index 064629708..973fa385a 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -153,7 +153,7 @@ int portCount -int UDPportCount +int SERVERportCount int ports [MAXSOCKS] @@ -208,7 +208,7 @@

    -Definition at line 59 of file modules.cpp. +Definition at line 64 of file modules.cpp.


    Typedef Documentation

    @@ -233,7 +233,7 @@ Definition at line 59 o

    -Definition at line 178 of file modules.cpp. +Definition at line 187 of file modules.cpp.

    @@ -257,7 +257,7 @@ Definition at line 178

    -Definition at line 177 of file modules.cpp. +Definition at line 186 of file modules.cpp.

    @@ -281,7 +281,7 @@ Definition at line 177

    -Definition at line 179 of file modules.cpp. +Definition at line 188 of file modules.cpp.

    @@ -305,7 +305,7 @@ Definition at line 179

    -Definition at line 205 of file modules.cpp. +Definition at line 214 of file modules.cpp.

    @@ -329,9 +329,9 @@ Definition at line 205

    -Definition at line 206 of file modules.cpp. +Definition at line 215 of file modules.cpp.

    -Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). +Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList().

    @@ -355,7 +355,7 @@ Referenced by ModeDefined()

    -Definition at line 176 of file modules.cpp. +Definition at line 185 of file modules.cpp.


    Function Documentation

    @@ -414,19 +414,19 @@ Definition at line 176

    -Definition at line 275 of file modules.cpp. +Definition at line 284 of file modules.cpp.

    -References EMode, and ModeDefined(). +References EMode, and ModeDefined().

    -Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). +Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode().

    -

    00276 {
    -00277         if (ModeDefined(modechar,type)) {
    -00278                 return false;
    -00279         }
    -00280         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
    -00281         return true;
    -00282 }
    +
    00285 {
    +00286         if (ModeDefined(modechar,type)) {
    +00287                 return false;
    +00288         }
    +00289         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
    +00290         return true;
    +00291 }
     
    @@ -496,22 +496,22 @@ Referenced by Server::AddEx

    -Definition at line 212 of file modules.cpp. +Definition at line 221 of file modules.cpp.

    -References EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

    -Referenced by DoAddExtendedMode(). +Referenced by DoAddExtendedMode().

    -

    00213 {
    -00214         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00215         {
    -00216                 if ((i->modechar == modechar) && (i->type == type))
    -00217                 {
    -00218                         return true;
    -00219                 }
    -00220         }
    -00221         return false;
    -00222 }
    +
    00222 {
    +00223         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    +00224         {
    +00225                 if ((i->modechar == modechar) && (i->type == type))
    +00226                 {
    +00227                         return true;
    +00228                 }
    +00229         }
    +00230         return false;
    +00231 }
     
    @@ -552,20 +552,20 @@ Referenced by DoAddExtended

    -Definition at line 262 of file modules.cpp. +Definition at line 271 of file modules.cpp.

    -References EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

    -

    00263 {
    -00264         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00265         {
    -00266                 if ((i->modechar == modechar) && (i->type == type))
    -00267                 {
    -00268                         return i->params_when_off;
    -00269                 }
    -00270         }
    -00271         return 0;
    -00272 }
    +
    00272 {
    +00273         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    +00274         {
    +00275                 if ((i->modechar == modechar) && (i->type == type))
    +00276                 {
    +00277                         return i->params_when_off;
    +00278                 }
    +00279         }
    +00280         return 0;
    +00281 }
     
    @@ -606,20 +606,20 @@ References EMode, and <

    -Definition at line 249 of file modules.cpp. +Definition at line 258 of file modules.cpp.

    -References EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

    -

    00250 {
    -00251         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00252         {
    -00253                 if ((i->modechar == modechar) && (i->type == type))
    -00254                 {
    -00255                         return i->params_when_on;
    -00256                 }
    -00257         }
    -00258         return 0;
    -00259 }
    +
    00259 {
    +00260         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    +00261         {
    +00262                 if ((i->modechar == modechar) && (i->type == type))
    +00263                 {
    +00264                         return i->params_when_on;
    +00265                 }
    +00266         }
    +00267         return 0;
    +00268 }
     
    @@ -660,20 +660,20 @@ References EMode, and <

    -Definition at line 236 of file modules.cpp. +Definition at line 245 of file modules.cpp.

    -References EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

    -

    00237 {
    -00238         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00239         {
    -00240                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
    -00241                 {
    -00242                         return true;
    -00243                 }
    -00244         }
    -00245         return false;
    -00246 }
    +
    00246 {
    +00247         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    +00248         {
    +00249                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
    +00250                 {
    +00251                         return true;
    +00252                 }
    +00253         }
    +00254         return false;
    +00255 }
     
    @@ -714,20 +714,20 @@ References EMode, and <

    -Definition at line 224 of file modules.cpp. +Definition at line 233 of file modules.cpp.

    -References EMode, and ExtModeListIter. +References EMode, and ExtModeListIter.

    -

    00225 {
    -00226         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00227         {
    -00228                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
    -00229                 {
    -00230                         return true;
    -00231                 }
    -00232         }
    -00233         return false;
    -00234 }
    +
    00234 {
    +00235         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    +00236         {
    +00237                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
    +00238                 {
    +00239                         return true;
    +00240                 }
    +00241         }
    +00242         return false;
    +00243 }
     
    @@ -759,23 +759,23 @@ References EMode, and <

    -Definition at line 285 of file modules.cpp. +Definition at line 294 of file modules.cpp.

    -References EMode, ExtModeListIter, and MT_CHANNEL. +References EMode, ExtModeListIter, and MT_CHANNEL.

    -Referenced by Server::AddExtendedListMode(). +Referenced by Server::AddExtendedListMode().

    -

    00286 {
    -00287         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00288         {
    -00289                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
    -00290                 {
    -00291                         i->list = true;
    -00292                         return;
    -00293                 }
    -00294         }
    -00295         return;
    -00296 }
    +
    00295 {
    +00296         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    +00297         {
    +00298                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
    +00299                 {
    +00300                         i->list = true;
    +00301                         return;
    +00302                 }
    +00303         }
    +00304         return;
    +00305 }
     
    @@ -830,7 +830,7 @@ Referenced by Server::AddEx

    -Definition at line 75 of file modules.cpp. +Definition at line 84 of file modules.cpp.

    @@ -854,7 +854,7 @@ Definition at line 75 o

    -Definition at line 74 of file modules.cpp. +Definition at line 83 of file modules.cpp.

    @@ -878,7 +878,7 @@ Definition at line 74 o

    -Definition at line 76 of file modules.cpp. +Definition at line 85 of file modules.cpp.

    @@ -902,7 +902,7 @@ Definition at line 76 o

    -Definition at line 103 of file modules.cpp. +Definition at line 112 of file modules.cpp.

    @@ -926,7 +926,7 @@ Definition at line 103

    -Definition at line 97 of file modules.cpp. +Definition at line 106 of file modules.cpp.

    @@ -950,7 +950,7 @@ Definition at line 97 o

    -Definition at line 183 of file modules.cpp. +Definition at line 192 of file modules.cpp.

    @@ -974,7 +974,7 @@ Definition at line 183

    -Definition at line 182 of file modules.cpp. +Definition at line 191 of file modules.cpp.

    @@ -998,7 +998,7 @@ Definition at line 182

    -Definition at line 185 of file modules.cpp. +Definition at line 194 of file modules.cpp.

    @@ -1022,7 +1022,7 @@ Definition at line 185

    -Definition at line 104 of file modules.cpp. +Definition at line 113 of file modules.cpp.

    @@ -1046,7 +1046,7 @@ Definition at line 104

    -Definition at line 85 of file modules.cpp. +Definition at line 94 of file modules.cpp.

    @@ -1070,7 +1070,7 @@ Definition at line 85 o

    -Definition at line 101 of file modules.cpp. +Definition at line 110 of file modules.cpp.

    @@ -1094,7 +1094,7 @@ Definition at line 101

    -Definition at line 88 of file modules.cpp. +Definition at line 97 of file modules.cpp.

    @@ -1118,7 +1118,7 @@ Definition at line 88 o

    -Definition at line 77 of file modules.cpp. +Definition at line 86 of file modules.cpp.

    @@ -1142,7 +1142,7 @@ Definition at line 77 o

    -Definition at line 83 of file modules.cpp. +Definition at line 92 of file modules.cpp.

    @@ -1166,9 +1166,9 @@ Definition at line 83 o

    -Definition at line 209 of file modules.cpp. +Definition at line 218 of file modules.cpp.

    -Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). +Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList().

    @@ -1192,7 +1192,7 @@ Referenced by DoAddExtended

    -Definition at line 66 of file modules.cpp. +Definition at line 75 of file modules.cpp.

    @@ -1216,7 +1216,7 @@ Definition at line 66 o

    -Definition at line 94 of file modules.cpp. +Definition at line 103 of file modules.cpp.

    @@ -1240,9 +1240,9 @@ Definition at line 94 o

    -Definition at line 110 of file modules.cpp. +Definition at line 119 of file modules.cpp.

    -Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). +Referenced by Server::FindDescriptor(), and Server::PseudoToUser().

    @@ -1266,7 +1266,7 @@ Referenced by Server::FindD

    -Definition at line 188 of file modules.cpp. +Definition at line 197 of file modules.cpp.

    @@ -1290,7 +1290,7 @@ Definition at line 188

    -Definition at line 81 of file modules.cpp. +Definition at line 90 of file modules.cpp.

    @@ -1314,7 +1314,7 @@ Definition at line 81 o

    -Definition at line 108 of file modules.cpp. +Definition at line 117 of file modules.cpp.

    @@ -1338,7 +1338,7 @@ Definition at line 108

    -Definition at line 70 of file modules.cpp. +Definition at line 79 of file modules.cpp.

    @@ -1362,7 +1362,7 @@ Definition at line 70 o

    -Definition at line 91 of file modules.cpp. +Definition at line 100 of file modules.cpp.

    @@ -1386,7 +1386,7 @@ Definition at line 91 o

    -Definition at line 106 of file modules.cpp. +Definition at line 115 of file modules.cpp.

    @@ -1410,7 +1410,7 @@ Definition at line 106

    -Definition at line 1048 of file modules.cpp. +Definition at line 1066 of file modules.cpp.

    @@ -1434,7 +1434,7 @@ Definition at line 1048

    -Definition at line 95 of file modules.cpp. +Definition at line 104 of file modules.cpp.

    @@ -1458,7 +1458,7 @@ Definition at line 95 o

    -Definition at line 65 of file modules.cpp. +Definition at line 74 of file modules.cpp.

    @@ -1482,7 +1482,7 @@ Definition at line 65 o

    -Definition at line 186 of file modules.cpp. +Definition at line 195 of file modules.cpp.

    @@ -1506,7 +1506,7 @@ Definition at line 186

    -Definition at line 79 of file modules.cpp. +Definition at line 88 of file modules.cpp.

    @@ -1530,7 +1530,7 @@ Definition at line 79 o

    -Definition at line 92 of file modules.cpp. +Definition at line 101 of file modules.cpp.

    @@ -1554,7 +1554,7 @@ Definition at line 92 o

    -Definition at line 90 of file modules.cpp. +Definition at line 99 of file modules.cpp.

    @@ -1578,7 +1578,7 @@ Definition at line 90 o

    -Definition at line 72 of file modules.cpp. +Definition at line 81 of file modules.cpp.

    @@ -1602,7 +1602,7 @@ Definition at line 72 o

    -Definition at line 98 of file modules.cpp. +Definition at line 107 of file modules.cpp.

    @@ -1626,7 +1626,7 @@ Definition at line 98 o

    -Definition at line 100 of file modules.cpp. +Definition at line 109 of file modules.cpp.

    @@ -1650,7 +1650,7 @@ Definition at line 100

    -Definition at line 82 of file modules.cpp. +Definition at line 91 of file modules.cpp.

    @@ -1674,7 +1674,7 @@ Definition at line 82 o

    -Definition at line 78 of file modules.cpp. +Definition at line 87 of file modules.cpp.

    @@ -1698,7 +1698,7 @@ Definition at line 78 o

    -Definition at line 187 of file modules.cpp. +Definition at line 196 of file modules.cpp.

    @@ -1722,7 +1722,7 @@ Definition at line 187

    -Definition at line 80 of file modules.cpp. +Definition at line 89 of file modules.cpp.

    @@ -1746,7 +1746,7 @@ Definition at line 80 o

    -Definition at line 73 of file modules.cpp. +Definition at line 82 of file modules.cpp.

    @@ -1770,16 +1770,16 @@ Definition at line 73 o

    -Definition at line 71 of file modules.cpp. +Definition at line 80 of file modules.cpp. -

    +

    @@ -1794,16 +1794,16 @@ Definition at line 71 o

    -Definition at line 89 of file modules.cpp. +Definition at line 108 of file modules.cpp.

    -
    time_t startup_time + int SERVERportCount
    -

    +

    @@ -1818,16 +1818,16 @@ Definition at line 89 o

    -Definition at line 68 of file modules.cpp. +Definition at line 98 of file modules.cpp.

    -
    time_t TIME + time_t startup_time
    -

    +

    @@ -1842,7 +1842,7 @@ Definition at line 68 o

    -Definition at line 99 of file modules.cpp. +Definition at line 77 of file modules.cpp.

    -
    int UDPportCount + time_t TIME

    @@ -1866,7 +1866,7 @@ Definition at line 99 o

    -Definition at line 184 of file modules.cpp. +Definition at line 193 of file modules.cpp.

    @@ -1890,7 +1890,7 @@ Definition at line 184

    -Definition at line 87 of file modules.cpp. +Definition at line 96 of file modules.cpp.

    @@ -1914,10 +1914,10 @@ Definition at line 87 o

    -Definition at line 86 of file modules.cpp. +Definition at line 95 of file modules.cpp. -


    Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:16 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index d402abc90..f8dd7dff6 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -449,7 +449,7 @@ 01304 typedef DLLFactory<ModuleFactory> ircd_module; 01305 01306 #endif -

    Generated on Sat May 7 15:34:21 2005 for InspIRCd by +

    Generated on Thu May 12 02:25:13 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html index c003807c2..d7e50acde 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -390,7 +390,7 @@ Definition at line 39 of

    Definition at line 37 of file modules.h.

    -Referenced by Module::OnAccessCheck(). +Referenced by Module::OnAccessCheck().

    @@ -440,7 +440,7 @@ Definition at line 38 of

    Definition at line 1138 of file modules.h.

    -Referenced by ConfigReader::ConfigReader(). +Referenced by ConfigReader::ConfigReader().

    @@ -466,7 +466,7 @@ Referenced by ConfigReader:

    Definition at line 1135 of file modules.h.

    -Referenced by ConfigReader::ReadInteger(). +Referenced by ConfigReader::ReadInteger().

    @@ -492,7 +492,7 @@ Referenced by ConfigReader:

    Definition at line 1136 of file modules.h.

    -Referenced by ConfigReader::ReadInteger(). +Referenced by ConfigReader::ReadInteger().

    @@ -518,7 +518,7 @@ Referenced by ConfigReader:

    Definition at line 1137 of file modules.h.

    -Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). +Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().

    @@ -544,7 +544,7 @@ Referenced by ConfigReader:

    Definition at line 23 of file modules.h.

    -Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DecUserCounter(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IncUserCounter(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). +Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), chanrec::SetCustomModeParam(), userrec::SetWriteError(), and Server::UserToPseudo().

    @@ -594,7 +594,7 @@ Definition at line 25 of

    Definition at line 99 of file modules.h.

    -Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). +Referenced by Server::PseudoToUser(), and Server::UserToPseudo().

    @@ -620,7 +620,7 @@ Referenced by Server::Pseud

    Definition at line 79 of file modules.h.

    -Referenced by Event::Send(). +Referenced by Event::Send().

    @@ -684,7 +684,7 @@ Definition at line 87 of

    Definition at line 31 of file modules.h.

    -Referenced by Server::AddExtendedListMode(), and ModeMakeList(). +Referenced by Server::AddExtendedListMode(), and ModeMakeList().

    @@ -710,7 +710,7 @@ Referenced by Server::AddEx

    Definition at line 32 of file modules.h.

    -Referenced by Server::AddExtendedMode(). +Referenced by Server::AddExtendedMode().

    @@ -736,7 +736,7 @@ Referenced by Server::AddEx

    Definition at line 33 of file modules.h.

    -Referenced by Server::AddExtendedMode(). +Referenced by Server::AddExtendedMode().

    @@ -906,7 +906,7 @@ Definition at line 53 of

    Definition at line 54 of file modules.h.

    -Referenced by Module::GetVersion(). +Referenced by Module::GetVersion().


    Typedef Documentation

    @@ -935,7 +935,7 @@ Holds a list of users in a channel.

    Definition at line 72 of file modules.h.

    -Referenced by Server::GetUsers(). +Referenced by Server::GetUsers().

    @@ -963,7 +963,7 @@ Low level definition of a FileReader Definition at line 67 of file modules.h.

    -Referenced by FileReader::FileReader(), and FileReader::LoadFile(). +Referenced by FileReader::FileReader(), and FileReader::LoadFile().

    @@ -1013,7 +1013,7 @@ Definition at line 1304 o

    Definition at line 68 of file modules.h.

    -Referenced by Module::OnChannelSync(), and Module::OnUserSync(). +Referenced by Module::OnChannelSync(), and Module::OnUserSync().


    Function Documentation

    @@ -1072,7 +1072,7 @@ Referenced by Module::OnCha

    -Referenced by Server::AddCommand(). +Referenced by Server::AddCommand().

    @@ -1118,10 +1118,10 @@ Referenced by Server::AddCo

    -Referenced by Server::SendMode(). +Referenced by Server::SendMode(). -


    Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:16 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/namespacenspace.html b/docs/module-doc/namespacenspace.html index 63778c33f..1e560dd80 100644 --- a/docs/module-doc/namespacenspace.html +++ b/docs/module-doc/namespacenspace.html @@ -15,7 +15,7 @@ struct  nspace.hash< string > -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/namespaces.html b/docs/module-doc/namespaces.html index 6cd02ce36..ced11e9ed 100644 --- a/docs/module-doc/namespaces.html +++ b/docs/module-doc/namespaces.html @@ -9,7 +9,7 @@ nspace std -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/namespacestd.html b/docs/module-doc/namespacestd.html index acb02d469..8dac21507 100644 --- a/docs/module-doc/namespacestd.html +++ b/docs/module-doc/namespacestd.html @@ -10,7 +10,7 @@
    -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/servers_8cpp-source.html b/docs/module-doc/servers_8cpp-source.html index e1148cb3d..bbcf5c632 100644 --- a/docs/module-doc/servers_8cpp-source.html +++ b/docs/module-doc/servers_8cpp-source.html @@ -63,7 +63,7 @@ 00056 strlcpy(nickserv,"",NICKMAX); 00057 } 00058 -

    Generated on Sat May 7 15:34:21 2005 for InspIRCd by +

    Generated on Thu May 12 02:25:13 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/servers_8cpp.html b/docs/module-doc/servers_8cpp.html index 39dda596e..776c4f9e8 100644 --- a/docs/module-doc/servers_8cpp.html +++ b/docs/module-doc/servers_8cpp.html @@ -44,7 +44,7 @@ Definition at line 24 of file servers.cpp. -
    Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:16 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/servers_8h-source.html b/docs/module-doc/servers_8h-source.html index b87d6683e..3c443abc6 100644 --- a/docs/module-doc/servers_8h-source.html +++ b/docs/module-doc/servers_8h-source.html @@ -61,7 +61,7 @@ 00082 00083 #endif 00084 -

    Generated on Sat May 7 15:34:21 2005 for InspIRCd by +

    Generated on Thu May 12 02:25:13 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/servers_8h.html b/docs/module-doc/servers_8h.html index 26257df7f..0b760db97 100644 --- a/docs/module-doc/servers_8h.html +++ b/docs/module-doc/servers_8h.html @@ -72,7 +72,7 @@ Definition at line 25 of Definition at line 26 of file servers.h. -
    Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:16 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structInAddr__HashComp-members.html b/docs/module-doc/structInAddr__HashComp-members.html index 9e1ae19c8..951c05837 100644 --- a/docs/module-doc/structInAddr__HashComp-members.html +++ b/docs/module-doc/structInAddr__HashComp-members.html @@ -7,7 +7,7 @@

    InAddr_HashComp Member List

    This is the complete list of members for InAddr_HashComp, including all inherited members. -
    operator()(const in_addr &s1, const in_addr &s2) constInAddr_HashComp [inline]

    Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structInAddr__HashComp.html b/docs/module-doc/structInAddr__HashComp.html index f78624ccb..88b933b91 100644 --- a/docs/module-doc/structInAddr__HashComp.html +++ b/docs/module-doc/structInAddr__HashComp.html @@ -49,23 +49,23 @@

    -Definition at line 162 of file modules.cpp. +Definition at line 171 of file modules.cpp.

    -

    00163         {
    -00164                 size_t q;
    -00165                 size_t p;
    -00166                 
    -00167                 memcpy(&q,&s1,sizeof(size_t));
    -00168                 memcpy(&p,&s2,sizeof(size_t));
    -00169                 
    -00170                 return (q == p);
    -00171         }
    +
    00172         {
    +00173                 size_t q;
    +00174                 size_t p;
    +00175                 
    +00176                 memcpy(&q,&s1,sizeof(size_t));
    +00177                 memcpy(&p,&s2,sizeof(size_t));
    +00178                 
    +00179                 return (q == p);
    +00180         }
     

    The documentation for this struct was generated from the following file: -
    Generated on Sat May 7 15:34:25 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:21 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structStrHashComp-members.html b/docs/module-doc/structStrHashComp-members.html index 26f728635..ab85bd8d7 100644 --- a/docs/module-doc/structStrHashComp-members.html +++ b/docs/module-doc/structStrHashComp-members.html @@ -7,7 +7,7 @@

    StrHashComp Member List

    This is the complete list of members for StrHashComp, including all inherited members. -
    operator()(const string &s1, const string &s2) constStrHashComp [inline]

    Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:28 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structStrHashComp.html b/docs/module-doc/structStrHashComp.html index 591148d1c..fa19cfc59 100644 --- a/docs/module-doc/structStrHashComp.html +++ b/docs/module-doc/structStrHashComp.html @@ -49,22 +49,22 @@

    -Definition at line 147 of file modules.cpp. +Definition at line 156 of file modules.cpp.

    -

    00148         {
    -00149                 char a[MAXBUF],b[MAXBUF];
    -00150                 strlcpy(a,s1.c_str(),MAXBUF);
    -00151                 strlcpy(b,s2.c_str(),MAXBUF);
    -00152                 strlower(a);
    -00153                 strlower(b);
    -00154                 return (strcasecmp(a,b) == 0);
    -00155         }
    +
    00157         {
    +00158                 char a[MAXBUF],b[MAXBUF];
    +00159                 strlcpy(a,s1.c_str(),MAXBUF);
    +00160                 strlcpy(b,s2.c_str(),MAXBUF);
    +00161                 strlower(a);
    +00162                 strlower(b);
    +00163                 return (strcasecmp(a,b) == 0);
    +00164         }
     

    The documentation for this struct was generated from the following file: -
    Generated on Sat May 7 15:34:28 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:28 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structdns__ip4list-members.html b/docs/module-doc/structdns__ip4list-members.html index e69018422..fce7a30d8 100644 --- a/docs/module-doc/structdns__ip4list-members.html +++ b/docs/module-doc/structdns__ip4list-members.html @@ -8,7 +8,7 @@

    dns_ip4list Member List

    This is the complete list of members for dns_ip4list, including all inherited members. -
    ipdns_ip4list
    nextdns_ip4list

    Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structdns__ip4list.html b/docs/module-doc/structdns__ip4list.html index ea0918e1b..9076908a6 100644 --- a/docs/module-doc/structdns__ip4list.html +++ b/docs/module-doc/structdns__ip4list.html @@ -66,7 +66,7 @@ Definition at line 28 of file
    The documentation for this struct was generated from the following file: -
    Generated on Sat May 7 15:34:24 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:20 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html index d34f49605..e85ac6e89 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4-members.html @@ -7,7 +7,7 @@

    nspace::hash< in_addr > Member List

    This is the complete list of members for nspace::hash< in_addr >, including all inherited members. -
    operator()(const struct in_addr &a) constnspace::hash< in_addr > [inline]

    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html index e05ed9105..e23d5d983 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01in__addr_01_4.html @@ -43,19 +43,19 @@

    -Definition at line 120 of file modules.cpp. +Definition at line 129 of file modules.cpp.

    -

    00121                 {
    -00122                         size_t q;
    -00123                         memcpy(&q,&a,sizeof(size_t));
    -00124                         return q;
    -00125                 }
    +
    00130                 {
    +00131                         size_t q;
    +00132                         memcpy(&q,&a,sizeof(size_t));
    +00133                         return q;
    +00134                 }
     

    The documentation for this struct was generated from the following file: -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html index 436af0f51..1a59a61ea 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4-members.html @@ -7,7 +7,7 @@

    nspace::hash< string > Member List

    This is the complete list of members for nspace::hash< string >, including all inherited members. -
    operator()(const string &s) constnspace::hash< string > [inline]

    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html index 1091180ae..a35172501 100644 --- a/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html +++ b/docs/module-doc/structnspace_1_1nspace_1_1hash_3_01string_01_4.html @@ -43,21 +43,21 @@

    -Definition at line 133 of file modules.cpp. +Definition at line 142 of file modules.cpp.

    -

    00134                 {
    -00135                         char a[MAXBUF];
    -00136                         static struct hash<const char *> strhash;
    -00137                         strlcpy(a,s.c_str(),MAXBUF);
    -00138                         strlower(a);
    -00139                         return strhash(a);
    -00140                 }
    +
    00143                 {
    +00144                         char a[MAXBUF];
    +00145                         static struct hash<const char *> strhash;
    +00146                         strlcpy(a,s.c_str(),MAXBUF);
    +00147                         strlower(a);
    +00148                         return strhash(a);
    +00149                 }
     

    The documentation for this struct was generated from the following file: -
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/users_8cpp-source.html b/docs/module-doc/users_8cpp-source.html index 7d30e3413..5a5d09547 100644 --- a/docs/module-doc/users_8cpp-source.html +++ b/docs/module-doc/users_8cpp-source.html @@ -47,184 +47,240 @@ 00040 strcpy(server,""); 00041 strcpy(awaymsg,""); 00042 strcpy(oper,""); -00043 reset_due = TIME; -00044 lines_in = 0; +00043 reset_due = TIME; +00044 lines_in = 0; 00045 fd = lastping = signon = idle_lastmsg = nping = registered = 0; 00046 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; 00047 haspassed = false; 00048 dns_done = false; 00049 recvq = ""; -00050 strcpy(result,""); -00051 for (int i = 0; i < MAXCHANS; i++) -00052 { -00053 this->chans[i].channel = NULL; -00054 this->chans[i].uc_modes = 0; -00055 } -00056 invites.clear(); -00057 } -00058 +00050 sendq = ""; +00051 strcpy(result,""); +00052 for (int i = 0; i < MAXCHANS; i++) +00053 { +00054 this->chans[i].channel = NULL; +00055 this->chans[i].uc_modes = 0; +00056 } +00057 invites.clear(); +00058 } 00059 -00060 -00061 char* userrec::GetFullHost() -00062 { -00063 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost); -00064 return result; -00065 } -00066 +00060 +00061 +00062 char* userrec::GetFullHost() +00063 { +00064 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost); +00065 return result; +00066 } 00067 -00068 char* userrec::GetFullRealHost() -00069 { -00070 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host); -00071 return result; -00072 } -00073 -00074 bool userrec::IsInvited(char* channel) -00075 { -00076 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -00077 { -00078 if (i->channel) { -00079 if (!strcasecmp(i->channel,channel)) -00080 { -00081 return true; -00082 } -00083 } -00084 } -00085 return false; -00086 } -00087 -00088 void userrec::InviteTo(char* channel) -00089 { -00090 Invited i; -00091 strlcpy(i.channel,channel,CHANMAX); -00092 invites.push_back(i); -00093 } -00094 -00095 void userrec::RemoveInvite(char* channel) -00096 { -00097 log(DEBUG,"Removing invites"); -00098 if (channel) -00099 { -00100 if (invites.size()) -00101 { -00102 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -00103 { -00104 if (i->channel) -00105 { -00106 if (!strcasecmp(i->channel,channel)) -00107 { -00108 invites.erase(i); -00109 return; -00110 } -00111 } -00112 } -00113 } -00114 } -00115 } -00116 -00117 bool userrec::HasPermission(char* command) -00118 { -00119 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -00120 char* mycmd; -00121 char* savept; -00122 char* savept2; -00123 -00124 // are they even an oper at all? -00125 if (strchr(this->modes,'o')) -00126 { -00127 log(DEBUG,"*** HasPermission: %s is an oper",this->nick); -00128 for (int j =0; j < ConfValueEnum("type",&config_f); j++) -00129 { -00130 ConfValue("type","name",j,TypeName,&config_f); -00131 if (!strcmp(TypeName,this->oper)) -00132 { -00133 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper); -00134 ConfValue("type","classes",j,Classes,&config_f); -00135 char* myclass = strtok_r(Classes," ",&savept); -00136 while (myclass) -00137 { -00138 log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass); -00139 for (int k =0; k < ConfValueEnum("class",&config_f); k++) -00140 { -00141 ConfValue("class","name",k,ClassName,&config_f); -00142 if (!strcmp(ClassName,myclass)) -00143 { -00144 ConfValue("class","commands",k,CommandList,&config_f); -00145 log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList); -00146 +00068 +00069 char* userrec::GetFullRealHost() +00070 { +00071 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host); +00072 return result; +00073 } +00074 +00075 bool userrec::IsInvited(char* channel) +00076 { +00077 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +00078 { +00079 if (i->channel) { +00080 if (!strcasecmp(i->channel,channel)) +00081 { +00082 return true; +00083 } +00084 } +00085 } +00086 return false; +00087 } +00088 +00089 void userrec::InviteTo(char* channel) +00090 { +00091 Invited i; +00092 strlcpy(i.channel,channel,CHANMAX); +00093 invites.push_back(i); +00094 } +00095 +00096 void userrec::RemoveInvite(char* channel) +00097 { +00098 log(DEBUG,"Removing invites"); +00099 if (channel) +00100 { +00101 if (invites.size()) +00102 { +00103 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +00104 { +00105 if (i->channel) +00106 { +00107 if (!strcasecmp(i->channel,channel)) +00108 { +00109 invites.erase(i); +00110 return; +00111 } +00112 } +00113 } +00114 } +00115 } +00116 } +00117 +00118 bool userrec::HasPermission(char* command) +00119 { +00120 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +00121 char* mycmd; +00122 char* savept; +00123 char* savept2; +00124 +00125 // are they even an oper at all? +00126 if (strchr(this->modes,'o')) +00127 { +00128 log(DEBUG,"*** HasPermission: %s is an oper",this->nick); +00129 for (int j =0; j < ConfValueEnum("type",&config_f); j++) +00130 { +00131 ConfValue("type","name",j,TypeName,&config_f); +00132 if (!strcmp(TypeName,this->oper)) +00133 { +00134 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper); +00135 ConfValue("type","classes",j,Classes,&config_f); +00136 char* myclass = strtok_r(Classes," ",&savept); +00137 while (myclass) +00138 { +00139 log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass); +00140 for (int k =0; k < ConfValueEnum("class",&config_f); k++) +00141 { +00142 ConfValue("class","name",k,ClassName,&config_f); +00143 if (!strcmp(ClassName,myclass)) +00144 { +00145 ConfValue("class","commands",k,CommandList,&config_f); +00146 log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList); 00147 -00148 mycmd = strtok_r(CommandList," ",&savept2); -00149 while (mycmd) -00150 { -00151 if (!strcasecmp(mycmd,command)) -00152 { -00153 log(DEBUG,"*** Command %s found, returning true",command); -00154 return true; -00155 } -00156 mycmd = strtok_r(NULL," ",&savept2); -00157 } -00158 } -00159 } -00160 myclass = strtok_r(NULL," ",&savept); -00161 } -00162 } -00163 } -00164 } -00165 return false; -00166 } -00167 +00148 +00149 mycmd = strtok_r(CommandList," ",&savept2); +00150 while (mycmd) +00151 { +00152 if (!strcasecmp(mycmd,command)) +00153 { +00154 log(DEBUG,"*** Command %s found, returning true",command); +00155 return true; +00156 } +00157 mycmd = strtok_r(NULL," ",&savept2); +00158 } +00159 } +00160 } +00161 myclass = strtok_r(NULL," ",&savept); +00162 } +00163 } +00164 } +00165 } +00166 return false; +00167 } 00168 -00169 bool userrec::AddBuffer(std::string a) -00170 { -00171 std::string b = ""; -00172 for (int i = 0; i < a.length(); i++) -00173 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) -00174 b = b + a[i]; -00175 std::stringstream stream(recvq); -00176 stream << b; -00177 recvq = stream.str(); -00178 int i = 0; -00179 // count the size of the first line in the buffer. -00180 while (i < recvq.length()) -00181 { -00182 if (recvq[i++] == '\n') -00183 break; -00184 } -00185 // return false if we've had more than 600 characters WITHOUT -00186 // a carriage return (this is BAD, drop the socket) -00187 return (i < 600); -00188 } -00189 -00190 bool userrec::BufferIsReady() -00191 { -00192 for (int i = 0; i < recvq.length(); i++) -00193 if (recvq[i] == '\n') -00194 return true; -00195 return false; -00196 } -00197 -00198 void userrec::ClearBuffer() -00199 { -00200 recvq = ""; -00201 } -00202 -00203 std::string userrec::GetBuffer() -00204 { -00205 if (recvq == "") -00206 return ""; -00207 char* line = (char*)recvq.c_str(); -00208 std::string ret = ""; -00209 while ((*line != '\n') && (strlen(line))) -00210 { -00211 ret = ret + *line; -00212 line++; -00213 } -00214 if ((*line == '\n') || (*line == '\r')) -00215 line++; -00216 recvq = line; -00217 return ret; -00218 } -00219 -

    Generated on Sat May 7 15:34:21 2005 for InspIRCd by +00169 +00170 bool userrec::AddBuffer(std::string a) +00171 { +00172 std::string b = ""; +00173 for (int i = 0; i < a.length(); i++) +00174 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) +00175 b = b + a[i]; +00176 std::stringstream stream(recvq); +00177 stream << b; +00178 recvq = stream.str(); +00179 int i = 0; +00180 // count the size of the first line in the buffer. +00181 while (i < recvq.length()) +00182 { +00183 if (recvq[i++] == '\n') +00184 break; +00185 } +00186 if (recvq.length() > this->recvqmax) +00187 { +00188 this->SetWriteError("RecvQ exceeded"); +00189 WriteOpers("*** User %s RecvQ of %d exceeds connect class maximum of %d",this->nick,recvq.length(),this->recvqmax); +00190 } +00191 // return false if we've had more than 600 characters WITHOUT +00192 // a carriage return (this is BAD, drop the socket) +00193 return (i < 600); +00194 } +00195 +00196 bool userrec::BufferIsReady() +00197 { +00198 for (int i = 0; i < recvq.length(); i++) +00199 if (recvq[i] == '\n') +00200 return true; +00201 return false; +00202 } +00203 +00204 void userrec::ClearBuffer() +00205 { +00206 recvq = ""; +00207 } +00208 +00209 std::string userrec::GetBuffer() +00210 { +00211 if (recvq == "") +00212 return ""; +00213 char* line = (char*)recvq.c_str(); +00214 std::string ret = ""; +00215 while ((*line != '\n') && (strlen(line))) +00216 { +00217 ret = ret + *line; +00218 line++; +00219 } +00220 if ((*line == '\n') || (*line == '\r')) +00221 line++; +00222 recvq = line; +00223 return ret; +00224 } +00225 +00226 void userrec::AddWriteBuf(std::string data) +00227 { +00228 if (this->GetWriteError() != "") +00229 return; +00230 if (sendq.length() + data.length() > this->sendqmax) +00231 { +00232 WriteOpers("*** User %s SendQ of %d exceeds connect class maximum of %d",this->nick,sendq.length() + data.length(),this->sendqmax); +00233 this->SetWriteError("SendQ exceeded"); +00234 return; +00235 } +00236 std::stringstream stream; +00237 stream << sendq << data; +00238 sendq = stream.str(); +00239 } +00240 +00241 // send AS MUCH OF THE USERS SENDQ as we are able to (might not be all of it) +00242 void userrec::FlushWriteBuf() +00243 { +00244 if (sendq.length()) +00245 { +00246 char* tb = (char*)this->sendq.c_str(); +00247 int n_sent = write(this->fd,tb,this->sendq.length()); +00248 if (n_sent == -1) +00249 { +00250 this->SetWriteError(strerror(errno)); +00251 } +00252 else +00253 { +00254 // advance the queue +00255 tb += n_sent; +00256 this->sendq = tb; +00257 // update the user's stats counters +00258 this->bytes_out += n_sent; +00259 this->cmds_out++; +00260 } +00261 } +00262 } +00263 +00264 void userrec::SetWriteError(std::string error) +00265 { +00266 log(DEBUG,"Setting error string for %s to '%s'",this->nick,error.c_str()); +00267 // don't try to set the error twice, its already set take the first string. +00268 if (this->WriteError == "") +00269 this->WriteError = error; +00270 } +00271 +00272 std::string userrec::GetWriteError() +00273 { +00274 return this->WriteError; +00275 } +

    Generated on Thu May 12 02:25:13 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/users_8cpp.html b/docs/module-doc/users_8cpp.html index 59a0a5549..8a29677a3 100644 --- a/docs/module-doc/users_8cpp.html +++ b/docs/module-doc/users_8cpp.html @@ -70,7 +70,7 @@ Definition at line 24 of Definition at line 26 of file users.cpp. -
    Generated on Sat May 7 15:34:22 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:16 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html index 1ebbec1e5..8a6aee69e 100644 --- a/docs/module-doc/users_8h-source.html +++ b/docs/module-doc/users_8h-source.html @@ -56,96 +56,120 @@ 00065 char pass[MAXBUF]; 00066 00069 long threshold; -00070 -00071 ConnectClass() -00072 { -00073 registration_timeout = 0; -00074 flood = 0; -00075 pingtime = 0; -00076 threshold = 0; -00077 strlcpy(host,"",MAXBUF); -00078 strlcpy(pass,"",MAXBUF); -00079 } -00080 }; -00081 -00084 typedef std::vector<Invited> InvitedList; -00085 -00086 -00087 -00090 typedef std::vector<ConnectClass> ClassVector; +00070 +00073 long sendqmax; +00074 +00077 long recvqmax; +00078 +00079 ConnectClass() +00080 { +00081 registration_timeout = 0; +00082 flood = 0; +00083 pingtime = 0; +00084 threshold = 0; +00085 sendqmax = 0; +00086 recvqmax = 0; +00087 strlcpy(host,"",MAXBUF); +00088 strlcpy(pass,"",MAXBUF); +00089 } +00090 }; 00091 -00098 class userrec : public connection -00099 { -00100 private: +00094 typedef std::vector<Invited> InvitedList; +00095 +00096 +00097 +00100 typedef std::vector<ConnectClass> ClassVector; 00101 -00104 InvitedList invites; -00105 public: -00106 -00111 char nick[NICKMAX]; -00112 -00115 char ident[64]; -00116 -00120 char dhost[256]; -00121 -00124 char fullname[128]; -00125 -00130 char modes[MAXBUF]; +00108 class userrec : public connection +00109 { +00110 private: +00111 +00114 InvitedList invites; +00115 public: +00116 +00121 char nick[NICKMAX]; +00122 +00125 char ident[64]; +00126 +00130 char dhost[256]; 00131 -00132 ucrec chans[MAXCHANS]; -00133 -00136 char server[256]; -00137 -00141 char awaymsg[512]; -00142 -00146 char result[256]; +00134 char fullname[128]; +00135 +00140 char modes[MAXBUF]; +00141 +00142 ucrec chans[MAXCHANS]; +00143 +00146 char server[256]; 00147 -00152 int flood; -00153 -00158 unsigned long timeout; -00159 -00165 char oper[NICKMAX]; -00166 -00169 bool dns_done; -00170 -00173 unsigned long pingmax; -00174 -00179 char password[MAXBUF]; +00151 char awaymsg[512]; +00152 +00156 char result[256]; +00157 +00162 int flood; +00163 +00168 unsigned long timeout; +00169 +00175 char oper[NICKMAX]; +00176 +00179 bool dns_done; 00180 -00185 std::string recvq; -00186 -00189 long lines_in; -00190 time_t reset_due; -00191 long threshold; -00192 -00193 userrec(); -00194 -00195 virtual ~userrec() { } -00196 -00201 virtual char* GetFullHost(); -00202 -00208 virtual char* GetFullRealHost(); -00209 -00212 virtual bool IsInvited(char* channel); -00213 -00216 virtual void InviteTo(char* channel); -00217 -00222 virtual void RemoveInvite(char* channel); +00183 unsigned long pingmax; +00184 +00189 char password[MAXBUF]; +00190 +00195 std::string recvq; +00196 +00200 std::string sendq; +00201 +00204 long lines_in; +00205 time_t reset_due; +00206 long threshold; +00207 +00208 /* Write error string +00209 */ +00210 std::string WriteError; +00211 +00214 long sendqmax; +00215 +00218 long recvqmax; +00219 +00220 userrec(); +00221 +00222 virtual ~userrec() { } 00223 -00228 bool HasPermission(char* command); -00229 -00237 bool AddBuffer(std::string a); -00238 -00242 bool BufferIsReady(); -00243 -00246 void ClearBuffer(); -00247 -00255 std::string GetBuffer(); -00256 -00257 }; -00258 -00259 -00260 #endif -

    Generated on Sat May 7 15:34:21 2005 for InspIRCd by +00228 virtual char* GetFullHost(); +00229 +00235 virtual char* GetFullRealHost(); +00236 +00239 virtual bool IsInvited(char* channel); +00240 +00243 virtual void InviteTo(char* channel); +00244 +00249 virtual void RemoveInvite(char* channel); +00250 +00255 bool HasPermission(char* command); +00256 +00264 bool AddBuffer(std::string a); +00265 +00269 bool BufferIsReady(); +00270 +00273 void ClearBuffer(); +00274 +00282 std::string GetBuffer(); +00283 +00289 void SetWriteError(std::string error); +00290 +00294 std::string GetWriteError(); +00295 +00301 void AddWriteBuf(std::string data); +00302 +00309 void FlushWriteBuf(); +00310 +00311 }; +00312 +00313 +00314 #endif +

    Generated on Thu May 12 02:25:14 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/users_8h.html b/docs/module-doc/users_8h.html index 3f9bced37..4b542a778 100644 --- a/docs/module-doc/users_8h.html +++ b/docs/module-doc/users_8h.html @@ -214,7 +214,7 @@ Holds a complete list of all allow and deny tags from the configuration file (co

    -Definition at line 90 of file users.h. +Definition at line 100 of file users.h.

    @@ -240,10 +240,10 @@ Holds a complete list of all channels to which a user has been invited and has n

    -Definition at line 84 of file users.h. +Definition at line 94 of file users.h. -


    Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:17 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/xline_8h-source.html b/docs/module-doc/xline_8h-source.html index 0924c5651..33ad97901 100644 --- a/docs/module-doc/xline_8h-source.html +++ b/docs/module-doc/xline_8h-source.html @@ -123,7 +123,7 @@ 00157 void sync_xlines(serverrec* serv, char* tcp_host); 00158 00159 #endif -

    Generated on Sat May 7 15:34:21 2005 for InspIRCd by +

    Generated on Thu May 12 02:25:14 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/xline_8h.html b/docs/module-doc/xline_8h.html index 3347f33b5..bfbbe3225 100644 --- a/docs/module-doc/xline_8h.html +++ b/docs/module-doc/xline_8h.html @@ -145,7 +145,7 @@

    -Referenced by Server::AddELine(). +Referenced by Server::AddELine().

    @@ -197,7 +197,7 @@ Referenced by Server::AddEL

    -Referenced by Server::AddGLine(). +Referenced by Server::AddGLine().

    @@ -249,7 +249,7 @@ Referenced by Server::AddGL

    -Referenced by Server::AddKLine(). +Referenced by Server::AddKLine().

    @@ -301,7 +301,7 @@ Referenced by Server::AddKL

    -Referenced by Server::AddQLine(). +Referenced by Server::AddQLine().

    @@ -353,7 +353,7 @@ Referenced by Server::AddQL

    -Referenced by Server::AddZLine(). +Referenced by Server::AddZLine().

    @@ -412,7 +412,7 @@ Referenced by Server::AddZL

    -Referenced by Server::DelELine(). +Referenced by Server::DelELine().

    @@ -443,7 +443,7 @@ Referenced by Server::DelEL

    -Referenced by Server::DelGLine(). +Referenced by Server::DelGLine().

    @@ -474,7 +474,7 @@ Referenced by Server::DelGL

    -Referenced by Server::DelKLine(). +Referenced by Server::DelKLine().

    @@ -505,7 +505,7 @@ Referenced by Server::DelKL

    -Referenced by Server::DelQLine(). +Referenced by Server::DelQLine().

    @@ -536,7 +536,7 @@ Referenced by Server::DelQL

    -Referenced by Server::DelZLine(). +Referenced by Server::DelZLine().

    @@ -1095,7 +1095,7 @@ Referenced by Server::DelZL -


    Generated on Sat May 7 15:34:23 2005 for InspIRCd by +
    Generated on Thu May 12 02:25:17 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/include/users.h b/include/users.h index 44005bb92..fa7ea0cfb 100644 --- a/include/users.h +++ b/include/users.h @@ -293,7 +293,19 @@ class userrec : public connection */ std::string GetWriteError(); + /** Adds to the user's write buffer. + * You may add any amount of text up to this users sendq value, if you exceed the + * sendq value, SetWriteError() will be called to set the users error string to + * "SendQ exceeded", and further buffer adds will be dropped. + */ void AddWriteBuf(std::string data); + + /** Flushes as much of the user's buffer to the file descriptor as possible. + * This function may not always flush the entire buffer, rather instead as much of it + * as it possibly can. If the send() call fails to send the entire buffer, the buffer + * position is advanced forwards and the rest of the data sent at the next call to + * this method. + */ void FlushWriteBuf(); }; -- cgit v1.2.3