From bc0d192a35489b8f5c42aa381ab2b120957ef770 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 7 May 2005 15:35:21 +0000 Subject: Added final documentation for inspircd Beta 4 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1322 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/man/man3/Admin.3 | 6 +- docs/man/man3/BanItem.3 | 2 +- docs/man/man3/ConfigReader.3 | 274 +-- docs/man/man3/ConnectClass.3 | 30 +- 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 | 84 +- 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 | 268 +-- docs/man/man3/ModuleFactory.3 | 12 +- docs/man/man3/ModuleMessage.3 | 2 +- docs/man/man3/QLine.3 | 2 +- docs/man/man3/Request.3 | 52 +- docs/man/man3/Server.3 | 763 ++++----- 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 | 8 +- docs/man/man3/channels.h.3 | 2 +- docs/man/man3/chanrec.3 | 6 +- docs/man/man3/classbase.3 | 2 +- docs/man/man3/command_t.3 | 2 +- docs/man/man3/commands.h.3 | 2 +- docs/man/man3/connection.3 | 49 +- 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 | 45 +- docs/man/man3/message.h.3 | 11 +- docs/man/man3/mode.h.3 | 2 +- docs/man/man3/modules.cpp.3 | 179 +- docs/man/man3/modules.h.3 | 14 +- 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 | 396 +++-- 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 | 4 +- docs/module-doc/channels_8cpp.html | 18 +- 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 | 320 ++-- docs/module-doc/classConnectClass-members.html | 3 +- docs/module-doc/classConnectClass.html | 62 +- 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 | 96 +- 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 | 8 +- docs/module-doc/classModule.html | 523 ++++-- docs/module-doc/classModuleFactory-members.html | 2 +- docs/module-doc/classModuleFactory.html | 12 +- 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 | 108 +- docs/module-doc/classServer.html | 1188 ++++++++------ 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 | 14 +- 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 | 3 +- docs/module-doc/classconnection.html | 79 +- docs/module-doc/classes.html | 2 +- docs/module-doc/classircd__connector-members.html | 5 +- docs/module-doc/classircd__connector.html | 128 +- docs/module-doc/classserverrec-members.html | 3 +- docs/module-doc/classserverrec.html | 6 +- docs/module-doc/classucrec-members.html | 2 +- docs/module-doc/classucrec.html | 4 +- docs/module-doc/classuserrec-members.html | 11 +- docs/module-doc/classuserrec.html | 613 +++++-- docs/module-doc/commands_8h-source.html | 2 +- docs/module-doc/commands_8h.html | 6 +- docs/module-doc/connection_8h-source.html | 228 +-- 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 | 156 +- docs/module-doc/functions_func.html | 138 +- docs/module-doc/functions_vars.html | 16 +- docs/module-doc/globals.html | 57 +- docs/module-doc/globals_defs.html | 2 +- docs/module-doc/globals_func.html | 26 +- docs/module-doc/globals_type.html | 14 +- docs/module-doc/globals_vars.html | 25 +- docs/module-doc/hierarchy.html | 2 +- docs/module-doc/main.html | 2 +- docs/module-doc/message_8h-source.html | 4 +- docs/module-doc/message_8h.html | 35 +- docs/module-doc/mode_8h-source.html | 2 +- docs/module-doc/mode_8h.html | 2 +- docs/module-doc/modules_8cpp-source.html | 1736 ++++++++++---------- docs/module-doc/modules_8cpp.html | 339 ++-- docs/module-doc/modules_8h-source.html | 343 ++-- docs/module-doc/modules_8h.html | 46 +- 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 | 302 ++-- docs/module-doc/users_8cpp.html | 2 +- docs/module-doc/users_8h-source.html | 157 +- docs/module-doc/users_8h.html | 6 +- docs/module-doc/xline_8h-source.html | 2 +- docs/module-doc/xline_8h.html | 22 +- 183 files changed, 5471 insertions(+), 4178 deletions(-) (limited to 'docs') diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 6e414dc78..55e088419 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -43,10 +43,10 @@ Definition at line 123 of file modules.h. .PP .SS "Admin::Admin (std::string name, std::string email, std::string nick)" .PP -Definition at line 306 of file modules.cpp. +Definition at line 304 of file modules.cpp. .PP .nf -306 : Name(name), Email(email), Nick(nick) { }; +304 : Name(name), Email(email), Nick(nick) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index 5a7e51df0..c1b9d2b62 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 294eec961..303fdf0d9 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -84,239 +84,239 @@ Allows reading of values from configuration files This class allows a module to It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read. .PP -Definition at line 1097 of file modules.h. +Definition at line 1147 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ConfigReader::ConfigReader ()" .PP -Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 835 of file modules.cpp. +Default constructor. This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.Definition at line 851 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -836 { -837 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -838 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -839 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -840 if (!this->readerror) -841 this->error = CONF_FILE_NOT_FOUND; -842 } +852 { +853 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +854 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +855 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +856 if (!this->readerror) +857 this->error = CONF_FILE_NOT_FOUND; +858 } .fi .SS "ConfigReader::ConfigReader (std::string filename)" .PP -Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 854 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 870 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -855 { -856 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -857 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -858 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -859 if (!this->readerror) -860 this->error = CONF_FILE_NOT_FOUND; -861 }; +871 { +872 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +873 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +874 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +875 if (!this->readerror) +876 this->error = CONF_FILE_NOT_FOUND; +877 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 845 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 861 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -846 { -847 if (this->cache) -848 delete this->cache; -849 if (this->errorlog) -850 delete this->errorlog; -851 } +862 { +863 if (this->cache) +864 delete this->cache; +865 if (this->errorlog) +866 delete this->errorlog; +867 } .fi .SH "Member Function Documentation" .PP .SS "void ConfigReader::DumpErrors (bool bail, \fBuserrec\fP * user)" .PP -Dumps the list of errors in a config file to an output location. If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.Definition at line 932 of file modules.cpp. +Dumps the list of errors in a config file to an output location. If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.Definition at line 948 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -933 { -934 if (bail) -935 { -936 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -937 exit(0); -938 } -939 else -940 { -941 char dataline[1024]; -942 if (user) -943 { -944 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -945 while (!errorlog->eof()) -946 { -947 errorlog->getline(dataline,1024); -948 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -949 } -950 } -951 else -952 { -953 WriteOpers('There were errors in the configuration file:',user->nick); -954 while (!errorlog->eof()) -955 { -956 errorlog->getline(dataline,1024); -957 WriteOpers(dataline); -958 } -959 } -960 return; -961 } -962 } +949 { +950 if (bail) +951 { +952 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +953 exit(0); +954 } +955 else +956 { +957 char dataline[1024]; +958 if (user) +959 { +960 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +961 while (!errorlog->eof()) +962 { +963 errorlog->getline(dataline,1024); +964 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +965 } +966 } +967 else +968 { +969 WriteOpers('There were errors in the configuration file:',user->nick); +970 while (!errorlog->eof()) +971 { +972 errorlog->getline(dataline,1024); +973 WriteOpers(dataline); +974 } +975 } +976 return; +977 } +978 } .fi .SS "int ConfigReader::Enumerate (std::string tag)" .PP -Counts the number of times a given tag appears in the config file. This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 965 of file modules.cpp. +Counts the number of times a given tag appears in the config file. This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of \fBConfigReader::ReadValue\fP to loop through all copies of a multiple instance tag.Definition at line 981 of file modules.cpp. .PP References cache. .PP .nf -966 { -967 return EnumConf(cache,tag.c_str()); -968 } +982 { +983 return EnumConf(cache,tag.c_str()); +984 } .fi .SS "int ConfigReader::EnumerateValues (std::string tag, int index)" .PP -Returns the number of items within a tag. For example if the tag was then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 970 of file modules.cpp. +Returns the number of items within a tag. For example if the tag was then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 986 of file modules.cpp. .PP References cache. .PP .nf -971 { -972 return EnumValues(cache, tag.c_str(), index); -973 } +987 { +988 return EnumValues(cache, tag.c_str(), index); +989 } .fi .SS "long ConfigReader::GetError ()" .PP -Returns the last error to occur. Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 925 of file modules.cpp. +Returns the last error to occur. Valid errors can be found by looking in \fBmodules.h\fP. Any nonzero value indicates an error condition. A call to \fBGetError()\fP resets the error flag back to 0.Definition at line 941 of file modules.cpp. .PP References error. .PP .nf -926 { -927 long olderr = this->error; -928 this->error = 0; -929 return olderr; -930 } +942 { +943 long olderr = this->error; +944 this->error = 0; +945 return olderr; +946 } .fi .SS "bool ConfigReader::ReadFlag (std::string tag, std::string name, int index)" .PP -Retrieves a boolean value from the config file. This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.Definition at line 879 of file modules.cpp. +Retrieves a boolean value from the config file. This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values '1', 'yes' and 'true' in the config file count as true to ReadFlag, and any other value counts as false.Definition at line 895 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -880 { -881 char val[MAXBUF]; -882 char t[MAXBUF]; -883 char n[MAXBUF]; -884 strlcpy(t,tag.c_str(),MAXBUF); -885 strlcpy(n,name.c_str(),MAXBUF); -886 int res = ReadConf(cache,t,n,index,val); -887 if (!res) -888 { -889 this->error = CONF_VALUE_NOT_FOUND; -890 return false; -891 } -892 std::string s = val; -893 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -894 } +896 { +897 char val[MAXBUF]; +898 char t[MAXBUF]; +899 char n[MAXBUF]; +900 strlcpy(t,tag.c_str(),MAXBUF); +901 strlcpy(n,name.c_str(),MAXBUF); +902 int res = ReadConf(cache,t,n,index,val); +903 if (!res) +904 { +905 this->error = CONF_VALUE_NOT_FOUND; +906 return false; +907 } +908 std::string s = val; +909 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +910 } .fi .SS "long ConfigReader::ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)" .PP -Retrieves an integer value from the config file. This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 896 of file modules.cpp. +Retrieves an integer value from the config file. This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to \fBGetError()\fP will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and \fBGetError()\fP will return CONF_NOT_UNSIGNEDDefinition at line 912 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -897 { -898 char val[MAXBUF]; -899 char t[MAXBUF]; -900 char n[MAXBUF]; -901 strlcpy(t,tag.c_str(),MAXBUF); -902 strlcpy(n,name.c_str(),MAXBUF); -903 int res = ReadConf(cache,t,n,index,val); -904 if (!res) -905 { -906 this->error = CONF_VALUE_NOT_FOUND; -907 return 0; -908 } -909 for (int i = 0; i < strlen(val); i++) -910 { -911 if (!isdigit(val[i])) -912 { -913 this->error = CONF_NOT_A_NUMBER; -914 return 0; -915 } -916 } -917 if ((needs_unsigned) && (atoi(val)<0)) -918 { -919 this->error = CONF_NOT_UNSIGNED; -920 return 0; -921 } -922 return atoi(val); -923 } +913 { +914 char val[MAXBUF]; +915 char t[MAXBUF]; +916 char n[MAXBUF]; +917 strlcpy(t,tag.c_str(),MAXBUF); +918 strlcpy(n,name.c_str(),MAXBUF); +919 int res = ReadConf(cache,t,n,index,val); +920 if (!res) +921 { +922 this->error = CONF_VALUE_NOT_FOUND; +923 return 0; +924 } +925 for (int i = 0; i < strlen(val); i++) +926 { +927 if (!isdigit(val[i])) +928 { +929 this->error = CONF_NOT_A_NUMBER; +930 return 0; +931 } +932 } +933 if ((needs_unsigned) && (atoi(val)<0)) +934 { +935 this->error = CONF_NOT_UNSIGNED; +936 return 0; +937 } +938 return atoi(val); +939 } .fi .SS "std::string ConfigReader::ReadValue (std::string tag, std::string name, int index)" .PP -Retrieves a value from the config file. This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.Definition at line 863 of file modules.cpp. +Retrieves a value from the config file. This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.Definition at line 879 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -864 { -865 char val[MAXBUF]; -866 char t[MAXBUF]; -867 char n[MAXBUF]; -868 strlcpy(t,tag.c_str(),MAXBUF); -869 strlcpy(n,name.c_str(),MAXBUF); -870 int res = ReadConf(cache,t,n,index,val); -871 if (!res) -872 { -873 this->error = CONF_VALUE_NOT_FOUND; -874 return ''; -875 } -876 return std::string(val); -877 } +880 { +881 char val[MAXBUF]; +882 char t[MAXBUF]; +883 char n[MAXBUF]; +884 strlcpy(t,tag.c_str(),MAXBUF); +885 strlcpy(n,name.c_str(),MAXBUF); +886 int res = ReadConf(cache,t,n,index,val); +887 if (!res) +888 { +889 this->error = CONF_VALUE_NOT_FOUND; +890 return ''; +891 } +892 return std::string(val); +893 } .fi .SS "bool ConfigReader::Verify ()" .PP -Returns true if a config file is valid. This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 975 of file modules.cpp. +Returns true if a config file is valid. This method is partially implemented and will only return false if the config file does not exist or could not be opened.Definition at line 991 of file modules.cpp. .PP References readerror. .PP .nf -976 { -977 return this->readerror; -978 } +992 { +993 return this->readerror; +994 } .fi .SH "Member Data Documentation" .PP .SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP" .PP -The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 1105 of file modules.h. +The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 1155 of file modules.h. .PP Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader(). .SS "long \fBConfigReader::error\fP\fC [protected]\fP" .PP -Definition at line 1110 of file modules.h. +Definition at line 1160 of file modules.h. .PP Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP" .PP -Definition at line 1106 of file modules.h. +Definition at line 1156 of file modules.h. .PP Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader(). .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP" .PP -Used to store errors. Definition at line 1109 of file modules.h. +Used to store errors. Definition at line 1159 of file modules.h. .PP Referenced by ConfigReader(), and Verify(). diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index 563c7368c..0721962c6 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -46,6 +46,10 @@ Inherits \fBclassbase\fP. .RI "char \fBpass\fP [MAXBUF]" .br .RI "\fI(Optional) Password for this line \fP" +.ti -1c +.RI "long \fBthreshold\fP" +.br +.RI "\fIThreshold value for flood disconnect. \fP" .in -1c .SH "Detailed Description" .PP @@ -54,18 +58,19 @@ Holds information relevent to and tags in the con .PP .SS "ConnectClass::ConnectClass ()\fC [inline]\fP" .PP -Definition at line 67 of file users.h. +Definition at line 71 of file users.h. .PP -References flood, host, pass, pingtime, and registration_timeout. +References flood, host, pass, pingtime, registration_timeout, and threshold. .PP .nf -68 { -69 registration_timeout = 0; -70 flood = 0; -71 pingtime = 0; -72 strlcpy(host,'',MAXBUF); -73 strlcpy(pass,'',MAXBUF); -74 } +72 { +73 registration_timeout = 0; +74 flood = 0; +75 pingtime = 0; +76 threshold = 0; +77 strlcpy(host,'',MAXBUF); +78 strlcpy(pass,'',MAXBUF); +79 } .fi .SH "Member Data Documentation" .PP @@ -94,6 +99,11 @@ Referenced by ConnectClass(). Max time to register the connection in seconds. Definition at line 53 of file users.h. .PP Referenced by ConnectClass(). +.SS "long \fBConnectClass::threshold\fP" +.PP +Threshold value for flood disconnect. Definition at line 69 of file users.h. +.PP +Referenced by ConnectClass(). .SS "int \fBConnectClass::type\fP" .PP Type of line, either CC_ALLOW or CC_DENY. Definition at line 50 of file users.h. diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index 8ca9f17b4..cb54283c9 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index dac7540a1..1dbd2376f 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Event.3 b/docs/man/man3/Event.3 index 40a9d4ea8..0c5e83e40 100644 --- a/docs/man/man3/Event.3 +++ b/docs/man/man3/Event.3 @@ -1,4 +1,4 @@ -.TH "Event" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Event" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -63,59 +63,59 @@ Definition at line 194 of file modules.h. .PP .SS "Event::Event (char * anydata, \fBModule\fP * src, std::string eventid)" .PP -Create a new Event. Definition at line 337 of file modules.cpp. +Create a new Event. Definition at line 335 of file modules.cpp. .PP .nf -337 : data(anydata), source(src), id(eventid) { }; +335 : data(anydata), source(src), id(eventid) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Event::GetData ()" .PP -Get the Event data. Definition at line 339 of file modules.cpp. +Get the Event data. Definition at line 337 of file modules.cpp. .PP References data. .PP .nf -340 { -341 return this->data; -342 } +338 { +339 return this->data; +340 } .fi .SS "std::string Event::GetEventID ()" .PP -Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 355 of file modules.cpp. +Get the event ID. Use this to determine the event type for safe casting of the data Definition at line 353 of file modules.cpp. .PP References id. .PP .nf -356 { -357 return this->id; -358 } +354 { +355 return this->id; +356 } .fi .SS "\fBModule\fP * Event::GetSource ()" .PP -Get the event Source. Definition at line 344 of file modules.cpp. +Get the event Source. Definition at line 342 of file modules.cpp. .PP References source. .PP .nf -345 { -346 return this->source; -347 } +343 { +344 return this->source; +345 } .fi .SS "char * Event::Send ()\fC [virtual]\fP" .PP Send the Event. The return result of an \fBEvent::Send()\fP will always be NULL as no replies are expected. Implements \fBModuleMessage\fP. .PP -Definition at line 349 of file modules.cpp. +Definition at line 347 of file modules.cpp. .PP References FOREACH_MOD. .PP .nf -350 { -351 FOREACH_MOD OnEvent(this); -352 return NULL; -353 } +348 { +349 FOREACH_MOD OnEvent(this); +350 return NULL; +351 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index e8ca07eea..4985ca640 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index 3c225024c..5b17a22cb 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -41,41 +41,41 @@ Inherits \fBclassbase\fP. .PP .SS "ExtMode::ExtMode (char mc, int ty, bool oper, int p_on, int p_off)\fC [inline]\fP" .PP -Definition at line 201 of file modules.cpp. +Definition at line 202 of file modules.cpp. .PP References modechar, needsoper, params_when_off, params_when_on, and type. .PP .nf -201 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +202 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; .fi .SH "Member Data Documentation" .PP .SS "bool \fBExtMode::list\fP" .PP -Definition at line 200 of file modules.cpp. +Definition at line 201 of file modules.cpp. .SS "char \fBExtMode::modechar\fP" .PP -Definition at line 195 of file modules.cpp. +Definition at line 196 of file modules.cpp. .PP Referenced by ExtMode(). .SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 199 of file modules.cpp. +Definition at line 200 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 198 of file modules.cpp. +Definition at line 199 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 197 of file modules.cpp. +Definition at line 198 of file modules.cpp. .PP Referenced by ExtMode(). .SS "int \fBExtMode::type\fP" .PP -Definition at line 196 of file modules.cpp. +Definition at line 197 of file modules.cpp. .PP Referenced by ExtMode(). diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index cd2180659..b58890fb7 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index a69617742..8373506b9 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -57,100 +57,100 @@ Caches a text file into memory and can be used to retrieve lines from it. This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. .PP -Definition at line 1186 of file modules.h. +Definition at line 1236 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" .PP -Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 988 of file modules.cpp. +Default constructor. This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.Definition at line 1004 of file modules.cpp. .PP .nf -989 { -990 } +1005 { +1006 } .fi .SS "FileReader::FileReader (std::string filename)" .PP -Secondary constructor. This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 981 of file modules.cpp. +Secondary constructor. This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 997 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -982 { -983 file_cache c; -984 readfile(c,filename.c_str()); -985 this->fc = c; -986 } +998 { +999 file_cache c; +1000 readfile(c,filename.c_str()); +1001 this->fc = c; +1002 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 1000 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 1016 of file modules.cpp. .PP .nf -1001 { -1002 } +1017 { +1018 } .fi .SH "Member Function Documentation" .PP .SS "bool FileReader::Exists ()" .PP -Returns true if the file exists This function will return false if the file could not be opened. Definition at line 1004 of file modules.cpp. +Returns true if the file exists This function will return false if the file could not be opened. Definition at line 1020 of file modules.cpp. .PP References fc. .PP .nf -1005 { -1006 if (fc.size() == 0) -1007 { -1008 return(false); -1009 } -1010 else -1011 { -1012 return(true); -1013 } -1014 } +1021 { +1022 if (fc.size() == 0) +1023 { +1024 return(false); +1025 } +1026 else +1027 { +1028 return(true); +1029 } +1030 } .fi .SS "int FileReader::FileSize ()" .PP -Returns the size of the file in lines. This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.Definition at line 1023 of file modules.cpp. +Returns the size of the file in lines. This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.Definition at line 1039 of file modules.cpp. .PP References fc. .PP .nf -1024 { -1025 return fc.size(); -1026 } +1040 { +1041 return fc.size(); +1042 } .fi .SS "std::string FileReader::GetLine (int x)" .PP -Retrieve one line from the file. This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.Definition at line 1016 of file modules.cpp. +Retrieve one line from the file. This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.Definition at line 1032 of file modules.cpp. .PP References fc. .PP .nf -1017 { -1018 if ((x<0) || (x>fc.size())) -1019 return ''; -1020 return fc[x]; -1021 } +1033 { +1034 if ((x<0) || (x>fc.size())) +1035 return ''; +1036 return fc[x]; +1037 } .fi .SS "void FileReader::LoadFile (std::string filename)" .PP -Used to load a file. This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 992 of file modules.cpp. +Used to load a file. This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, \fBFileReader::FileSize\fP returns 0.Definition at line 1008 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -993 { -994 file_cache c; -995 readfile(c,filename.c_str()); -996 this->fc = c; -997 } +1009 { +1010 file_cache c; +1011 readfile(c,filename.c_str()); +1012 this->fc = c; +1013 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 1188 of file modules.h. +Definition at line 1238 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index 118afd97b..155dffeb0 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index cbb5e7b2d..b61539767 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InAddr_HashComp.3 b/docs/man/man3/InAddr_HashComp.3 index ab6cd4563..70c1be8df 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,18 +17,18 @@ InAddr_HashComp \- .PP .SS "bool InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const\fC [inline]\fP" .PP -Definition at line 161 of file modules.cpp. +Definition at line 162 of file modules.cpp. .PP .nf -162 { -163 size_t q; -164 size_t p; -165 -166 memcpy(&q,&s1,sizeof(size_t)); -167 memcpy(&p,&s2,sizeof(size_t)); -168 -169 return (q == p); -170 } +163 { +164 size_t q; +165 size_t p; +166 +167 memcpy(&q,&s1,sizeof(size_t)); +168 memcpy(&p,&s2,sizeof(size_t)); +169 +170 return (q == p); +171 } .fi diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 9ce27dd83..595b9a85e 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index b0268a92e..cdb965a47 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index 211bfefb1..4fa82add2 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 41ce3695a..3868a5d81 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 486b10e2f..079f8b674 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -215,6 +215,30 @@ Inherits \fBclassbase\fP. .RI "virtual void \fBOnGlobalConnect\fP (\fBuserrec\fP *user)" .br .RI "\fICalled whenever a user connects, anywhere on the network. \fP" +.ti -1c +.RI "virtual int \fBOnAddBan\fP (\fBuserrec\fP *source, \fBchanrec\fP *channel, std::string banmask)" +.br +.RI "\fICalled whenever a ban is added to a channel's list. \fP" +.ti -1c +.RI "virtual int \fBOnDelBan\fP (\fBuserrec\fP *source, \fBchanrec\fP *channel, std::string banmask)" +.br +.RI "\fICalled whenever a ban is removed from a channel's list. \fP" +.ti -1c +.RI "virtual void \fBOnRawSocketAccept\fP (int fd, std::string ip, int localport)" +.br +.RI "\fICalled immediately after any connection is accepted. \fP" +.ti -1c +.RI "virtual int \fBOnRawSocketWrite\fP (int fd, char *buffer, int count)" +.br +.RI "\fICalled immediately before any write() operation on a user's socket in the core. \fP" +.ti -1c +.RI "virtual void \fBOnRawSocketClose\fP (int fd)" +.br +.RI "\fICalled immediately before any socket is closed. \fP" +.ti -1c +.RI "virtual int \fBOnRawSocketRead\fP (int fd, char *buffer, unsigned int count, int &readresult)" +.br +.RI "\fICalled immediately before any read() operation on a client socket in the core. \fP" .in -1c .SH "Detailed Description" .PP @@ -227,35 +251,35 @@ Definition at line 236 of file modules.h. .PP .SS "Module::Module ()" .PP -Default constructor creates a module class. Definition at line 361 of file modules.cpp. +Default constructor creates a module class. Definition at line 360 of file modules.cpp. .PP .nf -361 { } +360 { } .fi .SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class. Definition at line 362 of file modules.cpp. +Default destructor destroys a module class. Definition at line 361 of file modules.cpp. .PP .nf -362 { } +361 { } .fi .SH "Member Function Documentation" .PP .SS "\fBVersion\fP Module::GetVersion ()\fC [virtual]\fP" .PP -Returns the version number of a Module. The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 374 of file modules.cpp. +Returns the version number of a Module. The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 373 of file modules.cpp. .PP References VF_VENDOR. .PP .nf -374 { return Version(1,0,0,0,VF_VENDOR); } +373 { return Version(1,0,0,0,VF_VENDOR); } .fi .SS "void Module::On005Numeric (std::string & output)\fC [virtual]\fP" .PP -Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features.Definition at line 386 of file modules.cpp. +Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features.Definition at line 385 of file modules.cpp. .PP .nf -386 { }; +385 { }; .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP @@ -283,270 +307,312 @@ Called before an action which requires a channel privilage check. This function .br .br - Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 383 of file modules.cpp. + Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 382 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -383 { return ACR_DEFAULT; }; +382 { return ACR_DEFAULT; }; +.fi +.SS "int Module::OnAddBan (\fBuserrec\fP * source, \fBchanrec\fP * channel, std::string banmask)\fC [virtual]\fP" +.PP +Called whenever a ban is added to a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being added.Definition at line 410 of file modules.cpp. +.PP +.nf +410 { return 0; }; .fi .SS "void Module::OnBackgroundTimer (time_t curtime)\fC [virtual]\fP" .PP -Called once every five seconds for background processing. This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.Definition at line 389 of file modules.cpp. +Called once every five seconds for background processing. This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.Definition at line 388 of file modules.cpp. .PP .nf -389 { }; +388 { }; .fi .SS "int Module::OnChangeLocalUserGECOS (\fBuserrec\fP * user, std::string newhost)\fC [virtual]\fP" .PP -Called whenever a change of a local users GECOS (fullname field) is attempted. return 1 to deny the name change, or 0 to allow it.Definition at line 403 of file modules.cpp. +Called whenever a change of a local users GECOS (fullname field) is attempted. return 1 to deny the name change, or 0 to allow it.Definition at line 402 of file modules.cpp. .PP .nf -403 { return 0; }; +402 { return 0; }; .fi .SS "int Module::OnChangeLocalUserHost (\fBuserrec\fP * user, std::string newhost)\fC [virtual]\fP" .PP -Called whenever a change of a local users displayed host is attempted. Return 1 to deny the host change, or 0 to allow it.Definition at line 402 of file modules.cpp. +Called whenever a change of a local users displayed host is attempted. Return 1 to deny the host change, or 0 to allow it.Definition at line 401 of file modules.cpp. .PP .nf -402 { return 0; }; +401 { return 0; }; .fi .SS "\fBstring_list\fP Module::OnChannelSync (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called during a netburst to sync channel data. This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 385 of file modules.cpp. +Called during a netburst to sync channel data. This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 384 of file modules.cpp. .PP References string_list. .PP .nf -385 { string_list empty; return empty; } +384 { string_list empty; return empty; } .fi .SS "int Module::OnCheckBan (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 400 of file modules.cpp. +Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 399 of file modules.cpp. .PP .nf -400 { return 0; }; +399 { return 0; }; .fi .SS "int Module::OnCheckInvite (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if invite checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.Definition at line 397 of file modules.cpp. +Called whenever a user joins a channel, to determine if invite checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.Definition at line 396 of file modules.cpp. .PP .nf -397 { return 0; }; +396 { return 0; }; .fi .SS "int Module::OnCheckKey (\fBuserrec\fP * user, \fBchanrec\fP * chan, std::string keygiven)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if key checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 398 of file modules.cpp. +Called whenever a user joins a channel, to determine if key checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 397 of file modules.cpp. .PP .nf -398 { return 0; }; +397 { return 0; }; .fi .SS "int Module::OnCheckLimit (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 399 of file modules.cpp. +Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 398 of file modules.cpp. .PP .nf -399 { return 0; }; +398 { return 0; }; .fi .SS "bool Module::OnCheckReady (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.Definition at line 392 of file modules.cpp. +Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.Definition at line 391 of file modules.cpp. +.PP +.nf +391 { return true; }; +.fi +.SS "int Module::OnDelBan (\fBuserrec\fP * source, \fBchanrec\fP * channel, std::string banmask)\fC [virtual]\fP" +.PP +Called whenever a ban is removed from a channel's list. Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.Definition at line 411 of file modules.cpp. .PP .nf -392 { return true; }; +411 { return 0; }; .fi .SS "void Module::OnEvent (\fBEvent\fP * event)\fC [virtual]\fP" .PP -Called whenever an \fBEvent\fP class is sent to all module by another module. Please see the documentation of \fBEvent::Send()\fP for further information. The \fBEvent\fP sent can always be assumed to be non-NULL, you should *always* check the value of \fBEvent::GetEventID()\fP before doing anything to the event data, and you should *not* change the event data in any way!Definition at line 406 of file modules.cpp. +Called whenever an \fBEvent\fP class is sent to all module by another module. Please see the documentation of \fBEvent::Send()\fP for further information. The \fBEvent\fP sent can always be assumed to be non-NULL, you should *always* check the value of \fBEvent::GetEventID()\fP before doing anything to the event data, and you should *not* change the event data in any way!Definition at line 405 of file modules.cpp. .PP .nf -406 { return; }; +405 { return; }; .fi .SS "int Module::OnExtendedMode (\fBuserrec\fP * user, void * target, char modechar, int type, bool mode_on, \fBstring_list\fP & params)\fC [virtual]\fP" .PP -Called whenever an extended mode is to be processed. The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 373 of file modules.cpp. +Called whenever an extended mode is to be processed. The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 372 of file modules.cpp. .PP .nf -373 { return false; } +372 { return false; } .fi .SS "void Module::OnGlobalConnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user connects, anywhere on the network. This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.Definition at line 410 of file modules.cpp. +Called whenever a user connects, anywhere on the network. This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.Definition at line 409 of file modules.cpp. .PP .nf -410 { }; +409 { }; .fi .SS "void Module::OnGlobalOper (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user is given usermode +o, anywhere on the network. You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.Definition at line 409 of file modules.cpp. +Called whenever a user is given usermode +o, anywhere on the network. You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.Definition at line 408 of file modules.cpp. .PP .nf -409 { }; +408 { }; .fi .SS "void Module::OnInfo (\fBuserrec\fP * user)\fC [virtual]\fP" .PP Called whenever a user types /INFO. The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format: .PP - :information hereDefinition at line 376 of file modules.cpp. + :information hereDefinition at line 375 of file modules.cpp. .PP .nf -376 { }; +375 { }; .fi .SS "int Module::OnKill (\fBuserrec\fP * source, \fBuserrec\fP * dest, std::string reason)\fC [virtual]\fP" .PP -Called when a client is disconnected by KILL. If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!Definition at line 387 of file modules.cpp. +Called when a client is disconnected by KILL. If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!Definition at line 386 of file modules.cpp. .PP .nf -387 { return 0; }; +386 { return 0; }; .fi .SS "void Module::OnLoadModule (\fBModule\fP * mod, std::string name)\fC [virtual]\fP" .PP -Called whenever a module is loaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded 'm_killwidgets.so' with 'm_makewidgets.so'. It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).Definition at line 388 of file modules.cpp. +Called whenever a module is loaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded 'm_killwidgets.so' with 'm_makewidgets.so'. It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).Definition at line 387 of file modules.cpp. .PP .nf -388 { }; +387 { }; .fi .SS "int Module::OnLocalTopicChange (\fBuserrec\fP * user, \fBchanrec\fP * chan, std::string topic)\fC [virtual]\fP" .PP -Called whenever a topic is changed by a local user. Return 1 to deny the topic change, or 0 to allow it.Definition at line 404 of file modules.cpp. +Called whenever a topic is changed by a local user. Return 1 to deny the topic change, or 0 to allow it.Definition at line 403 of file modules.cpp. .PP .nf -404 { return 0; }; +403 { return 0; }; .fi .SS "int Module::OnMeshToken (char token, \fBstring_list\fP params, \fBserverrec\fP * source, \fBserverrec\fP * reply, std::string tcp_host, std::string ipaddr, int port)\fC [virtual]\fP" .PP -Called whenever an unknown token is received in a server to server link. The token value is the unknown token -- please check that no other modules are using the token that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to all opers with +s. The params list is a list of parameters, and if any parameters start with a colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are handled. source is the sender of the message, and reply is what should be replied to for a unicast message. Note that there are not many messages in the mesh protocol which require unicast messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal notation and port is the port number it is using.Definition at line 405 of file modules.cpp. +Called whenever an unknown token is received in a server to server link. The token value is the unknown token -- please check that no other modules are using the token that you use. Returning 1 supresses the 'unknown token type' error which is usually sent to all opers with +s. The params list is a list of parameters, and if any parameters start with a colon (:) it is treated as the whole of the last parameter, identical to how RFC messages are handled. source is the sender of the message, and reply is what should be replied to for a unicast message. Note that there are not many messages in the mesh protocol which require unicast messaging. tcp_host is the server name as a string, ipaddr is its ip address in dotted decimal notation and port is the port number it is using.Definition at line 404 of file modules.cpp. .PP .nf -405 { return 0; }; +404 { return 0; }; .fi .SS "void Module::OnOper (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 375 of file modules.cpp. +Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 374 of file modules.cpp. .PP .nf -375 { }; +374 { }; .fi .SS "int Module::OnOperCompare (std::string password, std::string input)\fC [virtual]\fP" .PP -Called whenever an oper password is to be compared to what a user has input. The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.Definition at line 408 of file modules.cpp. +Called whenever an oper password is to be compared to what a user has input. The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.Definition at line 407 of file modules.cpp. .PP .nf -408 { return 0; }; +407 { return 0; }; .fi .SS "void Module::OnPacketReceive (std::string & data, std::string serv)\fC [virtual]\fP" .PP -Called after a packet is received from another irc server. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 369 of file modules.cpp. +Called after a packet is received from another irc server. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 368 of file modules.cpp. .PP .nf -369 { } +368 { } .fi .SS "void Module::OnPacketTransmit (std::string & data, std::string serv)\fC [virtual]\fP" .PP -Called before a packet is transmitted across the irc network between two irc servers. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 368 of file modules.cpp. +Called before a packet is transmitted across the irc network between two irc servers. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 367 of file modules.cpp. .PP .nf -368 { } +367 { } .fi .SS "int Module::OnPreCommand (std::string command, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever any command is about to be executed. This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using \fBServer::QuitUser\fP) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)Definition at line 391 of file modules.cpp. +Called whenever any command is about to be executed. This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using \fBServer::QuitUser\fP) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)Definition at line 390 of file modules.cpp. .PP .nf -391 { return 0; }; +390 { return 0; }; .fi .SS "int Module::OnRawMode (\fBuserrec\fP * user, \fBchanrec\fP * chan, char mode, std::string param, bool adding, int pcnt)\fC [virtual]\fP" .PP -Called whenever a mode character is processed. Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!Definition at line 396 of file modules.cpp. +Called whenever a mode character is processed. Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!Definition at line 395 of file modules.cpp. .PP .nf -396 { return 0; }; +395 { return 0; }; +.fi +.SS "void Module::OnRawSocketAccept (int fd, std::string ip, int localport)\fC [virtual]\fP" +.PP +Called immediately after any connection is accepted. This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.Definition at line 412 of file modules.cpp. +.PP +.nf +412 { }; +.fi +.SS "void Module::OnRawSocketClose (int fd)\fC [virtual]\fP" +.PP +Called immediately before any socket is closed. When this event is called, shutdown() has not yet been called on the socket.Definition at line 414 of file modules.cpp. +.PP +.nf +414 { }; +.fi +.SS "int Module::OnRawSocketRead (int fd, char * buffer, unsigned int count, int & readresult)\fC [virtual]\fP" +.PP +Called immediately before any read() operation on a client socket in the core. This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult.Definition at line 415 of file modules.cpp. +.PP +.nf +415 { return 0; }; +.fi +.SS "int Module::OnRawSocketWrite (int fd, char * buffer, int count)\fC [virtual]\fP" +.PP +Called immediately before any write() operation on a user's socket in the core. Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write().Definition at line 413 of file modules.cpp. +.PP +.nf +413 { return 0; }; .fi .SS "void Module::OnRehash ()\fC [virtual]\fP" .PP -Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 370 of file modules.cpp. +Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 369 of file modules.cpp. .PP .nf -370 { } +369 { } .fi .SS "char * Module::OnRequest (\fBRequest\fP * request)\fC [virtual]\fP" .PP -Called whenever a \fBRequest\fP class is sent to your module by another module. Please see the documentation of \fBRequest::Send()\fP for further information. The \fBRequest\fP sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).Definition at line 407 of file modules.cpp. +Called whenever a \fBRequest\fP class is sent to your module by another module. Please see the documentation of \fBRequest::Send()\fP for further information. The \fBRequest\fP sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).Definition at line 406 of file modules.cpp. .PP Referenced by Request::Send(). .PP .nf -407 { return NULL; }; +406 { return NULL; }; .fi .SS "void Module::OnSendList (\fBuserrec\fP * user, \fBchanrec\fP * channel, char mode)\fC [virtual]\fP" .PP -Called whenever a list is needed for a listmode. For example, when a /MODE #channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.Definition at line 390 of file modules.cpp. +Called whenever a list is needed for a listmode. For example, when a /MODE #channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.Definition at line 389 of file modules.cpp. .PP .nf -390 { }; +389 { }; .fi .SS "void Module::OnServerRaw (std::string & raw, bool inbound, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 371 of file modules.cpp. +Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 370 of file modules.cpp. .PP .nf -371 { } +370 { } .fi .SS "void Module::OnStats (char symbol)\fC [virtual]\fP" .PP -Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. Definition at line 401 of file modules.cpp. +Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. Definition at line 400 of file modules.cpp. .PP .nf -401 { }; +400 { }; .fi .SS "void Module::OnUserConnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user connects. The details of the connecting user are available to you in the parameter userrec *userDefinition at line 363 of file modules.cpp. +Called when a user connects. The details of the connecting user are available to you in the parameter userrec *userDefinition at line 362 of file modules.cpp. .PP .nf -363 { } +362 { } .fi .SS "void Module::OnUserDisconnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user's socket is closed. The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.Definition at line 365 of file modules.cpp. +Called whenever a user's socket is closed. The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.Definition at line 364 of file modules.cpp. .PP .nf -365 { } +364 { } .fi .SS "void Module::OnUserJoin (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user joins a channel. The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 366 of file modules.cpp. +Called when a user joins a channel. The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 365 of file modules.cpp. .PP .nf -366 { } +365 { } .fi .SS "void Module::OnUserKick (\fBuserrec\fP * source, \fBuserrec\fP * user, \fBchanrec\fP * chan, std::string reason)\fC [virtual]\fP" .PP -Called whenever a user is kicked. If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use \fBModule::OnUserPreKick\fP instead of this method.Definition at line 395 of file modules.cpp. +Called whenever a user is kicked. If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use \fBModule::OnUserPreKick\fP instead of this method.Definition at line 394 of file modules.cpp. .PP .nf -395 { }; +394 { }; .fi .SS "void Module::OnUserPart (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user parts a channel. The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 367 of file modules.cpp. +Called when a user parts a channel. The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 366 of file modules.cpp. .PP .nf -367 { } +366 { } .fi .SS "void Module::OnUserPostNick (\fBuserrec\fP * user, std::string oldnick)\fC [virtual]\fP" .PP -Called after any nickchange, local or remote. This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this. Definition at line 382 of file modules.cpp. +Called after any nickchange, local or remote. This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this. Definition at line 381 of file modules.cpp. .PP .nf -382 { }; +381 { }; .fi .SS "int Module::OnUserPreInvite (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.Definition at line 378 of file modules.cpp. +Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.Definition at line 377 of file modules.cpp. .PP .nf -378 { return 0; }; +377 { return 0; }; .fi .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP" .PP @@ -554,68 +620,68 @@ Called whenever a user is about to join a channel, before any processing is done .PP IMPORTANT NOTE! .PP -If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 372 of file modules.cpp. +If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 371 of file modules.cpp. .PP .nf -372 { return 0; } +371 { return 0; } .fi .SS "int Module::OnUserPreKick (\fBuserrec\fP * source, \fBuserrec\fP * user, \fBchanrec\fP * chan, std::string reason)\fC [virtual]\fP" .PP -Called whenever a user is about to be kicked. Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. Definition at line 394 of file modules.cpp. +Called whenever a user is about to be kicked. Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. Definition at line 393 of file modules.cpp. .PP .nf -394 { return 0; }; +393 { return 0; }; .fi .SS "int Module::OnUserPreMessage (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 379 of file modules.cpp. +Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 378 of file modules.cpp. .PP .nf -379 { return 0; }; +378 { return 0; }; .fi .SS "int Module::OnUserPreNick (\fBuserrec\fP * user, std::string newnick)\fC [virtual]\fP" .PP -Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.Definition at line 381 of file modules.cpp. +Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.Definition at line 380 of file modules.cpp. .PP .nf -381 { return 0; }; +380 { return 0; }; .fi .SS "int Module::OnUserPreNotice (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 380 of file modules.cpp. +Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 379 of file modules.cpp. .PP .nf -380 { return 0; }; +379 { return 0; }; .fi .SS "void Module::OnUserQuit (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user quits. The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.Definition at line 364 of file modules.cpp. +Called when a user quits. The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.Definition at line 363 of file modules.cpp. .PP .nf -364 { } +363 { } .fi .SS "void Module::OnUserRegister (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user is about to register their connection (e.g. before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.Definition at line 393 of file modules.cpp. +Called whenever a user is about to register their connection (e.g. before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.Definition at line 392 of file modules.cpp. .PP .nf -393 { }; +392 { }; .fi .SS "\fBstring_list\fP Module::OnUserSync (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called during a netburst to sync user data. This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 384 of file modules.cpp. +Called during a netburst to sync user data. This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 383 of file modules.cpp. .PP References string_list. .PP .nf -384 { string_list empty; return empty; } +383 { string_list empty; return empty; } .fi .SS "void Module::OnWhois (\fBuserrec\fP * source, \fBuserrec\fP * dest)\fC [virtual]\fP" .PP -Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 377 of file modules.cpp. +Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 376 of file modules.cpp. .PP .nf -377 { }; +376 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index 5e8420840..8ab598e32 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -32,22 +32,22 @@ Instantiates classes inherited from \fBModule\fP This class creates a class inhe This is to allow for modules to create many different variants of \fBModule\fP, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules. .PP -Definition at line 1241 of file modules.h. +Definition at line 1291 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 1244 of file modules.h. +Definition at line 1294 of file modules.h. .PP .nf -1244 { } +1294 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 1245 of file modules.h. +Definition at line 1295 of file modules.h. .PP .nf -1245 { } +1295 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/ModuleMessage.3 b/docs/man/man3/ModuleMessage.3 index 3b04d034a..bcc6a69e0 100644 --- a/docs/man/man3/ModuleMessage.3 +++ b/docs/man/man3/ModuleMessage.3 @@ -1,4 +1,4 @@ -.TH "ModuleMessage" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleMessage" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index a8a1adf0b..8558748e9 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Request.3 b/docs/man/man3/Request.3 index 28a518bc5..e3bc31498 100644 --- a/docs/man/man3/Request.3 +++ b/docs/man/man3/Request.3 @@ -1,4 +1,4 @@ -.TH "Request" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Request" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -63,65 +63,65 @@ Definition at line 154 of file modules.h. .PP .SS "Request::Request (char * anydata, \fBModule\fP * src, \fBModule\fP * dst)" .PP -Create a new Request. Definition at line 308 of file modules.cpp. +Create a new Request. Definition at line 306 of file modules.cpp. .PP .nf -308 : data(anydata), source(src), dest(dst) { }; +306 : data(anydata), source(src), dest(dst) { }; .fi .SH "Member Function Documentation" .PP .SS "char * Request::GetData ()" .PP -Fetch the Request data. Definition at line 310 of file modules.cpp. +Fetch the Request data. Definition at line 308 of file modules.cpp. .PP References data. .PP .nf -311 { -312 return this->data; -313 } +309 { +310 return this->data; +311 } .fi .SS "\fBModule\fP * Request::GetDest ()" .PP -Fetch the request destination (should be 'this' in the receiving module). Definition at line 320 of file modules.cpp. +Fetch the request destination (should be 'this' in the receiving module). Definition at line 318 of file modules.cpp. .PP References dest. .PP .nf -321 { -322 return this->dest; -323 } +319 { +320 return this->dest; +321 } .fi .SS "\fBModule\fP * Request::GetSource ()" .PP -Fetch the request source. Definition at line 315 of file modules.cpp. +Fetch the request source. Definition at line 313 of file modules.cpp. .PP References source. .PP .nf -316 { -317 return this->source; -318 } +314 { +315 return this->source; +316 } .fi .SS "char * Request::Send ()\fC [virtual]\fP" .PP Send the Request. Upon returning the result will be arbitary data returned by the module you sent the request to. It is up to your module to know what this data is and how to deal with it. Implements \fBModuleMessage\fP. .PP -Definition at line 325 of file modules.cpp. +Definition at line 323 of file modules.cpp. .PP References dest, and Module::OnRequest(). .PP .nf -326 { -327 if (this->dest) -328 { -329 return dest->OnRequest(this); -330 } -331 else -332 { -333 return NULL; -334 } -335 } +324 { +325 if (this->dest) +326 { +327 return dest->OnRequest(this); +328 } +329 else +330 { +331 return NULL; +332 } +333 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 47253deec..739987c2a 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -40,6 +40,10 @@ Inherits \fBclassbase\fP. .br .RI "\fISends text from the server to a socket. \fP" .ti -1c +.RI "virtual void \fBSendChannelServerNotice\fP (std::string ServName, \fBchanrec\fP *Channel, std::string text)" +.br +.RI "\fIWrites text to a channel, but from a server, including all. \fP" +.ti -1c .RI "virtual void \fBSendFrom\fP (int Socket, \fBuserrec\fP *User, std::string s)" .br .RI "\fISends text from a user to a socket. \fP" @@ -76,6 +80,10 @@ Inherits \fBclassbase\fP. .br .RI "\fIAttempts to look up a nick and return a pointer to it. \fP" .ti -1c +.RI "virtual \fBuserrec\fP * \fBFindDescriptor\fP (int socket)" +.br +.RI "\fIAttempts to look up a nick using the file descriptor associated with that nick. \fP" +.ti -1c .RI "virtual \fBchanrec\fP * \fBFindChannel\fP (std::string channel)" .br .RI "\fIAttempts to look up a channel and return a pointer to it. \fP" @@ -254,24 +262,24 @@ Allows server output and query functions This class contains methods which allow All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. .PP -Definition at line 652 of file modules.h. +Definition at line 694 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 416 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 421 of file modules.cpp. .PP .nf -417 { -418 } +422 { +423 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 420 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 425 of file modules.cpp. .PP .nf -421 { -422 } +426 { +427 } .fi .SH "Member Function Documentation" .PP @@ -281,25 +289,25 @@ Adds a command to the command table. This allows modules to add extra commands i .PP typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP .PP -When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. 'm_blarp.so'. If you place the wrong identifier here, you can cause crashes if your module is unloaded.Definition at line 497 of file modules.cpp. +When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. 'm_blarp.so'. If you place the wrong identifier here, you can cause crashes if your module is unloaded.Definition at line 494 of file modules.cpp. .PP References createcommand(). .PP .nf -498 { -499 createcommand(cmd,f,flags,minparams,source); -500 } +495 { +496 createcommand(cmd,f,flags,minparams,source); +497 } .fi .SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP -Adds a E-line The E-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 715 of file modules.cpp. +Adds a E-line The E-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 731 of file modules.cpp. .PP References add_eline(), and duration(). .PP .nf -716 { -717 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -718 } +732 { +733 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +734 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -313,528 +321,540 @@ Adds an extended mode letter which is parsed by a module and handled in a list f .PP (4) The mode and its parameter are NOT stored in the channels modes structure .PP -It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.Definition at line 642 of file modules.cpp. +It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.Definition at line 657 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -643 { -644 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -645 if (res) -646 ModeMakeList(modechar); -647 return res; -648 } +658 { +659 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +660 if (res) +661 ModeMakeList(modechar); +662 return res; +663 } .fi .SS "bool Server::AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)\fC [virtual]\fP" .PP -Adds an extended mode letter which is parsed by a module. This allows modules to add extra mode letters, e.g. +x for hostcloak. the 'type' parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.Definition at line 622 of file modules.cpp. +Adds an extended mode letter which is parsed by a module. This allows modules to add extra mode letters, e.g. +x for hostcloak. the 'type' parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.Definition at line 629 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -623 { -624 if (type == MT_SERVER) -625 { -626 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -627 return false; -628 } -629 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -630 { -631 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -632 return false; -633 } -634 if ((params_when_on>1) || (params_when_off>1)) -635 { -636 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -637 return false; -638 } -639 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -640 } +630 { +631 if (((modechar >= 'A') && (modechar <= 'Z')) || ((modechar >= 'a') && (modechar <= 'z'))) +632 { +633 if (type == MT_SERVER) +634 { +635 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +636 return false; +637 } +638 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +639 { +640 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +641 return false; +642 } +643 if ((params_when_on>1) || (params_when_off>1)) +644 { +645 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +646 return false; +647 } +648 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +649 } +650 else +651 { +652 log(DEBUG,'*** API ERROR *** Muppet modechar detected.'); +653 } +654 return false; +655 } .fi .SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP -Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.Definition at line 695 of file modules.cpp. +Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.Definition at line 711 of file modules.cpp. .PP References add_gline(), and duration(). .PP .nf -696 { -697 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -698 } +712 { +713 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +714 } .fi .SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP" .PP -Adds a K-line The K-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 710 of file modules.cpp. +Adds a K-line The K-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 726 of file modules.cpp. .PP References add_kline(), and duration(). .PP .nf -711 { -712 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); -713 } +727 { +728 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +729 } .fi .SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP" .PP -Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 700 of file modules.cpp. +Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 716 of file modules.cpp. .PP References add_qline(), and duration(). .PP .nf -701 { -702 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); -703 } +717 { +718 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +719 } .fi .SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP" .PP -Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 705 of file modules.cpp. +Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 721 of file modules.cpp. .PP References add_zline(), and duration(). .PP .nf -706 { -707 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); -708 } +722 { +723 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +724 } .fi .SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP" .PP -Calculates a duration This method will take a string containing a formatted duration (e.g. '1w2d') and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.Definition at line 745 of file modules.cpp. +Calculates a duration This method will take a string containing a formatted duration (e.g. '1w2d') and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.Definition at line 761 of file modules.cpp. .PP References duration(). .PP .nf -746 { -747 return duration(delta.c_str()); -748 } +762 { +763 return duration(delta.c_str()); +764 } .fi .SS "void Server::CallCommandHandler (std::string commandname, char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP Calls the handler for a command, either implemented by the core or by another module. You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or .br -) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih \fBAddCommand()\fP. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.Definition at line 487 of file modules.cpp. +) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih \fBAddCommand()\fP. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.Definition at line 484 of file modules.cpp. .PP .nf -488 { -489 call_handler(commandname.c_str(),parameters,pcnt,user); -490 } +485 { +486 call_handler(commandname.c_str(),parameters,pcnt,user); +487 } .fi .SS "void Server::ChangeGECOS (\fBuserrec\fP * user, std::string gecos)\fC [virtual]\fP" .PP -Change GECOS (fullname) of a user. You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 575 of file modules.cpp. +Change GECOS (fullname) of a user. You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 577 of file modules.cpp. .PP References ChangeName(). .PP .nf -576 { -577 ChangeName(user,gecos.c_str()); -578 } +578 { +579 ChangeName(user,gecos.c_str()); +580 } .fi .SS "void Server::ChangeHost (\fBuserrec\fP * user, std::string host)\fC [virtual]\fP" .PP -Change displayed hostname of a user. You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 570 of file modules.cpp. +Change displayed hostname of a user. You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.Definition at line 572 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -571 { -572 ChangeDisplayedHost(user,host.c_str()); -573 } +573 { +574 ChangeDisplayedHost(user,host.c_str()); +575 } .fi .SS "void Server::ChangeUserNick (\fBuserrec\fP * user, std::string nickname)\fC [virtual]\fP" .PP -Forces a user nickchange. This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 471 of file modules.cpp. +Forces a user nickchange. This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.Definition at line 469 of file modules.cpp. .PP .nf -472 { -473 force_nickchange(user,nickname.c_str()); -474 } +470 { +471 force_nickchange(user,nickname.c_str()); +472 } .fi .SS "std::string Server::ChanMode (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP -Attempts to look up a user's privilages on a channel. This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 595 of file modules.cpp. +Attempts to look up a user's privilages on a channel. This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.Definition at line 602 of file modules.cpp. .PP References cmode(). .PP .nf -596 { -597 return cmode(User,Chan); -598 } +603 { +604 return cmode(User,Chan); +605 } .fi .SS "bool Server::CommonChannels (\fBuserrec\fP * u1, \fBuserrec\fP * u2)\fC [virtual]\fP" .PP -Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 548 of file modules.cpp. +Returns true if two users share a common channel. This method is used internally by the NICK and QUIT commands, and the \fBServer::SendCommon\fP method.Definition at line 550 of file modules.cpp. .PP References common_channels(). .PP .nf -549 { -550 return (common_channels(u1,u2) != 0); -551 } +551 { +552 return (common_channels(u1,u2) != 0); +553 } .fi .SS "int Server::CountUsers (\fBchanrec\fP * c)\fC [virtual]\fP" .PP -Returns a count of the number of users on a channel. This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.Definition at line 650 of file modules.cpp. +Returns a count of the number of users on a channel. This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.Definition at line 665 of file modules.cpp. .PP .nf -651 { -652 return usercount(c); -653 } +666 { +667 return usercount(c); +668 } .fi .SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local E-Line. Definition at line 740 of file modules.cpp. +Deletes a local E-Line. Definition at line 756 of file modules.cpp. .PP References del_eline(). .PP .nf -741 { -742 del_eline(hostmask.c_str()); -743 } +757 { +758 del_eline(hostmask.c_str()); +759 } .fi .SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a G-Line from all servers on the mesh. Definition at line 720 of file modules.cpp. +Deletes a G-Line from all servers on the mesh. Definition at line 736 of file modules.cpp. .PP References del_gline(). .PP .nf -721 { -722 del_gline(hostmask.c_str()); -723 } +737 { +738 del_gline(hostmask.c_str()); +739 } .fi .SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" .PP -Deletes a local K-Line. Definition at line 735 of file modules.cpp. +Deletes a local K-Line. Definition at line 751 of file modules.cpp. .PP References del_kline(). .PP .nf -736 { -737 del_kline(hostmask.c_str()); -738 } +752 { +753 del_kline(hostmask.c_str()); +754 } .fi .SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP" .PP -Deletes a Q-Line from all servers on the mesh. Definition at line 725 of file modules.cpp. +Deletes a Q-Line from all servers on the mesh. Definition at line 741 of file modules.cpp. .PP References del_qline(). .PP .nf -726 { -727 del_qline(nickname.c_str()); -728 } +742 { +743 del_qline(nickname.c_str()); +744 } .fi .SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP" .PP -Deletes a Z-Line from all servers on the mesh. Definition at line 730 of file modules.cpp. +Deletes a Z-Line from all servers on the mesh. Definition at line 746 of file modules.cpp. .PP References del_zline(). .PP .nf -731 { -732 del_zline(ipaddr.c_str()); -733 } +747 { +748 del_zline(ipaddr.c_str()); +749 } .fi .SS "\fBchanrec\fP * Server::FindChannel (std::string channel)\fC [virtual]\fP" .PP -Attempts to look up a channel and return a pointer to it. This function will return NULL if the channel does not exist.Definition at line 590 of file modules.cpp. +Attempts to look up a channel and return a pointer to it. This function will return NULL if the channel does not exist.Definition at line 597 of file modules.cpp. .PP .nf -591 { -592 return FindChan(channel.c_str()); -593 } +598 { +599 return FindChan(channel.c_str()); +600 } +.fi +.SS "\fBuserrec\fP * Server::FindDescriptor (int socket)\fC [virtual]\fP" +.PP +Attempts to look up a nick using the file descriptor associated with that nick. This function will return NULL if the file descriptor is not associated with a valid user.Definition at line 592 of file modules.cpp. +.PP +References fd_ref_table. +.PP +.nf +593 { +594 return (socket < 65536 ? fd_ref_table[socket] : NULL); +595 } .fi .SS "\fBModule\fP * Server::FindModule (std::string name)\fC [virtual]\fP" .PP -This function finds a module by name. You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.Definition at line 823 of file modules.cpp. +This function finds a module by name. You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.Definition at line 839 of file modules.cpp. .PP References MODCOUNT, module_names, and modules. .PP .nf -824 { -825 for (int i = 0; i <= MODCOUNT; i++) -826 { -827 if (module_names[i] == name) -828 { -829 return modules[i]; -830 } -831 } -832 return NULL; -833 } +840 { +841 for (int i = 0; i <= MODCOUNT; i++) +842 { +843 if (module_names[i] == name) +844 { +845 return modules[i]; +846 } +847 } +848 return NULL; +849 } .fi .SS "\fBuserrec\fP * Server::FindNick (std::string nick)\fC [virtual]\fP" .PP -Attempts to look up a nick and return a pointer to it. This function will return NULL if the nick does not exist.Definition at line 585 of file modules.cpp. +Attempts to look up a nick and return a pointer to it. This function will return NULL if the nick does not exist.Definition at line 587 of file modules.cpp. .PP .nf -586 { -587 return Find(nick); -588 } +588 { +589 return Find(nick); +590 } .fi .SS "\fBAdmin\fP Server::GetAdmin ()\fC [virtual]\fP" .PP -Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 615 of file modules.cpp. +Returns the information of the server as returned by the /ADMIN command. See the \fBAdmin\fP class for further information of the return value. The members \fBAdmin::Nick\fP, \fBAdmin::Email\fP and \fBAdmin::Name\fP contain the information for the server where the module is loaded.Definition at line 622 of file modules.cpp. .PP .nf -616 { -617 return Admin(getadminname(),getadminemail(),getadminnick()); -618 } +623 { +624 return Admin(getadminname(),getadminemail(),getadminnick()); +625 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 610 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 617 of file modules.cpp. .PP .nf -611 { -612 return getnetworkname(); -613 } +618 { +619 return getnetworkname(); +620 } .fi .SS "std::string Server::GetServerName ()\fC [virtual]\fP" .PP -Returns the server name of the server where the module is loaded. Definition at line 605 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 612 of file modules.cpp. .PP .nf -606 { -607 return getservername(); -608 } +613 { +614 return getservername(); +615 } .fi .SS "\fBchanuserlist\fP Server::GetUsers (\fBchanrec\fP * chan)\fC [virtual]\fP" .PP -Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 452 of file modules.cpp. +Fetches the userlist of a channel. This function must be here and not a member of userrec or chanrec due to include constraints.Definition at line 457 of file modules.cpp. .PP -References chanuserlist, clientlist, has_channel(), and isnick(). +References chanuserlist, chanrec::GetUsers(), and list. .PP .nf -453 { -454 chanuserlist userl; -455 userl.clear(); -456 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) -457 { -458 if (i->second) -459 { -460 if (has_channel(i->second,chan)) -461 { -462 if (isnick(i->second->nick)) -463 { -464 userl.push_back(i->second); -465 } -466 } -467 } -468 } -469 return userl; -470 } +458 { +459 chanuserlist userl; +460 userl.clear(); +461 std::vector *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 } .fi .SS "bool Server::IsNick (std::string nick)\fC [virtual]\fP" .PP -Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 580 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 582 of file modules.cpp. .PP References isnick(). .PP .nf -581 { -582 return (isnick(nick.c_str()) != 0); -583 } +583 { +584 return (isnick(nick.c_str()) != 0); +585 } .fi .SS "bool Server::IsOnChannel (\fBuserrec\fP * User, \fBchanrec\fP * Chan)\fC [virtual]\fP" .PP -Checks if a user is on a channel. This function will return true or false to indicate if user 'User' is on channel 'Chan'.Definition at line 600 of file modules.cpp. +Checks if a user is on a channel. This function will return true or false to indicate if user 'User' is on channel 'Chan'.Definition at line 607 of file modules.cpp. .PP References has_channel(). .PP .nf -601 { -602 return has_channel(User,Chan); -603 } +608 { +609 return has_channel(User,Chan); +610 } .fi .SS "bool Server::IsUlined (std::string server)\fC [virtual]\fP" .PP -Returns true if the servername you give is ulined. ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.Definition at line 482 of file modules.cpp. +Returns true if the servername you give is ulined. ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.Definition at line 479 of file modules.cpp. .PP References is_uline(). .PP .nf -483 { -484 return is_uline(server.c_str()); -485 } +480 { +481 return is_uline(server.c_str()); +482 } .fi .SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP" .PP -Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 750 of file modules.cpp. -.PP -.nf -751 { -752 const char* dest = mask.c_str(); -753 if (strchr(dest,'!')==0) -754 return false; -755 if (strchr(dest,'@')==0) -756 return false; -757 for (int i = 0; i < strlen(dest); i++) -758 if (dest[i] < 32) -759 return false; -760 for (int i = 0; i < strlen(dest); i++) -761 if (dest[i] > 126) -762 return false; -763 int c = 0; -764 for (int i = 0; i < strlen(dest); i++) -765 if (dest[i] == '!') -766 c++; -767 if (c>1) -768 return false; -769 c = 0; -770 for (int i = 0; i < strlen(dest); i++) -771 if (dest[i] == '@') -772 c++; -773 if (c>1) -774 return false; -775 -776 return true; -777 } +Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 766 of file modules.cpp. +.PP +.nf +767 { +768 const char* dest = mask.c_str(); +769 if (strchr(dest,'!')==0) +770 return false; +771 if (strchr(dest,'@')==0) +772 return false; +773 for (int i = 0; i < strlen(dest); i++) +774 if (dest[i] < 32) +775 return false; +776 for (int i = 0; i < strlen(dest); i++) +777 if (dest[i] > 126) +778 return false; +779 int c = 0; +780 for (int i = 0; i < strlen(dest); i++) +781 if (dest[i] == '!') +782 c++; +783 if (c>1) +784 return false; +785 c = 0; +786 for (int i = 0; i < strlen(dest); i++) +787 if (dest[i] == '@') +788 c++; +789 if (c>1) +790 return false; +791 +792 return true; +793 } .fi .SS "\fBchanrec\fP * Server::JoinUserToChannel (\fBuserrec\fP * user, std::string cname, std::string key)\fC [virtual]\fP" .PP -Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 442 of file modules.cpp. +Forces a user to join a channel. This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.Definition at line 447 of file modules.cpp. .PP .nf -443 { -444 return add_channel(user,cname.c_str(),key.c_str(),true); -445 } +448 { +449 return add_channel(user,cname.c_str(),key.c_str(),false); +450 } .fi .SS "void Server::Log (int level, std::string s)\fC [virtual]\fP" .PP -Writes a log string. This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.Definition at line 492 of file modules.cpp. +Writes a log string. This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.Definition at line 489 of file modules.cpp. .PP .nf -493 { -494 log(level,'%s',s.c_str()); -495 } +490 { +491 log(level,'%s',s.c_str()); +492 } .fi .SS "bool Server::MatchText (std::string sliteral, std::string spattern)\fC [virtual]\fP" .PP -Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 429 of file modules.cpp. +Matches text against a glob pattern. Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.Definition at line 434 of file modules.cpp. .PP .nf -430 { -431 char literal[MAXBUF],pattern[MAXBUF]; -432 strlcpy(literal,sliteral.c_str(),MAXBUF); -433 strlcpy(pattern,spattern.c_str(),MAXBUF); -434 return match(literal,pattern); -435 } +435 { +436 char literal[MAXBUF],pattern[MAXBUF]; +437 strlcpy(literal,sliteral.c_str(),MAXBUF); +438 strlcpy(pattern,spattern.c_str(),MAXBUF); +439 return match(literal,pattern); +440 } .fi .SS "bool Server::MeshCheckChan (\fBchanrec\fP * c, std::string servername)\fC [virtual]\fP" .PP -This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 805 of file modules.cpp. +This function is used to check if any users on channel c are on server servername. This is used internally by PRIVMSG etc. You should not need to use it.Definition at line 821 of file modules.cpp. .PP .nf -806 { -807 if (c) -808 { -809 return ChanAnyOnThisServer(c,(char*)servername.c_str()); -810 } -811 else return false; -812 } +822 { +823 if (c) +824 { +825 return ChanAnyOnThisServer(c,(char*)servername.c_str()); +826 } +827 else return false; +828 } .fi .SS "bool Server::MeshCheckCommon (\fBuserrec\fP * u, std::string servername)\fC [virtual]\fP" .PP -This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 814 of file modules.cpp. +This function is used to check if user u has any channels in common with users on servername. This is used internally by \fBServer::MeshSendCommon\fP. You should very rarely need to use it.Definition at line 830 of file modules.cpp. .PP .nf -815 { -816 if (u) -817 { -818 return CommonOnThisServer(u,(char*)servername.c_str()); -819 } -820 else return false; -821 } +831 { +832 if (u) +833 { +834 return CommonOnThisServer(u,(char*)servername.c_str()); +835 } +836 else return false; +837 } .fi .SS "void Server::MeshSendAll (std::string text)\fC [virtual]\fP" .PP -Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 779 of file modules.cpp. +Sends a line of text to all connected servers. If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.Definition at line 795 of file modules.cpp. .PP .nf -780 { -781 NetSendToAll((char*)text.c_str()); -782 } +796 { +797 NetSendToAll((char*)text.c_str()); +798 } .fi .SS "void Server::MeshSendAllAlive (std::string text)\fC [virtual]\fP" .PP -This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 790 of file modules.cpp. +This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable. Definition at line 806 of file modules.cpp. .PP .nf -791 { -792 NetSendToAllAlive((char*)text.c_str()); -793 } +807 { +808 NetSendToAllAlive((char*)text.c_str()); +809 } .fi .SS "void Server::MeshSendAllExcept (std::string target, std::string text)\fC [virtual]\fP" .PP -This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 800 of file modules.cpp. +This function sends to all servers EXCEPT the one you specify. You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.Definition at line 816 of file modules.cpp. .PP .nf -801 { -802 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); -803 } +817 { +818 NetSendToAllExcept(target.c_str(),(char*)text.c_str()); +819 } .fi .SS "void Server::MeshSendCommon (\fBuserrec\fP * user, std::string text)\fC [virtual]\fP" .PP -This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 784 of file modules.cpp. +This method sends a line of text to all servers who have users which share common channels with the user you provide. For example, if user A is on server A, and they are on channels #one and #two, and user B is on server B, and also on channel #one, but user C is on server C and on neither #one or #two, this function will cause the text to only be sent to server B. However, if server B is only reachable via C, it will route it to C (you do not have to worry about this routing, it is done transparently, but its good to know how things work!)Definition at line 800 of file modules.cpp. .PP .nf -785 { -786 if (user) -787 NetSendToCommon(user,(char*)text.c_str()); -788 } +801 { +802 if (user) +803 NetSendToCommon(user,(char*)text.c_str()); +804 } .fi .SS "void Server::MeshSendUnicast (std::string destination, std::string text)\fC [virtual]\fP" .PP -This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 795 of file modules.cpp. +This function sends a line of text directly to a server. If the server is not directly routable at this time, the server attempts to route text through the mesh.Definition at line 811 of file modules.cpp. .PP .nf -796 { -797 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); -798 } +812 { +813 NetSendToOne((char*)destination.c_str(),(char*)text.c_str()); +814 } .fi .SS "\fBchanrec\fP * Server::PartUserFromChannel (\fBuserrec\fP * user, std::string cname, std::string reason)\fC [virtual]\fP" .PP -Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 447 of file modules.cpp. +Forces a user to part a channel. This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.Definition at line 452 of file modules.cpp. .PP .nf -448 { -449 return del_channel(user,cname.c_str(),reason.c_str(),false); -450 } +453 { +454 return del_channel(user,cname.c_str(),reason.c_str(),false); +455 } .fi .SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP" .PP -This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.Definition at line 665 of file modules.cpp. +This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.Definition at line 681 of file modules.cpp. .PP -References ucrec::channel, userrec::chans, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. +References ucrec::channel, userrec::chans, userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, fd_ref_table, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. .PP .nf -666 { -667 zombie->fd = alive->fd; -668 alive->fd = FD_MAGIC_NUMBER; -669 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); -670 kill_link(alive,message.c_str()); -671 for (int i = 0; i != MAXCHANS; i++) -672 { -673 if (zombie->chans[i].channel != NULL) -674 { -675 if (zombie->chans[i].channel->name) -676 { -677 chanrec* Ptr = zombie->chans[i].channel; -678 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); -679 if (Ptr->topicset) -680 { -681 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); -682 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); -683 } -684 userlist(zombie,Ptr); -685 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); -686 //WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr)); -687 //WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created); -688 -689 } -690 } -691 } -692 -693 } +682 { +683 zombie->fd = alive->fd; +684 alive->fd = FD_MAGIC_NUMBER; +685 alive->ClearBuffer(); +686 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +687 kill_link(alive,message.c_str()); +688 fd_ref_table[zombie->fd] = zombie; +689 for (int i = 0; i != MAXCHANS; i++) +690 { +691 if (zombie->chans[i].channel != NULL) +692 { +693 if (zombie->chans[i].channel->name) +694 { +695 chanrec* Ptr = zombie->chans[i].channel; +696 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +697 if (Ptr->topicset) +698 { +699 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +700 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +701 } +702 userlist(zombie,Ptr); +703 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +704 +705 } +706 } +707 } +708 +709 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -842,65 +862,71 @@ Forces a user to quit with the specified reason. To the user, it will appear as .PP WARNING! .PP -Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 476 of file modules.cpp. -.PP -References userrec::nick, and send_network_quit(). +Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 474 of file modules.cpp. .PP .nf -477 { -478 send_network_quit(user->nick,reason.c_str()); -479 kill_link(user,reason.c_str()); -480 } +475 { +476 kill_link(user,reason.c_str()); +477 } .fi .SS "void Server::Send (int Socket, std::string s)\fC [virtual]\fP" .PP -Sends a line of text down a TCP/IP socket. This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.Definition at line 507 of file modules.cpp. +Sends a line of text down a TCP/IP socket. This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.Definition at line 504 of file modules.cpp. .PP .nf -508 { -509 Write(Socket,'%s',s.c_str()); -510 } +505 { +506 Write(Socket,'%s',s.c_str()); +507 } .fi .SS "void Server::SendChannel (\fBuserrec\fP * User, \fBchanrec\fP * Channel, std::string s, bool IncludeSender)\fC [virtual]\fP" .PP -Sends text from a user to a channel (mulicast). This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).Definition at line 536 of file modules.cpp. +Sends text from a user to a channel (mulicast). This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).Definition at line 538 of file modules.cpp. +.PP +.nf +539 { +540 if (IncludeSender) +541 { +542 WriteChannel(Channel,User,'%s',s.c_str()); +543 } +544 else +545 { +546 ChanExceptSender(Channel,User,'%s',s.c_str()); +547 } +548 } +.fi +.SS "void Server::SendChannelServerNotice (std::string ServName, \fBchanrec\fP * Channel, std::string text)\fC [virtual]\fP" +.PP +Writes text to a channel, but from a server, including all. This can be used to send server notices to a group of users.Definition at line 533 of file modules.cpp. .PP .nf -537 { -538 if (IncludeSender) -539 { -540 WriteChannel(Channel,User,'%s',s.c_str()); -541 } -542 else -543 { -544 ChanExceptSender(Channel,User,'%s',s.c_str()); -545 } -546 } +534 { +535 WriteChannelWithServ((char*)ServName.c_str(), Channel, '%s', text.c_str()); +536 } .fi .SS "void Server::SendCommon (\fBuserrec\fP * User, std::string text, bool IncludeSender)\fC [virtual]\fP" .PP -Sends text from a user to one or more channels (mulicast). This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.Definition at line 553 of file modules.cpp. +Sends text from a user to one or more channels (mulicast). This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.Definition at line 555 of file modules.cpp. .PP .nf -554 { -555 if (IncludeSender) -556 { -557 WriteCommon(User,'%s',text.c_str()); -558 } -559 else -560 { -561 WriteCommonExcept(User,'%s',text.c_str()); -562 } -563 } +556 { +557 if (IncludeSender) +558 { +559 WriteCommon(User,'%s',text.c_str()); +560 } +561 else +562 { +563 WriteCommonExcept(User,'%s',text.c_str()); +564 } +565 } .fi .SS "void Server::SendFrom (int Socket, \fBuserrec\fP * User, std::string s)\fC [virtual]\fP" .PP -Sends text from a user to a socket. This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)Definition at line 517 of file modules.cpp. +Sends text from a user to a socket. This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)Definition at line 514 of file modules.cpp. .PP .nf -518 { -519 WriteFrom(Socket,User,'%s',s.c_str()); -520 } +515 { +516 WriteFrom(Socket,User,'%s',s.c_str()); +517 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -918,32 +944,32 @@ modes[2] = user->nick; .PP Srv->SendMode(modes,3,user); .PP -The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!Definition at line 502 of file modules.cpp. +The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!Definition at line 499 of file modules.cpp. .PP References server_mode(). .PP .nf -503 { -504 server_mode(parameters,pcnt,user); -505 } +500 { +501 server_mode(parameters,pcnt,user); +502 } .fi .SS "void Server::SendOpers (std::string s)\fC [virtual]\fP" .PP -Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 424 of file modules.cpp. +Sends text to all opers. This method sends a server notice to all opers with the usermode +s.Definition at line 429 of file modules.cpp. .PP .nf -425 { -426 WriteOpers('%s',s.c_str()); -427 } +430 { +431 WriteOpers('%s',s.c_str()); +432 } .fi .SS "void Server::SendServ (int Socket, std::string s)\fC [virtual]\fP" .PP -Sends text from the server to a socket. This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)Definition at line 512 of file modules.cpp. +Sends text from the server to a socket. This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)Definition at line 509 of file modules.cpp. .PP .nf -513 { -514 WriteServ(Socket,'%s',s.c_str()); -515 } +510 { +511 WriteServ(Socket,'%s',s.c_str()); +512 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -955,23 +981,23 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 522 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 519 of file modules.cpp. .PP References connection::fd. .PP .nf -523 { -524 if (!Source) -525 { -526 // if source is NULL, then the message originates from the local server -527 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -528 } -529 else -530 { -531 // otherwise it comes from the user specified -532 WriteTo(Source,Dest,'%s',s.c_str()); -533 } -534 } +520 { +521 if (!Source) +522 { +523 // if source is NULL, then the message originates from the local server +524 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +525 } +526 else +527 { +528 // otherwise it comes from the user specified +529 WriteTo(Source,Dest,'%s',s.c_str()); +530 } +531 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -979,36 +1005,37 @@ Sends to all users matching a mode mask You must specify one or more usermodes a .PP Serv->SendToModeMask('xi', WM_OR, 'm00'); .PP -Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 437 of file modules.cpp. +Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.Definition at line 442 of file modules.cpp. .PP .nf -438 { -439 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -440 } +443 { +444 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +445 } .fi .SS "void Server::SendWallops (\fBuserrec\fP * User, std::string text)\fC [virtual]\fP" .PP -Sends a WALLOPS message. This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.Definition at line 565 of file modules.cpp. +Sends a WALLOPS message. This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.Definition at line 567 of file modules.cpp. .PP .nf -566 { -567 WriteWallOps(User,false,'%s',text.c_str()); -568 } +568 { +569 WriteWallOps(User,false,'%s',text.c_str()); +570 } .fi .SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP" .PP -Remove a user's connection to the irc server, but leave their client in existence in the user hash. When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.Definition at line 656 of file modules.cpp. +Remove a user's connection to the irc server, but leave their client in existence in the user hash. When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.Definition at line 671 of file modules.cpp. .PP -References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. +References userrec::ClearBuffer(), connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. .PP .nf -657 { -658 unsigned int old_fd = user->fd; -659 user->fd = FD_MAGIC_NUMBER; -660 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); -661 close(old_fd); -662 shutdown (old_fd,2); -663 } +672 { +673 unsigned int old_fd = user->fd; +674 user->fd = FD_MAGIC_NUMBER; +675 user->ClearBuffer(); +676 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +677 shutdown(old_fd,2); +678 close(old_fd); +679 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index bcdf74124..77581534f 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,17 +17,17 @@ StrHashComp \- .PP .SS "bool StrHashComp::operator() (const string & s1, const string & s2) const\fC [inline]\fP" .PP -Definition at line 146 of file modules.cpp. +Definition at line 147 of file modules.cpp. .PP .nf -147 { -148 char a[MAXBUF],b[MAXBUF]; -149 strlcpy(a,s1.c_str(),MAXBUF); -150 strlcpy(b,s2.c_str(),MAXBUF); -151 strlower(a); -152 strlower(b); -153 return (strcasecmp(a,b) == 0); -154 } +148 { +149 char a[MAXBUF],b[MAXBUF]; +150 strlcpy(a,s1.c_str(),MAXBUF); +151 strlcpy(b,s2.c_str(),MAXBUF); +152 strlower(a); +153 strlower(b); +154 return (strcasecmp(a,b) == 0); +155 } .fi diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index 2c0ed2ead..a6a4e7a22 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -49,10 +49,10 @@ Definition at line 111 of file modules.h. .PP .SS "Version::Version (int major, int minor, int revision, int build, int flags)" .PP -Definition at line 302 of file modules.cpp. +Definition at line 300 of file modules.cpp. .PP .nf -302 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; +300 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index caad829bc..9bf0c83b7 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index e350adf0e..4dba12a85 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/base.h.3 b/docs/man/man3/base.h.3 index bceb6d795..2b198832a 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/channels.cpp.3 b/docs/man/man3/channels.cpp.3 index c1cbe6acb..2d62f95bc 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -257,6 +257,8 @@ Definition at line 91 of file channels.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP Definition at line 78 of file channels.cpp. +.PP +Referenced by Server::GetUsers(). .SS "FILE* \fBlog_file\fP" .PP Definition at line 105 of file channels.cpp. @@ -271,7 +273,7 @@ Definition at line 88 of file channels.cpp. Definition at line 103 of file channels.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1032 of file modules.cpp. +Definition at line 1048 of file modules.cpp. .PP Referenced by Server::FindModule(). .SS "std::vector \fBmodule_names\fP" @@ -324,7 +326,7 @@ Definition at line 86 of file channels.cpp. .PP Definition at line 107 of file channels.cpp. .PP -Referenced by serverrec::serverrec(). +Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "int \fBUDPportCount\fP" .PP Definition at line 96 of file channels.cpp. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index 5d6c7051e..77dd2caea 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 80b5db18d..8dcd2fade 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -254,6 +254,8 @@ Obrain the internal reference list The internal reference list contains a list o .PP References internal_userlist. .PP +Referenced by Server::GetUsers(). +.PP .nf 241 { 242 return &internal_userlist; @@ -292,7 +294,7 @@ References custom_modes, DEBUG, and SetCustomModeParam(). .nf 126 { 127 if (mode_on) { -128 char m[3]; +128 static char m[3]; 129 m[0] = mode; 130 m[1] = '\0'; 131 if (!strchr(this->custom_modes,mode)) diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index aa5dbd61e..da70de3fc 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/command_t.3 b/docs/man/man3/command_t.3 index b826865e6..9fa5a044c 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/commands.h.3 b/docs/man/man3/commands.h.3 index 7f72427e7..ac7a2a429 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index ca2a69951..7b1f51029 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -53,10 +53,6 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .RI "bool \fBAddIncoming\fP (int \fBfd\fP, char *targethost, int sourceport)" .br .RI "\fIAdd an incoming connection to the connection pool. \fP" -.ti -1c -.RI "long \fBGenKey\fP ()" -.br -.RI "\fIThis function is deprecated and may be removed in a later alpha/beta. \fP" .in -1c .SS "Public Attributes" @@ -140,7 +136,7 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .in -1c .SH "Detailed Description" .PP -Please note: classes serverrec and userrec both inherit from class connection. Definition at line 178 of file connection.h. +Please note: classes serverrec and userrec both inherit from class connection. Definition at line 210 of file connection.h. .SH "Constructor & Destructor Documentation" .PP .SS "connection::connection ()" @@ -160,9 +156,6 @@ Create a listening socket on 'host' using port number 'p'. .SS "\fBircd_connector\fP* connection::FindHost (std::string host)" .PP Find the \fBircd_connector\fP oject related to a certain servername given in 'host'. -.SS "long connection::GenKey ()" -.PP -This function is deprecated and may be removed in a later alpha/beta. .SS "bool connection::MeshCookie (char * targethost, int port, unsigned long cookie, char * servername)" .PP Begin an outbound mesh link to another ircd on a network you are already an authenticated member of. @@ -179,91 +172,91 @@ Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnecti .PP .SS "long \fBconnection::bytes_in\fP" .PP -Stats counter for bytes inbound. Definition at line 199 of file connection.h. +Stats counter for bytes inbound. Definition at line 231 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::bytes_out\fP" .PP -Stats counter for bytes outbound. Definition at line 203 of file connection.h. +Stats counter for bytes outbound. Definition at line 235 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::cmds_in\fP" .PP -Stats counter for commands inbound. Definition at line 207 of file connection.h. +Stats counter for commands inbound. Definition at line 239 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::cmds_out\fP" .PP -Stats counter for commands outbound. Definition at line 211 of file connection.h. +Stats counter for commands outbound. Definition at line 243 of file connection.h. .PP Referenced by userrec::userrec(). .SS "std::vector<\fBircd_connector\fP> \fBconnection::connectors\fP" .PP -With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 258 of file connection.h. +With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 290 of file connection.h. .SS "int \fBconnection::fd\fP" .PP -File descriptor of the connection. Definition at line 183 of file connection.h. +File descriptor of the connection. Definition at line 215 of file connection.h. .PP Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). .SS "bool \fBconnection::haspassed\fP" .PP -True if server/user has authenticated, false if otherwise. Definition at line 215 of file connection.h. +True if server/user has authenticated, false if otherwise. Definition at line 247 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::host\fP[256]" .PP -Hostname of connection. Not used if this is a serverrecDefinition at line 187 of file connection.h. +Hostname of connection. Not used if this is a serverrecDefinition at line 219 of file connection.h. .PP Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo(). .SS "time_t \fBconnection::idle_lastmsg\fP" .PP -Time that the connection last sent data, used to calculate idle time. Definition at line 241 of file connection.h. +Time that the connection last sent data, used to calculate idle time. Definition at line 273 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::inbuf\fP[MAXBUF]" .PP -Inbuf of connection. Only used for userrecDefinition at line 195 of file connection.h. +Inbuf of connection. Only used for userrecDefinition at line 227 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::internal_addr\fP[MAXBUF]" .PP -Unused, will be removed in a future alpha/beta. Definition at line 249 of file connection.h. +Unused, will be removed in a future alpha/beta. Definition at line 281 of file connection.h. .SS "int \fBconnection::internal_port\fP" .PP -Unused, will be removed in a future alpha/beta. Definition at line 253 of file connection.h. +Unused, will be removed in a future alpha/beta. Definition at line 285 of file connection.h. .SS "char \fBconnection::ip\fP[32]" .PP -IP of connection. Reserved for future use.Definition at line 191 of file connection.h. +IP of connection. Reserved for future use.Definition at line 223 of file connection.h. .PP Referenced by userrec::userrec(). .SS "time_t \fBconnection::lastping\fP" .PP -Time the connection was last pinged. Definition at line 233 of file connection.h. +Time the connection was last pinged. Definition at line 265 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "time_t \fBconnection::nping\fP" .PP -Used by PING checks with clients. Definition at line 245 of file connection.h. +Used by PING checks with clients. Definition at line 277 of file connection.h. .PP Referenced by userrec::userrec(). .SS "int \fBconnection::port\fP" .PP -Port number For a userrec, this is the port they connected to the network on. For a serverrec this is the current listening port of the serverrec object.Definition at line 221 of file connection.h. +Port number For a userrec, this is the port they connected to the network on. For a serverrec this is the current listening port of the serverrec object.Definition at line 253 of file connection.h. .PP Referenced by userrec::userrec(). .SS "int \fBconnection::registered\fP" .PP -Used by userrec to indicate the registration status of the connection. Definition at line 225 of file connection.h. +Used by userrec to indicate the registration status of the connection. Definition at line 257 of file connection.h. .PP Referenced by userrec::userrec(). .SS "time_t \fBconnection::signon\fP" .PP -Time the connection was created, set in the constructor. Definition at line 237 of file connection.h. +Time the connection was created, set in the constructor. Definition at line 269 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). .SS "short int \fBconnection::state\fP" .PP -Reserved for future use. Definition at line 229 of file connection.h. +Reserved for future use. Definition at line 261 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index b0d6374fc..492693091 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ctables.h.3 b/docs/man/man3/ctables.h.3 index 6541dbb1a..194ed71d7 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/dns.h.3 b/docs/man/man3/dns.h.3 index 3b7155194..1f6765422 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/dns_ip4list.3 b/docs/man/man3/dns_ip4list.3 index f850d584a..eeb799dea 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index 5c9e3016b..7e39dd73d 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -74,15 +74,27 @@ Inherits \fBExtensible\fP. .ti -1c .RI "void \fBAddBuffer\fP (std::string a)" .br +.RI "\fIThis method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer. \fP" .ti -1c .RI "bool \fBBufferIsComplete\fP ()" .br +.RI "\fIThis method returns true if the buffer contains at least one carriage return character, e.g. \fP" .ti -1c .RI "void \fBClearBuffer\fP ()" .br +.RI "\fIThis method clears the server's buffer by setting it to an empty string. \fP" .ti -1c .RI "std::string \fBGetBuffer\fP ()" .br +.RI "\fIThis method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok(). \fP" +.ti -1c +.RI "void \fBSetVersionString\fP (std::string newversion)" +.br +.RI "\fIThis method sets the version string of the remote server. \fP" +.ti -1c +.RI "std::string \fBGetVersionString\fP ()" +.br +.RI "\fIThis method returns the version string of the remote server. \fP" .in -1c .SS "Public Attributes" @@ -90,7 +102,9 @@ Inherits \fBExtensible\fP. .ti -1c .RI "std::string \fBircdbuffer\fP" .br -.RI "\fIIRCD Buffer for input characters, holds one line. \fP" +.RI "\fIIRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a +.br + seperator. \fP" .ti -1c .RI "char \fBhost\fP [MAXBUF]" .br @@ -135,6 +149,10 @@ Inherits \fBExtensible\fP. .RI "int \fBstate\fP" .br .RI "\fIState. \fP" +.ti -1c +.RI "std::string \fBversion\fP" +.br +.RI "\fIThis string holds the ircd's version response. \fP" .in -1c .SH "Detailed Description" .PP @@ -147,15 +165,19 @@ Definition at line 54 of file connection.h. .PP .SS "void ircd_connector::AddBuffer (std::string a)" .PP +This method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer. It is the sending server's responsibility to ensure sent data is kept within reasonable quanities. .SS "bool ircd_connector::BufferIsComplete ()" .PP +This method returns true if the buffer contains at least one carriage return character, e.g. one line can be read from the buffer successfully. .SS "void ircd_connector::ClearBuffer ()" .PP +This method clears the server's buffer by setting it to an empty string. .SS "void ircd_connector::CloseConnection ()" .PP Close the connection by calling close() on its file descriptor This function call updates no other data. .SS "std::string ircd_connector::GetBuffer ()" .PP +This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok(). .SS "std::string ircd_connector::GetDescription ()" .PP Get the server description of this connection. @@ -174,6 +196,9 @@ Get the port number being used for this connection If the connection is outbound .SS "int ircd_connector::GetState ()" .PP Get the state flags for this connection. +.SS "std::string ircd_connector::GetVersionString ()" +.PP +This method returns the version string of the remote server. If the server has no version string an empty string is returned. .SS "bool ircd_connector::MakeOutboundConnection (char * newhost, int newport)" .PP Create an outbound connection to a listening socket. @@ -198,6 +223,9 @@ Set the port used by this connection. .SS "void ircd_connector::SetState (int state)" .PP Set the state flags for this connection. +.SS "void ircd_connector::SetVersionString (std::string newversion)" +.PP +This method sets the version string of the remote server. .SH "Member Data Documentation" .PP .SS "sockaddr_in \fBircd_connector::addr\fP\fC [private]\fP" @@ -211,22 +239,27 @@ Sockaddr of the outbound ip and port. Definition at line 59 of file connection.h File descriptor of the connection. Definition at line 63 of file connection.h. .SS "char \fBircd_connector::host\fP[MAXBUF]" .PP -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 94 of file connection.h. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 99 of file connection.h. .SS "std::string \fBircd_connector::ircdbuffer\fP" .PP -IRCD Buffer for input characters, holds one line. Definition at line 87 of file connection.h. +IRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a +.br + seperator. Definition at line 92 of file connection.h. .SS "int \fBircd_connector::port\fP" .PP -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 100 of file connection.h. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. Definition at line 105 of file connection.h. .SS "std::vector \fBircd_connector::routes\fP" .PP -\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. Definition at line 106 of file connection.h. +\fBServer\fP names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. Definition at line 111 of file connection.h. .SS "std::string \fBircd_connector::servername\fP\fC [private]\fP" .PP \fBServer\fP name. Definition at line 67 of file connection.h. .SS "int \fBircd_connector::state\fP\fC [private]\fP" .PP State. STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTEDDefinition at line 76 of file connection.h. +.SS "std::string \fBircd_connector::version\fP\fC [private]\fP" +.PP +This string holds the ircd's version response. Definition at line 84 of file connection.h. .SH "Author" .PP diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 127926d3e..21aa67806 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -81,7 +81,7 @@ message.h \- .RI "void \fBTidyBan\fP (char *ban)" .br .ti -1c -.RI "char * \fBchlist\fP (\fBuserrec\fP *user)" +.RI "char * \fBchlist\fP (\fBuserrec\fP *user, \fBuserrec\fP *source)" .br .ti -1c .RI "void \fBsend_network_quit\fP (const char *nick, const char *reason)" @@ -99,7 +99,7 @@ Referenced by Server::ChangeHost(). .SS "void ChangeName (\fBuserrec\fP * user, const char * gecos)" .PP Referenced by Server::ChangeGECOS(). -.SS "char* chlist (\fBuserrec\fP * user)" +.SS "char* chlist (\fBuserrec\fP * user, \fBuserrec\fP * source)" .PP .SS "void chop (char * str)" .PP @@ -115,14 +115,14 @@ Referenced by Server::CommonChannels(). .PP .SS "int has_channel (\fBuserrec\fP * u, \fBchanrec\fP * c)" .PP -Referenced by Server::GetUsers(), and Server::IsOnChannel(). +Referenced by Server::IsOnChannel(). .SS "bool hasumode (\fBuserrec\fP * user, char mode)" .PP .SS "int isident (const char * n)" .PP .SS "int isnick (const char * n)" .PP -Referenced by Server::GetUsers(), and Server::IsNick(). +Referenced by Server::IsNick(). .SS "void NonBlocking (int s)" .PP .SS "void safedelete (\fBuserrec\fP * p)" @@ -131,7 +131,6 @@ Referenced by Server::GetUsers(), and Server::IsNick(). .PP .SS "void send_network_quit (const char * nick, const char * reason)" .PP -Referenced by Server::QuitUser(). .SS "void TidyBan (char * ban)" .PP .SS "void tidystring (char * str)" diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index e6a1628c1..f4a8d3254 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/modules.cpp.3 b/docs/man/man3/modules.cpp.3 index cde9a3b91..2bfbe387e 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -266,6 +266,9 @@ modules.cpp \- .RI "FILE * \fBlog_file\fP" .br .ti -1c +.RI "\fBuserrec\fP * \fBfd_ref_table\fP [65536]" +.br +.ti -1c .RI "\fBuser_hash\fP \fBclientlist\fP" .br .ti -1c @@ -299,56 +302,55 @@ Definition at line 59 of file modules.cpp. .PP .SS "typedef nspace::hash_map, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 177 of file modules.cpp. +Definition at line 178 of file modules.cpp. .SS "typedef nspace::hash_map, \fBStrHashComp\fP> \fBchan_hash\fP" .PP -Definition at line 176 of file modules.cpp. +Definition at line 177 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 178 of file modules.cpp. +Definition at line 179 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 204 of file modules.cpp. +Definition at line 205 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 205 of file modules.cpp. +Definition at line 206 of file modules.cpp. .PP Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "typedef nspace::hash_map, \fBStrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 175 of file modules.cpp. +Definition at line 176 of file modules.cpp. .SH "Function Documentation" .PP .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)" .PP -Definition at line 277 of file modules.cpp. +Definition at line 275 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -278 { -279 if (ModeDefined(modechar,type)) { -280 return false; -281 } -282 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -283 return true; -284 } +276 { +277 if (ModeDefined(modechar,type)) { +278 return false; +279 } +280 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +281 return true; +282 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 211 of file modules.cpp. +Definition at line 212 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -212 { -213 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +213 { 214 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) 215 { 216 if ((i->modechar == modechar) && (i->type == type)) @@ -361,98 +363,96 @@ Referenced by DoAddExtendedMode(). .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 264 of file modules.cpp. +Definition at line 262 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -265 { -266 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -267 { -268 if ((i->modechar == modechar) && (i->type == type)) -269 { -270 return i->params_when_off; -271 } -272 } -273 return 0; -274 } +263 { +264 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +265 { +266 if ((i->modechar == modechar) && (i->type == type)) +267 { +268 return i->params_when_off; +269 } +270 } +271 return 0; +272 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 251 of file modules.cpp. +Definition at line 249 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -252 { -253 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -254 { -255 if ((i->modechar == modechar) && (i->type == type)) -256 { -257 return i->params_when_on; -258 } -259 } -260 return 0; -261 } +250 { +251 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +252 { +253 if ((i->modechar == modechar) && (i->type == type)) +254 { +255 return i->params_when_on; +256 } +257 } +258 return 0; +259 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 237 of file modules.cpp. +Definition at line 236 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP .nf -238 { -239 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -240 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -241 { -242 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) -243 { -244 return true; -245 } -246 } -247 return false; -248 } +237 { +238 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +239 { +240 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +241 { +242 return true; +243 } +244 } +245 return false; +246 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP Definition at line 224 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP .nf 225 { -226 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -227 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -228 { -229 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) -230 { -231 return true; -232 } -233 } -234 return false; -235 } +226 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +227 { +228 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +229 { +230 return true; +231 } +232 } +233 return false; +234 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 287 of file modules.cpp. +Definition at line 285 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -288 { -289 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -290 { -291 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -292 { -293 i->list = true; -294 return; -295 } -296 } -297 return; -298 } +286 { +287 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +288 { +289 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +290 { +291 i->list = true; +292 return; +293 } +294 } +295 return; +296 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -475,15 +475,13 @@ Definition at line 103 of file modules.cpp. Definition at line 97 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 182 of file modules.cpp. +Definition at line 183 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 181 of file modules.cpp. -.PP -Referenced by Server::GetUsers(). +Definition at line 182 of file modules.cpp. .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 184 of file modules.cpp. +Definition at line 185 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP Definition at line 104 of file modules.cpp. @@ -504,7 +502,7 @@ Definition at line 77 of file modules.cpp. Definition at line 83 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 208 of file modules.cpp. +Definition at line 209 of file modules.cpp. .PP Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "std::vector<\fBircd_module\fP*> factory" @@ -513,9 +511,14 @@ Definition at line 66 of file modules.cpp. .SS "std::vector \fBfd_reap\fP" .PP Definition at line 94 of file modules.cpp. +.SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]" +.PP +Definition at line 110 of file modules.cpp. +.PP +Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 187 of file modules.cpp. +Definition at line 188 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP Definition at line 81 of file modules.cpp. @@ -533,7 +536,7 @@ Definition at line 91 of file modules.cpp. Definition at line 106 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1032 of file modules.cpp. +Definition at line 1048 of file modules.cpp. .SS "std::vector \fBmodule_names\fP" .PP Definition at line 95 of file modules.cpp. @@ -542,7 +545,7 @@ Definition at line 95 of file modules.cpp. Definition at line 65 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 185 of file modules.cpp. +Definition at line 186 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP Definition at line 79 of file modules.cpp. @@ -569,7 +572,7 @@ Definition at line 82 of file modules.cpp. Definition at line 78 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 186 of file modules.cpp. +Definition at line 187 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP Definition at line 80 of file modules.cpp. @@ -590,7 +593,7 @@ Definition at line 68 of file modules.cpp. Definition at line 99 of file modules.cpp. .SS "\fBuser_hash\fP \fBwhowas\fP" .PP -Definition at line 183 of file modules.cpp. +Definition at line 184 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP Definition at line 87 of file modules.cpp. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index 5b3be2f2a..4be3d09c9 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -230,29 +230,29 @@ Referenced by Module::OnAccessCheck(). Definition at line 38 of file modules.h. .SS "#define CONF_FILE_NOT_FOUND 0x000200" .PP -Definition at line 1088 of file modules.h. +Definition at line 1138 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 1085 of file modules.h. +Definition at line 1135 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 1086 of file modules.h. +Definition at line 1136 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 1087 of file modules.h. +Definition at line 1137 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" .PP Definition at line 23 of file modules.h. .PP -Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DecUserCounter(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IncUserCounter(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). +Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DecUserCounter(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IncUserCounter(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). .SS "#define DEFAULT 30" .PP Definition at line 25 of file modules.h. @@ -333,7 +333,7 @@ Low level definition of a \fBFileReader\fP classes file cache area. Definition a Referenced by FileReader::FileReader(), and FileReader::LoadFile(). .SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP" .PP -Definition at line 1254 of file modules.h. +Definition at line 1304 of file modules.h. .SS "typedef \fBfile_cache\fP \fBstring_list\fP" .PP Definition at line 68 of file modules.h. diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index 7cfff7689..c0b5d7ec0 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 index 2f257e697..f4d292abd 100644 --- a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 +++ b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< in_addr >" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,14 +20,14 @@ nspace::nspace::hash< in_addr > \- .PP .SS "size_t nspace::hash< in_addr >::operator() (const struct in_addr & a) const\fC [inline]\fP" .PP -Definition at line 119 of file modules.cpp. +Definition at line 120 of file modules.cpp. .PP .nf -120 { -121 size_t q; -122 memcpy(&q,&a,sizeof(size_t)); -123 return q; -124 } +121 { +122 size_t q; +123 memcpy(&q,&a,sizeof(size_t)); +124 return q; +125 } .fi diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index dce6079d6..2ed553162 100644 --- a/docs/man/man3/nspace_nspace_hash_ string _.3 +++ b/docs/man/man3/nspace_nspace_hash_ string _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< string >" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,16 +20,16 @@ nspace::nspace::hash< string > \- .PP .SS "size_t nspace::hash< string >::operator() (const string & s) const\fC [inline]\fP" .PP -Definition at line 132 of file modules.cpp. +Definition at line 133 of file modules.cpp. .PP .nf -133 { -134 char a[MAXBUF]; -135 static struct hash strhash; -136 strlcpy(a,s.c_str(),MAXBUF); -137 strlower(a); -138 return strhash(a); -139 } +134 { +135 char a[MAXBUF]; +136 static struct hash strhash; +137 strlcpy(a,s.c_str(),MAXBUF); +138 strlower(a); +139 return strhash(a); +140 } .fi diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 3517dc84d..c5b428a4a 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index ef1e28d83..41fd8df92 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.h.3 b/docs/man/man3/servers.h.3 index 13cf46371..b486aef53 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 107c01c59..dd1a4d72e 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 5f9098e25..168036a35 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 2e78c5206..7e5c3ea11 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -45,6 +45,22 @@ Inherits \fBconnection\fP. .RI "bool \fBHasPermission\fP (char *command)" .br .RI "\fIReturns true or false for if a user can execute a privilaged oper command. \fP" +.ti -1c +.RI "bool \fBAddBuffer\fP (std::string a)" +.br +.RI "\fIThis method adds data to the buffer of the user. \fP" +.ti -1c +.RI "bool \fBBufferIsReady\fP ()" +.br +.RI "\fIThis method returns true if the buffer contains at least one carriage return character (e.g. \fP" +.ti -1c +.RI "void \fBClearBuffer\fP ()" +.br +.RI "\fIThis function clears the entire buffer by setting it to an empty string. \fP" +.ti -1c +.RI "std::string \fBGetBuffer\fP ()" +.br +.RI "\fIThis method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. \fP" .in -1c .SS "Public Attributes" @@ -108,6 +124,20 @@ Inherits \fBconnection\fP. .RI "char \fBpassword\fP [MAXBUF]" .br .RI "\fIPassword specified by the user when they registered. \fP" +.ti -1c +.RI "std::string \fBrecvq\fP" +.br +.RI "\fIUser's receive queue. \fP" +.ti -1c +.RI "long \fBlines_in\fP" +.br +.RI "\fIFlood counters. \fP" +.ti -1c +.RI "time_t \fBreset_due\fP" +.br +.ti -1c +.RI "long \fBthreshold\fP" +.br .in -1c .SS "Private Attributes" @@ -123,14 +153,14 @@ Holds all information about a user This class stores all information about a use Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname. .PP -Definition at line 93 of file users.h. +Definition at line 98 of file users.h. .SH "Constructor & Destructor Documentation" .PP .SS "userrec::userrec ()" .PP Definition at line 28 of file users.cpp. .PP -References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. +References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, result, server, connection::signon, TIME, timeout, and ucrec::uc_modes. .PP .nf 29 { @@ -147,246 +177,344 @@ References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, 40 strcpy(server,''); 41 strcpy(awaymsg,''); 42 strcpy(oper,''); -43 fd = lastping = signon = idle_lastmsg = nping = registered = 0; -44 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; -45 haspassed = false; -46 dns_done = false; -47 strcpy(result,''); -48 for (int i = 0; i < MAXCHANS; i++) -49 { -50 this->chans[i].channel = NULL; -51 this->chans[i].uc_modes = 0; -52 } -53 invites.clear(); -54 } +43 reset_due = TIME; +44 lines_in = 0; +45 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +46 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +47 haspassed = false; +48 dns_done = false; +49 recvq = ''; +50 strcpy(result,''); +51 for (int i = 0; i < MAXCHANS; i++) +52 { +53 this->chans[i].channel = NULL; +54 this->chans[i].uc_modes = 0; +55 } +56 invites.clear(); +57 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 178 of file users.h. +Definition at line 195 of file users.h. .PP .nf -178 { } +195 { } .fi .SH "Member Function Documentation" .PP +.SS "bool userrec::AddBuffer (std::string a)" +.PP +This method adds data to the buffer of the user. The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted.Definition at line 169 of file users.cpp. +.PP +References recvq. +.PP +.nf +170 { +171 std::string b = ''; +172 for (int i = 0; i < a.length(); i++) +173 if ((a[i] != '\r') && (a[i] != '\0') && (a[i] != 7)) +174 b = b + a[i]; +175 std::stringstream stream(recvq); +176 stream << b; +177 recvq = stream.str(); +178 int i = 0; +179 // count the size of the first line in the buffer. +180 while (i < recvq.length()) +181 { +182 if (recvq[i++] == '\n') +183 break; +184 } +185 // return false if we've had more than 600 characters WITHOUT +186 // a carriage return (this is BAD, drop the socket) +187 return (i < 600); +188 } +.fi +.SS "bool userrec::BufferIsReady ()" +.PP +This method returns true if the buffer contains at least one carriage return character (e.g. one complete line may be read)Definition at line 190 of file users.cpp. +.PP +References recvq. +.PP +.nf +191 { +192 for (int i = 0; i < recvq.length(); i++) +193 if (recvq[i] == '\n') +194 return true; +195 return false; +196 } +.fi +.SS "void userrec::ClearBuffer ()" +.PP +This function clears the entire buffer by setting it to an empty string. Definition at line 198 of file users.cpp. +.PP +References recvq. +.PP +Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). +.PP +.nf +199 { +200 recvq = ''; +201 } +.fi +.SS "std::string userrec::GetBuffer ()" +.PP +This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use \fBBufferIsReady()\fP to check if it is ok to read the buffer before calling \fBGetBuffer()\fP.Definition at line 203 of file users.cpp. +.PP +References recvq. +.PP +.nf +204 { +205 if (recvq == '') +206 return ''; +207 char* line = (char*)recvq.c_str(); +208 std::string ret = ''; +209 while ((*line != '\n') && (strlen(line))) +210 { +211 ret = ret + *line; +212 line++; +213 } +214 if ((*line == '\n') || (*line == '\r')) +215 line++; +216 recvq = line; +217 return ret; +218 } +.fi .SS "char * userrec::GetFullHost ()\fC [virtual]\fP" .PP -Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 58 of file users.cpp. +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 61 of file users.cpp. .PP References dhost, ident, nick, and result. .PP .nf -59 { -60 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -61 return result; -62 } +62 { +63 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +64 return result; +65 } .fi .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP" .PP -Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 65 of file users.cpp. +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 68 of file users.cpp. .PP References connection::host, ident, nick, and result. .PP .nf -66 { -67 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -68 return result; -69 } +69 { +70 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +71 return result; +72 } .fi .SS "bool userrec::HasPermission (char * command)" .PP -Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 114 of file users.cpp. +Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 117 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -115 { -116 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -117 char* mycmd; -118 char* savept; -119 char* savept2; -120 -121 // are they even an oper at all? -122 if (strchr(this->modes,'o')) -123 { -124 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -125 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -126 { -127 ConfValue('type','name',j,TypeName,&config_f); -128 if (!strcmp(TypeName,this->oper)) -129 { -130 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -131 ConfValue('type','classes',j,Classes,&config_f); -132 char* myclass = strtok_r(Classes,' ',&savept); -133 while (myclass) -134 { -135 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -136 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -137 { -138 ConfValue('class','name',k,ClassName,&config_f); -139 if (!strcmp(ClassName,myclass)) -140 { -141 ConfValue('class','commands',k,CommandList,&config_f); -142 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -143 -144 -145 mycmd = strtok_r(CommandList,' ',&savept2); -146 while (mycmd) -147 { -148 if (!strcasecmp(mycmd,command)) -149 { -150 log(DEBUG,'*** Command %s found, returning true',command); -151 return true; -152 } -153 mycmd = strtok_r(NULL,' ',&savept2); -154 } -155 } -156 } -157 myclass = strtok_r(NULL,' ',&savept); -158 } -159 } -160 } -161 } -162 return false; -163 } +118 { +119 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +120 char* mycmd; +121 char* savept; +122 char* savept2; +123 +124 // are they even an oper at all? +125 if (strchr(this->modes,'o')) +126 { +127 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +128 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +129 { +130 ConfValue('type','name',j,TypeName,&config_f); +131 if (!strcmp(TypeName,this->oper)) +132 { +133 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +134 ConfValue('type','classes',j,Classes,&config_f); +135 char* myclass = strtok_r(Classes,' ',&savept); +136 while (myclass) +137 { +138 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +139 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +140 { +141 ConfValue('class','name',k,ClassName,&config_f); +142 if (!strcmp(ClassName,myclass)) +143 { +144 ConfValue('class','commands',k,CommandList,&config_f); +145 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); +146 +147 +148 mycmd = strtok_r(CommandList,' ',&savept2); +149 while (mycmd) +150 { +151 if (!strcasecmp(mycmd,command)) +152 { +153 log(DEBUG,'*** Command %s found, returning true',command); +154 return true; +155 } +156 mycmd = strtok_r(NULL,' ',&savept2); +157 } +158 } +159 } +160 myclass = strtok_r(NULL,' ',&savept); +161 } +162 } +163 } +164 } +165 return false; +166 } .fi .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP" .PP -Adds a channel to a users invite list (invites them to a channel). Definition at line 85 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 88 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -86 { -87 Invited i; -88 strlcpy(i.channel,channel,CHANMAX); -89 invites.push_back(i); -90 } +89 { +90 Invited i; +91 strlcpy(i.channel,channel,CHANMAX); +92 invites.push_back(i); +93 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 71 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 74 of file users.cpp. .PP References invites. .PP .nf -72 { -73 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -74 { -75 if (i->channel) { -76 if (!strcasecmp(i->channel,channel)) -77 { -78 return true; -79 } -80 } -81 } -82 return false; -83 } +75 { +76 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +77 { +78 if (i->channel) { +79 if (!strcasecmp(i->channel,channel)) +80 { +81 return true; +82 } +83 } +84 } +85 return false; +86 } .fi .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP" .PP -Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 92 of file users.cpp. +Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 95 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -93 { -94 log(DEBUG,'Removing invites'); -95 if (channel) -96 { -97 if (invites.size()) -98 { -99 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -100 { -101 if (i->channel) -102 { -103 if (!strcasecmp(i->channel,channel)) -104 { -105 invites.erase(i); -106 return; -107 } -108 } -109 } -110 } -111 } -112 } +96 { +97 log(DEBUG,'Removing invites'); +98 if (channel) +99 { +100 if (invites.size()) +101 { +102 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +103 { +104 if (i->channel) +105 { +106 if (!strcasecmp(i->channel,channel)) +107 { +108 invites.erase(i); +109 return; +110 } +111 } +112 } +113 } +114 } +115 } .fi .SH "Member Data Documentation" .PP .SS "char \fBuserrec::awaymsg\fP[512]" .PP -The user's away message. If this string is empty, the user is not marked as away.Definition at line 136 of file users.h. +The user's away message. If this string is empty, the user is not marked as away.Definition at line 141 of file users.h. .PP Referenced by userrec(). .SS "\fBucrec\fP \fBuserrec::chans\fP[MAXCHANS]" .PP -Definition at line 127 of file users.h. +Definition at line 132 of file users.h. .PP Referenced by Server::PseudoToUser(), and userrec(). .SS "char \fBuserrec::dhost\fP[256]" .PP -The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 115 of file users.h. +The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 120 of file users.h. .PP Referenced by GetFullHost(), and userrec(). .SS "bool \fBuserrec::dns_done\fP" .PP -True when \fBDNS\fP lookups are completed. Definition at line 164 of file users.h. +True when \fBDNS\fP lookups are completed. Definition at line 169 of file users.h. .PP Referenced by userrec(). .SS "int \fBuserrec::flood\fP" .PP -Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 147 of file users.h. +Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 152 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::fullname\fP[128]" .PP -The users full name. Definition at line 119 of file users.h. +The users full name. Definition at line 124 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::ident\fP[64]" .PP -The users ident reply. Definition at line 110 of file users.h. +The users ident reply. Definition at line 115 of file users.h. .PP Referenced by GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), userrec(), and Server::UserToPseudo(). .SS "\fBInvitedList\fP \fBuserrec::invites\fP\fC [private]\fP" .PP -A list of channels the user has a pending invite to. Definition at line 99 of file users.h. +A list of channels the user has a pending invite to. Definition at line 104 of file users.h. .PP Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). +.SS "long \fBuserrec::lines_in\fP" +.PP +Flood counters. Definition at line 189 of file users.h. +.PP +Referenced by userrec(). .SS "char \fBuserrec::modes\fP[MAXBUF]" .PP -The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 125 of file users.h. +The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 130 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::nick\fP[NICKMAX]" .PP -The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 106 of file users.h. +The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 111 of file users.h. .PP -Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), Server::QuitUser(), and userrec(). +Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), and userrec(). .SS "char \fBuserrec::oper\fP[NICKMAX]" .PP -The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 160 of file users.h. +The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 165 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::password\fP[MAXBUF]" .PP -Password specified by the user when they registered. This is stored even if the block doesnt need a password, so that modules may check it.Definition at line 174 of file users.h. +Password specified by the user when they registered. This is stored even if the block doesnt need a password, so that modules may check it.Definition at line 179 of file users.h. .SS "unsigned long \fBuserrec::pingmax\fP" .PP -Number of seconds between PINGs for this user (set from tag. Definition at line 168 of file users.h. +Number of seconds between PINGs for this user (set from tag. Definition at line 173 of file users.h. +.SS "std::string \fBuserrec::recvq\fP" +.PP +User's receive queue. Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.Definition at line 185 of file users.h. +.PP +Referenced by AddBuffer(), BufferIsReady(), ClearBuffer(), GetBuffer(), and userrec(). +.SS "time_t \fBuserrec::reset_due\fP" +.PP +Definition at line 190 of file users.h. +.PP +Referenced by userrec(). .SS "char \fBuserrec::result\fP[256]" .PP -Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 141 of file users.h. +Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 146 of file users.h. .PP Referenced by GetFullHost(), GetFullRealHost(), and userrec(). .SS "char \fBuserrec::server\fP[256]" .PP -The server the user is connected to. Definition at line 131 of file users.h. +The server the user is connected to. Definition at line 136 of file users.h. .PP Referenced by userrec(). +.SS "long \fBuserrec::threshold\fP" +.PP +Definition at line 191 of file users.h. .SS "unsigned long \fBuserrec::timeout\fP" .PP -Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 153 of file users.h. +Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 158 of file users.h. .PP Referenced by userrec(). diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index 614228ad2..0416d8dc5 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/users.h.3 b/docs/man/man3/users.h.3 index 09eb0ae89..21e2e3b0d 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -91,10 +91,10 @@ Definition at line 28 of file users.h. .PP .SS "typedef std::vector<\fBConnectClass\fP> \fBClassVector\fP" .PP -Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 85 of file users.h. +Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 90 of file users.h. .SS "typedef std::vector<\fBInvited\fP> \fBInvitedList\fP" .PP -Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 79 of file users.h. +Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 84 of file users.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 8a3263c2f..8006488c5 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index 6e437bf8f..05b7ad4af 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 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 66fe97bfe..4b4b46e2e 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 Tue Apr 26 17:11:43 2005 for InspIRCd by +
Generated on Sat May 7 15:34:20 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 181c18aae..db1420198 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 Tue Apr 26 17:11:44 2005 for InspIRCd by +
Generated on Sat May 7 15:34:21 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 c149c9b12..ac07b4d77 100644 --- a/docs/module-doc/channels_8cpp-source.html +++ b/docs/module-doc/channels_8cpp-source.html @@ -132,7 +132,7 @@ 00125 void chanrec::SetCustomMode(char mode,bool mode_on) 00126 { 00127 if (mode_on) { -00128 char m[3]; +00128 static char m[3]; 00129 m[0] = mode; 00130 m[1] = '\0'; 00131 if (!strchr(this->custom_modes,mode)) @@ -248,7 +248,7 @@ 00241 { 00242 return &internal_userlist; 00243 } -
Generated on Tue Apr 26 17:11:43 2005 for InspIRCd by +
Generated on Sat May 7 15:34:20 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 9956afa92..053be42bb 100644 --- a/docs/module-doc/channels_8cpp.html +++ b/docs/module-doc/channels_8cpp.html @@ -293,7 +293,7 @@ Definition at line 94

Definition at line 101 of file channels.cpp.

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

@@ -511,7 +511,9 @@ Definition at line 91

-Definition at line 78 of file channels.cpp. +Definition at line 78 of file channels.cpp. +

+Referenced by Server::GetUsers().

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

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

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

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

Definition at line 92 of file channels.cpp.

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

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

Definition at line 64 of file channels.cpp.

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

@@ -999,7 +1001,7 @@ Definition at line 86

Definition at line 107 of file channels.cpp.

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

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


Generated on Tue Apr 26 17:11:45 2005 for InspIRCd by +
Generated on Sat May 7 15:34:21 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 6d1312c53..e5b46e8e7 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 Tue Apr 26 17:11:43 2005 for InspIRCd by +
Generated on Sat May 7 15:34:20 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 cee3ed386..3309aacd7 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 Tue Apr 26 17:11:45 2005 for InspIRCd by +
Generated on Sat May 7 15:34:21 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 ac42b3705..77dd3c841 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classAdmin.html b/docs/module-doc/classAdmin.html index 585a7249b..019560bc6 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 306 of file modules.cpp. +Definition at line 304 of file modules.cpp.

-

00306 : Name(name), Email(email), Nick(nick) { };
+
00304 : 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 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 a5f221045..4e32014a4 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classBanItem.html b/docs/module-doc/classBanItem.html index 572bbc0f2..fcd2d112e 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 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 1ed2aed93..49f826983 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 Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 7b302eed2..b7228f6c1 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -67,7 +67,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 1097 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 1147 of file modules.h.

Constructor & Destructor Documentation

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

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

-

00836 {
-00837         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00838         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00839         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00840         if (!this->readerror)
-00841                 this->error = CONF_FILE_NOT_FOUND;
-00842 }
+
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 }
 
@@ -141,17 +141,17 @@ Overloaded constructor.

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

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

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

-

00855 {
-00856         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00857         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00858         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00859         if (!this->readerror)
-00860                 this->error = CONF_FILE_NOT_FOUND;
-00861 };
+
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 };
 
@@ -184,16 +184,16 @@ Default destructor.

This method destroys the ConfigReader class.

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

-References cache, and errorlog. +References cache, and errorlog.

-

00846 {
-00847         if (this->cache)
-00848                 delete this->cache;
-00849         if (this->errorlog)
-00850                 delete this->errorlog;
-00851 }
+
00862 {
+00863         if (this->cache)
+00864                 delete this->cache;
+00865         if (this->errorlog)
+00866                 delete this->errorlog;
+00867 }
 
@@ -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 932 of file modules.cpp. -

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

-

00933 {
-00934         if (bail)
-00935         {
-00936                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00937                 exit(0);
-00938         }
-00939         else
-00940         {
-00941                 char dataline[1024];
-00942                 if (user)
-00943                 {
-00944                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00945                         while (!errorlog->eof())
-00946                         {
-00947                                 errorlog->getline(dataline,1024);
-00948                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00949                         }
-00950                 }
-00951                 else
-00952                 {
-00953                         WriteOpers("There were errors in the configuration file:",user->nick);
-00954                         while (!errorlog->eof())
-00955                         {
-00956                                 errorlog->getline(dataline,1024);
-00957                                 WriteOpers(dataline);
-00958                         }
-00959                 }
-00960                 return;
-00961         }
-00962 }
+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 }
 
@@ -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 965 of file modules.cpp. +Definition at line 981 of file modules.cpp.

-References cache. +References cache.

-

00966 {
-00967         return EnumConf(cache,tag.c_str());
-00968 }
+
00982 {
+00983         return EnumConf(cache,tag.c_str());
+00984 }
 
@@ -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 970 of file modules.cpp. +Definition at line 986 of file modules.cpp.

-References cache. +References cache.

-

00971 {
-00972         return EnumValues(cache, tag.c_str(), index);
-00973 }
+
00987 {
+00988         return EnumValues(cache, tag.c_str(), index);
+00989 }
 
@@ -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 925 of file modules.cpp. +Definition at line 941 of file modules.cpp.

-References error. +References error.

-

00926 {
-00927         long olderr = this->error;
-00928         this->error = 0;
-00929         return olderr;
-00930 }
+
00942 {
+00943         long olderr = this->error;
+00944         this->error = 0;
+00945         return olderr;
+00946 }
 
@@ -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 879 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 false;
-00891         }
-00892         std::string s = val;
-00893         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00894 }
+Definition at line 895 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 }
 
@@ -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 896 of file modules.cpp. -

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

-

00897 {
-00898         char val[MAXBUF];
-00899         char t[MAXBUF];
-00900         char n[MAXBUF];
-00901         strlcpy(t,tag.c_str(),MAXBUF);
-00902         strlcpy(n,name.c_str(),MAXBUF);
-00903         int res = ReadConf(cache,t,n,index,val);
-00904         if (!res)
-00905         {
-00906                 this->error = CONF_VALUE_NOT_FOUND;
-00907                 return 0;
-00908         }
-00909         for (int i = 0; i < strlen(val); i++)
-00910         {
-00911                 if (!isdigit(val[i]))
-00912                 {
-00913                         this->error = CONF_NOT_A_NUMBER;
-00914                         return 0;
-00915                 }
-00916         }
-00917         if ((needs_unsigned) && (atoi(val)<0))
-00918         {
-00919                 this->error = CONF_NOT_UNSIGNED;
-00920                 return 0;
-00921         }
-00922         return atoi(val);
-00923 }
+Definition at line 912 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 }
 
@@ -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 863 of file modules.cpp. -

-References cache, CONF_VALUE_NOT_FOUND, and error. -

-

00864 {
-00865         char val[MAXBUF];
-00866         char t[MAXBUF];
-00867         char n[MAXBUF];
-00868         strlcpy(t,tag.c_str(),MAXBUF);
-00869         strlcpy(n,name.c_str(),MAXBUF);
-00870         int res = ReadConf(cache,t,n,index,val);
-00871         if (!res)
-00872         {
-00873                 this->error = CONF_VALUE_NOT_FOUND;
-00874                 return "";
-00875         }
-00876         return std::string(val);
-00877 }
+Definition at line 879 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 }
 
@@ -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 975 of file modules.cpp. +Definition at line 991 of file modules.cpp.

-References readerror. +References readerror.

-

00976 {
-00977         return this->readerror;
-00978 }
+
00992 {
+00993         return this->readerror;
+00994 }
 
@@ -685,9 +685,9 @@ The contents of the configuration file This protected member should never be acc

It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.

-Definition at line 1105 of file modules.h. +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().

@@ -711,9 +711,9 @@ Referenced by ConfigReader(

-Definition at line 1110 of file modules.h. +Definition at line 1160 of file modules.h.

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

@@ -737,9 +737,9 @@ Referenced by ConfigReader(

-Definition at line 1106 of file modules.h. +Definition at line 1156 of file modules.h.

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

@@ -765,14 +765,14 @@ Used to store errors.

-Definition at line 1109 of file modules.h. +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 Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 0f73e7de4..abaf3804f 100644 --- a/docs/module-doc/classConnectClass-members.html +++ b/docs/module-doc/classConnectClass-members.html @@ -14,9 +14,10 @@ passConnectClass pingtimeConnectClass registration_timeoutConnectClass + thresholdConnectClass typeConnectClass ~classbase()classbase [inline] -
Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html index 61fb38d40..e7d958aa8 100644 --- a/docs/module-doc/classConnectClass.html +++ b/docs/module-doc/classConnectClass.html @@ -36,6 +36,9 @@ Inherits classbase. char pass [MAXBUF]  (Optional) Password for this line

+long threshold + + Threshold value for flood disconnect.



Detailed Description

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

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

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

-

00068         {
-00069                 registration_timeout = 0;
-00070                 flood = 0;
-00071                 pingtime = 0;
-00072                 strlcpy(host,"",MAXBUF);
-00073                 strlcpy(pass,"",MAXBUF);
-00074         }
+
00072         {
+00073                 registration_timeout = 0;
+00074                 flood = 0;
+00075                 pingtime = 0;
+00076                 threshold = 0;
+00077                 strlcpy(host,"",MAXBUF);
+00078                 strlcpy(pass,"",MAXBUF);
+00079         }
 
@@ -110,7 +114,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().

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

Definition at line 59 of file users.h.

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

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

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

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

Definition at line 62 of file users.h.

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

@@ -222,7 +226,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::threshold +
+
+ + + +
+   + + +

+Threshold value for flood disconnect. +

+ +

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

+Referenced by ConnectClass().

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


The documentation for this class was generated from the following file: -
Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 27446a113..bd9aff1a9 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classDNS.html b/docs/module-doc/classDNS.html index 9b2563cf4..ea2a87e1b 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 bed310fd6..2b98f9ea9 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classELine.html b/docs/module-doc/classELine.html index 7d4681a99..4ea2be125 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 3e77cb876..9f1084c4a 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classEvent.html b/docs/module-doc/classEvent.html index 86bb599fa..980de41c0 100644 --- a/docs/module-doc/classEvent.html +++ b/docs/module-doc/classEvent.html @@ -94,9 +94,9 @@ Create a new Event.

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

-

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

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

References data.

-

00340 {
-00341         return this->data;
-00342 }
+
00338 {
+00339         return this->data;
+00340 }
 
@@ -169,13 +169,13 @@ Get the event ID.

Use this to determine the event type for safe casting of the data

-Definition at line 355 of file modules.cpp. +Definition at line 353 of file modules.cpp.

References id.

-

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

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

References source.

-

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

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

References FOREACH_MOD.

-

00350 {
-00351         FOREACH_MOD OnEvent(this);
-00352         return NULL;
-00353 }
+
00348 {
+00349         FOREACH_MOD OnEvent(this);
+00350         return NULL;
+00351 }
 
@@ -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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 bbece52c2..8bd3c1019 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExemptItem.html b/docs/module-doc/classExemptItem.html index 3eb87d59d..40e24cd97 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 a76751ffc..8a6a72bcb 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExtMode.html b/docs/module-doc/classExtMode.html index c173b696f..f030e065f 100644 --- a/docs/module-doc/classExtMode.html +++ b/docs/module-doc/classExtMode.html @@ -82,11 +82,11 @@

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

-

00201 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { };
+
00202 : 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 200 of file modules.cpp. +Definition at line 201 of file modules.cpp.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


The documentation for this class was generated from the following file: -
Generated on Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 9627587a2..d459cfcff 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index eb4935693..1c8e993eb 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 b4b4ce247..b13b2bfe9 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 15bfc3626..1319a66e2 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -47,7 +47,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 1186 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 1236 of file modules.h.

Constructor & Destructor Documentation

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

-

00989 {
-00990 }
+
01005 {
+01006 }
 
@@ -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 981 of file modules.cpp. +Definition at line 997 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00982 {
-00983         file_cache c;
-00984         readfile(c,filename.c_str());
-00985         this->fc = c;
-00986 }
+
00998 {
+00999         file_cache c;
+01000         readfile(c,filename.c_str());
+01001         this->fc = c;
+01002 }
 
@@ -155,10 +155,10 @@ Default destructor.

This deletes the memory allocated to the file.

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

-

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

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

-References fc. +References fc.

-

01005 {
-01006         if (fc.size() == 0)
-01007         {
-01008                 return(false);
-01009         }
-01010         else
-01011         {
-01012                 return(true);
-01013         }
-01014 }
+
01021 {
+01022         if (fc.size() == 0)
+01023         {
+01024                 return(false);
+01025         }
+01026         else
+01027         {
+01028                 return(true);
+01029         }
+01030 }
 
@@ -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 1023 of file modules.cpp. +Definition at line 1039 of file modules.cpp.

-References fc. +References fc.

-

01024 {
-01025         return fc.size();
-01026 }
+
01040 {
+01041         return fc.size();
+01042 }
 
@@ -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 1016 of file modules.cpp. +Definition at line 1032 of file modules.cpp.

-References fc. +References fc.

-

01017 {
-01018         if ((x<0) || (x>fc.size()))
-01019                 return "";
-01020         return fc[x];
-01021 }
+
01033 {
+01034         if ((x<0) || (x>fc.size()))
+01035                 return "";
+01036         return fc[x];
+01037 }
 
@@ -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 992 of file modules.cpp. +Definition at line 1008 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00993 {
-00994         file_cache c;
-00995         readfile(c,filename.c_str());
-00996         this->fc = c;
-00997 }
+
01009 {
+01010         file_cache c;
+01011         readfile(c,filename.c_str());
+01012         this->fc = c;
+01013 }
 
@@ -354,14 +354,14 @@ References fc, and

-Definition at line 1188 of file modules.h. +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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 b8e35fd58..ca5405af0 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classGLine.html b/docs/module-doc/classGLine.html index 3ea20d2ce..8dae2d04b 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 e76b1ac3e..0053dc346 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classHostItem.html b/docs/module-doc/classHostItem.html index 71d59cfe3..90237c5f5 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 4a5a4aa56..7e43a92ad 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classInviteItem.html b/docs/module-doc/classInviteItem.html index 2172cc4ea..db30696d3 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 e6442ed32..0e220accf 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classInvited.html b/docs/module-doc/classInvited.html index 61717cecc..baeb2dc09 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 556118288..3015be7b7 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classKLine.html b/docs/module-doc/classKLine.html index 4f707ad92..384c57192 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 fceaaac90..01fb8b353 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModeParameter.html b/docs/module-doc/classModeParameter.html index 4f4bdd98b..75dc0540a 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 ddafaae13..b748a548b 100644 --- a/docs/module-doc/classModule-members.html +++ b/docs/module-doc/classModule-members.html @@ -12,6 +12,7 @@ Module()Module On005Numeric(std::string &output)Module [virtual] OnAccessCheck(userrec *source, userrec *dest, chanrec *channel, int access_type)Module [virtual] + OnAddBan(userrec *source, chanrec *channel, std::string banmask)Module [virtual] OnBackgroundTimer(time_t curtime)Module [virtual] OnChangeLocalUserGECOS(userrec *user, std::string newhost)Module [virtual] OnChangeLocalUserHost(userrec *user, std::string newhost)Module [virtual] @@ -21,6 +22,7 @@ OnCheckKey(userrec *user, chanrec *chan, std::string keygiven)Module [virtual] OnCheckLimit(userrec *user, chanrec *chan)Module [virtual] OnCheckReady(userrec *user)Module [virtual] + OnDelBan(userrec *source, chanrec *channel, std::string banmask)Module [virtual] OnEvent(Event *event)Module [virtual] OnExtendedMode(userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)Module [virtual] OnGlobalConnect(userrec *user)Module [virtual] @@ -36,6 +38,10 @@ OnPacketTransmit(std::string &data, std::string serv)Module [virtual] OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user)Module [virtual] OnRawMode(userrec *user, chanrec *chan, char mode, std::string param, bool adding, int pcnt)Module [virtual] + OnRawSocketAccept(int fd, std::string ip, int localport)Module [virtual] + OnRawSocketClose(int fd)Module [virtual] + OnRawSocketRead(int fd, char *buffer, unsigned int count, int &readresult)Module [virtual] + OnRawSocketWrite(int fd, char *buffer, int count)Module [virtual] OnRehash()Module [virtual] OnRequest(Request *request)Module [virtual] OnSendList(userrec *user, chanrec *channel, char mode)Module [virtual] @@ -59,7 +65,7 @@ OnWhois(userrec *source, userrec *dest)Module [virtual] ~classbase()classbase [inline] ~Module()Module [virtual] -
Generated on Tue Apr 26 17:11:49 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index c587dcc90..eec90db64 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -165,6 +165,24 @@ Inherits classbase. virtual void OnGlobalConnect (userrec *user)  Called whenever a user connects, anywhere on the network.

+virtual int OnAddBan (userrec *source, chanrec *channel, std::string banmask) + + Called whenever a ban is added to a channel's list.


+virtual int OnDelBan (userrec *source, chanrec *channel, std::string banmask) + + Called whenever a ban is removed from a channel's list.


+virtual void OnRawSocketAccept (int fd, std::string ip, int localport) + + Called immediately after any connection is accepted.


+virtual int OnRawSocketWrite (int fd, char *buffer, int count) + + Called immediately before any write() operation on a user's socket in the core.


+virtual void OnRawSocketClose (int fd) + + Called immediately before any socket is closed.


+virtual int OnRawSocketRead (int fd, char *buffer, unsigned int count, int &readresult) + + Called immediately before any read() operation on a client socket in the core.



Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -203,9 +221,9 @@ Default constructor creates a module class.

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

-

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

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

-

00362 { }
+
00361 { }
 
@@ -274,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 374 of file modules.cpp. +Definition at line 373 of file modules.cpp.

References VF_VENDOR.

-

00374 { return Version(1,0,0,0,VF_VENDOR); }
+
00373 { return Version(1,0,0,0,VF_VENDOR); }
 
@@ -312,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 386 of file modules.cpp. +Definition at line 385 of file modules.cpp.

-

00386 { };
+
00385 { };
 
@@ -381,11 +399,62 @@ 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 383 of file modules.cpp. +Definition at line 382 of file modules.cpp.

References ACR_DEFAULT.

-

00383 { return ACR_DEFAULT; };
+
00382 { return ACR_DEFAULT; };
+
+ + +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnAddBan userrec source,
chanrec channel,
std::string  banmask
[virtual]
+
+ + + +
+   + + +

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

+

00410 { return 0; };
 
@@ -419,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 389 of file modules.cpp. +Definition at line 388 of file modules.cpp.

-

00389 { };
+
00388 { };
 
@@ -464,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 403 of file modules.cpp. +Definition at line 402 of file modules.cpp.

-

00403 { return 0; };
+
00402 { return 0; };
 
@@ -509,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 402 of file modules.cpp. +Definition at line 401 of file modules.cpp.

-

00402 { return 0; };
+
00401 { return 0; };
 
@@ -545,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 385 of file modules.cpp. +Definition at line 384 of file modules.cpp.

References string_list.

-

00385 { string_list empty; return empty; }
+
00384 { string_list empty; return empty; }
 
@@ -592,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 400 of file modules.cpp. +Definition at line 399 of file modules.cpp.

-

00400 { return 0; };
+
00399 { return 0; };
 
@@ -637,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 397 of file modules.cpp. +Definition at line 396 of file modules.cpp.

-

00397 { return 0; };
+
00396 { return 0; };
 
@@ -688,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 398 of file modules.cpp. +Definition at line 397 of file modules.cpp.

-

00398 { return 0; };
+
00397 { return 0; };
 
@@ -733,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 399 of file modules.cpp. +Definition at line 398 of file modules.cpp.

-

00399 { return 0; };
+
00398 { return 0; };
 
@@ -769,9 +838,60 @@ 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 392 of file modules.cpp. +Definition at line 391 of file modules.cpp.

-

00392 { return true; };
+
00391 { return true; };
+
+ + +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnDelBan userrec source,
chanrec channel,
std::string  banmask
[virtual]
+
+ + + +
+   + + +

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

+

00411 { return 0; };
 
@@ -805,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 406 of file modules.cpp. +Definition at line 405 of file modules.cpp.

-

00406 { return; };
+
00405 { return; };
 
@@ -872,11 +992,11 @@ Definition at line 406

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

-

00373 { return false; }
+
00372 { return false; }
 
@@ -910,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 410 of file modules.cpp. +Definition at line 409 of file modules.cpp.

-

00410 { };
+
00409 { };
 
@@ -946,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 409 of file modules.cpp. +Definition at line 408 of file modules.cpp.

-

00409 { };
+
00408 { };
 
@@ -983,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 376 of file modules.cpp. +Definition at line 375 of file modules.cpp.

-

00376 { };
+
00375 { };
 
@@ -1034,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 387 of file modules.cpp. +Definition at line 386 of file modules.cpp.

-

00387 { return 0; };
+
00386 { return 0; };
 
@@ -1079,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 388 of file modules.cpp. +Definition at line 387 of file modules.cpp.

-

00388 { };
+
00387 { };
 
@@ -1130,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 404 of file modules.cpp. +Definition at line 403 of file modules.cpp.

-

00404 { return 0; };
+
00403 { return 0; };
 
@@ -1205,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 405 of file modules.cpp. +Definition at line 404 of file modules.cpp.

-

00405 { return 0; };
+
00404 { return 0; };
 
@@ -1241,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 375 of file modules.cpp. +Definition at line 374 of file modules.cpp.

-

00375 { };
+
00374 { };
 
@@ -1286,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 408 of file modules.cpp. +Definition at line 407 of file modules.cpp.

-

00408 { return 0; };
+
00407 { return 0; };
 
@@ -1331,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 369 of file modules.cpp. +Definition at line 368 of file modules.cpp.

-

00369 { }
+
00368 { }
 
@@ -1376,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 368 of file modules.cpp. +Definition at line 367 of file modules.cpp.

-

00368 { }
+
00367 { }
 
@@ -1431,11 +1551,11 @@ Definition at line 368

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!) +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 391 of file modules.cpp. +Definition at line 390 of file modules.cpp.

-

00391 { return 0; };
+
00390 { return 0; };
 
@@ -1502,9 +1622,204 @@ Called whenever a mode character is processed.

Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!

-Definition at line 396 of file modules.cpp. +Definition at line 395 of file modules.cpp.

-

00396 { return 0; };
+
00395 { return 0; };
+
+ + +

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void Module::OnRawSocketAccept int  fd,
std::string  ip,
int  localport
[virtual]
+
+ + + + + +
+   + + +

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

+

00412 { };
+
+

+ + + + +
+ + + + + + + + + + +
void Module::OnRawSocketClose int  fd  )  [virtual]
+
+ + + + + +
+   + + +

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

+

00414 { };
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnRawSocketRead int  fd,
char *  buffer,
unsigned int  count,
int &  readresult
[virtual]
+
+ + + + + +
+   + + +

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

+

00415 { return 0; };
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
int Module::OnRawSocketWrite int  fd,
char *  buffer,
int  count
[virtual]
+
+ + + +
+   + + +

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

+

00413 { return 0; };
 
@@ -1537,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 370 of file modules.cpp. +Definition at line 369 of file modules.cpp.

-

00370 { }
+
00369 { }
 
@@ -1573,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 407 of file modules.cpp. +Definition at line 406 of file modules.cpp.

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

-

00407 { return NULL; };
+
00406 { return NULL; };
 
@@ -1626,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 390 of file modules.cpp. +Definition at line 389 of file modules.cpp.

-

00390 { };
+
00389 { };
 
@@ -1677,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 371 of file modules.cpp. +Definition at line 370 of file modules.cpp.

-

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

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

-

00401 { };
+
00400 { };
 
@@ -1749,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 363 of file modules.cpp. +Definition at line 362 of file modules.cpp.

-

00363 { }
+
00362 { }
 
@@ -1785,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 365 of file modules.cpp. +Definition at line 364 of file modules.cpp.

-

00365 { }
+
00364 { }
 
@@ -1830,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 366 of file modules.cpp. +Definition at line 365 of file modules.cpp.

-

00366 { }
+
00365 { }
 
@@ -1887,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 395 of file modules.cpp. +Definition at line 394 of file modules.cpp.

-

00395 { };
+
00394 { };
 
@@ -1932,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 367 of file modules.cpp. +Definition at line 366 of file modules.cpp.

-

00367 { }
+
00366 { }
 
@@ -1977,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 382 of file modules.cpp. +Definition at line 381 of file modules.cpp.

-

00382 { };
+
00381 { };
 
@@ -2028,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 378 of file modules.cpp. +Definition at line 377 of file modules.cpp.

-

00378 { return 0; };
+
00377 { return 0; };
 
@@ -2081,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 372 of file modules.cpp. +Definition at line 371 of file modules.cpp.

-

00372 { return 0; }
+
00371 { return 0; }
 
@@ -2138,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 394 of file modules.cpp. +Definition at line 393 of file modules.cpp.

-

00394 { return 0; };
+
00393 { return 0; };
 
@@ -2195,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 379 of file modules.cpp. +Definition at line 378 of file modules.cpp.

-

00379 { return 0; };
+
00378 { return 0; };
 
@@ -2240,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 381 of file modules.cpp. +Definition at line 380 of file modules.cpp.

-

00381 { return 0; };
+
00380 { return 0; };
 
@@ -2297,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 380 of file modules.cpp. +Definition at line 379 of file modules.cpp.

-

00380 { return 0; };
+
00379 { return 0; };
 
@@ -2333,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 364 of file modules.cpp. +Definition at line 363 of file modules.cpp.

-

00364 { }
+
00363 { }
 
@@ -2369,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 393 of file modules.cpp. +Definition at line 392 of file modules.cpp.

-

00393 { };
+
00392 { };
 
@@ -2405,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 384 of file modules.cpp. +Definition at line 383 of file modules.cpp.

References string_list.

-

00384 { string_list empty; return empty; }
+
00383 { string_list empty; return empty; }
 
@@ -2452,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 377 of file modules.cpp. +Definition at line 376 of file modules.cpp.

-

00377 { };
+
00376 { };
 

The documentation for this class was generated from the following files: -
Generated on Tue Apr 26 17:11:49 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 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 eb43d4db8..91c25da0d 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 Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModuleFactory.html b/docs/module-doc/classModuleFactory.html index b17f50643..0f89639ee 100644 --- a/docs/module-doc/classModuleFactory.html +++ b/docs/module-doc/classModuleFactory.html @@ -30,7 +30,7 @@ This is to allow for modules to create many different variants of

-Definition at line 1241 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 1291 of file modules.h.

Constructor & Destructor Documentation

@@ -58,9 +58,9 @@ Definition at line 1241 o

-Definition at line 1244 of file modules.h. +Definition at line 1294 of file modules.h.

-

01244 { }
+
01294 { }
 
@@ -91,9 +91,9 @@ Definition at line 1244 o

-Definition at line 1245 of file modules.h. +Definition at line 1295 of file modules.h.

-

01245 { }
+
01295 { }
 
@@ -130,7 +130,7 @@ Your inherited class of ModuleFactory must return a pointer to your modules.h -
Generated on Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 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 91cee99f4..c91b0afcf 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 Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classModuleMessage.html b/docs/module-doc/classModuleMessage.html index 75d1769b2..d99c79411 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 Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 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 da0ee8a07..225e085cf 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 Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classQLine.html b/docs/module-doc/classQLine.html index 2404c5e44..35c91a091 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 Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:26 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 e9c70663d..c5e1f0307 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 Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:27 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classRequest.html b/docs/module-doc/classRequest.html index 68ba84a00..e344bbd81 100644 --- a/docs/module-doc/classRequest.html +++ b/docs/module-doc/classRequest.html @@ -94,9 +94,9 @@ Create a new Request.

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

-

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

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

References data.

-

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

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

References dest.

-

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

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

References source.

-

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

Implements ModuleMessage.

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

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

-

00326 {
-00327         if (this->dest)
-00328         {
-00329                 return dest->OnRequest(this);
-00330         }
-00331         else
-00332         {
-00333                 return NULL;
-00334         }
-00335 }
+
00324 {
+00325         if (this->dest)
+00326         {
+00327                 return dest->OnRequest(this);
+00328         }
+00329         else
+00330         {
+00331                 return NULL;
+00332         }
+00333 }
 
@@ -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 Tue Apr 26 17:11:50 2005 for InspIRCd by +
Generated on Sat May 7 15:34:27 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 cff4e3588..521e78e89 100644 --- a/docs/module-doc/classServer-members.html +++ b/docs/module-doc/classServer-members.html @@ -6,68 +6,70 @@

Server Member List

This is the complete list of members for Server, including all inherited members. - - - - - - - - + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - - - - + + + + + - - - + + + - + -
AddCommand(char *cmd, handlerfunc f, char flags, int minparams, char *source)Server [virtual]
AddELine(long duration, std::string source, std::string reason, std::string hostmask)Server [virtual]
AddExtendedListMode(char modechar)Server [virtual]
AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)Server [virtual]
AddGLine(long duration, std::string source, std::string reason, std::string hostmask)Server [virtual]
AddKLine(long duration, std::string source, std::string reason, std::string hostmask)Server [virtual]
AddQLine(long duration, std::string source, std::string reason, std::string nickname)Server [virtual]
AddZLine(long duration, std::string source, std::string reason, std::string ipaddr)Server [virtual]
AddCommand(char *cmd, handlerfunc f, char flags, int minparams, char *source)Server [virtual]
AddELine(long duration, std::string source, std::string reason, std::string hostmask)Server [virtual]
AddExtendedListMode(char modechar)Server [virtual]
AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)Server [virtual]
AddGLine(long duration, std::string source, std::string reason, std::string hostmask)Server [virtual]
AddKLine(long duration, std::string source, std::string reason, std::string hostmask)Server [virtual]
AddQLine(long duration, std::string source, std::string reason, std::string nickname)Server [virtual]
AddZLine(long duration, std::string source, std::string reason, std::string ipaddr)Server [virtual]
ageclassbase
CalcDuration(std::string duration)Server [virtual]
CallCommandHandler(std::string commandname, char **parameters, int pcnt, userrec *user)Server [virtual]
ChangeGECOS(userrec *user, std::string gecos)Server [virtual]
ChangeHost(userrec *user, std::string host)Server [virtual]
ChangeUserNick(userrec *user, std::string nickname)Server [virtual]
ChanMode(userrec *User, chanrec *Chan)Server [virtual]
CalcDuration(std::string duration)Server [virtual]
CallCommandHandler(std::string commandname, char **parameters, int pcnt, userrec *user)Server [virtual]
ChangeGECOS(userrec *user, std::string gecos)Server [virtual]
ChangeHost(userrec *user, std::string host)Server [virtual]
ChangeUserNick(userrec *user, std::string nickname)Server [virtual]
ChanMode(userrec *User, chanrec *Chan)Server [virtual]
classbase()classbase [inline]
CommonChannels(userrec *u1, userrec *u2)Server [virtual]
CountUsers(chanrec *c)Server [virtual]
DelELine(std::string hostmask)Server [virtual]
DelGLine(std::string hostmask)Server [virtual]
DelKLine(std::string hostmask)Server [virtual]
DelQLine(std::string nickname)Server [virtual]
DelZLine(std::string ipaddr)Server [virtual]
FindChannel(std::string channel)Server [virtual]
FindModule(std::string name)Server [virtual]
FindNick(std::string nick)Server [virtual]
GetAdmin()Server [virtual]
GetNetworkName()Server [virtual]
GetServerName()Server [virtual]
GetUsers(chanrec *chan)Server [virtual]
IsNick(std::string nick)Server [virtual]
IsOnChannel(userrec *User, chanrec *Chan)Server [virtual]
IsUlined(std::string server)Server [virtual]
IsValidMask(std::string mask)Server [virtual]
JoinUserToChannel(userrec *user, std::string cname, std::string key)Server [virtual]
CommonChannels(userrec *u1, userrec *u2)Server [virtual]
CountUsers(chanrec *c)Server [virtual]
DelELine(std::string hostmask)Server [virtual]
DelGLine(std::string hostmask)Server [virtual]
DelKLine(std::string hostmask)Server [virtual]
DelQLine(std::string nickname)Server [virtual]
DelZLine(std::string ipaddr)Server [virtual]
FindChannel(std::string channel)Server [virtual]
FindDescriptor(int socket)Server [virtual]
FindModule(std::string name)Server [virtual]
FindNick(std::string nick)Server [virtual]
GetAdmin()Server [virtual]
GetNetworkName()Server [virtual]
GetServerName()Server [virtual]
GetUsers(chanrec *chan)Server [virtual]
IsNick(std::string nick)Server [virtual]
IsOnChannel(userrec *User, chanrec *Chan)Server [virtual]
IsUlined(std::string server)Server [virtual]
IsValidMask(std::string mask)Server [virtual]
JoinUserToChannel(userrec *user, std::string cname, std::string key)Server [virtual]
Log(int level, std::string s)Server [virtual]
MatchText(std::string sliteral, std::string spattern)Server [virtual]
MeshCheckChan(chanrec *c, std::string servername)Server [virtual]
MeshCheckCommon(userrec *u, std::string servername)Server [virtual]
MeshSendAll(std::string text)Server [virtual]
MeshSendAllAlive(std::string text)Server [virtual]
MeshSendAllExcept(std::string target, std::string text)Server [virtual]
MeshSendCommon(userrec *user, std::string text)Server [virtual]
MeshSendUnicast(std::string destination, std::string text)Server [virtual]
PartUserFromChannel(userrec *user, std::string cname, std::string reason)Server [virtual]
PseudoToUser(userrec *alive, userrec *zombie, std::string message)Server [virtual]
QuitUser(userrec *user, std::string reason)Server [virtual]
MatchText(std::string sliteral, std::string spattern)Server [virtual]
MeshCheckChan(chanrec *c, std::string servername)Server [virtual]
MeshCheckCommon(userrec *u, std::string servername)Server [virtual]
MeshSendAll(std::string text)Server [virtual]
MeshSendAllAlive(std::string text)Server [virtual]
MeshSendAllExcept(std::string target, std::string text)Server [virtual]
MeshSendCommon(userrec *user, std::string text)Server [virtual]
MeshSendUnicast(std::string destination, std::string text)Server [virtual]
PartUserFromChannel(userrec *user, std::string cname, std::string reason)Server [virtual]
PseudoToUser(userrec *alive, userrec *zombie, std::string message)Server [virtual]
QuitUser(userrec *user, std::string reason)Server [virtual]
Send(int Socket, std::string s)Server [virtual]
SendChannel(userrec *User, chanrec *Channel, std::string s, bool IncludeSender)Server [virtual]
SendCommon(userrec *User, std::string text, bool IncludeSender)Server [virtual]
SendFrom(int Socket, userrec *User, std::string s)Server [virtual]
SendMode(char **parameters, int pcnt, userrec *user)Server [virtual]
SendChannel(userrec *User, chanrec *Channel, std::string s, bool IncludeSender)Server [virtual]
SendChannelServerNotice(std::string ServName, chanrec *Channel, std::string text)Server [virtual]
SendCommon(userrec *User, std::string text, bool IncludeSender)Server [virtual]
SendFrom(int Socket, userrec *User, std::string s)Server [virtual]
SendMode(char **parameters, int pcnt, userrec *user)Server [virtual]
SendOpers(std::string s)Server [virtual]
SendServ(int Socket, std::string s)Server [virtual]
SendTo(userrec *Source, userrec *Dest, std::string s)Server [virtual]
SendToModeMask(std::string modes, int flags, std::string text)Server [virtual]
SendWallops(userrec *User, std::string text)Server [virtual]
SendTo(userrec *Source, userrec *Dest, std::string s)Server [virtual]
SendToModeMask(std::string modes, int flags, std::string text)Server [virtual]
SendWallops(userrec *User, std::string text)Server [virtual]
Server()Server
UserToPseudo(userrec *user, std::string message)Server [virtual]
UserToPseudo(userrec *user, std::string message)Server [virtual]
~classbase()classbase [inline]
~Server()Server [virtual]

Generated on Tue Apr 26 17:11:51 2005 for InspIRCd by +
Generated on Sat May 7 15:34:28 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html index ae31470bc..4a850c16a 100644 --- a/docs/module-doc/classServer.html +++ b/docs/module-doc/classServer.html @@ -33,162 +33,168 @@ Inherits classbase. virtual void SendServ (int Socket, std::string s)  Sends text from the server to a socket.

-virtual void SendFrom (int Socket, userrec *User, std::string s) +virtual void SendChannelServerNotice (std::string ServName, chanrec *Channel, std::string text) - Sends text from a user to a socket.


-virtual void SendTo (userrec *Source, userrec *Dest, std::string s) + Writes text to a channel, but from a server, including all.


+virtual void SendFrom (int Socket, userrec *User, std::string s) - Sends text from a user to another user.


-virtual void SendChannel (userrec *User, chanrec *Channel, std::string s, bool IncludeSender) + Sends text from a user to a socket.


+virtual void SendTo (userrec *Source, userrec *Dest, std::string s) - Sends text from a user to a channel (mulicast).


-virtual bool CommonChannels (userrec *u1, userrec *u2) + Sends text from a user to another user.


+virtual void SendChannel (userrec *User, chanrec *Channel, std::string s, bool IncludeSender) - Returns true if two users share a common channel.


-virtual void SendCommon (userrec *User, std::string text, bool IncludeSender) + Sends text from a user to a channel (mulicast).


+virtual bool CommonChannels (userrec *u1, userrec *u2) - Sends text from a user to one or more channels (mulicast).


-virtual void SendWallops (userrec *User, std::string text) + Returns true if two users share a common channel.


+virtual void SendCommon (userrec *User, std::string text, bool IncludeSender) - Sends a WALLOPS message.


-virtual bool IsNick (std::string nick) + Sends text from a user to one or more channels (mulicast).


+virtual void SendWallops (userrec *User, std::string text) - Returns true if a nick is valid.


-virtual int CountUsers (chanrec *c) + Sends a WALLOPS message.


+virtual bool IsNick (std::string nick) - Returns a count of the number of users on a channel.


-virtual userrecFindNick (std::string nick) + Returns true if a nick is valid.


+virtual int CountUsers (chanrec *c) - Attempts to look up a nick and return a pointer to it.


-virtual chanrecFindChannel (std::string channel) + Returns a count of the number of users on a channel.


+virtual userrecFindNick (std::string nick) - Attempts to look up a channel and return a pointer to it.


-virtual std::string ChanMode (userrec *User, chanrec *Chan) + Attempts to look up a nick and return a pointer to it.


+virtual userrecFindDescriptor (int socket) - Attempts to look up a user's privilages on a channel.


-virtual bool IsOnChannel (userrec *User, chanrec *Chan) + Attempts to look up a nick using the file descriptor associated with that nick.


+virtual chanrecFindChannel (std::string channel) - Checks if a user is on a channel.


-virtual std::string GetServerName () + Attempts to look up a channel and return a pointer to it.


+virtual std::string ChanMode (userrec *User, chanrec *Chan) - Returns the server name of the server where the module is loaded.


-virtual std::string GetNetworkName () + Attempts to look up a user's privilages on a channel.


+virtual bool IsOnChannel (userrec *User, chanrec *Chan) - Returns the network name, global to all linked servers.


-virtual Admin GetAdmin () + Checks if a user is on a channel.


+virtual std::string GetServerName () - Returns the information of the server as returned by the /ADMIN command.


-virtual bool AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off) + Returns the server name of the server where the module is loaded.


+virtual std::string GetNetworkName () - Adds an extended mode letter which is parsed by a module.


-virtual bool AddExtendedListMode (char modechar) + Returns the network name, global to all linked servers.


+virtual Admin GetAdmin () - Adds an extended mode letter which is parsed by a module and handled in a list fashion.


-virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) + Returns the information of the server as returned by the /ADMIN command.


+virtual bool AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off) - Adds a command to the command table.


-virtual void SendMode (char **parameters, int pcnt, userrec *user) + Adds an extended mode letter which is parsed by a module.


+virtual bool AddExtendedListMode (char modechar) - Sends a servermode.


-virtual void SendToModeMask (std::string modes, int flags, std::string text) + Adds an extended mode letter which is parsed by a module and handled in a list fashion.


+virtual void AddCommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) - Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.


-virtual chanrecJoinUserToChannel (userrec *user, std::string cname, std::string key) + Adds a command to the command table.


+virtual void SendMode (char **parameters, int pcnt, userrec *user) - Forces a user to join a channel.


-virtual chanrecPartUserFromChannel (userrec *user, std::string cname, std::string reason) + Sends a servermode.


+virtual void SendToModeMask (std::string modes, int flags, std::string text) - Forces a user to part a channel.


-virtual void ChangeUserNick (userrec *user, std::string nickname) + Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.


+virtual chanrecJoinUserToChannel (userrec *user, std::string cname, std::string key) - Forces a user nickchange.


-virtual void QuitUser (userrec *user, std::string reason) + Forces a user to join a channel.


+virtual chanrecPartUserFromChannel (userrec *user, std::string cname, std::string reason) - Forces a user to quit with the specified reason.


-virtual bool MatchText (std::string sliteral, std::string spattern) + Forces a user to part a channel.


+virtual void ChangeUserNick (userrec *user, std::string nickname) - Matches text against a glob pattern.


-virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user) + Forces a user nickchange.


+virtual void QuitUser (userrec *user, std::string reason) - Calls the handler for a command, either implemented by the core or by another module.


-virtual void ChangeHost (userrec *user, std::string host) + Forces a user to quit with the specified reason.


+virtual bool MatchText (std::string sliteral, std::string spattern) - Change displayed hostname of a user.


-virtual void ChangeGECOS (userrec *user, std::string gecos) + Matches text against a glob pattern.


+virtual void CallCommandHandler (std::string commandname, char **parameters, int pcnt, userrec *user) - Change GECOS (fullname) of a user.


-virtual bool IsUlined (std::string server) + Calls the handler for a command, either implemented by the core or by another module.


+virtual void ChangeHost (userrec *user, std::string host) - Returns true if the servername you give is ulined.


-virtual chanuserlist GetUsers (chanrec *chan) + Change displayed hostname of a user.


+virtual void ChangeGECOS (userrec *user, std::string gecos) - Fetches the userlist of a channel.


-virtual bool UserToPseudo (userrec *user, std::string message) + Change GECOS (fullname) of a user.


+virtual bool IsUlined (std::string server) - Remove a user's connection to the irc server, but leave their client in existence in the user hash.


-virtual bool PseudoToUser (userrec *alive, userrec *zombie, std::string message) + Returns true if the servername you give is ulined.


+virtual chanuserlist GetUsers (chanrec *chan) - This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other.


-virtual void AddGLine (long duration, std::string source, std::string reason, std::string hostmask) + Fetches the userlist of a channel.


+virtual bool UserToPseudo (userrec *user, std::string message) - 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.


-virtual void AddQLine (long duration, std::string source, std::string reason, std::string nickname) + Remove a user's connection to the irc server, but leave their client in existence in the user hash.


+virtual bool PseudoToUser (userrec *alive, userrec *zombie, std::string message) - 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.


-virtual void AddZLine (long duration, std::string source, std::string reason, std::string ipaddr) + This user takes one user, and switches their file descriptor with another user, so that one user "becomes" the other.


+virtual void AddGLine (long duration, std::string source, std::string reason, std::string hostmask) - 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.


-virtual void AddKLine (long duration, std::string source, std::string reason, std::string hostmask) + 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.


+virtual void AddQLine (long duration, std::string source, std::string reason, std::string nickname) - Adds a K-line The K-line is enforced as soon as it is added.


-virtual void AddELine (long duration, std::string source, std::string reason, std::string hostmask) + 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.


+virtual void AddZLine (long duration, std::string source, std::string reason, std::string ipaddr) - Adds a E-line The E-line is enforced as soon as it is added.


-virtual bool DelGLine (std::string hostmask) + 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.


+virtual void AddKLine (long duration, std::string source, std::string reason, std::string hostmask) - Deletes a G-Line from all servers on the mesh.


-virtual bool DelQLine (std::string nickname) + Adds a K-line The K-line is enforced as soon as it is added.


+virtual void AddELine (long duration, std::string source, std::string reason, std::string hostmask) - Deletes a Q-Line from all servers on the mesh.


-virtual bool DelZLine (std::string ipaddr) + Adds a E-line The E-line is enforced as soon as it is added.


+virtual bool DelGLine (std::string hostmask) - Deletes a Z-Line from all servers on the mesh.


-virtual bool DelKLine (std::string hostmask) + Deletes a G-Line from all servers on the mesh.


+virtual bool DelQLine (std::string nickname) - Deletes a local K-Line.


-virtual bool DelELine (std::string hostmask) + Deletes a Q-Line from all servers on the mesh.


+virtual bool DelZLine (std::string ipaddr) - Deletes a local E-Line.


-virtual long CalcDuration (std::string duration) + Deletes a Z-Line from all servers on the mesh.


+virtual bool DelKLine (std::string hostmask) - Calculates a duration This method will take a string containing a formatted duration (e.g.


-virtual bool IsValidMask (std::string mask) + Deletes a local K-Line.


+virtual bool DelELine (std::string hostmask) - Returns true if a nick!ident string is correctly formatted, false if otherwise.


-virtual void MeshSendAll (std::string text) + Deletes a local E-Line.


+virtual long CalcDuration (std::string duration) - Sends a line of text to all connected servers.


-virtual void MeshSendCommon (userrec *user, std::string text) + Calculates a duration This method will take a string containing a formatted duration (e.g.


+virtual bool IsValidMask (std::string mask) - This method sends a line of text to all servers who have users which share common channels with the user you provide.


-virtual void MeshSendAllAlive (std::string text) + Returns true if a nick!ident string is correctly formatted, false if otherwise.


+virtual void MeshSendAll (std::string text) - This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable.


-virtual void MeshSendUnicast (std::string destination, std::string text) + Sends a line of text to all connected servers.


+virtual void MeshSendCommon (userrec *user, std::string text) - This function sends a line of text directly to a server.


-virtual void MeshSendAllExcept (std::string target, std::string text) + This method sends a line of text to all servers who have users which share common channels with the user you provide.


+virtual void MeshSendAllAlive (std::string text) - This function sends to all servers EXCEPT the one you specify.


-virtual bool MeshCheckChan (chanrec *c, std::string servername) + This function is equivalent to Server::MeshSendToAll except it will only route to servers which are directly routable.


+virtual void MeshSendUnicast (std::string destination, std::string text) - This function is used to check if any users on channel c are on server servername.


-virtual bool MeshCheckCommon (userrec *u, std::string servername) + This function sends a line of text directly to a server.


+virtual void MeshSendAllExcept (std::string target, std::string text) - This function is used to check if user u has any channels in common with users on servername.


-virtual ModuleFindModule (std::string name) + This function sends to all servers EXCEPT the one you specify.


+virtual bool MeshCheckChan (chanrec *c, std::string servername) - This function finds a module by name.


+ This function is used to check if any users on channel c are on server servername.


+virtual bool MeshCheckCommon (userrec *u, std::string servername) + + This function is used to check if user u has any channels in common with users on servername.


+virtual ModuleFindModule (std::string name) + + This function finds a module by name.



Detailed Description

Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. @@ -197,7 +203,7 @@ All modules should instantiate at least one copy of this class, and use its memb

-Definition at line 652 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 694 of file modules.h.

Constructor & Destructor Documentation

@@ -227,10 +233,10 @@ Default constructor.

Creates a Server object.

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

-

00417 {
-00418 }
+
00422 {
+00423 }
 
@@ -263,15 +269,15 @@ Default destructor.

Destroys a Server object.

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

-

00421 {
-00422 }
+
00426 {
+00427 }
 

Member Function Documentation

-

+

@@ -330,17 +336,17 @@ 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 497 of file modules.cpp. +Definition at line 494 of file modules.cpp.

References createcommand().

-

00498 {
-00499         createcommand(cmd,f,flags,minparams,source);
-00500 }
+
00495 {
+00496         createcommand(cmd,f,flags,minparams,source);
+00497 }
 
-

+

@@ -389,19 +395,19 @@ References createcommand().

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

References add_eline(), and duration().

-

00716 {
-00717         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00718 }
+
00732 {
+00733         add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00734 }
 
-

+

@@ -436,20 +442,20 @@ 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 642 of file modules.cpp. +Definition at line 657 of file modules.cpp.

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

-

00643 {
-00644         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-00645         if (res)
-00646                 ModeMakeList(modechar);
-00647         return res;
-00648 }
+
00658 {
+00659         bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+00660         if (res)
+00661                 ModeMakeList(modechar);
+00662         return res;
+00663 }
 
-

+

@@ -506,32 +512,40 @@ Adds an extended mode letter which is parsed by a module.

This allows modules to add extra mode letters, e.g. +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.

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

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

-

00623 {
-00624         if (type == MT_SERVER)
-00625         {
-00626                 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
-00627                 return false;
-00628         }
-00629         if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-00630         {
-00631                 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
-00632                 return false;
-00633         }
-00634         if ((params_when_on>1) || (params_when_off>1))
-00635         {
-00636                 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
-00637                 return false;
-00638         }
-00639         return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-00640 }
+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 }
 
-

+

@@ -580,19 +594,19 @@ References DEBUG, 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 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. +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 695 of file modules.cpp. +Definition at line 711 of file modules.cpp.

References add_gline(), and duration().

-

00696 {
-00697         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00698 }
+
00712 {
+00713         add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00714 }
 
-

+

@@ -641,19 +655,19 @@ References add_gline(), and 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. +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 710 of file modules.cpp. +Definition at line 726 of file modules.cpp.

References add_kline(), and duration().

-

00711 {
-00712         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-00713 }
+
00727 {
+00728         add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+00729 }
 
-

+

@@ -702,19 +716,19 @@ References add_kline(), and 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. +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 700 of file modules.cpp. +Definition at line 716 of file modules.cpp.

References add_qline(), and duration().

-

00701 {
-00702         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-00703 }
+
00717 {
+00718         add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+00719 }
 
-

+

@@ -763,19 +777,19 @@ References add_qline(), and 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. +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 705 of file modules.cpp. +Definition at line 721 of file modules.cpp.

References add_zline(), and duration().

-

00706 {
-00707         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-00708 }
+
00722 {
+00723         add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+00724 }
 
-

+

@@ -805,17 +819,17 @@ 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 745 of file modules.cpp. +Definition at line 761 of file modules.cpp.

References duration().

-

00746 {
-00747         return duration(delta.c_str());
-00748 }
+
00762 {
+00763         return duration(delta.c_str());
+00764 }
 
-

+

@@ -865,17 +879,17 @@ References duration(). 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
-) 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. +) 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 487 of file modules.cpp. +Definition at line 484 of file modules.cpp.

-

00488 {
-00489         call_handler(commandname.c_str(),parameters,pcnt,user);
-00490 }
+
00485 {
+00486         call_handler(commandname.c_str(),parameters,pcnt,user);
+00487 }
 
-

+

@@ -914,17 +928,17 @@ Change GECOS (fullname) of a user.

You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.

-Definition at line 575 of file modules.cpp. +Definition at line 577 of file modules.cpp.

References ChangeName().

-

00576 {
-00577         ChangeName(user,gecos.c_str());
-00578 }
+
00578 {
+00579         ChangeName(user,gecos.c_str());
+00580 }
 
-

+

@@ -963,17 +977,17 @@ Change displayed hostname of a user.

You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.

-Definition at line 570 of file modules.cpp. +Definition at line 572 of file modules.cpp.

References ChangeDisplayedHost().

-

00571 {
-00572         ChangeDisplayedHost(user,host.c_str());
-00573 }
+
00573 {
+00574         ChangeDisplayedHost(user,host.c_str());
+00575 }
 
-

+

@@ -1012,15 +1026,15 @@ Forces a user nickchange.

This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.

-Definition at line 471 of file modules.cpp. +Definition at line 469 of file modules.cpp.

-

00472 {
-00473         force_nickchange(user,nickname.c_str());
-00474 }
+
00470 {
+00471         force_nickchange(user,nickname.c_str());
+00472 }
 
-

+

@@ -1059,17 +1073,17 @@ Attempts to look up a user's privilages on a channel.

This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.

-Definition at line 595 of file modules.cpp. +Definition at line 602 of file modules.cpp.

References cmode().

-

00596 {
-00597         return cmode(User,Chan);
-00598 }
+
00603 {
+00604         return cmode(User,Chan);
+00605 }
 
-

+

@@ -1106,19 +1120,19 @@ References cmode().

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. +This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.

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

References common_channels().

-

00549 {
-00550         return (common_channels(u1,u2) != 0);
-00551 }
+
00551 {
+00552         return (common_channels(u1,u2) != 0);
+00553 }
 
-

+

@@ -1148,15 +1162,15 @@ Returns a count of the number of users on a channel.

This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.

-Definition at line 650 of file modules.cpp. +Definition at line 665 of file modules.cpp.

-

00651 {
-00652         return usercount(c);
-00653 }
+
00666 {
+00667         return usercount(c);
+00668 }
 
-

+

@@ -1186,17 +1200,17 @@ Deletes a local E-Line.

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

References del_eline().

-

00741 {
-00742         del_eline(hostmask.c_str());
-00743 }
+
00757 {
+00758         del_eline(hostmask.c_str());
+00759 }
 
-

+

@@ -1226,17 +1240,17 @@ Deletes a G-Line from all servers on the mesh.

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

References del_gline().

-

00721 {
-00722         del_gline(hostmask.c_str());
-00723 }
+
00737 {
+00738         del_gline(hostmask.c_str());
+00739 }
 
-

+

@@ -1266,17 +1280,17 @@ Deletes a local K-Line.

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

References del_kline().

-

00736 {
-00737         del_kline(hostmask.c_str());
-00738 }
+
00752 {
+00753         del_kline(hostmask.c_str());
+00754 }
 
-

+

@@ -1306,17 +1320,17 @@ Deletes a Q-Line from all servers on the mesh.

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

References del_qline().

-

00726 {
-00727         del_qline(nickname.c_str());
-00728 }
+
00742 {
+00743         del_qline(nickname.c_str());
+00744 }
 
-

+

@@ -1346,17 +1360,17 @@ Deletes a Z-Line from all servers on the mesh.

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

References del_zline().

-

00731 {
-00732         del_zline(ipaddr.c_str());
-00733 }
+
00747 {
+00748         del_zline(ipaddr.c_str());
+00749 }
 
-

+

@@ -1386,15 +1400,55 @@ Attempts to look up a channel and return a pointer to it.

This function will return NULL if the channel does not exist.

-Definition at line 590 of file modules.cpp. +Definition at line 597 of file modules.cpp.

-

00591 {
-00592         return FindChan(channel.c_str());
-00593 }
+
00598 {
+00599         return FindChan(channel.c_str());
+00600 }
 
-

+

+ + + + +
+ + + + + + + + + + +
userrec * Server::FindDescriptor int  socket  )  [virtual]
+
+ + + + + +
+   + + +

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

+References fd_ref_table. +

+

00593 {
+00594         return (socket < 65536 ? fd_ref_table[socket] : NULL);
+00595 }
+
+

@@ -1424,24 +1478,24 @@ This function finds a module by name.

You must provide the filename of the module. If the module cannot be found (is not loaded) the function will return NULL.

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

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

-

00824 {
-00825         for (int i = 0; i <= MODCOUNT; i++)
-00826         {
-00827                 if (module_names[i] == name)
-00828                 {
-00829                         return modules[i];
-00830                 }
-00831         }
-00832         return NULL;
-00833 }
+
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 }
 
-

+

@@ -1471,15 +1525,15 @@ Attempts to look up a nick and return a pointer to it.

This function will return NULL if the nick does not exist.

-Definition at line 585 of file modules.cpp. +Definition at line 587 of file modules.cpp.

-

00586 {
-00587         return Find(nick);
-00588 }
+
00588 {
+00589         return Find(nick);
+00590 }
 
-

+

@@ -1508,15 +1562,15 @@ 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 615 of file modules.cpp. +Definition at line 622 of file modules.cpp.

-

00616 {
-00617         return Admin(getadminname(),getadminemail(),getadminnick());
-00618 }
+
00623 {
+00624         return Admin(getadminname(),getadminemail(),getadminnick());
+00625 }
 
-

+

@@ -1545,15 +1599,15 @@ Returns the network name, global to all linked servers.

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

-

00611 {
-00612         return getnetworkname();
-00613 }
+
00618 {
+00619         return getnetworkname();
+00620 }
 
-

+

@@ -1582,15 +1636,15 @@ Returns the server name of the server where the module is loaded.

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

-

00606 {
-00607         return getservername();
-00608 }
+
00613 {
+00614         return getservername();
+00615 }
 
-

+

@@ -1620,32 +1674,25 @@ Fetches the userlist of a channel.

This function must be here and not a member of userrec or chanrec due to include constraints.

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

-References chanuserlist, clientlist, has_channel(), and isnick(). -

-

00453 {
-00454         chanuserlist userl;
-00455         userl.clear();
-00456         for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-00457         {
-00458                 if (i->second)
-00459                 {
-00460                         if (has_channel(i->second,chan))
-00461                         {
-00462                                 if (isnick(i->second->nick))
-00463                                 {
-00464                                         userl.push_back(i->second);
-00465                                 }
-00466                         }
-00467                 }
-00468         }
-00469         return userl;
-00470 }
+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 }
 
-

+

@@ -1675,17 +1722,17 @@ Returns true if a nick is valid.

Nicks for unregistered connections will return false.

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

References isnick().

-

00581 {
-00582         return (isnick(nick.c_str()) != 0);
-00583 }
+
00583 {
+00584         return (isnick(nick.c_str()) != 0);
+00585 }
 
-

+

@@ -1724,17 +1771,17 @@ Checks if a user is on a channel.

This function will return true or false to indicate if user 'User' is on channel 'Chan'.

-Definition at line 600 of file modules.cpp. +Definition at line 607 of file modules.cpp.

References has_channel().

-

00601 {
-00602         return has_channel(User,Chan);
-00603 }
+
00608 {
+00609         return has_channel(User,Chan);
+00610 }
 
-

+

@@ -1764,17 +1811,17 @@ Returns true if the servername you give is ulined.

ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.

-Definition at line 482 of file modules.cpp. +Definition at line 479 of file modules.cpp.

References is_uline().

-

00483 {
-00484         return is_uline(server.c_str());
-00485 }
+
00480 {
+00481         return is_uline(server.c_str());
+00482 }
 
-

+

@@ -1804,39 +1851,39 @@ Returns true if a nick!ident string is correctly formatted, false if otherwise.

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

-

00751 {
-00752         const char* dest = mask.c_str();
-00753         if (strchr(dest,'!')==0)
-00754                 return false;
-00755         if (strchr(dest,'@')==0)
-00756                 return false;
-00757         for (int i = 0; i < strlen(dest); i++)
-00758                 if (dest[i] < 32)
-00759                         return false;
-00760         for (int i = 0; i < strlen(dest); i++)
-00761                 if (dest[i] > 126)
-00762                         return false;
-00763         int c = 0;
-00764         for (int i = 0; i < strlen(dest); i++)
-00765                 if (dest[i] == '!')
-00766                         c++;
-00767         if (c>1)
-00768                 return false;
-00769         c = 0;
-00770         for (int i = 0; i < strlen(dest); i++)
-00771                 if (dest[i] == '@')
-00772                         c++;
-00773         if (c>1)
-00774                 return false;
-00775 
-00776         return true;
-00777 }
+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)
+00790                 return false;
+00791 
+00792         return true;
+00793 }
 
-

+

@@ -1881,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 442 of file modules.cpp. +Definition at line 447 of file modules.cpp.

-

00443 {
-00444         return add_channel(user,cname.c_str(),key.c_str(),true);
-00445 }
+
00448 {
+00449         return add_channel(user,cname.c_str(),key.c_str(),false);
+00450 }
 
@@ -1928,15 +1975,15 @@ Writes a log string.

This method writes a line of text to the log. If the level given is lower than the level given in the configuration, this command has no effect.

-Definition at line 492 of file modules.cpp. +Definition at line 489 of file modules.cpp.

-

00493 {
-00494         log(level,"%s",s.c_str());
-00495 }
+
00490 {
+00491         log(level,"%s",s.c_str());
+00492 }
 
-

+

@@ -1975,18 +2022,18 @@ Matches text against a glob pattern.

Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.

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

-

00430 {
-00431         char literal[MAXBUF],pattern[MAXBUF];
-00432         strlcpy(literal,sliteral.c_str(),MAXBUF);
-00433         strlcpy(pattern,spattern.c_str(),MAXBUF);
-00434         return match(literal,pattern);
-00435 }
+
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 }
 
-

+

@@ -2025,19 +2072,19 @@ 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 805 of file modules.cpp. +Definition at line 821 of file modules.cpp.

-

00806 {
-00807         if (c)
-00808         {
-00809                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
-00810         }
-00811         else return false;
-00812 }
+
00822 {
+00823         if (c)
+00824         {
+00825                 return ChanAnyOnThisServer(c,(char*)servername.c_str());
+00826         }
+00827         else return false;
+00828 }
 
-

+

@@ -2074,21 +2121,21 @@ Definition at line 805

This function is used to check if user u has any channels in common with users on servername.

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

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

-

00815 {
-00816         if (u)
-00817         {
-00818                 return CommonOnThisServer(u,(char*)servername.c_str());
-00819         }
-00820         else return false;
-00821 }
+
00831 {
+00832         if (u)
+00833         {
+00834                 return CommonOnThisServer(u,(char*)servername.c_str());
+00835         }
+00836         else return false;
+00837 }
 
-

+

@@ -2118,15 +2165,15 @@ Sends a line of text to all connected servers.

If a server is not directly reachable, the core deals with routing the message, and will also deal with failures transparently.

-Definition at line 779 of file modules.cpp. +Definition at line 795 of file modules.cpp.

-

00780 {
-00781         NetSendToAll((char*)text.c_str());
-00782 }
+
00796 {
+00797         NetSendToAll((char*)text.c_str());
+00798 }
 
-

+

@@ -2156,15 +2203,15 @@ This function is equivalent to Server::MeshSendToAll except it will only route t

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

-

00791 {
-00792         NetSendToAllAlive((char*)text.c_str());
-00793 }
+
00807 {
+00808         NetSendToAllAlive((char*)text.c_str());
+00809 }
 
-

+

@@ -2203,15 +2250,15 @@ This function sends to all servers EXCEPT the one you specify.

You should usually use this function to send messages, specifying the SENDER of your message as 'target'. This will prevent message loops.

-Definition at line 800 of file modules.cpp. +Definition at line 816 of file modules.cpp.

-

00801 {
-00802         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
-00803 }
+
00817 {
+00818         NetSendToAllExcept(target.c_str(),(char*)text.c_str());
+00819 }
 
-

+

@@ -2250,16 +2297,16 @@ 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 784 of file modules.cpp. +Definition at line 800 of file modules.cpp.

-

00785 {
-00786         if (user)
-00787                 NetSendToCommon(user,(char*)text.c_str());
-00788 }
+
00801 {
+00802         if (user)
+00803                 NetSendToCommon(user,(char*)text.c_str());
+00804 }
 
-

+

@@ -2298,15 +2345,15 @@ This function sends a line of text directly to a server.

If the server is not directly routable at this time, the server attempts to route text through the mesh.

-Definition at line 795 of file modules.cpp. +Definition at line 811 of file modules.cpp.

-

00796 {
-00797         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
-00798 }
+
00812 {
+00813         NetSendToOne((char*)destination.c_str(),(char*)text.c_str());
+00814 }
 
-

+

@@ -2351,15 +2398,15 @@ Forces a user to part a channel.

This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.

-Definition at line 447 of file modules.cpp. +Definition at line 452 of file modules.cpp.

-

00448 {
-00449         return del_channel(user,cname.c_str(),reason.c_str(),false);
-00450 }
+
00453 {
+00454         return del_channel(user,cname.c_str(),reason.c_str(),false);
+00455 }
 
-

+

@@ -2404,42 +2451,42 @@ 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 665 of file modules.cpp. -

-References ucrec::channel, userrec::chans, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. -

-

00666 {
-00667         zombie->fd = alive->fd;
-00668         alive->fd = FD_MAGIC_NUMBER;
-00669         Write(zombie->fd,":%s!%s@%s NICK %s",alive->nick,alive->ident,alive->host,zombie->nick);
-00670         kill_link(alive,message.c_str());
-00671         for (int i = 0; i != MAXCHANS; i++)
-00672         {
-00673                 if (zombie->chans[i].channel != NULL)
-00674                 {
-00675                         if (zombie->chans[i].channel->name)
-00676                         {
-00677                                 chanrec* Ptr = zombie->chans[i].channel;
-00678                                 WriteFrom(zombie->fd,zombie,"JOIN %s",Ptr->name);
-00679                                 if (Ptr->topicset)
-00680                                 {
-00681                                         WriteServ(zombie->fd,"332 %s %s :%s", zombie->nick, Ptr->name, Ptr->topic);
-00682                                         WriteServ(zombie->fd,"333 %s %s %s %d", zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-00683                                 }
-00684                                 userlist(zombie,Ptr);
-00685                                 WriteServ(zombie->fd,"366 %s %s :End of /NAMES list.", zombie->nick, Ptr->name);
-00686                                 //WriteServ(zombie->fd,"324 %s %s +%s",zombie->nick, Ptr->name,chanmodes(Ptr));
-00687                                 //WriteServ(zombie->fd,"329 %s %s %d", zombie->nick, Ptr->name, Ptr->created);
-00688 
-00689                         }
-00690                 }
-00691         }
-00692 
-00693 }
+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 }
 
-

+

@@ -2480,14 +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 476 of file modules.cpp. -

-References userrec::nick, and send_network_quit(). +Definition at line 474 of file modules.cpp.

-

00477 {
-00478         send_network_quit(user->nick,reason.c_str());
-00479         kill_link(user,reason.c_str());
-00480 }
+
00475 {
+00476         kill_link(user,reason.c_str());
+00477 }
 
@@ -2530,15 +2574,15 @@ Sends a line of text down a TCP/IP socket.

This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.

-Definition at line 507 of file modules.cpp. +Definition at line 504 of file modules.cpp.

-

00508 {
-00509         Write(Socket,"%s",s.c_str());
-00510 }
+
00505 {
+00506         Write(Socket,"%s",s.c_str());
+00507 }
 
-

+

+ +
@@ -2589,22 +2633,75 @@ Sends text from a user to a channel (mulicast).

This method writes a line of text to a channel, with the given user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in MODE (see RFC 1459).

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

-

00537 {
-00538         if (IncludeSender)
-00539         {
-00540                 WriteChannel(Channel,User,"%s",s.c_str());
-00541         }
-00542         else
-00543         {
-00544                 ChanExceptSender(Channel,User,"%s",s.c_str());
-00545         }
-00546 }
+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 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void Server::SendChannelServerNotice std::string  ServName,
chanrec Channel,
std::string  text
[virtual]
+
+ + + +
+   + + +

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

+

00534 {
+00535         WriteChannelWithServ((char*)ServName.c_str(), Channel, "%s", text.c_str());
+00536 }
 
-

+

@@ -2649,22 +2746,22 @@ Sends text from a user to one or more channels (mulicast).

This method writes a line of text to all users which share a common channel with a given user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it is only sent to the other recipients, as seen in QUIT.

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

-

00554 {
-00555         if (IncludeSender)
-00556         {
-00557                 WriteCommon(User,"%s",text.c_str());
-00558         }
-00559         else
-00560         {
-00561                 WriteCommonExcept(User,"%s",text.c_str());
-00562         }
-00563 }
+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 }
 
-

+

@@ -2709,15 +2806,15 @@ Sends text from a user to a socket.

This method writes a line of text to an established socket, with the given user's nick/ident /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)

-Definition at line 517 of file modules.cpp. +Definition at line 514 of file modules.cpp.

-

00518 {
-00519         WriteFrom(Socket,User,"%s",s.c_str());
-00520 }
+
00515 {
+00516         WriteFrom(Socket,User,"%s",s.c_str());
+00517 }
 
-

+

@@ -2769,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 502 of file modules.cpp. +Definition at line 499 of file modules.cpp.

References server_mode().

-

00503 {
-00504         server_mode(parameters,pcnt,user);
-00505 }
+
00500 {
+00501         server_mode(parameters,pcnt,user);
+00502 }
 
@@ -2809,11 +2906,11 @@ Sends text to all opers.

This method sends a server notice to all opers with the usermode +s.

-Definition at line 424 of file modules.cpp. +Definition at line 429 of file modules.cpp.

-

00425 {
-00426         WriteOpers("%s",s.c_str());
-00427 }
+
00430 {
+00431         WriteOpers("%s",s.c_str());
+00432 }
 
@@ -2856,15 +2953,15 @@ Sends text from the server to a socket.

This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)

-Definition at line 512 of file modules.cpp. +Definition at line 509 of file modules.cpp.

-

00513 {
-00514         WriteServ(Socket,"%s",s.c_str());
-00515 }
+
00510 {
+00511         WriteServ(Socket,"%s",s.c_str());
+00512 }
 
-

+

@@ -2913,26 +3010,26 @@ The format will become:

:localserver TEXT

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

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

-References connection::fd. -

-

00523 {
-00524         if (!Source)
-00525         {
-00526                 // if source is NULL, then the message originates from the local server
-00527                 Write(Dest->fd,":%s %s",this->GetServerName().c_str(),s.c_str());
-00528         }
-00529         else
-00530         {
-00531                 // otherwise it comes from the user specified
-00532                 WriteTo(Source,Dest,"%s",s.c_str());
-00533         }
-00534 }
+Definition at line 519 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 }
 
-

+

@@ -2979,15 +3076,15 @@ 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 437 of file modules.cpp. +Definition at line 442 of file modules.cpp.

-

00438 {
-00439         WriteMode(modes.c_str(),flags,"%s",text.c_str());
-00440 }
+
00443 {
+00444         WriteMode(modes.c_str(),flags,"%s",text.c_str());
+00445 }
 
-

+

@@ -3026,15 +3123,15 @@ Sends a WALLOPS message.

This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.

-Definition at line 565 of file modules.cpp. +Definition at line 567 of file modules.cpp.

-

00566 {
-00567         WriteWallOps(User,false,"%s",text.c_str());
-00568 }
+
00568 {
+00569         WriteWallOps(User,false,"%s",text.c_str());
+00570 }
 
-

+

@@ -3073,23 +3170,24 @@ 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 656 of file modules.cpp. +Definition at line 671 of file modules.cpp.

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

-

00657 {
-00658         unsigned int old_fd = user->fd;
-00659         user->fd = FD_MAGIC_NUMBER;
-00660         Write(old_fd,"ERROR :Closing link (%s@%s) [%s]",user->ident,user->host,message.c_str());
-00661         close(old_fd);
-00662         shutdown (old_fd,2);
-00663 }
+
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 }
 


The documentation for this class was generated from the following files: -
Generated on Tue Apr 26 17:11:51 2005 for InspIRCd by +
Generated on Sat May 7 15:34:28 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 bfdff0636..cf4a60a8a 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classVersion.html b/docs/module-doc/classVersion.html index 3312bb364..c792987c2 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 302 of file modules.cpp. +Definition at line 300 of file modules.cpp.

-

00302 : Major(major), Minor(minor), Revision(revision), Build(build), Flags(flags) { };
+
00300 : 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34: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 62610243f..abb102776 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classXLine.html b/docs/module-doc/classXLine.html index 9eb242dd5..8d26c8e3a 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34: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 69aced718..b9d028897 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classZLine.html b/docs/module-doc/classZLine.html index ef8261a20..07ac0eb8a 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34: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 068b05362..392b35af8 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 Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index 9ad664151..424fd9ee9 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -444,6 +444,8 @@ Definition at line 240

References internal_userlist.

+Referenced by Server::GetUsers(). +

00241 {
 00242         return &internal_userlist;
 00243 }
@@ -576,7 +578,7 @@ References custom_modes,
 

00126 {
 00127         if (mode_on) {
-00128                 char m[3];
+00128                 static char m[3];
 00129                 m[0] = mode;
 00130                 m[1] = '\0';
 00131                 if (!strchr(this->custom_modes,mode))
@@ -958,7 +960,7 @@ The channels name.
 

Definition at line 99 of file channels.h.

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

@@ -1042,7 +1044,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().

@@ -1070,7 +1072,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().

@@ -1126,7 +1128,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().

@@ -1159,7 +1161,7 @@ Referenced by chanrec()


The documentation for this class was generated from the following files: -
Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 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 eb0477ae7..f135846df 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 Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classclassbase.html b/docs/module-doc/classclassbase.html index e68905f3a..89c86c19b 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 Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:23 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 3687ae71f..44ffa4ed4 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 Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 dfd8774e7..984063bc4 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 Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 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 c7f4c7f7e..cad6cfc13 100644 --- a/docs/module-doc/classconnection-members.html +++ b/docs/module-doc/classconnection-members.html @@ -20,7 +20,6 @@ Extend(std::string key, char *p)Extensible fdconnection FindHost(std::string host)connection - GenKey()connection GetExt(std::string key)Extensible haspassedconnection hostconnection @@ -41,7 +40,7 @@ stateconnection TerminateLink(char *targethost)connection ~classbase()classbase [inline] -
Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classconnection.html b/docs/module-doc/classconnection.html index 54e5565f1..a02f27de1 100644 --- a/docs/module-doc/classconnection.html +++ b/docs/module-doc/classconnection.html @@ -44,9 +44,6 @@ Inherited by serverrec, and bool AddIncoming (int fd, char *targethost, int sourceport)  Add an incoming connection to the connection pool.

-long GenKey () - - This function is deprecated and may be removed in a later alpha/beta.



Public Attributes

int fd @@ -111,7 +108,7 @@ Please note: classes serverrec and userrec both inherit from class connection.

-Definition at line 178 of file connection.h.


Constructor & Destructor Documentation

+Definition at line 210 of file connection.h.

Constructor & Destructor Documentation

@@ -318,36 +315,6 @@ Find the ircd_connector oject
-

- - - - -
- - - - - - - - - -
long connection::GenKey  ) 
-
- - - - - -
-   - - -

-This function is deprecated and may be removed in a later alpha/beta. -

-

@@ -535,7 +502,7 @@ Stats counter for bytes inbound.

-Definition at line 199 of file connection.h. +Definition at line 231 of file connection.h.

Referenced by userrec::userrec().

@@ -563,7 +530,7 @@ Stats counter for bytes outbound.

-Definition at line 203 of file connection.h. +Definition at line 235 of file connection.h.

Referenced by userrec::userrec(). @@ -591,7 +558,7 @@ Stats counter for commands inbound.

-Definition at line 207 of file connection.h. +Definition at line 239 of file connection.h.

Referenced by userrec::userrec(). @@ -619,7 +586,7 @@ Stats counter for commands outbound.

-Definition at line 211 of file connection.h. +Definition at line 243 of file connection.h.

Referenced by userrec::userrec(). @@ -647,7 +614,7 @@ With a serverrec, this is a list of all established server connections.

With a userrec this is unused.

-Definition at line 258 of file connection.h. +Definition at line 290 of file connection.h.

@@ -673,9 +640,9 @@ File descriptor of the connection.

-Definition at line 183 of file connection.h. +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().

@@ -701,7 +668,7 @@ True if server/user has authenticated, false if otherwise.

-Definition at line 215 of file connection.h. +Definition at line 247 of file connection.h.

Referenced by userrec::userrec(). @@ -729,9 +696,9 @@ Hostname of connection.

Not used if this is a serverrec

-Definition at line 187 of file connection.h. +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().

@@ -757,7 +724,7 @@ Time that the connection last sent data, used to calculate idle time.

-Definition at line 241 of file connection.h. +Definition at line 273 of file connection.h.

Referenced by userrec::userrec(). @@ -785,7 +752,7 @@ Inbuf of connection.

Only used for userrec

-Definition at line 195 of file connection.h. +Definition at line 227 of file connection.h.

Referenced by userrec::userrec(). @@ -813,7 +780,7 @@ Unused, will be removed in a future alpha/beta.

-Definition at line 249 of file connection.h. +Definition at line 281 of file connection.h.

@@ -839,7 +806,7 @@ Unused, will be removed in a future alpha/beta.

-Definition at line 253 of file connection.h. +Definition at line 285 of file connection.h.

@@ -865,7 +832,7 @@ IP of connection.

Reserved for future use.

-Definition at line 191 of file connection.h. +Definition at line 223 of file connection.h.

Referenced by userrec::userrec(). @@ -893,7 +860,7 @@ Time the connection was last pinged.

-Definition at line 233 of file connection.h. +Definition at line 265 of file connection.h.

Referenced by serverrec::serverrec(), and userrec::userrec(). @@ -921,7 +888,7 @@ Used by PING checks with clients.

-Definition at line 245 of file connection.h. +Definition at line 277 of file connection.h.

Referenced by userrec::userrec(). @@ -949,7 +916,7 @@ Port number For a userrec, this is the port they connected to the network on.

For a serverrec this is the current listening port of the serverrec object.

-Definition at line 221 of file connection.h. +Definition at line 253 of file connection.h.

Referenced by userrec::userrec(). @@ -977,7 +944,7 @@ Used by userrec to indicate the registration status of the connection.

-Definition at line 225 of file connection.h. +Definition at line 257 of file connection.h.

Referenced by userrec::userrec(). @@ -1005,7 +972,7 @@ Time the connection was created, set in the constructor.

-Definition at line 237 of file connection.h. +Definition at line 269 of file connection.h.

Referenced by serverrec::serverrec(), and userrec::userrec(). @@ -1033,12 +1000,12 @@ Reserved for future use.

-Definition at line 229 of file connection.h. +Definition at line 261 of file connection.h.


The documentation for this class was generated from the following file: -
Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by +
Generated on Sat May 7 15:34:24 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classes.html b/docs/module-doc/classes.html index b3c5d1746..6899bd21c 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +GLine   Module   
Generated on Sat May 7 15:34:23 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 323460439..a5059edbc 100644 --- a/docs/module-doc/classircd__connector-members.html +++ b/docs/module-doc/classircd__connector-members.html @@ -24,6 +24,7 @@ GetServerName()ircd_connector GetServerPort()ircd_connector GetState()ircd_connector + GetVersionString()ircd_connector hostircd_connector ircdbufferircd_connector MakeOutboundConnection(char *newhost, int newport)ircd_connector @@ -37,10 +38,12 @@ SetServerName(std::string serv)ircd_connector SetServerPort(int p)ircd_connector SetState(int state)ircd_connector + SetVersionString(std::string newversion)ircd_connector Shrink(std::string key)Extensible stateircd_connector [private] + versionircd_connector [private] ~classbase()classbase [inline] -
Generated on Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 a5acb44f1..b0027cdda 100644 --- a/docs/module-doc/classircd__connector.html +++ b/docs/module-doc/classircd__connector.html @@ -59,16 +59,27 @@ Inherits Extensible.  Close the connection by calling close() on its file descriptor This function call updates no other data.


void AddBuffer (std::string a) + This method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer.


bool BufferIsComplete () + This method returns true if the buffer contains at least one carriage return character, e.g.


void ClearBuffer () + This method clears the server's buffer by setting it to an empty string.


std::string GetBuffer () + This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok().


+void SetVersionString (std::string newversion) + + This method sets the version string of the remote server.


+std::string GetVersionString () + + This method returns the version string of the remote server.



Public Attributes

std::string ircdbuffer - IRCD Buffer for input characters, holds one line.


+ IRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a
+ seperator.


char host [MAXBUF]  When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.


@@ -98,6 +109,9 @@ Inherits Extensible. int state  State.


+std::string version + + This string holds the ircd's version response.



Detailed Description

Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. @@ -133,7 +147,9 @@ Definition at line 54

- +This method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer. +

+It is the sending server's responsibility to ensure sent data is kept within reasonable quanities.

@@ -161,7 +177,9 @@ Definition at line 54

- +This method returns true if the buffer contains at least one carriage return character, e.g. +

+one line can be read from the buffer successfully.

@@ -188,6 +206,8 @@ Definition at line 54 +

+This method clears the server's buffer by setting it to an empty string.

@@ -246,6 +266,8 @@ Close the connection by calling close() on its file descriptor This function cal +

+This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok().

@@ -430,6 +452,36 @@ Get the state flags for this connection. +

+ + + + +
+ + + + + + + + + +
std::string ircd_connector::GetVersionString  ) 
+
+ + + + + +
+   + + +

+This method returns the version string of the remote server. +

+If the server has no version string an empty string is returned.

@@ -705,6 +757,37 @@ Set the state flags for this connection.
+

+ + + + +
+ + + + + + + + + + +
void ircd_connector::SetVersionString std::string  newversion  ) 
+
+ + + + + +
+   + + +

+This method sets the version string of the remote server. +

+


Member Data Documentation

@@ -807,7 +890,7 @@ When MakeOutboundConnection is called, these public members are filled with the

-Definition at line 94 of file connection.h. +Definition at line 99 of file connection.h.

@@ -829,11 +912,12 @@ Definition at line 94

-IRCD Buffer for input characters, holds one line. +IRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a
+ seperator.

-Definition at line 87 of file connection.h. +Definition at line 92 of file connection.h.

@@ -859,7 +943,7 @@ When MakeOutboundConnection is called, these public members are filled with the

-Definition at line 100 of file connection.h. +Definition at line 105 of file connection.h.

@@ -885,7 +969,7 @@ Definition at line 100

-Definition at line 106 of file connection.h. +Definition at line 111 of file connection.h.

@@ -940,9 +1024,35 @@ STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STAT Definition at line 76 of file connection.h. +

+ + + + +
+ + +
std::string ircd_connector::version [private] +
+
+ + + + + +
+   + + +

+This string holds the ircd's version response. +

+ +

+Definition at line 84 of file connection.h.


The documentation for this class was generated from the following file: -
Generated on Tue Apr 26 17:11:48 2005 for InspIRCd by +
Generated on Sat May 7 15:34:25 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 56dabbf32..2c772e794 100644 --- a/docs/module-doc/classserverrec-members.html +++ b/docs/module-doc/classserverrec-members.html @@ -21,7 +21,6 @@ Extend(std::string key, char *p)Extensible fdconnection FindHost(std::string host)connection - GenKey()connection GetExt(std::string key)Extensible haspassedconnection hops_awayserverrec @@ -55,7 +54,7 @@ versionserverrec ~classbase()classbase [inline] ~serverrec()serverrec -
Generated on Tue Apr 26 17:11:51 2005 for InspIRCd by +
Generated on Sat May 7 15:34:28 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classserverrec.html b/docs/module-doc/classserverrec.html index 8f838c1a7..730b8c5e3 100644 --- a/docs/module-doc/classserverrec.html +++ b/docs/module-doc/classserverrec.html @@ -95,7 +95,7 @@ Constructor.

Definition at line 26 of file servers.cpp.

-References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, TIME, usercount, usercount_i, and version. +References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, TIME, usercount, usercount_i, and version.

00027 {
 00028         strlcpy(name,"",256);
@@ -159,7 +159,7 @@ Constructor which initialises some of the main variables.
 

Definition at line 45 of file servers.cpp.

-References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, TIME, usercount, usercount_i, and version. +References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, TIME, usercount, usercount_i, and version.

00046 {
 00047         strlcpy(name,n,256);
@@ -519,7 +519,7 @@ Referenced by serverrec()
 
The documentation for this class was generated from the following files:
-
Generated on Tue Apr 26 17:11:51 2005 for InspIRCd by +
Generated on Sat May 7 15:34: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 7a55022ca..dc63998ac 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 Tue Apr 26 17:11:51 2005 for InspIRCd by +
Generated on Sat May 7 15:34:28 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classucrec.html b/docs/module-doc/classucrec.html index 0d275e0e5..c108eb9de 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 Tue Apr 26 17:11:51 2005 for InspIRCd by +
Generated on Sat May 7 15:34: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 1fad78737..b989419b1 100644 --- a/docs/module-doc/classuserrec-members.html +++ b/docs/module-doc/classuserrec-members.html @@ -6,14 +6,17 @@

userrec Member List

This is the complete list of members for userrec, including all inherited members. + + + @@ -26,7 +29,7 @@ - + @@ -43,6 +46,7 @@ + @@ -52,8 +56,10 @@ + + @@ -61,11 +67,12 @@ + -
AddBuffer(std::string a)userrec
AddIncoming(int fd, char *targethost, int sourceport)connection
ageclassbase
awaymsguserrec
BeginLink(char *targethost, int port, char *password, char *servername, int myport)connection
BufferIsReady()userrec
bytes_inconnection
bytes_outconnection
chansuserrec
classbase()classbase [inline]
ClearBuffer()userrec
cmds_inconnection
cmds_outconnection
connection()connection
FindHost(std::string host)connection
flooduserrec
fullnameuserrec
GenKey()connection
GetBuffer()userrec
GetExt(std::string key)Extensible
GetFullHost()userrec [virtual]
GetFullRealHost()userrec [virtual]
ipconnection
IsInvited(char *channel)userrec [virtual]
lastpingconnection
lines_inuserrec
MeshCookie(char *targethost, int port, unsigned long cookie, char *servername)connection
modesuserrec
nickuserrec
pingmaxuserrec
portconnection
RecvPacket(std::deque< std::string > &messages, char *host)connection
recvquserrec
registeredconnection
RemoveInvite(char *channel)userrec [virtual]
reset_dueuserrec
resultuserrec
SendPacket(char *message, const char *host)connection
serveruserrec
signonconnection
stateconnection
TerminateLink(char *targethost)connection
thresholduserrec
timeoutuserrec
userrec()userrec
~classbase()classbase [inline]
~userrec()userrec [inline, virtual]

Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34:29 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 0e698ae74..16ad17d03 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -37,6 +37,18 @@ Inherits connection. bool HasPermission (char *command)  Returns true or false for if a user can execute a privilaged oper command.

+bool AddBuffer (std::string a) + + This method adds data to the buffer of the user.


+bool BufferIsReady () + + This method returns true if the buffer contains at least one carriage return character (e.g.


+void ClearBuffer () + + This function clears the entire buffer by setting it to an empty string.


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



Public Attributes

char nick [NICKMAX] @@ -82,6 +94,16 @@ Inherits connection. char password [MAXBUF]  Password specified by the user when they registered.


+std::string recvq + + User's receive queue.


+long lines_in + + Flood counters.


+time_t reset_due + +long threshold +

Private Attributes

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

-Definition at line 93 of file users.h.


Constructor & Destructor Documentation

+Definition at line 98 of file users.h.

Constructor & Destructor Documentation

@@ -124,7 +146,7 @@ Definition at line 93 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, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. +References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, lines_in, modes, nick, connection::nping, oper, connection::port, recvq, connection::registered, reset_due, result, server, connection::signon, TIME, timeout, and ucrec::uc_modes.

00029 {
 00030         // the PROPER way to do it, AVOID bzero at *ALL* costs
@@ -140,18 +162,21 @@ References awaymsg, "");
 00041         strcpy(awaymsg,"");
 00042         strcpy(oper,"");
-00043         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
-00044         flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
-00045         haspassed = false;
-00046         dns_done = false;
-00047         strcpy(result,"");
-00048         for (int i = 0; i < MAXCHANS; i++)
-00049         {
-00050                 this->chans[i].channel = NULL;
-00051                 this->chans[i].uc_modes = 0;
-00052         }
-00053         invites.clear();
-00054 }
+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 }
 
@@ -182,13 +207,203 @@ References awaymsg,

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

-

00178 {  }
+
00195 {  }
 

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
bool userrec::AddBuffer std::string  a  ) 
+
+ + + + + +
+   + + +

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

+ + + + +
+ + + + + + + + + +
bool userrec::BufferIsReady  ) 
+
+ + + + + +
+   + + +

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

+References recvq. +

+

00191 {
+00192         for (int i = 0; i < recvq.length(); i++)
+00193                 if (recvq[i] == '\n')
+00194                         return true;
+00195         return false;
+00196 }
+
+

+ + + + +
+ + + + + + + + + +
void userrec::ClearBuffer  ) 
+
+ + + + + +
+   + + +

+This function clears the entire buffer by setting it to an empty string. +

+ +

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

+References recvq. +

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

+

00199 {
+00200         recvq = "";
+00201 }
+
+

+ + + + +
+ + + + + + + + + +
std::string userrec::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. +

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

@@ -218,14 +433,14 @@ Returns the full displayed host of the user This member function returns the hos

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

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

-

00059 {
-00060         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
-00061         return result;
-00062 }
+
00062 {
+00063         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost);
+00064         return result;
+00065 }
 
@@ -258,14 +473,14 @@ 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 65 of file users.cpp. +Definition at line 68 of file users.cpp.

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

-

00066 {
-00067         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
-00068         return result;
-00069 }
+
00069 {
+00070         snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host);
+00071         return result;
+00072 }
 
@@ -299,59 +514,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 114 of file users.cpp. +Definition at line 117 of file users.cpp.

References config_f, and DEBUG.

-

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

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

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

-

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

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

-References invites. +References invites.

-

00072 {
-00073         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00074         {
-00075                 if (i->channel) {
-00076                         if (!strcasecmp(i->channel,channel))
-00077                         {
-00078                                 return true;
-00079                         }
-00080                 }
-00081         }
-00082         return false;
-00083 }
+
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 }
 
@@ -476,30 +691,30 @@ Removes a channel from a users invite list.

This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.

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

-References DEBUG, and invites. -

-

00093 {
-00094         log(DEBUG,"Removing invites");
-00095         if (channel)
-00096         {
-00097                 if (invites.size())
-00098                 {
-00099                         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00100                         {
-00101                                 if (i->channel)
-00102                                 {
-00103                                         if (!strcasecmp(i->channel,channel))
-00104                                         {
-00105                                                 invites.erase(i);
-00106                                                 return;
-00107                                         }
-00108                                 }
-00109                         }
-00110                 }
-00111         }
-00112 }
+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 }
 
@@ -527,7 +742,7 @@ The user's away message.

If this string is empty, the user is not marked as away.

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

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

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

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

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

This usually matches the value of userrec::host.

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

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

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

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

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

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

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

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

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

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

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

@@ -721,9 +936,37 @@ A list of channels the user has a pending invite to.

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

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

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

+Flood counters. +

+ +

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

+Referenced by userrec().

@@ -749,7 +992,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 125 of file users.h. +Definition at line 130 of file users.h.

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

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

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

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

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

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

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

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

+ + + + +
+ + +
std::string userrec::recvq +
+
+ + + + + +
+   + + +

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

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

+

+ + + + +
+ + +
time_t userrec::reset_due +
+
+ + + +
+   + + +

+ +

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

+Referenced by userrec().

@@ -885,9 +1182,9 @@ Stores the result of the last GetFullHost or GetRealHost call.

You may use this to increase the speed of use of this class.

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

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

@@ -913,11 +1210,35 @@ The server the user is connected to.

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

Referenced by userrec(). +

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

+ +

+Definition at line 191 of file users.h.

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

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

Referenced by userrec().


The documentation for this class was generated from the following files: -
Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
Generated on Sat May 7 15:34: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 cadb3d3f2..ed4e6e32b 100644 --- a/docs/module-doc/commands_8h-source.html +++ b/docs/module-doc/commands_8h-source.html @@ -118,7 +118,7 @@ 00121 long duration(const char* str); 00122 00123 #endif -

Generated on Tue Apr 26 17:11:43 2005 for InspIRCd by +

Generated on Sat May 7 15:34:20 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 578df85d6..2ff8ab777 100644 --- a/docs/module-doc/commands_8h.html +++ b/docs/module-doc/commands_8h.html @@ -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().

@@ -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 Tue Apr 26 17:11:45 2005 for InspIRCd by +
Generated on Sat May 7 15:34:22 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 52c7221ad..279b3b5b7 100644 --- a/docs/module-doc/connection_8h-source.html +++ b/docs/module-doc/connection_8h-source.html @@ -61,120 +61,126 @@ 00077 00080 bool SetHostAddress(char* host, int port); 00081 -00082 -00083 public: -00084 -00087 std::string ircdbuffer; -00088 -00089 -00094 char host[MAXBUF]; -00095 -00100 int port; -00101 -00106 std::vector<std::string> routes; -00107 -00108 -00111 bool MakeOutboundConnection(char* newhost, int newport); +00084 std::string version; +00085 +00086 public: +00087 +00092 std::string ircdbuffer; +00093 +00094 +00099 char host[MAXBUF]; +00100 +00105 int port; +00106 +00111 std::vector<std::string> routes; 00112 -00115 std::string GetServerName(); -00116 -00119 void SetServerName(std::string serv); -00120 -00123 int GetDescriptor(); -00124 -00127 void SetDescriptor(int fd); -00128 -00131 int GetState(); -00132 -00135 void SetState(int state); -00136 -00139 char* GetServerIP(); -00140 -00143 std::string GetDescription(); -00144 -00147 void SetDescription(std::string desc); -00148 -00154 int GetServerPort(); -00155 -00158 void SetServerPort(int p); -00159 -00162 bool SetHostAndPort(char* newhost, int newport); -00163 -00167 void CloseConnection(); -00168 -00169 void AddBuffer(std::string a); -00170 bool BufferIsComplete(); -00171 void ClearBuffer(); -00172 std::string GetBuffer(); -00173 }; -00174 -00175 -00178 class connection : public Extensible -00179 { -00180 public: -00183 int fd; -00184 -00187 char host[256]; -00188 -00191 char ip[32]; -00192 -00195 char inbuf[MAXBUF]; -00196 -00199 long bytes_in; +00113 +00116 bool MakeOutboundConnection(char* newhost, int newport); +00117 +00120 std::string GetServerName(); +00121 +00124 void SetServerName(std::string serv); +00125 +00128 int GetDescriptor(); +00129 +00132 void SetDescriptor(int fd); +00133 +00136 int GetState(); +00137 +00140 void SetState(int state); +00141 +00144 char* GetServerIP(); +00145 +00148 std::string GetDescription(); +00149 +00152 void SetDescription(std::string desc); +00153 +00159 int GetServerPort(); +00160 +00163 void SetServerPort(int p); +00164 +00167 bool SetHostAndPort(char* newhost, int newport); +00168 +00172 void CloseConnection(); +00173 +00179 void AddBuffer(std::string a); +00180 +00185 bool BufferIsComplete(); +00186 +00189 void ClearBuffer(); +00190 +00195 std::string GetBuffer(); +00196 +00199 void SetVersionString(std::string newversion); 00200 -00203 long bytes_out; -00204 -00207 long cmds_in; -00208 -00211 long cmds_out; -00212 -00215 bool haspassed; -00216 -00221 int port; -00222 -00225 int registered; -00226 -00229 short int state; -00230 -00233 time_t lastping; -00234 -00237 time_t signon; -00238 -00241 time_t idle_lastmsg; -00242 -00245 time_t nping; -00246 -00249 char internal_addr[MAXBUF]; -00250 -00253 int internal_port; -00254 -00258 std::vector<ircd_connector> connectors; -00259 -00262 connection(); -00263 -00266 bool CreateListener(char* host, int p); -00267 -00270 bool BeginLink(char* targethost, int port, char* password, char* servername, int myport); -00271 -00274 bool MeshCookie(char* targethost, int port, unsigned long cookie, char* servername); -00275 -00278 void TerminateLink(char* targethost); -00279 -00283 bool SendPacket(char *message, const char* host); -00284 -00289 bool RecvPacket(std::deque<std::string> &messages, char* host); -00290 -00293 ircd_connector* FindHost(std::string host); -00294 -00298 bool AddIncoming(int fd,char* targethost, int sourceport); +00204 std::string GetVersionString(); +00205 }; +00206 +00207 +00210 class connection : public Extensible +00211 { +00212 public: +00215 int fd; +00216 +00219 char host[256]; +00220 +00223 char ip[32]; +00224 +00227 char inbuf[MAXBUF]; +00228 +00231 long bytes_in; +00232 +00235 long bytes_out; +00236 +00239 long cmds_in; +00240 +00243 long cmds_out; +00244 +00247 bool haspassed; +00248 +00253 int port; +00254 +00257 int registered; +00258 +00261 short int state; +00262 +00265 time_t lastping; +00266 +00269 time_t signon; +00270 +00273 time_t idle_lastmsg; +00274 +00277 time_t nping; +00278 +00281 char internal_addr[MAXBUF]; +00282 +00285 int internal_port; +00286 +00290 std::vector<ircd_connector> connectors; +00291 +00294 connection(); +00295 +00298 bool CreateListener(char* host, int p); 00299 -00302 long GenKey(); -00303 }; -00304 -00305 -00306 #endif -00307 -

Generated on Tue Apr 26 17:11:43 2005 for InspIRCd by +00302 bool BeginLink(char* targethost, int port, char* password, char* servername, int myport); +00303 +00306 bool MeshCookie(char* targethost, int port, unsigned long cookie, char* servername); +00307 +00310 void TerminateLink(char* targethost); +00311 +00315 bool SendPacket(char *message, const char* host); +00316 +00321 bool RecvPacket(std::deque<std::string> &messages, char* host); +00322 +00325 ircd_connector* FindHost(std::string host); +00326 +00330 bool AddIncoming(int fd,char* targethost, int sourceport); +00331 +00332 }; +00333 +00334 +00335 #endif +

Generated on Sat May 7 15:34:20 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 e3d38e665..d14420fd2 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 Tue Apr 26 17:11:45 2005 for InspIRCd by +
Generated on Sat May 7 15:34:22 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 5d6cf02e2..9f7d60625 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 Tue Apr 26 17:11:43 2005 for InspIRCd by +

Generated on Sat May 7 15:34:20 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 e1c5676a6..054d18eda 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 Tue Apr 26 17:11:45 2005 for InspIRCd by +
Generated on Sat May 7 15:34:22 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 1ad122520..642c2c910 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 Tue Apr 26 17:11:43 2005 for InspIRCd by +

Generated on Sat May 7 15:34:20 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 2bfda7fe8..e9b108443 100644 --- a/docs/module-doc/dns_8h.html +++ b/docs/module-doc/dns_8h.html @@ -20,7 +20,7 @@ struct  dns_ip4list -
Generated on Tue Apr 26 17:11:45 2005 for InspIRCd by +
Generated on Sat May 7 15:34:22 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/files.html b/docs/module-doc/files.html index 7dc8a974a..f2ecaae05 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 Tue Apr 26 17:11:43 2005 for InspIRCd by +
Generated on Sat May 7 15:34:19 2005 for InspIRCd by doxygen 1.3.3
diff --git a/docs/module-doc/functions.html b/docs/module-doc/functions.html index f6d013382..d35e6dc2f 100644 --- a/docs/module-doc/functions.html +++ b/docs/module-doc/functions.html @@ -14,18 +14,18 @@ Here is a list of all class members with links to the classes they belong to:

- a -

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

chanrec
  • BeginLink() : connection
  • binip : DNS
  • BufferIsComplete() -: ircd_connector
  • Build +: ircd_connector
  • BufferIsReady() +: userrec
  • Build : Version
  • bytes_in : connection
  • bytes_out : connection @@ -44,27 +45,27 @@ Here is a list of all class members with links to the classes they belong to:

    c_private : chanrec
  • cache : ConfigReader
  • CalcDuration() -: Server
  • CallCommandHandler() -: Server
  • ChangeGECOS() -: Server
  • ChangeHost() -: Server
  • ChangeUserNick() -: Server
  • ChanMode() -: Server
  • channel +: Server
  • CallCommandHandler() +: Server
  • ChangeGECOS() +: Server
  • ChangeHost() +: Server
  • ChangeUserNick() +: Server
  • ChanMode() +: Server
  • channel : Invited, ucrec, ModeParameter
  • chanrec() : chanrec
  • chans : userrec
  • classbase() : classbase
  • ClearBuffer() -: ircd_connector
  • CloseConnection() +: userrec, ircd_connector
  • CloseConnection() : ircd_connector
  • cmds_in : connection
  • cmds_out : connection
  • command : command_t
  • CommonChannels() -: Server
  • ConfigReader() +: Server
  • ConfigReader() : ConfigReader
  • ConnectClass() : ConnectClass
  • connection() : connection
  • connectors : connection
  • CountUsers() -: Server
  • created +: Server
  • created : chanrec
  • CreateListener() : connection
  • CreateModule() : ModuleFactory
  • custom_modes @@ -74,12 +75,12 @@ Here is a list of all class members with links to the classes they belong to:

    data : Event, Request, HostItem
  • DecUserCounter() : chanrec
  • DelELine() -: Server
  • DelGLine() -: Server
  • DelKLine() -: Server
  • DelQLine() -: Server
  • DelUser() +: Server
  • DelGLine() +: Server
  • DelKLine() +: Server
  • DelQLine() +: Server
  • DelUser() : chanrec
  • DelZLine() -: Server
  • description +: Server
  • description : serverrec, ircd_connector
  • dest : Request
  • dhost : userrec
  • DNS() @@ -121,10 +122,11 @@ Here is a list of all class members with links to the classes they belong to:

    DNS, connection, ircd_connector
  • FileReader() : FileReader
  • FileSize() : FileReader
  • FindChannel() -: Server
  • FindHost() +: Server
  • FindDescriptor() +: Server
  • FindHost() : connection
  • FindModule() -: Server
  • FindNick() -: Server
  • Flags +: Server
  • FindNick() +: Server
  • Flags : Version
  • flags_needed : command_t
  • flood : userrec, ConnectClass
  • ForwardLookup() @@ -132,10 +134,9 @@ Here is a list of all class members with links to the classes they belong to:

    userrec

    - g -

    +: Server, chanrec
  • GetVersion() +: Module
  • GetVersionString() +: ircd_connector

    - h -

    • handler_function @@ -189,14 +191,14 @@ Here is a list of all class members with links to the classes they belong to:

      QLine, ZLine
    • IsCustomModeSet() : chanrec
    • IsInvited() : userrec
    • IsNick() -: Server
    • IsOnChannel() -: Server
    • IsUlined() -: Server
    • IsValidMask() -: Server
    +: Server
  • IsOnChannel() +: Server
  • IsUlined() +: Server
  • IsValidMask() +: Server

    - j -

    - k -

    - q -

    +: Server

    - r -

    - v -

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

    - ~ -

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

      serverrec
    • ~ucrec() : ucrec
    • ~userrec() : userrec
    -
    Generated on Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:23 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 41dd60c14..48c9b3079 100644 --- a/docs/module-doc/functions_func.html +++ b/docs/module-doc/functions_func.html @@ -14,53 +14,54 @@

    - a -

    - b -

    +: ircd_connector
  • BufferIsReady() +: userrec

    - c -

    - d -

    - g -

    +: Server, chanrec
  • GetVersion() +: Module
  • GetVersionString() +: ircd_connector

    - h -

    +: Server
  • IsOnChannel() +: Server
  • IsUlined() +: Server
  • IsValidMask() +: Server

    - j -

    • JoinUserToChannel() -: Server
    +: Server

    - l -

    • LoadFile() @@ -154,22 +156,23 @@
  • - o -

    - q -

    +: Server

    - r -

    • ReadFlag() @@ -239,16 +247,17 @@
  • - t -

    +: Server

    - v -

    -
    Generated on Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:23 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 232a0479a..26917e64b 100644 --- a/docs/module-doc/functions_vars.html +++ b/docs/module-doc/functions_vars.html @@ -99,7 +99,8 @@
  • - m -

      @@ -144,9 +145,11 @@
  • @@ -166,7 +169,8 @@

    - t -

    +
    Generated on Sat May 7 15:34:23 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/globals.html b/docs/module-doc/globals.html index f60106e7b..e748fa3eb 100644 --- a/docs/module-doc/globals.html +++ b/docs/module-doc/globals.html @@ -32,7 +32,7 @@ Here is a list of all file members with links to the files they belong to:

    xline.h
  • add_qline() : xline.h
  • add_zline() : xline.h
  • address_cache -: modules.cpp
  • AdminEmail +: modules.cpp
  • AdminEmail : modules.cpp, channels.cpp
  • AdminName : modules.cpp, channels.cpp
  • AdminNick : modules.cpp, channels.cpp
  • allowed_umode() @@ -51,19 +51,19 @@ Here is a list of all file members with links to the files they belong to:

    message.h
  • CC_ALLOW : users.h
  • CC_DENY : users.h
  • chan_hash -: modules.cpp
  • ChangeDisplayedHost() +: modules.cpp
  • ChangeDisplayedHost() : message.h
  • ChangeName() : message.h
  • chanlist -: modules.cpp
  • chanuserlist +: modules.cpp
  • chanuserlist : modules.h
  • chlist() : message.h
  • chop() : message.h
  • ClassVector : users.h
  • CleanAndResolve() : message.h
  • clientlist -: modules.cpp
  • cmdlist -: modules.cpp
  • cmode() +: modules.cpp
  • cmdlist +: modules.cpp
  • cmode() : message.h
  • command_table -: modules.cpp
  • common_channels() +: modules.cpp
  • common_channels() : message.h
  • CONF_FILE_NOT_FOUND : modules.h
  • CONF_NOT_A_NUMBER : modules.h
  • CONF_NOT_UNSIGNED @@ -88,22 +88,23 @@ Here is a list of all file members with links to the files they belong to:

    modules.cpp, channels.cpp
  • diepass : modules.cpp, channels.cpp
  • DieValue : modules.cpp, channels.cpp
  • DoAddExtendedMode() -: modules.cpp
  • duration() +: modules.cpp
  • duration() : commands.h

    - e -

    +: modules.cpp
  • ExtModeListIter +: modules.cpp

    - f -

    @@ -175,9 +176,9 @@ Here is a list of all file members with links to the files they belong to:

    commands.h
  • handle_squit() : commands.h
  • handle_stats() : commands.h
  • handle_summon() -: commands.h
  • handle_T() -: commands.h
  • handle_t() -: commands.h
  • handle_time() +: commands.h
  • handle_t() +: commands.h
  • handle_T() +: commands.h
  • handle_time() : commands.h
  • handle_topic() : commands.h
  • handle_trace() : commands.h
  • handle_unloadmodule() @@ -198,7 +199,7 @@ Here is a list of all file members with links to the files they belong to:

    InvitedList : users.h
  • InviteList : channels.h
  • IP -: modules.cpp
  • ircd_module +: modules.cpp
  • ircd_module : modules.h
  • is_uline() : commands.h
  • isident() : message.h
  • isnick() @@ -224,16 +225,16 @@ Here is a list of all file members with links to the files they belong to:

    mode.h
  • merge_mode2() : mode.h
  • MODCOUNT : modules.cpp, channels.cpp
  • ModeDefined() -: modules.cpp
  • ModeDefinedOff() -: modules.cpp
  • ModeDefinedOn() -: modules.cpp
  • ModeDefinedOper() -: modules.cpp
  • ModeIsListMode() -: modules.cpp
  • ModeMakeList() -: modules.cpp
  • module_names +: modules.cpp
  • ModeDefinedOff() +: modules.cpp
  • ModeDefinedOn() +: modules.cpp
  • ModeDefinedOper() +: modules.cpp
  • ModeIsListMode() +: modules.cpp
  • ModeMakeList() +: modules.cpp
  • module_names : modules.cpp, channels.cpp
  • modules -: modules.cpp, channels.cpp
  • motd +: modules.cpp, channels.cpp
  • motd : modules.cpp, channels.cpp
  • MOTD -: modules.cpp
  • MT_CHANNEL +: modules.cpp
  • MT_CHANNEL : modules.h
  • MT_CLIENT : modules.h
  • MT_SERVER : modules.h @@ -266,7 +267,7 @@ Here is a list of all file members with links to the files they belong to:

    xline.h
  • restartpass : modules.cpp, channels.cpp
  • rules : modules.cpp, channels.cpp
  • RULES -: modules.cpp +: modules.cpp

    - s -

    +: modules.cpp

    - v -

    -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 d8998d96b..b673ec510 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:29 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 f972c317c..1cb50d3ce 100644 --- a/docs/module-doc/globals_func.html +++ b/docs/module-doc/globals_func.html @@ -47,7 +47,7 @@ : xline.h
  • del_qline() : xline.h
  • del_zline() : xline.h
  • DoAddExtendedMode() -: modules.cpp
  • duration() +: modules.cpp
  • duration() : commands.h

    - e -

    - g -

    +: modules.cpp
  • ModeDefinedOff() +: modules.cpp
  • ModeDefinedOn() +: modules.cpp
  • ModeDefinedOper() +: modules.cpp
  • ModeIsListMode() +: modules.cpp
  • ModeMakeList() +: modules.cpp
  • modules() +: modules.cpp, channels.cpp

    - n -

    • NonBlocking() @@ -211,7 +211,7 @@
    • zline_make_global() : xline.h
    • zline_set_creation_time() : xline.h
    -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 7b6b38f78..2ac9ad07d 100644 --- a/docs/module-doc/globals_type.html +++ b/docs/module-doc/globals_type.html @@ -10,23 +10,23 @@

    -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:29 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 a9891509e..36c958b8d 100644 --- a/docs/module-doc/globals_vars.html +++ b/docs/module-doc/globals_vars.html @@ -25,9 +25,9 @@

    - c -

    - d - @@ -41,16 +41,17 @@

    - e -

    +: modules.cpp

    - f -

    +: modules.cpp, channels.cpp
  • fd_reap +: modules.cpp, channels.cpp
  • fd_ref_table +: modules.cpp

    - i -

    +: modules.cpp

    - l -

    +: modules.cpp

    - n -

    +: modules.cpp

    - s -

    -
    Generated on Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:23 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/main.html b/docs/module-doc/main.html index 2ebb5c84c..8d7a4d765 100644 --- a/docs/module-doc/main.html +++ b/docs/module-doc/main.html @@ -7,7 +7,7 @@

    InspIRCd Documentation

    -


    Generated on Tue Apr 26 17:11:43 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:19 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 6902ce0e8..fac1f8833 100644 --- a/docs/module-doc/message_8h-source.html +++ b/docs/module-doc/message_8h-source.html @@ -53,11 +53,11 @@ 00046 int cstatus(userrec *user, chanrec *chan); 00047 int has_channel(userrec *u, chanrec *c); 00048 void TidyBan(char *ban); -00049 char* chlist(userrec *user); +00049 char* chlist(userrec *user, userrec* source); 00050 void send_network_quit(const char* nick, const char* reason); 00051 00052 #endif -

  • Generated on Tue Apr 26 17:11:43 2005 for InspIRCd by +

    Generated on Sat May 7 15:34:20 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 1407037f2..f33caee98 100644 --- a/docs/module-doc/message_8h.html +++ b/docs/module-doc/message_8h.html @@ -54,7 +54,7 @@ void TidyBan (char *ban) -char * chlist (userrec *user) +char * chlist (userrec *user, userrec *source) void send_network_quit (const char *nick, const char *reason) @@ -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().

    @@ -207,9 +207,18 @@ Referenced by Server::Chang char* chlist (  userrec *  - user -  )  - + user, + + + + + userrec *  + source + + + + )  + @@ -331,7 +340,7 @@ Referenced by Server::Chang

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

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

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

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

    -Referenced by Server::GetUsers(), and Server::IsOnChannel(). +Referenced by Server::IsOnChannel().

    @@ -547,7 +556,7 @@ Referenced by Server::GetUs

    -Referenced by Server::GetUsers(), and Server::IsNick(). +Referenced by Server::IsNick().

    @@ -672,9 +681,7 @@ Referenced by Server::GetUs

    - -

    -Referenced by Server::QuitUser(). +

    @@ -735,7 +742,7 @@ Referenced by Server::QuitU -


    Generated on Tue Apr 26 17:11:45 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:22 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 3454d6b52..b77c7e141 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 Tue Apr 26 17:11:43 2005 for InspIRCd by +

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

    Generated on Tue Apr 26 17:11:44 2005 for InspIRCd by +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; +01049 +01050 +

    Generated on Sat May 7 15:34:21 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 ead727c76..064629708 100644 --- a/docs/module-doc/modules_8cpp.html +++ b/docs/module-doc/modules_8cpp.html @@ -57,40 +57,40 @@

    Typedefs

    typedef nspace::hash_map<
    std::string, userrec *, nspace::hash<
    - string >, StrHashCompuser_hash + string >, StrHashCompuser_hash typedef nspace::hash_map<
    std::string, chanrec *, nspace::hash<
    - string >, StrHashCompchan_hash + string >, StrHashCompchan_hash typedef nspace::hash_map<
    in_addr, string *, nspace::hash<
    - in_addr >, InAddr_HashCompaddress_cache + in_addr >, InAddr_HashCompaddress_cache -typedef std::deque< command_tcommand_table +typedef std::deque< command_tcommand_table -typedef std::vector< ExtModeExtModeList +typedef std::vector< ExtModeExtModeList -typedef ExtModeList::iterator ExtModeListIter +typedef ExtModeList::iterator ExtModeListIter

    Functions

    -bool ModeDefined (char modechar, int type) +bool ModeDefined (char modechar, int type) -bool ModeIsListMode (char modechar, int type) +bool ModeIsListMode (char modechar, int type) -bool ModeDefinedOper (char modechar, int type) +bool ModeDefinedOper (char modechar, int type) -int ModeDefinedOn (char modechar, int type) +int ModeDefinedOn (char modechar, int type) -int ModeDefinedOff (char modechar, int type) +int ModeDefinedOff (char modechar, int type) -bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off) +bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off) -void ModeMakeList (char modechar) +void ModeMakeList (char modechar) -std::vector< Module * > modules (255) +std::vector< Module * > modules (255) -std::vector< ircd_module * > factory (255) +std::vector< ircd_module * > factory (255)

    Variables

    int MODCOUNT = -1 @@ -167,21 +167,23 @@ FILE * log_file -user_hash clientlist +userrecfd_ref_table [65536] -chan_hash chanlist +user_hash clientlist -user_hash whowas +chan_hash chanlist -command_table cmdlist +user_hash whowas -file_cache MOTD +command_table cmdlist -file_cache RULES +file_cache MOTD -address_cache IP +file_cache RULES -ExtModeList EMode +address_cache IP + +ExtModeList EMode

    Define Documentation

    @@ -210,13 +212,13 @@ Definition at line 59 o

    Typedef Documentation

    -

    +

    @@ -231,16 +233,16 @@ Definition at line 59 o

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

    -
    typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, InAddr_HashComp> address_cache + typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, InAddr_HashComp> address_cache
    -

    +

    @@ -255,16 +257,16 @@ Definition at line 177

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

    -
    typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, StrHashComp> chan_hash + typedef nspace::hash_map<std::string, chanrec*, nspace::hash<string>, StrHashComp> chan_hash
    -

    +

    @@ -279,16 +281,16 @@ Definition at line 176

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

    -
    typedef std::deque<command_t> command_table + typedef std::deque<command_t> command_table
    -

    +

    @@ -303,16 +305,16 @@ Definition at line 178

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

    -
    typedef std::vector<ExtMode> ExtModeList + typedef std::vector<ExtMode> ExtModeList
    -

    +

    @@ -327,18 +329,18 @@ Definition at line 204

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

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

    -
    typedef ExtModeList::iterator ExtModeListIter + typedef ExtModeList::iterator ExtModeListIter
    -

    +

    @@ -353,11 +355,11 @@ Referenced by ModeDefined()

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

    -
    typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, StrHashComp> user_hash + typedef nspace::hash_map<std::string, userrec*, nspace::hash<string>, StrHashComp> user_hash


    Function Documentation

    -

    +

    @@ -412,23 +414,23 @@ Definition at line 175

    -Definition at line 277 of file modules.cpp. +Definition at line 275 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().

    -

    00278 {
    -00279         if (ModeDefined(modechar,type)) {
    -00280                 return false;
    -00281         }
    -00282         EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off));
    -00283         return true;
    -00284 }
    +
    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 }
     
    -

    +

    @@ -457,7 +459,7 @@ Referenced by Server::AddEx
    -

    +

    @@ -494,15 +496,14 @@ Referenced by Server::AddEx

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

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

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

    -

    00212 {
    -00213         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
    -00214         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    +
    00213 {
    +00214         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
     00215         {
     00216                 if ((i->modechar == modechar) && (i->type == type))
     00217                 {
    @@ -514,7 +515,7 @@ Referenced by DoAddExtended
     
    -

    +

    @@ -551,24 +552,24 @@ Referenced by DoAddExtended

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

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

    -

    00265 {
    -00266         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00267         {
    -00268                 if ((i->modechar == modechar) && (i->type == type))
    -00269                 {
    -00270                         return i->params_when_off;
    -00271                 }
    -00272         }
    -00273         return 0;
    -00274 }
    +
    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 }
     
    -

    +

    @@ -605,24 +606,24 @@ References EMode, and <

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

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

    -

    00252 {
    -00253         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00254         {
    -00255                 if ((i->modechar == modechar) && (i->type == type))
    -00256                 {
    -00257                         return i->params_when_on;
    -00258                 }
    -00259         }
    -00260         return 0;
    -00261 }
    +
    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 }
     
    -

    +

    @@ -659,25 +660,24 @@ References EMode, and <

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

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

    -

    00238 {
    -00239         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
    -00240         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00241         {
    -00242                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
    -00243                 {
    -00244                         return true;
    -00245                 }
    -00246         }
    -00247         return false;
    -00248 }
    +
    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 }
     
    -

    +

    @@ -716,23 +716,22 @@ References DEBUG, Definition at line 224 of file modules.cpp.

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

    00225 {
    -00226         log(DEBUG,"Size of extmodes vector is %d",EMode.size());
    -00227         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00228         {
    -00229                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
    -00230                 {
    -00231                         return true;
    -00232                 }
    -00233         }
    -00234         return false;
    -00235 }
    +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 }
     
    -

    +

    @@ -760,27 +759,27 @@ References DEBUG,

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

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

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

    -

    00288 {
    -00289         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
    -00290         {
    -00291                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
    -00292                 {
    -00293                         i->list = true;
    -00294                         return;
    -00295                 }
    -00296         }
    -00297         return;
    -00298 }
    +
    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 }
     
    -

    +

    @@ -930,13 +929,13 @@ Definition at line 103 Definition at line 97 of file modules.cpp.
    -

    +

    @@ -951,16 +950,16 @@ Definition at line 97 o

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

    -
    chan_hash chanlist + chan_hash chanlist
    -

    +

    @@ -975,18 +974,16 @@ Definition at line 182

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

    -Referenced by Server::GetUsers(). +Definition at line 182 of file modules.cpp.

    -
    user_hash clientlist + user_hash clientlist
    -

    +

    @@ -1001,7 +998,7 @@ Referenced by Server::GetUs

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

    -
    command_table cmdlist + command_table cmdlist

    @@ -1148,13 +1145,13 @@ Definition at line 77 o Definition at line 83 of file modules.cpp. -

    +

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

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

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

    -
    ExtModeList EMode + ExtModeList EMode

    @@ -1222,13 +1219,13 @@ Definition at line 66 o Definition at line 94 of file modules.cpp. -

    +

    @@ -1243,7 +1240,33 @@ Definition at line 94 o

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

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

    -
    address_cache IP + userrec* fd_ref_table[65536]
    +

    + + + + +
    + + +
    address_cache IP +
    +
    + + + +
    +   + + +

    + +

    +Definition at line 188 of file modules.cpp.

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

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

    @@ -1438,13 +1461,13 @@ Definition at line 95 o Definition at line 65 of file modules.cpp. -

    +

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

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

    -
    file_cache MOTD + file_cache MOTD

    @@ -1654,13 +1677,13 @@ Definition at line 82 o Definition at line 78 of file modules.cpp. -

    +

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

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

    -
    file_cache RULES + file_cache RULES

    @@ -1822,13 +1845,13 @@ Definition at line 68 o Definition at line 99 of file modules.cpp. -

    +

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

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

    -
    user_hash whowas + user_hash whowas

    @@ -1894,7 +1917,7 @@ Definition at line 87 o Definition at line 86 of file modules.cpp. -


    Generated on Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:22 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 c9a740a95..d402abc90 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -268,175 +268,188 @@ 00637 00642 virtual void OnGlobalConnect(userrec* user); 00643 -00644 }; -00645 -00646 -00652 class Server : public classbase -00653 { -00654 public: -00658 Server(); -00662 virtual ~Server(); -00663 -00667 virtual void SendOpers(std::string s); -00672 virtual void Log(int level, std::string s); -00677 virtual void Send(int Socket, std::string s); -00682 virtual void SendServ(int Socket, std::string s); -00687 virtual void SendFrom(int Socket, userrec* User, std::string s); -00702 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); -00709 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); -00714 virtual bool CommonChannels(userrec* u1, userrec* u2); -00722 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); -00727 virtual void SendWallops(userrec* User, std::string text); -00728 -00732 virtual bool IsNick(std::string nick); -00736 virtual int CountUsers(chanrec* c); -00740 virtual userrec* FindNick(std::string nick); -00744 virtual chanrec* FindChannel(std::string channel); -00749 virtual std::string ChanMode(userrec* User, chanrec* Chan); -00753 virtual bool IsOnChannel(userrec* User, chanrec* Chan); -00756 virtual std::string GetServerName(); -00759 virtual std::string GetNetworkName(); -00765 virtual Admin GetAdmin(); -00784 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); -00785 -00807 virtual bool AddExtendedListMode(char modechar); -00808 -00826 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source); -00827 -00849 virtual void SendMode(char **parameters, int pcnt, userrec *user); -00850 -00863 virtual void SendToModeMask(std::string modes, int flags, std::string text); -00864 -00870 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); -00871 -00877 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); -00878 -00884 virtual void ChangeUserNick(userrec* user, std::string nickname); -00885 -00896 virtual void QuitUser(userrec* user, std::string reason); -00897 -00902 virtual bool MatchText(std::string sliteral, std::string spattern); -00903 -00915 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); -00916 -00922 virtual void ChangeHost(userrec* user, std::string host); -00923 -00929 virtual void ChangeGECOS(userrec* user, std::string gecos); -00930 -00939 virtual bool IsUlined(std::string server); -00940 -00944 virtual chanuserlist GetUsers(chanrec* chan); -00945 -00952 virtual bool UserToPseudo(userrec* user,std::string message); -00953 -00960 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message); -00961 -00969 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask); -00970 -00978 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname); -00979 -00987 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr); -00988 -00996 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask); -00997 -01005 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask); -01006 -01009 virtual bool DelGLine(std::string hostmask); -01010 -01013 virtual bool DelQLine(std::string nickname); -01014 -01017 virtual bool DelZLine(std::string ipaddr); -01018 -01021 virtual bool DelKLine(std::string hostmask); -01022 -01025 virtual bool DelELine(std::string hostmask); -01026 -01032 virtual long CalcDuration(std::string duration); -01033 -01036 virtual bool IsValidMask(std::string mask); -01037 -01042 virtual void MeshSendAll(std::string text); -01043 -01050 virtual void MeshSendCommon(userrec* user, std::string text); -01051 -01054 virtual void MeshSendAllAlive(std::string text); -01055 -01059 virtual void MeshSendUnicast(std::string destination, std::string text); +00647 virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask); +00648 +00652 virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask); +00653 +00660 virtual void OnRawSocketAccept(int fd, std::string ip, int localport); +00661 +00668 virtual int OnRawSocketWrite(int fd, char* buffer, int count); +00669 +00673 virtual void OnRawSocketClose(int fd); +00674 +00685 virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult); +00686 }; +00687 +00688 +00694 class Server : public classbase +00695 { +00696 public: +00700 Server(); +00704 virtual ~Server(); +00705 +00709 virtual void SendOpers(std::string s); +00714 virtual void Log(int level, std::string s); +00719 virtual void Send(int Socket, std::string s); +00724 virtual void SendServ(int Socket, std::string s); +00728 virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text); +00733 virtual void SendFrom(int Socket, userrec* User, std::string s); +00748 virtual void SendTo(userrec* Source, userrec* Dest, std::string s); +00755 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender); +00760 virtual bool CommonChannels(userrec* u1, userrec* u2); +00768 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender); +00773 virtual void SendWallops(userrec* User, std::string text); +00774 +00778 virtual bool IsNick(std::string nick); +00782 virtual int CountUsers(chanrec* c); +00786 virtual userrec* FindNick(std::string nick); +00790 virtual userrec* FindDescriptor(int socket); +00794 virtual chanrec* FindChannel(std::string channel); +00799 virtual std::string ChanMode(userrec* User, chanrec* Chan); +00803 virtual bool IsOnChannel(userrec* User, chanrec* Chan); +00806 virtual std::string GetServerName(); +00809 virtual std::string GetNetworkName(); +00815 virtual Admin GetAdmin(); +00834 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off); +00835 +00857 virtual bool AddExtendedListMode(char modechar); +00858 +00876 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source); +00877 +00899 virtual void SendMode(char **parameters, int pcnt, userrec *user); +00900 +00913 virtual void SendToModeMask(std::string modes, int flags, std::string text); +00914 +00920 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key); +00921 +00927 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason); +00928 +00934 virtual void ChangeUserNick(userrec* user, std::string nickname); +00935 +00946 virtual void QuitUser(userrec* user, std::string reason); +00947 +00952 virtual bool MatchText(std::string sliteral, std::string spattern); +00953 +00965 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user); +00966 +00972 virtual void ChangeHost(userrec* user, std::string host); +00973 +00979 virtual void ChangeGECOS(userrec* user, std::string gecos); +00980 +00989 virtual bool IsUlined(std::string server); +00990 +00994 virtual chanuserlist GetUsers(chanrec* chan); +00995 +01002 virtual bool UserToPseudo(userrec* user,std::string message); +01003 +01010 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message); +01011 +01019 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask); +01020 +01028 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname); +01029 +01037 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr); +01038 +01046 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask); +01047 +01055 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask); +01056 +01059 virtual bool DelGLine(std::string hostmask); 01060 -01065 virtual void MeshSendAllExcept(std::string target, std::string text); -01066 -01070 virtual bool MeshCheckChan(chanrec *c,std::string servername); -01071 -01075 virtual bool MeshCheckCommon(userrec* u,std::string servername); +01063 virtual bool DelQLine(std::string nickname); +01064 +01067 virtual bool DelZLine(std::string ipaddr); +01068 +01071 virtual bool DelKLine(std::string hostmask); +01072 +01075 virtual bool DelELine(std::string hostmask); 01076 -01081 virtual Module* FindModule(std::string name); -01082 }; +01082 virtual long CalcDuration(std::string duration); 01083 -01084 -01085 #define CONF_NOT_A_NUMBER 0x000010 -01086 #define CONF_NOT_UNSIGNED 0x000080 -01087 #define CONF_VALUE_NOT_FOUND 0x000100 -01088 #define CONF_FILE_NOT_FOUND 0x000200 -01089 -01090 -01097 class ConfigReader : public classbase -01098 { -01099 protected: -01105 std::stringstream *cache; -01106 std::stringstream *errorlog; -01109 bool readerror; -01110 long error; -01111 -01112 public: -01117 ConfigReader(); // default constructor reads ircd.conf -01121 ConfigReader(std::string filename); // read a module-specific config -01125 ~ConfigReader(); -01130 std::string ReadValue(std::string tag, std::string name, int index); -01136 bool ReadFlag(std::string tag, std::string name, int index); -01145 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); -01150 long GetError(); -01157 int Enumerate(std::string tag); -01162 bool Verify(); -01169 void DumpErrors(bool bail,userrec* user); -01170 -01176 int EnumerateValues(std::string tag, int index); -01177 }; -01178 -01179 -01180 -01186 class FileReader : public classbase -01187 { -01188 file_cache fc; -01189 public: -01194 FileReader(); -01195 -01201 FileReader(std::string filename); -01202 -01206 ~FileReader(); -01207 -01213 void LoadFile(std::string filename); -01214 -01218 bool Exists(); -01219 -01224 std::string GetLine(int x); -01225 -01231 int FileSize(); -01232 }; -01233 -01234 -01241 class ModuleFactory : public classbase -01242 { -01243 public: -01244 ModuleFactory() { } -01245 virtual ~ModuleFactory() { } -01250 virtual Module * CreateModule() = 0; -01251 }; +01086 virtual bool IsValidMask(std::string mask); +01087 +01092 virtual void MeshSendAll(std::string text); +01093 +01100 virtual void MeshSendCommon(userrec* user, std::string text); +01101 +01104 virtual void MeshSendAllAlive(std::string text); +01105 +01109 virtual void MeshSendUnicast(std::string destination, std::string text); +01110 +01115 virtual void MeshSendAllExcept(std::string target, std::string text); +01116 +01120 virtual bool MeshCheckChan(chanrec *c,std::string servername); +01121 +01125 virtual bool MeshCheckCommon(userrec* u,std::string servername); +01126 +01131 virtual Module* FindModule(std::string name); +01132 }; +01133 +01134 +01135 #define CONF_NOT_A_NUMBER 0x000010 +01136 #define CONF_NOT_UNSIGNED 0x000080 +01137 #define CONF_VALUE_NOT_FOUND 0x000100 +01138 #define CONF_FILE_NOT_FOUND 0x000200 +01139 +01140 +01147 class ConfigReader : public classbase +01148 { +01149 protected: +01155 std::stringstream *cache; +01156 std::stringstream *errorlog; +01159 bool readerror; +01160 long error; +01161 +01162 public: +01167 ConfigReader(); // default constructor reads ircd.conf +01171 ConfigReader(std::string filename); // read a module-specific config +01175 ~ConfigReader(); +01180 std::string ReadValue(std::string tag, std::string name, int index); +01186 bool ReadFlag(std::string tag, std::string name, int index); +01195 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned); +01200 long GetError(); +01207 int Enumerate(std::string tag); +01212 bool Verify(); +01219 void DumpErrors(bool bail,userrec* user); +01220 +01226 int EnumerateValues(std::string tag, int index); +01227 }; +01228 +01229 +01230 +01236 class FileReader : public classbase +01237 { +01238 file_cache fc; +01239 public: +01244 FileReader(); +01245 +01251 FileReader(std::string filename); 01252 -01253 -01254 typedef DLLFactory<ModuleFactory> ircd_module; -01255 -01256 #endif -

    Generated on Tue Apr 26 17:11:44 2005 for InspIRCd by +01256 ~FileReader(); +01257 +01263 void LoadFile(std::string filename); +01264 +01268 bool Exists(); +01269 +01274 std::string GetLine(int x); +01275 +01281 int FileSize(); +01282 }; +01283 +01284 +01291 class ModuleFactory : public classbase +01292 { +01293 public: +01294 ModuleFactory() { } +01295 virtual ~ModuleFactory() { } +01300 virtual Module * CreateModule() = 0; +01301 }; +01302 +01303 +01304 typedef DLLFactory<ModuleFactory> ircd_module; +01305 +01306 #endif +

    Generated on Sat May 7 15:34:21 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 68cb59620..c003807c2 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().

    @@ -438,9 +438,9 @@ Definition at line 38 of

    -Definition at line 1088 of file modules.h. +Definition at line 1138 of file modules.h.

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

    @@ -464,9 +464,9 @@ Referenced by ConfigReader:

    -Definition at line 1085 of file modules.h. +Definition at line 1135 of file modules.h.

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

    @@ -490,9 +490,9 @@ Referenced by ConfigReader:

    -Definition at line 1086 of file modules.h. +Definition at line 1136 of file modules.h.

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

    @@ -516,9 +516,9 @@ Referenced by ConfigReader:

    -Definition at line 1087 of file modules.h. +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(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). +Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DecUserCounter(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IncUserCounter(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam().

    @@ -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().

    @@ -987,7 +987,7 @@ Referenced by FileReader::F

    -Definition at line 1254 of file modules.h. +Definition at line 1304 of file modules.h.

    @@ -1013,7 +1013,7 @@ Definition at line 1254 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:22 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/namespacenspace.html b/docs/module-doc/namespacenspace.html index 534867ea7..63778c33f 100644 --- a/docs/module-doc/namespacenspace.html +++ b/docs/module-doc/namespacenspace.html @@ -15,7 +15,7 @@ struct  nspace.hash< string > -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/namespaces.html b/docs/module-doc/namespaces.html index 2f246fd98..6cd02ce36 100644 --- a/docs/module-doc/namespaces.html +++ b/docs/module-doc/namespaces.html @@ -9,7 +9,7 @@ nspace std -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:29 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/namespacestd.html b/docs/module-doc/namespacestd.html index ccdc6898f..acb02d469 100644 --- a/docs/module-doc/namespacestd.html +++ b/docs/module-doc/namespacestd.html @@ -10,7 +10,7 @@
    -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 a5fa077c4..e1148cb3d 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 Tue Apr 26 17:11:44 2005 for InspIRCd by +

    Generated on Sat May 7 15:34:21 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 0efa69319..39dda596e 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:22 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 2c1befe74..b87d6683e 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 Tue Apr 26 17:11:44 2005 for InspIRCd by +

    Generated on Sat May 7 15:34:21 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 80556cb11..26257df7f 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:22 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 24f481673..9e1ae19c8 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:25 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 b45ca83c3..f78624ccb 100644 --- a/docs/module-doc/structInAddr__HashComp.html +++ b/docs/module-doc/structInAddr__HashComp.html @@ -49,23 +49,23 @@

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

    -

    00162         {
    -00163                 size_t q;
    -00164                 size_t p;
    -00165                 
    -00166                 memcpy(&q,&s1,sizeof(size_t));
    -00167                 memcpy(&p,&s2,sizeof(size_t));
    -00168                 
    -00169                 return (q == p);
    -00170         }
    +
    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         }
     

    The documentation for this struct was generated from the following file: -
    Generated on Tue Apr 26 17:11:48 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:25 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 0c6279dfe..26f728635 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 Tue Apr 26 17:11:51 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:28 2005 for InspIRCd by doxygen 1.3.3
    diff --git a/docs/module-doc/structStrHashComp.html b/docs/module-doc/structStrHashComp.html index 1ea550cd7..591148d1c 100644 --- a/docs/module-doc/structStrHashComp.html +++ b/docs/module-doc/structStrHashComp.html @@ -49,22 +49,22 @@

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

    -

    00147         {
    -00148                 char a[MAXBUF],b[MAXBUF];
    -00149                 strlcpy(a,s1.c_str(),MAXBUF);
    -00150                 strlcpy(b,s2.c_str(),MAXBUF);
    -00151                 strlower(a);
    -00152                 strlower(b);
    -00153                 return (strcasecmp(a,b) == 0);
    -00154         }
    +
    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         }
     

    The documentation for this struct was generated from the following file: -
    Generated on Tue Apr 26 17:11:51 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 2296bfd99..e69018422 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:24 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 28b8f7177..ea0918e1b 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 Tue Apr 26 17:11:48 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:24 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 77c30e7f7..d34f49605 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 2e34eaa3e..e05ed9105 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 119 of file modules.cpp. +Definition at line 120 of file modules.cpp.

    -

    00120                 {
    -00121                         size_t q;
    -00122                         memcpy(&q,&a,sizeof(size_t));
    -00123                         return q;
    -00124                 }
    +
    00121                 {
    +00122                         size_t q;
    +00123                         memcpy(&q,&a,sizeof(size_t));
    +00124                         return q;
    +00125                 }
     

    The documentation for this struct was generated from the following file: -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 fa3749c8a..436af0f51 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 Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 ab59de41f..1091180ae 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 132 of file modules.cpp. +Definition at line 133 of file modules.cpp.

    -

    00133                 {
    -00134                         char a[MAXBUF];
    -00135                         static struct hash<const char *> strhash;
    -00136                         strlcpy(a,s.c_str(),MAXBUF);
    -00137                         strlower(a);
    -00138                         return strhash(a);
    -00139                 }
    +
    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                 }
     

    The documentation for this struct was generated from the following file: -
    Generated on Tue Apr 26 17:11:52 2005 for InspIRCd by +
    Generated on Sat May 7 15:34: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 1d43fea60..7d30e3413 100644 --- a/docs/module-doc/users_8cpp-source.html +++ b/docs/module-doc/users_8cpp-source.html @@ -47,130 +47,184 @@ 00040 strcpy(server,""); 00041 strcpy(awaymsg,""); 00042 strcpy(oper,""); -00043 fd = lastping = signon = idle_lastmsg = nping = registered = 0; -00044 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; -00045 haspassed = false; -00046 dns_done = false; -00047 strcpy(result,""); -00048 for (int i = 0; i < MAXCHANS; i++) -00049 { -00050 this->chans[i].channel = NULL; -00051 this->chans[i].uc_modes = 0; -00052 } -00053 invites.clear(); -00054 } -00055 -00056 -00057 -00058 char* userrec::GetFullHost() -00059 { -00060 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost); -00061 return result; -00062 } -00063 -00064 -00065 char* userrec::GetFullRealHost() -00066 { -00067 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,host); -00068 return result; -00069 } -00070 -00071 bool userrec::IsInvited(char* channel) -00072 { -00073 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -00074 { -00075 if (i->channel) { -00076 if (!strcasecmp(i->channel,channel)) -00077 { -00078 return true; -00079 } -00080 } -00081 } -00082 return false; -00083 } -00084 -00085 void userrec::InviteTo(char* channel) -00086 { -00087 Invited i; -00088 strlcpy(i.channel,channel,CHANMAX); -00089 invites.push_back(i); -00090 } -00091 -00092 void userrec::RemoveInvite(char* channel) -00093 { -00094 log(DEBUG,"Removing invites"); -00095 if (channel) -00096 { -00097 if (invites.size()) -00098 { -00099 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -00100 { -00101 if (i->channel) -00102 { -00103 if (!strcasecmp(i->channel,channel)) -00104 { -00105 invites.erase(i); -00106 return; -00107 } -00108 } -00109 } -00110 } -00111 } -00112 } -00113 -00114 bool userrec::HasPermission(char* command) -00115 { -00116 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -00117 char* mycmd; -00118 char* savept; -00119 char* savept2; -00120 -00121 // are they even an oper at all? -00122 if (strchr(this->modes,'o')) -00123 { -00124 log(DEBUG,"*** HasPermission: %s is an oper",this->nick); -00125 for (int j =0; j < ConfValueEnum("type",&config_f); j++) -00126 { -00127 ConfValue("type","name",j,TypeName,&config_f); -00128 if (!strcmp(TypeName,this->oper)) -00129 { -00130 log(DEBUG,"*** HasPermission: %s is an oper of type '%s'",this->nick,this->oper); -00131 ConfValue("type","classes",j,Classes,&config_f); -00132 char* myclass = strtok_r(Classes," ",&savept); -00133 while (myclass) -00134 { -00135 log(DEBUG,"*** HasPermission: checking classtype '%s'",myclass); -00136 for (int k =0; k < ConfValueEnum("class",&config_f); k++) -00137 { -00138 ConfValue("class","name",k,ClassName,&config_f); -00139 if (!strcmp(ClassName,myclass)) -00140 { -00141 ConfValue("class","commands",k,CommandList,&config_f); -00142 log(DEBUG,"*** HasPermission: found class named %s with commands: '%s'",ClassName,CommandList); -00143 -00144 -00145 mycmd = strtok_r(CommandList," ",&savept2); -00146 while (mycmd) -00147 { -00148 if (!strcasecmp(mycmd,command)) -00149 { -00150 log(DEBUG,"*** Command %s found, returning true",command); -00151 return true; -00152 } -00153 mycmd = strtok_r(NULL," ",&savept2); -00154 } -00155 } -00156 } -00157 myclass = strtok_r(NULL," ",&savept); -00158 } -00159 } -00160 } -00161 } -00162 return false; -00163 } -00164 -00165 -

    Generated on Tue Apr 26 17:11:44 2005 for InspIRCd by +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 +00059 +00060 +00061 char* userrec::GetFullHost() +00062 { +00063 snprintf(result,MAXBUF,"%s!%s@%s",nick,ident,dhost); +00064 return result; +00065 } +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 +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 +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 doxygen 1.3.3
    diff --git a/docs/module-doc/users_8cpp.html b/docs/module-doc/users_8cpp.html index b39702ebe..59a0a5549 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:22 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 3427aae77..1ebbec1e5 100644 --- a/docs/module-doc/users_8h-source.html +++ b/docs/module-doc/users_8h-source.html @@ -54,81 +54,98 @@ 00059 char host[MAXBUF]; 00062 int pingtime; 00065 char pass[MAXBUF]; -00066 -00067 ConnectClass() -00068 { -00069 registration_timeout = 0; -00070 flood = 0; -00071 pingtime = 0; -00072 strlcpy(host,"",MAXBUF); -00073 strlcpy(pass,"",MAXBUF); -00074 } -00075 }; -00076 -00079 typedef std::vector<Invited> InvitedList; -00080 +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 -00082 -00085 typedef std::vector<ConnectClass> ClassVector; +00084 typedef std::vector<Invited> InvitedList; +00085 00086 -00093 class userrec : public connection -00094 { -00095 private: -00096 -00099 InvitedList invites; -00100 public: -00101 -00106 char nick[NICKMAX]; -00107 -00110 char ident[64]; -00111 -00115 char dhost[256]; -00116 -00119 char fullname[128]; -00120 -00125 char modes[MAXBUF]; -00126 -00127 ucrec chans[MAXCHANS]; -00128 -00131 char server[256]; -00132 -00136 char awaymsg[512]; +00087 +00090 typedef std::vector<ConnectClass> ClassVector; +00091 +00098 class userrec : public connection +00099 { +00100 private: +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]; +00131 +00132 ucrec chans[MAXCHANS]; +00133 +00136 char server[256]; 00137 -00141 char result[256]; +00141 char awaymsg[512]; 00142 -00147 int flood; -00148 -00153 unsigned long timeout; -00154 -00160 char oper[NICKMAX]; -00161 -00164 bool dns_done; -00165 -00168 unsigned long pingmax; -00169 -00174 char password[MAXBUF]; -00175 -00176 userrec(); -00177 -00178 virtual ~userrec() { } -00179 -00184 virtual char* GetFullHost(); -00185 -00191 virtual char* GetFullRealHost(); -00192 -00195 virtual bool IsInvited(char* channel); +00146 char result[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]; +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 -00199 virtual void InviteTo(char* channel); -00200 -00205 virtual void RemoveInvite(char* channel); -00206 -00211 bool HasPermission(char* command); -00212 -00213 }; -00214 -00215 -00216 #endif -

    Generated on Tue Apr 26 17:11:44 2005 for InspIRCd by +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); +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 doxygen 1.3.3
    diff --git a/docs/module-doc/users_8h.html b/docs/module-doc/users_8h.html index fd23fdc16..3f9bced37 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 85 of file users.h. +Definition at line 90 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 79 of file users.h. +Definition at line 84 of file users.h. -


    Generated on Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:23 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 a1063db89..0924c5651 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 Tue Apr 26 17:11:44 2005 for InspIRCd by +

    Generated on Sat May 7 15:34:21 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 4a903f279..3347f33b5 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 Tue Apr 26 17:11:46 2005 for InspIRCd by +
    Generated on Sat May 7 15:34:23 2005 for InspIRCd by doxygen 1.3.3
    -- cgit v1.2.3