diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-04 18:13:55 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-04 18:13:55 +0000 |
commit | 9c8b44176b47d2186c88743dc1f68023c26d780b (patch) | |
tree | b5ea400fcc976129e466dc212a0f326960618dbd /docs/man | |
parent | d68dcc665827575df74156f08b22451f98aaaef6 (diff) |
Added new documentation for ELine class and OnUserPostNick method
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@977 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man')
55 files changed, 534 insertions, 466 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 5136dc6c1..38345d7c9 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index d89113e36..5ab1500b3 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 6a0065cfe..f3e02bdb4 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "4 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 669 of file modules.h. +Definition at line 675 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 576 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 577 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -577 { -578 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -579 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -580 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -581 if (!this->readerror) -582 this->error = CONF_FILE_NOT_FOUND; -583 } +578 { +579 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +580 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +581 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); +582 if (!this->readerror) +583 this->error = CONF_FILE_NOT_FOUND; +584 } .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 595 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 596 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -596 { -597 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -598 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -599 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -600 if (!this->readerror) -601 this->error = CONF_FILE_NOT_FOUND; -602 }; +597 { +598 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); +599 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); +600 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); +601 if (!this->readerror) +602 this->error = CONF_FILE_NOT_FOUND; +603 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 586 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 587 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -587 { -588 if (this->cache) -589 delete this->cache; -590 if (this->errorlog) -591 delete this->errorlog; -592 } +588 { +589 if (this->cache) +590 delete this->cache; +591 if (this->errorlog) +592 delete this->errorlog; +593 } .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 673 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 674 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -674 { -675 if (bail) -676 { -677 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -678 exit(0); -679 } -680 else -681 { -682 char dataline[1024]; -683 if (user) -684 { -685 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -686 while (!errorlog->eof()) -687 { -688 errorlog->getline(dataline,1024); -689 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -690 } -691 } -692 else -693 { -694 WriteOpers('There were errors in the configuration file:',user->nick); -695 while (!errorlog->eof()) -696 { -697 errorlog->getline(dataline,1024); -698 WriteOpers(dataline); -699 } -700 } -701 return; -702 } -703 } +675 { +676 if (bail) +677 { +678 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); +679 exit(0); +680 } +681 else +682 { +683 char dataline[1024]; +684 if (user) +685 { +686 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); +687 while (!errorlog->eof()) +688 { +689 errorlog->getline(dataline,1024); +690 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); +691 } +692 } +693 else +694 { +695 WriteOpers('There were errors in the configuration file:',user->nick); +696 while (!errorlog->eof()) +697 { +698 errorlog->getline(dataline,1024); +699 WriteOpers(dataline); +700 } +701 } +702 return; +703 } +704 } .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 706 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 707 of file modules.cpp. .PP References cache. .PP .nf -707 { -708 return EnumConf(cache,tag.c_str()); -709 } +708 { +709 return EnumConf(cache,tag.c_str()); +710 } .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 711 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 712 of file modules.cpp. .PP References cache. .PP .nf -712 { -713 return EnumValues(cache, tag.c_str(), index); -714 } +713 { +714 return EnumValues(cache, tag.c_str(), index); +715 } .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 666 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 667 of file modules.cpp. .PP References error. .PP .nf -667 { -668 long olderr = this->error; -669 this->error = 0; -670 return olderr; -671 } +668 { +669 long olderr = this->error; +670 this->error = 0; +671 return olderr; +672 } .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 620 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 621 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -621 { -622 char val[MAXBUF]; -623 char t[MAXBUF]; -624 char n[MAXBUF]; -625 strlcpy(t,tag.c_str(),MAXBUF); -626 strlcpy(n,name.c_str(),MAXBUF); -627 int res = ReadConf(cache,t,n,index,val); -628 if (!res) -629 { -630 this->error = CONF_VALUE_NOT_FOUND; -631 return false; -632 } -633 std::string s = val; -634 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -635 } +622 { +623 char val[MAXBUF]; +624 char t[MAXBUF]; +625 char n[MAXBUF]; +626 strlcpy(t,tag.c_str(),MAXBUF); +627 strlcpy(n,name.c_str(),MAXBUF); +628 int res = ReadConf(cache,t,n,index,val); +629 if (!res) +630 { +631 this->error = CONF_VALUE_NOT_FOUND; +632 return false; +633 } +634 std::string s = val; +635 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); +636 } .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 637 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 638 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -638 { -639 char val[MAXBUF]; -640 char t[MAXBUF]; -641 char n[MAXBUF]; -642 strlcpy(t,tag.c_str(),MAXBUF); -643 strlcpy(n,name.c_str(),MAXBUF); -644 int res = ReadConf(cache,t,n,index,val); -645 if (!res) -646 { -647 this->error = CONF_VALUE_NOT_FOUND; -648 return 0; -649 } -650 for (int i = 0; i < strlen(val); i++) -651 { -652 if (!isdigit(val[i])) -653 { -654 this->error = CONF_NOT_A_NUMBER; -655 return 0; -656 } -657 } -658 if ((needs_unsigned) && (atoi(val)<0)) -659 { -660 this->error = CONF_NOT_UNSIGNED; -661 return 0; -662 } -663 return atoi(val); -664 } +639 { +640 char val[MAXBUF]; +641 char t[MAXBUF]; +642 char n[MAXBUF]; +643 strlcpy(t,tag.c_str(),MAXBUF); +644 strlcpy(n,name.c_str(),MAXBUF); +645 int res = ReadConf(cache,t,n,index,val); +646 if (!res) +647 { +648 this->error = CONF_VALUE_NOT_FOUND; +649 return 0; +650 } +651 for (int i = 0; i < strlen(val); i++) +652 { +653 if (!isdigit(val[i])) +654 { +655 this->error = CONF_NOT_A_NUMBER; +656 return 0; +657 } +658 } +659 if ((needs_unsigned) && (atoi(val)<0)) +660 { +661 this->error = CONF_NOT_UNSIGNED; +662 return 0; +663 } +664 return atoi(val); +665 } .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 604 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 605 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -605 { -606 char val[MAXBUF]; -607 char t[MAXBUF]; -608 char n[MAXBUF]; -609 strlcpy(t,tag.c_str(),MAXBUF); -610 strlcpy(n,name.c_str(),MAXBUF); -611 int res = ReadConf(cache,t,n,index,val); -612 if (!res) -613 { -614 this->error = CONF_VALUE_NOT_FOUND; -615 return ''; -616 } -617 return std::string(val); -618 } +606 { +607 char val[MAXBUF]; +608 char t[MAXBUF]; +609 char n[MAXBUF]; +610 strlcpy(t,tag.c_str(),MAXBUF); +611 strlcpy(n,name.c_str(),MAXBUF); +612 int res = ReadConf(cache,t,n,index,val); +613 if (!res) +614 { +615 this->error = CONF_VALUE_NOT_FOUND; +616 return ''; +617 } +618 return std::string(val); +619 } .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 716 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 717 of file modules.cpp. .PP References readerror. .PP .nf -717 { -718 return this->readerror; -719 } +718 { +719 return this->readerror; +720 } .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 677 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 683 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 682 of file modules.h. +Definition at line 688 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 678 of file modules.h. +Definition at line 684 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 681 of file modules.h. +Used to store errors. Definition at line 687 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 9f3d55c37..549784a28 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index f73724fba..68f450166 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 new file mode 100644 index 000000000..bc8a86094 --- /dev/null +++ b/docs/man/man3/ELine.3 @@ -0,0 +1,29 @@ +.TH "ELine" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ELine \- +.SH SYNOPSIS +.br +.PP +\fC#include <xline.h>\fP +.PP +Inherits \fBXLine\fP. +.PP +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "char \fBhostmask\fP [MAXBUF]" +.br +.RI "\fIHostmask (ident) to match against May contain wildcards. \fP" +.in -1c +.SH "Member Data Documentation" +.PP +.SS "char \fBELine::hostmask\fP[MAXBUF]" +.PP +Hostmask (ident) to match against May contain wildcards. Definition at line 88 of file xline.h. + +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index 120febbc9..170f480cb 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index b43786de2..9abd492ad 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index 9b735c22f..90bb78178 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 3cb35ebd7..377933336 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "4 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 758 of file modules.h. +Definition at line 764 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 729 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 730 of file modules.cpp. .PP .nf -730 { -731 } +731 { +732 } .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 722 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 723 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -723 { -724 file_cache c; -725 readfile(c,filename.c_str()); -726 this->fc = c; -727 } +724 { +725 file_cache c; +726 readfile(c,filename.c_str()); +727 this->fc = c; +728 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 741 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 742 of file modules.cpp. .PP .nf -742 { -743 } +743 { +744 } .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 745 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 746 of file modules.cpp. .PP References fc. .PP .nf -746 { -747 if (fc.size() == 0) -748 { -749 return(false); -750 } -751 else -752 { -753 return(true); -754 } -755 } +747 { +748 if (fc.size() == 0) +749 { +750 return(false); +751 } +752 else +753 { +754 return(true); +755 } +756 } .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 764 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 765 of file modules.cpp. .PP References fc. .PP .nf -765 { -766 return fc.size(); -767 } +766 { +767 return fc.size(); +768 } .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 757 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 758 of file modules.cpp. .PP References fc. .PP .nf -758 { -759 if ((x<0) || (x>fc.size())) -760 return ''; -761 return fc[x]; -762 } +759 { +760 if ((x<0) || (x>fc.size())) +761 return ''; +762 return fc[x]; +763 } .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 733 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 734 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -734 { -735 file_cache c; -736 readfile(c,filename.c_str()); -737 this->fc = c; -738 } +735 { +736 file_cache c; +737 readfile(c,filename.c_str()); +738 this->fc = c; +739 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 760 of file modules.h. +Definition at line 766 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 3fc99ec2b..d55391531 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index f176b6c9b..d767c5879 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "4 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 e6f60886b..eb1584eaf 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 6581c363f..89d36a36a 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index 19f5d7964..ab1a87bb8 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index a63b3ce13..991453d01 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 3306c65f4..b374643d8 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 3db75227e..1196ebcaa 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -96,6 +96,10 @@ Inherits \fBclassbase\fP. .br .RI "\fICalled before any nickchange, local or remote. \fP" .ti -1c +.RI "virtual void \fBOnUserPostNick\fP (\fBuserrec\fP *user, std::string oldnick)" +.br +.RI "\fICalled after any nickchange, local or remote. \fP" +.ti -1c .RI "virtual int \fBOnAccessCheck\fP (\fBuserrec\fP *source, \fBuserrec\fP *dest, \fBchanrec\fP *channel, int access_type)" .br .RI "\fICalled before an action which requires a channel privilage check. \fP" @@ -154,10 +158,10 @@ Returns the version number of a Module. The method should return a \fBVersion\fP .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 327 of file modules.cpp. +Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features.Definition at line 328 of file modules.cpp. .PP .nf -327 { }; +328 { }; .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP @@ -185,21 +189,21 @@ 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 324 of file modules.cpp. + Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).Definition at line 325 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -324 { return ACR_DEFAULT; }; +325 { return ACR_DEFAULT; }; .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 326 of file modules.cpp. +Called during a netburst to sync channel data. This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 327 of file modules.cpp. .PP References string_list. .PP .nf -326 { string_list empty; return empty; } +327 { string_list empty; return empty; } .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 @@ -219,17 +223,17 @@ Called whenever a user types /INFO. The userrec will contain the information of .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 328 of file modules.cpp. +Called when a client is disconnected by KILL. If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers. If you do so youre risking race conditions, desyncs and worse!Definition at line 329 of file modules.cpp. .PP .nf -328 { return 0; }; +329 { return 0; }; .fi .SS "void Module::OnLoadModule (\fBModule\fP * mod, std::string name)\fC [virtual]\fP" .PP -Called whenever a module is loaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded 'm_killwidgets.so' with 'm_makewidgets.so'. It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).Definition at line 329 of file modules.cpp. +Called whenever a module is loaded. mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded 'm_killwidgets.so' with 'm_makewidgets.so'. It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).Definition at line 330 of file modules.cpp. .PP .nf -329 { }; +330 { }; .fi .SS "void Module::OnOper (\fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -287,6 +291,13 @@ Called when a user parts a channel. The details of the leaving user are availabl .nf 309 { } .fi +.SS "void Module::OnUserPostNick (\fBuserrec\fP * user, std::string oldnick)\fC [virtual]\fP" +.PP +Called after any nickchange, local or remote. This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this. Definition at line 324 of file modules.cpp. +.PP +.nf +324 { }; +.fi .SS "int Module::OnUserPreInvite (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.Definition at line 320 of file modules.cpp. @@ -314,7 +325,7 @@ Called whenever a user is about to PRIVMSG A user or a channel, before any proce .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. 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 323 of file modules.cpp. +Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.Definition at line 323 of file modules.cpp. .PP .nf 323 { return 0; }; @@ -335,12 +346,12 @@ Called when a user quits. The details of the exiting user are available to you i .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 325 of file modules.cpp. +Called during a netburst to sync user data. This is called during the netburst on a per-user basis. You should use this call to up any special user-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 326 of file modules.cpp. .PP References string_list. .PP .nf -325 { string_list empty; return empty; } +326 { string_list empty; return empty; } .fi .SS "void Module::OnWhois (\fBuserrec\fP * source, \fBuserrec\fP * dest)\fC [virtual]\fP" .PP diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index c209bc48a..b17e177bf 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "4 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 813 of file modules.h. +Definition at line 819 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 816 of file modules.h. +Definition at line 822 of file modules.h. .PP .nf -816 { } +822 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 817 of file modules.h. +Definition at line 823 of file modules.h. .PP .nf -817 { } +823 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index e563152c3..a90addc4c 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -26,15 +26,15 @@ Inherits \fBXLine\fP. .in -1c .SH "Detailed Description" .PP -QLine class. Definition at line 99 of file xline.h. +QLine class. Definition at line 108 of file xline.h. .SH "Member Data Documentation" .PP .SS "bool \fBQLine::is_global\fP" .PP -Set if this is a global Z:line (e.g. it came from another server)Definition at line 109 of file xline.h. +Set if this is a global Z:line (e.g. it came from another server)Definition at line 118 of file xline.h. .SS "char \fBQLine::nick\fP[MAXBUF]" .PP -Nickname to match against. May contain wildcards.Definition at line 105 of file xline.h. +Nickname to match against. May contain wildcards.Definition at line 114 of file xline.h. .SH "Author" .PP diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index a41d9992a..56e6c0252 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -166,24 +166,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 365 of file modules.h. +Definition at line 371 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 336 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 337 of file modules.cpp. .PP .nf -337 { -338 } +338 { +339 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 340 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 341 of file modules.cpp. .PP .nf -341 { -342 } +342 { +343 } .fi .SH "Member Function Documentation" .PP @@ -193,14 +193,14 @@ 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'.Definition at line 417 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'.Definition at line 418 of file modules.cpp. .PP References createcommand(). .PP .nf -418 { -419 createcommand(cmd,f,flags,minparams); -420 } +419 { +420 createcommand(cmd,f,flags,minparams); +421 } .fi .SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP" .PP @@ -214,259 +214,259 @@ 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 562 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 563 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -563 { -564 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -565 if (res) -566 ModeMakeList(modechar); -567 return res; -568 } +564 { +565 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +566 if (res) +567 ModeMakeList(modechar); +568 return res; +569 } .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 542 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 543 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -543 { -544 if (type == MT_SERVER) -545 { -546 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -547 return false; -548 } -549 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -550 { -551 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -552 return false; -553 } -554 if ((params_when_on>1) || (params_when_off>1)) -555 { -556 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); -557 return false; -558 } -559 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -560 } +544 { +545 if (type == MT_SERVER) +546 { +547 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); +548 return false; +549 } +550 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) +551 { +552 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); +553 return false; +554 } +555 if ((params_when_on>1) || (params_when_off>1)) +556 { +557 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +558 return false; +559 } +560 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); +561 } .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 407 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 408 of file modules.cpp. .PP .nf -408 { -409 call_handler(commandname.c_str(),parameters,pcnt,user); -410 } +409 { +410 call_handler(commandname.c_str(),parameters,pcnt,user); +411 } .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 495 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 496 of file modules.cpp. .PP References ChangeName(). .PP .nf -496 { -497 ChangeName(user,gecos.c_str()); -498 } +497 { +498 ChangeName(user,gecos.c_str()); +499 } .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 490 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 491 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -491 { -492 ChangeDisplayedHost(user,host.c_str()); -493 } +492 { +493 ChangeDisplayedHost(user,host.c_str()); +494 } .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 391 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 392 of file modules.cpp. .PP .nf -392 { -393 force_nickchange(user,nickname.c_str()); -394 } +393 { +394 force_nickchange(user,nickname.c_str()); +395 } .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 515 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 516 of file modules.cpp. .PP References cmode(). .PP .nf -516 { -517 return cmode(User,Chan); -518 } +517 { +518 return cmode(User,Chan); +519 } .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 468 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 469 of file modules.cpp. .PP References common_channels(). .PP .nf -469 { -470 return (common_channels(u1,u2) != 0); -471 } +470 { +471 return (common_channels(u1,u2) != 0); +472 } .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 570 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 571 of file modules.cpp. .PP .nf -571 { -572 return usercount(c); -573 } +572 { +573 return usercount(c); +574 } .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 510 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 511 of file modules.cpp. .PP .nf -511 { -512 return FindChan(channel.c_str()); -513 } +512 { +513 return FindChan(channel.c_str()); +514 } .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 505 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 506 of file modules.cpp. .PP .nf -506 { -507 return Find(nick); -508 } +507 { +508 return Find(nick); +509 } .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 535 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 536 of file modules.cpp. .PP .nf -536 { -537 return Admin(getadminname(),getadminemail(),getadminnick()); -538 } +537 { +538 return Admin(getadminname(),getadminemail(),getadminnick()); +539 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 530 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 531 of file modules.cpp. .PP .nf -531 { -532 return getnetworkname(); -533 } +532 { +533 return getnetworkname(); +534 } .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 525 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 526 of file modules.cpp. .PP .nf -526 { -527 return getservername(); -528 } +527 { +528 return getservername(); +529 } .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 372 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 373 of file modules.cpp. .PP References chanuserlist, clientlist, has_channel(), and isnick(). .PP .nf -373 { -374 chanuserlist userl; -375 userl.clear(); -376 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) -377 { -378 if (i->second) -379 { -380 if (has_channel(i->second,chan)) -381 { -382 if (isnick(i->second->nick)) -383 { -384 userl.push_back(i->second); -385 } -386 } -387 } -388 } -389 return userl; -390 } +374 { +375 chanuserlist userl; +376 userl.clear(); +377 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) +378 { +379 if (i->second) +380 { +381 if (has_channel(i->second,chan)) +382 { +383 if (isnick(i->second->nick)) +384 { +385 userl.push_back(i->second); +386 } +387 } +388 } +389 } +390 return userl; +391 } .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 500 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 501 of file modules.cpp. .PP References isnick(). .PP .nf -501 { -502 return (isnick(nick.c_str()) != 0); -503 } +502 { +503 return (isnick(nick.c_str()) != 0); +504 } .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 520 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 521 of file modules.cpp. .PP References has_channel(). .PP .nf -521 { -522 return has_channel(User,Chan); -523 } +522 { +523 return has_channel(User,Chan); +524 } .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 402 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 403 of file modules.cpp. .PP References is_uline(). .PP .nf -403 { -404 return is_uline(server.c_str()); -405 } +404 { +405 return is_uline(server.c_str()); +406 } .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 362 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 363 of file modules.cpp. .PP .nf -363 { -364 return add_channel(user,cname.c_str(),key.c_str(),true); -365 } +364 { +365 return add_channel(user,cname.c_str(),key.c_str(),true); +366 } .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 412 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 413 of file modules.cpp. .PP .nf -413 { -414 log(level,'%s',s.c_str()); -415 } +414 { +415 log(level,'%s',s.c_str()); +416 } .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 349 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 350 of file modules.cpp. .PP .nf -350 { -351 char literal[MAXBUF],pattern[MAXBUF]; -352 strlcpy(literal,sliteral.c_str(),MAXBUF); -353 strlcpy(pattern,spattern.c_str(),MAXBUF); -354 return match(literal,pattern); -355 } +351 { +352 char literal[MAXBUF],pattern[MAXBUF]; +353 strlcpy(literal,sliteral.c_str(),MAXBUF); +354 strlcpy(pattern,spattern.c_str(),MAXBUF); +355 return match(literal,pattern); +356 } .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 367 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 368 of file modules.cpp. .PP .nf -368 { -369 return del_channel(user,cname.c_str(),reason.c_str(),false); -370 } +369 { +370 return del_channel(user,cname.c_str(),reason.c_str(),false); +371 } .fi .SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP" .PP @@ -474,65 +474,65 @@ 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 396 of file modules.cpp. +Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.Definition at line 397 of file modules.cpp. .PP References userrec::nick, and send_network_quit(). .PP .nf -397 { -398 send_network_quit(user->nick,reason.c_str()); -399 kill_link(user,reason.c_str()); -400 } +398 { +399 send_network_quit(user->nick,reason.c_str()); +400 kill_link(user,reason.c_str()); +401 } .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 427 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 428 of file modules.cpp. .PP .nf -428 { -429 Write(Socket,'%s',s.c_str()); -430 } +429 { +430 Write(Socket,'%s',s.c_str()); +431 } .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 456 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 457 of file modules.cpp. .PP .nf -457 { -458 if (IncludeSender) -459 { -460 WriteChannel(Channel,User,'%s',s.c_str()); -461 } -462 else -463 { -464 ChanExceptSender(Channel,User,'%s',s.c_str()); -465 } -466 } +458 { +459 if (IncludeSender) +460 { +461 WriteChannel(Channel,User,'%s',s.c_str()); +462 } +463 else +464 { +465 ChanExceptSender(Channel,User,'%s',s.c_str()); +466 } +467 } .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 473 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 474 of file modules.cpp. .PP .nf -474 { -475 if (IncludeSender) -476 { -477 WriteCommon(User,'%s',text.c_str()); -478 } -479 else -480 { -481 WriteCommonExcept(User,'%s',text.c_str()); -482 } -483 } +475 { +476 if (IncludeSender) +477 { +478 WriteCommon(User,'%s',text.c_str()); +479 } +480 else +481 { +482 WriteCommonExcept(User,'%s',text.c_str()); +483 } +484 } .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 437 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 438 of file modules.cpp. .PP .nf -438 { -439 WriteFrom(Socket,User,'%s',s.c_str()); -440 } +439 { +440 WriteFrom(Socket,User,'%s',s.c_str()); +441 } .fi .SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP" .PP @@ -550,32 +550,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 422 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 423 of file modules.cpp. .PP References server_mode(). .PP .nf -423 { -424 server_mode(parameters,pcnt,user); -425 } +424 { +425 server_mode(parameters,pcnt,user); +426 } .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 344 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 345 of file modules.cpp. .PP .nf -345 { -346 WriteOpers('%s',s.c_str()); -347 } +346 { +347 WriteOpers('%s',s.c_str()); +348 } .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 432 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 433 of file modules.cpp. .PP .nf -433 { -434 WriteServ(Socket,'%s',s.c_str()); -435 } +434 { +435 WriteServ(Socket,'%s',s.c_str()); +436 } .fi .SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP" .PP @@ -587,23 +587,23 @@ The format will become: .PP :localserver TEXT .PP -Which is useful for numerics and server notices to single users, etc.Definition at line 442 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 443 of file modules.cpp. .PP References connection::fd. .PP .nf -443 { -444 if (!Source) -445 { -446 // if source is NULL, then the message originates from the local server -447 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -448 } -449 else -450 { -451 // otherwise it comes from the user specified -452 WriteTo(Source,Dest,'%s',s.c_str()); -453 } -454 } +444 { +445 if (!Source) +446 { +447 // if source is NULL, then the message originates from the local server +448 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); +449 } +450 else +451 { +452 // otherwise it comes from the user specified +453 WriteTo(Source,Dest,'%s',s.c_str()); +454 } +455 } .fi .SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP" .PP @@ -611,21 +611,21 @@ 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 357 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 358 of file modules.cpp. .PP .nf -358 { -359 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -360 } +359 { +360 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +361 } .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 485 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 486 of file modules.cpp. .PP .nf -486 { -487 WriteWallOps(User,false,'%s',text.c_str()); -488 } +487 { +488 WriteWallOps(User,false,'%s',text.c_str()); +489 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 46cbfc684..2614d4533 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index c2de24cbc..5f4bdea7c 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index f826b07f1..c71f4b90e 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -12,7 +12,7 @@ XLine \- XLine is the base class for ban lines such as G lines and K lines. .PP Inherits \fBclassbase\fP. .PP -Inherited by \fBGLine\fP, \fBKLine\fP, \fBQLine\fP, and \fBZLine\fP. +Inherited by \fBELine\fP, \fBGLine\fP, \fBKLine\fP, \fBQLine\fP, and \fBZLine\fP. .PP .SS "Public Attributes" diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 83789ac14..158e01b73 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -26,15 +26,15 @@ Inherits \fBXLine\fP. .in -1c .SH "Detailed Description" .PP -ZLine class. Definition at line 84 of file xline.h. +ZLine class. Definition at line 93 of file xline.h. .SH "Member Data Documentation" .PP .SS "char \fBZLine::ipaddr\fP[MAXBUF]" .PP -IP Address (xx.yy.zz.aa) to match against May contain wildcards. Definition at line 90 of file xline.h. +IP Address (xx.yy.zz.aa) to match against May contain wildcards. Definition at line 99 of file xline.h. .SS "bool \fBZLine::is_global\fP" .PP -Set if this is a global Z:line (e.g. it came from another server)Definition at line 94 of file xline.h. +Set if this is a global Z:line (e.g. it came from another server)Definition at line 103 of file xline.h. .SH "Author" .PP diff --git a/docs/man/man3/base.h.3 b/docs/man/man3/base.h.3 index e3a22b878..72bc81322 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "4 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 c78d20ccd..05c9e5ce5 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -268,7 +268,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 773 of file modules.cpp. +Definition at line 774 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 b7741ef34..c4717f2e6 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 9c34f89f5..4a75dcff5 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index c2be7ecc6..a48ba4b2a 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "4 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 1ca49d97f..30cc7884c 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "4 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 064913891..1862a08e6 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -166,6 +166,9 @@ commands.h \- .RI "void \fBhandle_qline\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br .ti -1c +.RI "void \fBhandle_eline\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" +.br +.ti -1c .RI "void \fBhandle_server\fP (char **parameters, int pcnt, \fBuserrec\fP *user)" .br .ti -1c @@ -268,6 +271,8 @@ These are the handlers for server commands (tokens). .PP .SS "void handle_dollar (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" .PP +.SS "void handle_eline (char ** parameters, int pcnt, \fBuserrec\fP * user)" +.PP .SS "void handle_F (char token, char * params, \fBserverrec\fP * source, \fBserverrec\fP * reply, char * tcp_host)" .PP .SS "void handle_gline (char ** parameters, int pcnt, \fBuserrec\fP * user)" diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index 51123dc92..81ec8837b 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index 85798d51e..9e725ed53 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "4 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 2d7b20a28..1d86c7691 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "4 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 104d3d407..bb90ae447 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "4 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 df12a2e34..a6b848650 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "4 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 c3ab7cd80..6589a00e4 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "4 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 71da5e323..e9f815aeb 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "4 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 308b4c8ba..b2411fc99 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "4 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 6cd0c1d53..695648eb0 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -530,7 +530,7 @@ Definition at line 89 of file modules.cpp. Definition at line 104 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 773 of file modules.cpp. +Definition at line 774 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP Definition at line 93 of file modules.cpp. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index 0b756cd74..710ae58f2 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -203,22 +203,22 @@ Referenced by Module::OnAccessCheck(). Definition at line 38 of file modules.h. .SS "#define CONF_FILE_NOT_FOUND 0x000200" .PP -Definition at line 661 of file modules.h. +Definition at line 667 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 658 of file modules.h. +Definition at line 664 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 659 of file modules.h. +Definition at line 665 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 660 of file modules.h. +Definition at line 666 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" @@ -285,7 +285,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 826 of file modules.h. +Definition at line 832 of file modules.h. .SS "typedef \fBfile_cache\fP \fBstring_list\fP" .PP Definition at line 61 of file modules.h. diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index 06233a744..8c2952b8c 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "4 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 ceb957551..b7c3416ae 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 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "4 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 9e5858072..8b1d756c9 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 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/packet.3 b/docs/man/man3/packet.3 index 75c78921f..9341780fb 100644 --- a/docs/man/man3/packet.3 +++ b/docs/man/man3/packet.3 @@ -1,4 +1,4 @@ -.TH "packet" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "packet" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index e84e3877a..1453b9af0 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "4 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 43d03344b..bb2c03249 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "4 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 c0c76ee9c..bcc9682d3 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index fe9a1733e..e6219e93d 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index da49bdac2..821b53864 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index 952fcb26c..c0b101d3b 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index ee6bd305f..a59c5fc6b 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "4 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 a59f1d846..ab692bb35 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "4 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 d7647c7aa..b0cf4684b 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -27,6 +27,9 @@ xline.h \- .in +1c .ti -1c +.RI "class \fBELine\fP" +.br +.ti -1c .RI "class \fBGLine\fP" .br .RI "\fIGLine class. \fP" @@ -66,6 +69,9 @@ xline.h \- .RI "void \fBadd_kline\fP (long duration, char *source, char *reason, char *hostmask)" .br .ti -1c +.RI "void \fBadd_eline\fP (long duration, char *source, char *reason, char *hostmask)" +.br +.ti -1c .RI "bool \fBdel_gline\fP (char *hostmask)" .br .ti -1c @@ -78,6 +84,9 @@ xline.h \- .RI "bool \fBdel_kline\fP (char *hostmask)" .br .ti -1c +.RI "bool \fBdel_eline\fP (char *hostmask)" +.br +.ti -1c .RI "char * \fBmatches_qline\fP (const char *nick)" .br .ti -1c @@ -90,6 +99,9 @@ xline.h \- .RI "char * \fBmatches_kline\fP (const char *host)" .br .ti -1c +.RI "char * \fBmatches_exception\fP (const char *host)" +.br +.ti -1c .RI "void \fBexpire_lines\fP ()" .br .ti -1c @@ -108,6 +120,9 @@ xline.h \- .RI "void \fBstats_z\fP (\fBuserrec\fP *user)" .br .ti -1c +.RI "void \fBstats_e\fP (\fBuserrec\fP *user)" +.br +.ti -1c .RI "void \fBgline_set_creation_time\fP (char *host, time_t create_time)" .br .ti -1c @@ -128,6 +143,8 @@ xline.h \- .in -1c .SH "Function Documentation" .PP +.SS "void add_eline (long duration, char * source, char * reason, char * hostmask)" +.PP .SS "void add_gline (long duration, char * source, char * reason, char * hostmask)" .PP .SS "void add_kline (long duration, char * source, char * reason, char * hostmask)" @@ -138,6 +155,8 @@ xline.h \- .PP .SS "void apply_lines ()" .PP +.SS "bool del_eline (char * hostmask)" +.PP .SS "bool del_gline (char * hostmask)" .PP .SS "bool del_kline (char * hostmask)" @@ -150,6 +169,8 @@ xline.h \- .PP .SS "void gline_set_creation_time (char * host, time_t create_time)" .PP +.SS "char* matches_exception (const char * host)" +.PP .SS "char* matches_gline (const char * host)" .PP .SS "char* matches_kline (const char * host)" @@ -164,6 +185,8 @@ xline.h \- .PP .SS "void read_xline_defaults ()" .PP +.SS "void stats_e (\fBuserrec\fP * user)" +.PP .SS "void stats_g (\fBuserrec\fP * user)" .PP .SS "void stats_k (\fBuserrec\fP * user)" |