diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-13 12:41:46 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-13 12:41:46 +0000 |
| commit | c0f731e19d61a971af5cf26d073ccd25bfc5c91c (patch) | |
| tree | cb070a261330b5110d30ecbcf4e446e1419886e2 /docs/man/man3 | |
| parent | 58f076212f6330429e027576eb32cfc75bde82ae (diff) | |
Added Server::AddGLine
Added Server::AddKLine
Added Server::AddZLine
Added Server::AddQLine
Added Server::AddELine
Added Server::DelGLine
Added Server::DelKLine
Added Server::DelZLine
Added Server::DelQLine
Added Server::DelELine
Added Server::Duration
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1071 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3')
55 files changed, 556 insertions, 291 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 1f7b31c41..54a99fd1f 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -38,7 +38,7 @@ Holds /ADMIN data This class contains the admin details of the local server. It is constructed by class \fBServer\fP, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running. .PP -Definition at line 121 of file modules.h. +Definition at line 123 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Admin::Admin (std::string name, std::string email, std::string nick)" @@ -52,13 +52,13 @@ Definition at line 304 of file modules.cpp. .PP .SS "const std::string \fBAdmin::Email\fP" .PP -Definition at line 124 of file modules.h. +Definition at line 126 of file modules.h. .SS "const std::string \fBAdmin::Name\fP" .PP -Definition at line 124 of file modules.h. +Definition at line 126 of file modules.h. .SS "const std::string \fBAdmin::Nick\fP" .PP -Definition at line 124 of file modules.h. +Definition at line 126 of file modules.h. .SH "Author" .PP diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index 3458f2aaa..650e388d1 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index a2a9afaf2..7891a2773 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "13 Apr 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 683 of file modules.h. +Definition at line 780 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 579 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 674 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -580 { -581 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -582 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -583 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -584 if (!this->readerror) -585 this->error = CONF_FILE_NOT_FOUND; -586 } +675 { +676 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +677 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +678 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +679 if (!this->readerror) +680 this->error = CONF_FILE_NOT_FOUND; +681 } .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 598 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 693 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -599 { -600 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -601 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -602 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -603 if (!this->readerror) -604 this->error = CONF_FILE_NOT_FOUND; -605 }; +694 { +695 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +696 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +697 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +698 if (!this->readerror) +699 this->error = CONF_FILE_NOT_FOUND; +700 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 589 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 684 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -590 { -591 if (this->cache) -592 delete this->cache; -593 if (this->errorlog) -594 delete this->errorlog; -595 } +685 { +686 if (this->cache) +687 delete this->cache; +688 if (this->errorlog) +689 delete this->errorlog; +690 } .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 676 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 771 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -677 { -678 if (bail) -679 { -680 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -681 exit(0); -682 } -683 else -684 { -685 char dataline[1024]; -686 if (user) -687 { -688 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -689 while (!errorlog->eof()) -690 { -691 errorlog->getline(dataline,1024); -692 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -693 } -694 } -695 else -696 { -697 WriteOpers('There were errors in the configuration file:',user->nick); -698 while (!errorlog->eof()) -699 { -700 errorlog->getline(dataline,1024); -701 WriteOpers(dataline); -702 } -703 } -704 return; -705 } -706 } +772 { +773 if (bail) +774 { +775 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +776 exit(0); +777 } +778 else +779 { +780 char dataline[1024]; +781 if (user) +782 { +783 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +784 while (!errorlog->eof()) +785 { +786 errorlog->getline(dataline,1024); +787 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +788 } +789 } +790 else +791 { +792 WriteOpers('There were errors in the configuration file:',user->nick); +793 while (!errorlog->eof()) +794 { +795 errorlog->getline(dataline,1024); +796 WriteOpers(dataline); +797 } +798 } +799 return; +800 } +801 } .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 709 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 804 of file modules.cpp. .PP References cache. .PP .nf -710 { -711 return EnumConf(cache,tag.c_str()); -712 } +805 { +806 return EnumConf(cache,tag.c_str()); +807 } .fi .SS "int ConfigReader::EnumerateValues (std::string tag, int index)" .PP -Returns the number of items within a tag. For example if the tag was <test tag='blah' data='foo'> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 714 of file modules.cpp. +Returns the number of items within a tag. For example if the tag was <test tag='blah' data='foo'> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.Definition at line 809 of file modules.cpp. .PP References cache. .PP .nf -715 { -716 return EnumValues(cache, tag.c_str(), index); -717 } +810 { +811 return EnumValues(cache, tag.c_str(), index); +812 } .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 669 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 764 of file modules.cpp. .PP References error. .PP .nf -670 { -671 long olderr = this->error; -672 this->error = 0; -673 return olderr; -674 } +765 { +766 long olderr = this->error; +767 this->error = 0; +768 return olderr; +769 } .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 623 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 718 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -624 { -625 char val[MAXBUF]; -626 char t[MAXBUF]; -627 char n[MAXBUF]; -628 strlcpy(t,tag.c_str(),MAXBUF); -629 strlcpy(n,name.c_str(),MAXBUF); -630 int res = ReadConf(cache,t,n,index,val); -631 if (!res) -632 { -633 this->error = CONF_VALUE_NOT_FOUND; -634 return false; -635 } -636 std::string s = val; -637 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -638 } +719 { +720 char val[MAXBUF]; +721 char t[MAXBUF]; +722 char n[MAXBUF]; +723 strlcpy(t,tag.c_str(),MAXBUF); +724 strlcpy(n,name.c_str(),MAXBUF); +725 int res = ReadConf(cache,t,n,index,val); +726 if (!res) +727 { +728 this->error = CONF_VALUE_NOT_FOUND; +729 return false; +730 } +731 std::string s = val; +732 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +733 } .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 640 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 735 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -641 { -642 char val[MAXBUF]; -643 char t[MAXBUF]; -644 char n[MAXBUF]; -645 strlcpy(t,tag.c_str(),MAXBUF); -646 strlcpy(n,name.c_str(),MAXBUF); -647 int res = ReadConf(cache,t,n,index,val); -648 if (!res) -649 { -650 this->error = CONF_VALUE_NOT_FOUND; -651 return 0; -652 } -653 for (int i = 0; i < strlen(val); i++) -654 { -655 if (!isdigit(val[i])) -656 { -657 this->error = CONF_NOT_A_NUMBER; -658 return 0; -659 } -660 } -661 if ((needs_unsigned) && (atoi(val)<0)) -662 { -663 this->error = CONF_NOT_UNSIGNED; -664 return 0; -665 } -666 return atoi(val); -667 } +736 { +737 char val[MAXBUF]; +738 char t[MAXBUF]; +739 char n[MAXBUF]; +740 strlcpy(t,tag.c_str(),MAXBUF); +741 strlcpy(n,name.c_str(),MAXBUF); +742 int res = ReadConf(cache,t,n,index,val); +743 if (!res) +744 { +745 this->error = CONF_VALUE_NOT_FOUND; +746 return 0; +747 } +748 for (int i = 0; i < strlen(val); i++) +749 { +750 if (!isdigit(val[i])) +751 { +752 this->error = CONF_NOT_A_NUMBER; +753 return 0; +754 } +755 } +756 if ((needs_unsigned) && (atoi(val)<0)) +757 { +758 this->error = CONF_NOT_UNSIGNED; +759 return 0; +760 } +761 return atoi(val); +762 } .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 607 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 702 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -608 { -609 char val[MAXBUF]; -610 char t[MAXBUF]; -611 char n[MAXBUF]; -612 strlcpy(t,tag.c_str(),MAXBUF); -613 strlcpy(n,name.c_str(),MAXBUF); -614 int res = ReadConf(cache,t,n,index,val); -615 if (!res) -616 { -617 this->error = CONF_VALUE_NOT_FOUND; -618 return ''; -619 } -620 return std::string(val); -621 } +703 { +704 char val[MAXBUF]; +705 char t[MAXBUF]; +706 char n[MAXBUF]; +707 strlcpy(t,tag.c_str(),MAXBUF); +708 strlcpy(n,name.c_str(),MAXBUF); +709 int res = ReadConf(cache,t,n,index,val); +710 if (!res) +711 { +712 this->error = CONF_VALUE_NOT_FOUND; +713 return ''; +714 } +715 return std::string(val); +716 } .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 719 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 814 of file modules.cpp. .PP References readerror. .PP .nf -720 { -721 return this->readerror; -722 } +815 { +816 return this->readerror; +817 } .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 691 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 788 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 696 of file modules.h. +Definition at line 793 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 692 of file modules.h. +Definition at line 789 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 695 of file modules.h. +Used to store errors. Definition at line 792 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 baa288a3f..1b1aaa11f 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index 4e842b60d..7bfa95a50 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -45,6 +45,9 @@ DNS \- The DNS class allows fast nonblocking resolution of hostnames and ip addr .RI "int \fBGetFD\fP ()" .br .RI "\fIThis method returns the file handle used by the dns query socket or zero if the query is invalid for some reason, e.g. \fP" +.ti -1c +.RI "void \fBSetNS\fP (std::string dnsserver)" +.br .in -1c .SS "Private Member Functions" @@ -174,6 +177,8 @@ This method will return true when the lookup is completed. It uses poll internal .SS "bool DNS::ReverseLookup (std::string ip)" .PP This method will start the reverse lookup of an ip given in dotted decimal format, e.g. 1.2.3.4, and returns true if the lookup was successfully initiated. +.SS "void DNS::SetNS (std::string dnsserver)" +.PP .SH "Member Data Documentation" .PP .SS "in_addr* \fBDNS::binip\fP\fC [private]\fP" diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index 7d54fe534..a15d813e8 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index d6bde382b..0024f7798 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index e3dcb371c..21ef48092 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index 5d21ed164..3e1a79557 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 0b9e07501..bcc5f2c28 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "13 Apr 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 772 of file modules.h. +Definition at line 869 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 732 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 827 of file modules.cpp. .PP .nf -733 { -734 } +828 { +829 } .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 725 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 820 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -726 { -727 file_cache c; -728 readfile(c,filename.c_str()); -729 this->fc = c; -730 } +821 { +822 file_cache c; +823 readfile(c,filename.c_str()); +824 this->fc = c; +825 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 744 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 839 of file modules.cpp. .PP .nf -745 { -746 } +840 { +841 } .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 748 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 843 of file modules.cpp. .PP References fc. .PP .nf -749 { -750 if (fc.size() == 0) -751 { -752 return(false); -753 } -754 else -755 { -756 return(true); -757 } -758 } +844 { +845 if (fc.size() == 0) +846 { +847 return(false); +848 } +849 else +850 { +851 return(true); +852 } +853 } .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 767 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 862 of file modules.cpp. .PP References fc. .PP .nf -768 { -769 return fc.size(); -770 } +863 { +864 return fc.size(); +865 } .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 760 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 855 of file modules.cpp. .PP References fc. .PP .nf -761 { -762 if ((x<0) || (x>fc.size())) -763 return ''; -764 return fc[x]; -765 } +856 { +857 if ((x<0) || (x>fc.size())) +858 return ''; +859 return fc[x]; +860 } .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 736 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 831 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -737 { -738 file_cache c; -739 readfile(c,filename.c_str()); -740 this->fc = c; -741 } +832 { +833 file_cache c; +834 readfile(c,filename.c_str()); +835 this->fc = c; +836 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 774 of file modules.h. +Definition at line 871 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 2cf341141..9483f2aca 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index 2571be4b8..4f32f7ae2 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "13 Apr 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 94ba034da..fbea99847 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index bd77e0626..bec559e8a 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index fab638087..976db7b6d 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index b9a460657..ceaba5127 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 3401d36cb..513cc7a6f 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index d7837affb..326d33cec 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -123,6 +123,10 @@ Inherits \fBclassbase\fP. .RI "virtual void \fBOnLoadModule\fP (\fBModule\fP *mod, std::string name)" .br .RI "\fICalled whenever a module is loaded. \fP" +.ti -1c +.RI "virtual void \fBOnBackgroundTimer\fP (time_t curtime)" +.br +.RI "\fICalled once every five seconds for background processing. \fP" .in -1c .SH "Detailed Description" .PP @@ -130,7 +134,7 @@ Base class for all InspIRCd modules This class is the base class for InspIRCd mo All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the \fBModuleFactory\fP class (see relevent section) for the plugin to be initialised. .PP -Definition at line 133 of file modules.h. +Definition at line 135 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Module::Module ()" @@ -198,6 +202,13 @@ References ACR_DEFAULT. .nf 327 { return ACR_DEFAULT; }; .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 333 of file modules.cpp. +.PP +.nf +333 { }; +.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 329 of file modules.cpp. diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index 45d5e2207..4b153bd9c 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "13 Apr 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 827 of file modules.h. +Definition at line 924 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 830 of file modules.h. +Definition at line 927 of file modules.h. .PP .nf -830 { } +927 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 831 of file modules.h. +Definition at line 928 of file modules.h. .PP .nf -831 { } +928 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index efda7f1a9..7803a9c44 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index eaa423117..8da159dc2 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -159,6 +159,58 @@ Inherits \fBclassbase\fP. .RI "virtual \fBchanuserlist\fP \fBGetUsers\fP (\fBchanrec\fP *chan)" .br .RI "\fIFetches the userlist of a channel. \fP" +.ti -1c +.RI "virtual bool \fBUserToPseudo\fP (\fBuserrec\fP *user, std::string message)" +.br +.RI "\fIRemove a user's connection to the irc server, but leave their client in existence in the user hash. \fP" +.ti -1c +.RI "virtual bool \fBPseudoToUser\fP (\fBuserrec\fP *alive, \fBuserrec\fP *zombie, std::string message)" +.br +.RI "\fIThis user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. \fP" +.ti -1c +.RI "virtual void \fBAddGLine\fP (long duration, std::string source, std::string reason, std::string hostmask)" +.br +.RI "\fIAdds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP" +.ti -1c +.RI "virtual void \fBAddQLine\fP (long duration, std::string source, std::string reason, std::string nickname)" +.br +.RI "\fIAdds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP" +.ti -1c +.RI "virtual void \fBAddZLine\fP (long duration, std::string source, std::string reason, std::string ipaddr)" +.br +.RI "\fIAdds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. \fP" +.ti -1c +.RI "virtual void \fBAddKLine\fP (long duration, std::string source, std::string reason, std::string hostmask)" +.br +.RI "\fIAdds a K-line The K-line is enforced as soon as it is added. \fP" +.ti -1c +.RI "virtual void \fBAddELine\fP (long duration, std::string source, std::string reason, std::string hostmask)" +.br +.RI "\fIAdds a E-line The E-line is enforced as soon as it is added. \fP" +.ti -1c +.RI "virtual bool \fBDelGLine\fP (std::string hostmask)" +.br +.RI "\fIDeletes a G-Line from all servers on the mesh. \fP" +.ti -1c +.RI "virtual bool \fBDelQLine\fP (std::string nickname)" +.br +.RI "\fIDeletes a Q-Line from all servers on the mesh. \fP" +.ti -1c +.RI "virtual bool \fBDelZLine\fP (std::string ipaddr)" +.br +.RI "\fIDeletes a Z-Line from all servers on the mesh. \fP" +.ti -1c +.RI "virtual bool \fBDelKLine\fP (std::string hostmask)" +.br +.RI "\fIDeletes a local K-Line. \fP" +.ti -1c +.RI "virtual bool \fBDelELine\fP (std::string hostmask)" +.br +.RI "\fIDeletes a local E-Line. \fP" +.ti -1c +.RI "virtual long \fBCalcDuration\fP (std::string duration)" +.br +.RI "\fICalculates a duration This method will take a string containing a formatted duration (e.g. \fP" .in -1c .SH "Detailed Description" .PP @@ -166,7 +218,7 @@ 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 376 of file modules.h. +Definition at line 385 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" @@ -202,6 +254,17 @@ References createcommand(). 422 createcommand(cmd,f,flags,minparams,source); 423 } .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 638 of file modules.cpp. +.PP +References add_eline(), and duration(). +.PP +.nf +639 { +640 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +641 } +.fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP Adds an extended mode letter which is parsed by a module and handled in a list fashion. This call is used to implement modes like +q and +a. The characteristics of these modes are as follows: @@ -252,6 +315,61 @@ References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. 562 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); 563 } .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 618 of file modules.cpp. +.PP +References add_gline(), and duration(). +.PP +.nf +619 { +620 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +621 } +.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 633 of file modules.cpp. +.PP +References add_kline(), and duration(). +.PP +.nf +634 { +635 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str()); +636 } +.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 623 of file modules.cpp. +.PP +References add_qline(), and duration(). +.PP +.nf +624 { +625 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str()); +626 } +.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 628 of file modules.cpp. +.PP +References add_zline(), and duration(). +.PP +.nf +629 { +630 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str()); +631 } +.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 668 of file modules.cpp. +.PP +References duration(). +.PP +.nf +669 { +670 return duration(delta.c_str()); +671 } +.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 @@ -325,6 +443,61 @@ Returns a count of the number of users on a channel. This will NEVER be 0, as if 575 return usercount(c); 576 } .fi +.SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP" +.PP +Deletes a local E-Line. Definition at line 663 of file modules.cpp. +.PP +References del_eline(). +.PP +.nf +664 { +665 del_eline(hostmask.c_str()); +666 } +.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 643 of file modules.cpp. +.PP +References del_gline(). +.PP +.nf +644 { +645 del_gline(hostmask.c_str()); +646 } +.fi +.SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP" +.PP +Deletes a local K-Line. Definition at line 658 of file modules.cpp. +.PP +References del_kline(). +.PP +.nf +659 { +660 del_kline(hostmask.c_str()); +661 } +.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 648 of file modules.cpp. +.PP +References del_qline(). +.PP +.nf +649 { +650 del_qline(nickname.c_str()); +651 } +.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 653 of file modules.cpp. +.PP +References del_zline(). +.PP +.nf +654 { +655 del_zline(ipaddr.c_str()); +656 } +.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 513 of file modules.cpp. @@ -468,6 +641,42 @@ Forces a user to part a channel. This is similar to svspart and can be used to i 372 return del_channel(user,cname.c_str(),reason.c_str(),false); 373 } .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 588 of file modules.cpp. +.PP +References ucrec::channel, userrec::chans, chanrec::created, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset. +.PP +.nf +589 { +590 zombie->fd = alive->fd; +591 alive->fd = FD_MAGIC_NUMBER; +592 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick); +593 kill_link(alive,message.c_str()); +594 for (int i = 0; i != MAXCHANS; i++) +595 { +596 if (zombie->chans[i].channel != NULL) +597 { +598 if (zombie->chans[i].channel->name) +599 { +600 chanrec* Ptr = zombie->chans[i].channel; +601 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name); +602 if (Ptr->topicset) +603 { +604 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic); +605 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset); +606 } +607 userlist(zombie,Ptr); +608 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name); +609 WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr)); +610 WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created); +611 +612 } +613 } +614 } +615 +616 } +.fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP Forces a user to quit with the specified reason. To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file. @@ -627,6 +836,21 @@ Sends a WALLOPS message. This method writes a WALLOPS message to all users with 490 WriteWallOps(User,false,'%s',text.c_str()); 491 } .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 579 of file modules.cpp. +.PP +References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident. +.PP +.nf +580 { +581 unsigned int old_fd = user->fd; +582 user->fd = FD_MAGIC_NUMBER; +583 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str()); +584 close(old_fd); +585 shutdown (old_fd,2); +586 } +.fi .SH "Author" diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 8ca9ffb81..5f2a1b098 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index c0d4fd052..3488e1cb2 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -44,7 +44,7 @@ Holds a module's Version information The four members (set by the constructor on A class of type Version is returned by the GetVersion method of the \fBModule\fP class. .PP -Definition at line 109 of file modules.h. +Definition at line 111 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Version::Version (int major, int minor, int revision, int build, int flags)" @@ -58,19 +58,19 @@ Definition at line 300 of file modules.cpp. .PP .SS "const int \fBVersion::Build\fP" .PP -Definition at line 112 of file modules.h. +Definition at line 114 of file modules.h. .SS "const int \fBVersion::Flags\fP" .PP -Definition at line 112 of file modules.h. +Definition at line 114 of file modules.h. .SS "const int \fBVersion::Major\fP" .PP -Definition at line 112 of file modules.h. +Definition at line 114 of file modules.h. .SS "const int \fBVersion::Minor\fP" .PP -Definition at line 112 of file modules.h. +Definition at line 114 of file modules.h. .SS "const int \fBVersion::Revision\fP" .PP -Definition at line 112 of file modules.h. +Definition at line 114 of file modules.h. .SH "Author" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 3d9909619..84bf188f0 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 940be822d..47d573b2b 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "13 Apr 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 ad0974665..0b9f1c214 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "13 Apr 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 3ece27eb2..f6e000195 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -271,7 +271,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 776 of file modules.cpp. +Definition at line 871 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP Definition at line 92 of file channels.cpp. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index 0c2273556..4b671c2fc 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 2039c3025..b73d9dbed 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -254,7 +254,7 @@ Referenced by chanrec(). .PP Creation time. Definition at line 111 of file channels.h. .PP -Referenced by chanrec(). +Referenced by chanrec(), and Server::PseudoToUser(). .SS "char \fBchanrec::custom_modes\fP[MAXMODES]" .PP Custom modes for the channel. Plugins may use this field in any way they see fit.Definition at line 103 of file channels.h. @@ -284,7 +284,7 @@ Referenced by chanrec(). .PP The channels name. Definition at line 99 of file channels.h. .PP -Referenced by chanrec(). +Referenced by chanrec(), and Server::PseudoToUser(). .SS "short int \fBchanrec::noexternal\fP" .PP Nonzero if the mode +n is set. Definition at line 137 of file channels.h. @@ -299,12 +299,12 @@ Referenced by chanrec(). .PP The last user to set the topic. If this member is an empty string, no topic was ever set.Definition at line 119 of file channels.h. .PP -Referenced by chanrec(). +Referenced by chanrec(), and Server::PseudoToUser(). .SS "char \fBchanrec::topic\fP[MAXBUF]" .PP Channel topic. If this is an empty string, no channel topic is set.Definition at line 108 of file channels.h. .PP -Referenced by chanrec(). +Referenced by chanrec(), and Server::PseudoToUser(). .SS "short int \fBchanrec::topiclock\fP" .PP Nonzero if the mode +t is set. Definition at line 133 of file channels.h. @@ -314,7 +314,7 @@ Referenced by chanrec(). .PP Time topic was set. If no topic was ever set, this will be equal to \fBchanrec::created\fPDefinition at line 115 of file channels.h. .PP -Referenced by chanrec(). +Referenced by chanrec(), and Server::PseudoToUser(). .SH "Author" .PP diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index fba93b6cd..ef67bcf19 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "13 Apr 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 ebaa41001..379f83fbe 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "13 Apr 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 ff2b363b8..4618f4a0f 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -255,9 +255,16 @@ commands.h \- .RI "bool \fBis_uline\fP (const char *server)" .br .RI "\fIFunctions for u:lined servers. \fP" +.ti -1c +.RI "long \fBduration\fP (const char *str)" +.br +.RI "\fIOther useful functions. \fP" .in -1c .SH "Function Documentation" .PP +.SS "long duration (const char * str)" +.PP +Other useful functions. Referenced by Server::AddELine(), Server::AddGLine(), Server::AddKLine(), Server::AddQLine(), Server::AddZLine(), and Server::CalcDuration(). .SS "void handle_a (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" .PP .SS "void handle_admin (char ** parameters, int pcnt, \fBuserrec\fP * user)" diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index 1db27f5e4..d1c103cab 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -204,7 +204,7 @@ With a serverrec, this is a list of all established server connections. With a u .PP File descriptor of the connection. Definition at line 178 of file connection.h. .PP -Referenced by ConfigReader::DumpErrors(), Server::SendTo(), serverrec::serverrec(), and userrec::userrec(). +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 210 of file connection.h. @@ -214,7 +214,7 @@ Referenced by userrec::userrec(). .PP Hostname of connection. Not used if this is a serverrecDefinition at line 182 of file connection.h. .PP -Referenced by userrec::GetFullRealHost(), and userrec::userrec(). +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 236 of file connection.h. diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index d0e85f663..154c35673 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "13 Apr 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 ba0c82f2a..4b4c2705c 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "13 Apr 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 3f7b577b6..1b8a88000 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "13 Apr 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 c8d7792b1..2e974e79d 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "13 Apr 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 fbccfe8c9..fa7c1f269 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index 502c9d479..d3e4e1ea4 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index 3a4f2395d..4c95c9b68 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "13 Apr 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 6bacc994d..855e8a16f 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -533,7 +533,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 776 of file modules.cpp. +Definition at line 871 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP Definition at line 95 of file modules.cpp. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index 2a1924d97..092567805 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -133,6 +133,9 @@ modules.h \- .RI "#define \fBFOREACH_RESULT\fP(x)" .br .ti -1c +.RI "#define \fBFD_MAGIC_NUMBER\fP -42" +.br +.ti -1c .RI "#define \fBCONF_NOT_A_NUMBER\fP 0x000010" .br .ti -1c @@ -215,22 +218,22 @@ Referenced by Module::OnAccessCheck(). Definition at line 38 of file modules.h. .SS "#define CONF_FILE_NOT_FOUND 0x000200" .PP -Definition at line 675 of file modules.h. +Definition at line 772 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 672 of file modules.h. +Definition at line 769 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 673 of file modules.h. +Definition at line 770 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 674 of file modules.h. +Definition at line 771 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" @@ -241,6 +244,11 @@ Referenced by Server::AddExtendedMode(), userrec::HasPermission(), chanrec::IsCu .SS "#define DEFAULT 30" .PP Definition at line 25 of file modules.h. +.SS "#define FD_MAGIC_NUMBER -42" +.PP +Definition at line 99 of file modules.h. +.PP +Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). .SS "#define FOREACH_MOD for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->" .PP Definition at line 79 of file modules.h. @@ -311,7 +319,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 840 of file modules.h. +Definition at line 937 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 2a2ce73e7..68bf04bab 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "13 Apr 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 af95e6cd0..57071a8cf 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 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index 69cfab153..b5b512f46 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 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/packet.3 b/docs/man/man3/packet.3 index 8c40129a4..fc5710d66 100644 --- a/docs/man/man3/packet.3 +++ b/docs/man/man3/packet.3 @@ -1,4 +1,4 @@ -.TH "packet" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "packet" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index a9c894df0..94189878d 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "13 Apr 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 d0677ae0a..d47ff592e 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "13 Apr 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 b19bfffc1..a1d16729a 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 5e60136f9..79c07bd19 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 9525851b8..c56008f7a 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -63,7 +63,7 @@ Definition at line 216 of file channels.h. .PP Points to the channel record where the given modes apply. If the record is not in use, this value will be NULL.Definition at line 213 of file channels.h. .PP -Referenced by userrec::userrec(). +Referenced by Server::PseudoToUser(), and userrec::userrec(). .SS "long \fBucrec::uc_modes\fP" .PP Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.Definition at line 208 of file channels.h. diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 51e5d70e5..ce305ed8b 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -319,7 +319,7 @@ Referenced by userrec(). .PP Definition at line 127 of file users.h. .PP -Referenced by userrec(). +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. @@ -344,7 +344,7 @@ Referenced by userrec(). .PP The users ident reply. Definition at line 110 of file users.h. .PP -Referenced by GetFullHost(), GetFullRealHost(), and userrec(). +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. @@ -359,7 +359,7 @@ Referenced by userrec(). .PP The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 106 of file users.h. .PP -Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::QuitUser(), and userrec(). +Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::PseudoToUser(), Server::QuitUser(), 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. diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index dac38dea5..841d30d6b 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "13 Apr 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 c515cd5de..344634924 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index d25646cd9..f5bd289ba 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -57,34 +57,34 @@ xline.h \- .RI "void \fBread_xline_defaults\fP ()" .br .ti -1c -.RI "void \fBadd_gline\fP (long duration, char *source, char *reason, char *hostmask)" +.RI "void \fBadd_gline\fP (long duration, const char *source, const char *reason, const char *hostmask)" .br .ti -1c -.RI "void \fBadd_qline\fP (long duration, char *source, char *reason, char *nickname)" +.RI "void \fBadd_qline\fP (long duration, const char *source, const char *reason, const char *nickname)" .br .ti -1c -.RI "void \fBadd_zline\fP (long duration, char *source, char *reason, char *ipaddr)" +.RI "void \fBadd_zline\fP (long duration, const char *source, const char *reason, const char *ipaddr)" .br .ti -1c -.RI "void \fBadd_kline\fP (long duration, char *source, char *reason, char *hostmask)" +.RI "void \fBadd_kline\fP (long duration, const char *source, const char *reason, const char *hostmask)" .br .ti -1c -.RI "void \fBadd_eline\fP (long duration, char *source, char *reason, char *hostmask)" +.RI "void \fBadd_eline\fP (long duration, const char *source, const char *reason, const char *hostmask)" .br .ti -1c -.RI "bool \fBdel_gline\fP (char *hostmask)" +.RI "bool \fBdel_gline\fP (const char *hostmask)" .br .ti -1c -.RI "bool \fBdel_qline\fP (char *nickname)" +.RI "bool \fBdel_qline\fP (const char *nickname)" .br .ti -1c -.RI "bool \fBdel_zline\fP (char *ipaddr)" +.RI "bool \fBdel_zline\fP (const char *ipaddr)" .br .ti -1c -.RI "bool \fBdel_kline\fP (char *hostmask)" +.RI "bool \fBdel_kline\fP (const char *hostmask)" .br .ti -1c -.RI "bool \fBdel_eline\fP (char *hostmask)" +.RI "bool \fBdel_eline\fP (const char *hostmask)" .br .ti -1c .RI "char * \fBmatches_qline\fP (const char *nick)" @@ -132,10 +132,10 @@ xline.h \- .RI "void \fBzline_set_creation_time\fP (char *ip, time_t create_time)" .br .ti -1c -.RI "bool \fBzline_make_global\fP (char *ipaddr)" +.RI "bool \fBzline_make_global\fP (const char *ipaddr)" .br .ti -1c -.RI "bool \fBqline_make_global\fP (char *nickname)" +.RI "bool \fBqline_make_global\fP (const char *nickname)" .br .ti -1c .RI "void \fBsync_xlines\fP (\fBserverrec\fP *serv, char *tcp_host)" @@ -143,28 +143,38 @@ xline.h \- .in -1c .SH "Function Documentation" .PP -.SS "void add_eline (long duration, char * source, char * reason, char * hostmask)" +.SS "void add_eline (long duration, const char * source, const char * reason, const char * hostmask)" .PP -.SS "void add_gline (long duration, char * source, char * reason, char * hostmask)" +Referenced by Server::AddELine(). +.SS "void add_gline (long duration, const char * source, const char * reason, const char * hostmask)" .PP -.SS "void add_kline (long duration, char * source, char * reason, char * hostmask)" +Referenced by Server::AddGLine(). +.SS "void add_kline (long duration, const char * source, const char * reason, const char * hostmask)" .PP -.SS "void add_qline (long duration, char * source, char * reason, char * nickname)" +Referenced by Server::AddKLine(). +.SS "void add_qline (long duration, const char * source, const char * reason, const char * nickname)" .PP -.SS "void add_zline (long duration, char * source, char * reason, char * ipaddr)" +Referenced by Server::AddQLine(). +.SS "void add_zline (long duration, const char * source, const char * reason, const char * ipaddr)" .PP +Referenced by Server::AddZLine(). .SS "void apply_lines ()" .PP -.SS "bool del_eline (char * hostmask)" +.SS "bool del_eline (const char * hostmask)" .PP -.SS "bool del_gline (char * hostmask)" +Referenced by Server::DelELine(). +.SS "bool del_gline (const char * hostmask)" .PP -.SS "bool del_kline (char * hostmask)" +Referenced by Server::DelGLine(). +.SS "bool del_kline (const char * hostmask)" .PP -.SS "bool del_qline (char * nickname)" +Referenced by Server::DelKLine(). +.SS "bool del_qline (const char * nickname)" .PP -.SS "bool del_zline (char * ipaddr)" +Referenced by Server::DelQLine(). +.SS "bool del_zline (const char * ipaddr)" .PP +Referenced by Server::DelZLine(). .SS "void expire_lines ()" .PP .SS "void gline_set_creation_time (char * host, time_t create_time)" @@ -179,7 +189,7 @@ xline.h \- .PP .SS "char* matches_zline (const char * ipaddr)" .PP -.SS "bool qline_make_global (char * nickname)" +.SS "bool qline_make_global (const char * nickname)" .PP .SS "void qline_set_creation_time (char * nick, time_t create_time)" .PP @@ -197,7 +207,7 @@ xline.h \- .PP .SS "void sync_xlines (\fBserverrec\fP * serv, char * tcp_host)" .PP -.SS "bool zline_make_global (char * ipaddr)" +.SS "bool zline_make_global (const char * ipaddr)" .PP .SS "void zline_set_creation_time (char * ip, time_t create_time)" .PP |