diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-01 17:07:33 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-01 17:07:33 +0000 |
| commit | 260d107be38928396b5339829ab321c2207f09bc (patch) | |
| tree | 07e861e346d973f2bcf54d7b6580f421d7376be5 /docs | |
| parent | 19aa5d081acc8e35fb6a49016ffebeb447f1d375 (diff) | |
Updated documentation (manpages)
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@936 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs')
51 files changed, 999 insertions, 941 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index c467589a8..7fcf1ee74 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -43,10 +43,10 @@ Definition at line 114 of file modules.h. .PP .SS "Admin::Admin (std::string name, std::string email, std::string nick)" .PP -Definition at line 295 of file modules.cpp. +Definition at line 302 of file modules.cpp. .PP .nf -295 : Name(name), Email(email), Nick(nick) { }; +302 : Name(name), Email(email), Nick(nick) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index 0cff6dab3..aa95d518e 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index fc31d292e..014c3ff9e 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "28 Mar 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 641 of file modules.h. +Definition at line 669 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 566 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 576 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -567 { -568 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -569 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -570 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog); -571 if (!this->readerror) -572 this->error = CONF_FILE_NOT_FOUND; -573 } +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 } .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 585 of file modules.cpp. +Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 595 of file modules.cpp. .PP References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. .PP .nf -586 { -587 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out); -588 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out); -589 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog); -590 if (!this->readerror) -591 this->error = CONF_FILE_NOT_FOUND; -592 }; +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 }; .fi .SS "ConfigReader::~\fBConfigReader\fP ()" .PP -Default destructor. This method destroys the ConfigReader class.Definition at line 576 of file modules.cpp. +Default destructor. This method destroys the ConfigReader class.Definition at line 586 of file modules.cpp. .PP References cache, and errorlog. .PP .nf -577 { -578 if (this->cache) -579 delete this->cache; -580 if (this->errorlog) -581 delete this->errorlog; -582 } +587 { +588 if (this->cache) +589 delete this->cache; +590 if (this->errorlog) +591 delete this->errorlog; +592 } .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 663 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 673 of file modules.cpp. .PP References errorlog, connection::fd, and userrec::nick. .PP .nf -664 { -665 if (bail) -666 { -667 printf('There were errors in your configuration:\n%s',errorlog->str().c_str()); -668 exit(0); -669 } -670 else -671 { -672 char dataline[1024]; -673 if (user) -674 { -675 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick); -676 while (!errorlog->eof()) -677 { -678 errorlog->getline(dataline,1024); -679 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline); -680 } -681 } -682 else -683 { -684 WriteOpers('There were errors in the configuration file:',user->nick); -685 while (!errorlog->eof()) -686 { -687 errorlog->getline(dataline,1024); -688 WriteOpers(dataline); -689 } -690 } -691 return; -692 } -693 } +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 } .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 696 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 706 of file modules.cpp. .PP References cache. .PP .nf -697 { -698 return EnumConf(cache,tag.c_str()); -699 } +707 { +708 return EnumConf(cache,tag.c_str()); +709 } .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 701 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 711 of file modules.cpp. .PP References cache. .PP .nf -702 { -703 return EnumValues(cache, tag.c_str(), index); -704 } +712 { +713 return EnumValues(cache, tag.c_str(), index); +714 } .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 656 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 666 of file modules.cpp. .PP References error. .PP .nf -657 { -658 long olderr = this->error; -659 this->error = 0; -660 return olderr; -661 } +667 { +668 long olderr = this->error; +669 this->error = 0; +670 return olderr; +671 } .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 610 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 620 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -611 { -612 char val[MAXBUF]; -613 char t[MAXBUF]; -614 char n[MAXBUF]; -615 strlcpy(t,tag.c_str(),MAXBUF); -616 strlcpy(n,name.c_str(),MAXBUF); -617 int res = ReadConf(cache,t,n,index,val); -618 if (!res) -619 { -620 this->error = CONF_VALUE_NOT_FOUND; -621 return false; -622 } -623 std::string s = val; -624 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1')); -625 } +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 } .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 627 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 637 of file modules.cpp. .PP References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. .PP .nf -628 { -629 char val[MAXBUF]; -630 char t[MAXBUF]; -631 char n[MAXBUF]; -632 strlcpy(t,tag.c_str(),MAXBUF); -633 strlcpy(n,name.c_str(),MAXBUF); -634 int res = ReadConf(cache,t,n,index,val); -635 if (!res) -636 { -637 this->error = CONF_VALUE_NOT_FOUND; -638 return 0; -639 } -640 for (int i = 0; i < strlen(val); i++) -641 { -642 if (!isdigit(val[i])) -643 { -644 this->error = CONF_NOT_A_NUMBER; -645 return 0; -646 } -647 } -648 if ((needs_unsigned) && (atoi(val)<0)) -649 { -650 this->error = CONF_NOT_UNSIGNED; -651 return 0; -652 } -653 return atoi(val); -654 } +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 } .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 594 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 604 of file modules.cpp. .PP References cache, CONF_VALUE_NOT_FOUND, and error. .PP .nf -595 { -596 char val[MAXBUF]; -597 char t[MAXBUF]; -598 char n[MAXBUF]; -599 strlcpy(t,tag.c_str(),MAXBUF); -600 strlcpy(n,name.c_str(),MAXBUF); -601 int res = ReadConf(cache,t,n,index,val); -602 if (!res) -603 { -604 this->error = CONF_VALUE_NOT_FOUND; -605 return ''; -606 } -607 return std::string(val); -608 } +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 } .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 706 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 716 of file modules.cpp. .PP References readerror. .PP .nf -707 { -708 return this->readerror; -709 } +717 { +718 return this->readerror; +719 } .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 649 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 677 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 654 of file modules.h. +Definition at line 682 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 650 of file modules.h. +Definition at line 678 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 653 of file modules.h. +Used to store errors. Definition at line 681 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 b19e07801..6c9646c36 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index 39ecb407b..7015b6ac8 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index 1be57e1ec..e8b2efc37 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -41,31 +41,43 @@ Inherits \fBclassbase\fP. .PP .SS "ExtMode::ExtMode (char mc, int ty, bool oper, int p_on, int p_off)\fC [inline]\fP" .PP -Definition at line 190 of file modules.cpp. +Definition at line 197 of file modules.cpp. +.PP +References modechar, needsoper, params_when_off, params_when_on, and type. .PP .nf -190 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; +197 : modechar(mc), type(ty), needsoper(oper), params_when_on(p_on), params_when_off(p_off) { }; .fi .SH "Member Data Documentation" .PP .SS "bool \fBExtMode::list\fP" .PP -Definition at line 189 of file modules.cpp. +Definition at line 196 of file modules.cpp. .SS "char \fBExtMode::modechar\fP" .PP -Definition at line 184 of file modules.cpp. +Definition at line 191 of file modules.cpp. +.PP +Referenced by ExtMode(). .SS "bool \fBExtMode::needsoper\fP" .PP -Definition at line 188 of file modules.cpp. +Definition at line 195 of file modules.cpp. +.PP +Referenced by ExtMode(). .SS "int \fBExtMode::params_when_off\fP" .PP -Definition at line 187 of file modules.cpp. +Definition at line 194 of file modules.cpp. +.PP +Referenced by ExtMode(). .SS "int \fBExtMode::params_when_on\fP" .PP -Definition at line 186 of file modules.cpp. +Definition at line 193 of file modules.cpp. +.PP +Referenced by ExtMode(). .SS "int \fBExtMode::type\fP" .PP -Definition at line 185 of file modules.cpp. +Definition at line 192 of file modules.cpp. +.PP +Referenced by ExtMode(). .SH "Author" .PP diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index f234a10f9..edfabcddf 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 60ee3d2dd..48adcd0d4 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "28 Mar 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 730 of file modules.h. +Definition at line 758 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 719 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 729 of file modules.cpp. .PP .nf -720 { -721 } +730 { +731 } .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 712 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 722 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -713 { -714 file_cache c; -715 readfile(c,filename.c_str()); -716 this->fc = c; -717 } +723 { +724 file_cache c; +725 readfile(c,filename.c_str()); +726 this->fc = c; +727 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 731 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 741 of file modules.cpp. .PP .nf -732 { -733 } +742 { +743 } .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 735 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 745 of file modules.cpp. .PP References fc. .PP .nf -736 { -737 if (fc.size() == 0) -738 { -739 return(false); -740 } -741 else -742 { -743 return(true); -744 } -745 } +746 { +747 if (fc.size() == 0) +748 { +749 return(false); +750 } +751 else +752 { +753 return(true); +754 } +755 } .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 754 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 764 of file modules.cpp. .PP References fc. .PP .nf -755 { -756 return fc.size(); -757 } +765 { +766 return fc.size(); +767 } .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 747 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 757 of file modules.cpp. .PP References fc. .PP .nf -748 { -749 if ((x<0) || (x>fc.size())) -750 return ''; -751 return fc[x]; -752 } +758 { +759 if ((x<0) || (x>fc.size())) +760 return ''; +761 return fc[x]; +762 } .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 723 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 733 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -724 { -725 file_cache c; -726 readfile(c,filename.c_str()); -727 this->fc = c; -728 } +734 { +735 file_cache c; +736 readfile(c,filename.c_str()); +737 this->fc = c; +738 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 732 of file modules.h. +Definition at line 760 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 16bdc1fbf..46ffa4850 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index 9f9171770..11abe5702 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "28 Mar 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 01929e516..09b2ac2f8 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,18 +17,18 @@ InAddr_HashComp \- .PP .SS "bool InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const\fC [inline]\fP" .PP -Definition at line 150 of file modules.cpp. +Definition at line 157 of file modules.cpp. .PP .nf -151 { -152 size_t q; -153 size_t p; -154 -155 memcpy(&q,&s1,sizeof(size_t)); -156 memcpy(&p,&s2,sizeof(size_t)); -157 -158 return (q == p); -159 } +158 { +159 size_t q; +160 size_t p; +161 +162 memcpy(&q,&s1,sizeof(size_t)); +163 memcpy(&p,&s2,sizeof(size_t)); +164 +165 return (q == p); +166 } .fi diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 8e1a1453a..06220485b 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index a6e52eb0d..eeac38031 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index 7ce3c2dc7..a5eeaf01e 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index a3ae736f6..c17d1015f 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 1974eb93a..60239b1da 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -107,6 +107,18 @@ Inherits \fBclassbase\fP. .RI "virtual \fBstring_list\fP \fBOnChannelSync\fP (\fBchanrec\fP *chan)" .br .RI "\fICalled during a netburst to sync channel data. \fP" +.ti -1c +.RI "virtual void \fBOn005Numeric\fP (std::string &output)" +.br +.RI "\fICalled when a 005 numeric is about to be output. \fP" +.ti -1c +.RI "virtual int \fBOnKill\fP (\fBuserrec\fP *source, \fBuserrec\fP *dest, std::string reason)" +.br +.RI "\fICalled when a client is disconnected by KILL. \fP" +.ti -1c +.RI "virtual void \fBOnLoadModule\fP (\fBModule\fP *mod, std::string name)" +.br +.RI "\fICalled whenever a module is loaded. \fP" .in -1c .SH "Detailed Description" .PP @@ -119,26 +131,33 @@ Definition at line 126 of file modules.h. .PP .SS "Module::Module ()" .PP -Default constructor creates a module class. Definition at line 297 of file modules.cpp. +Default constructor creates a module class. Definition at line 304 of file modules.cpp. .PP .nf -297 { } +304 { } .fi .SS "Module::~\fBModule\fP ()\fC [virtual]\fP" .PP -Default destructor destroys a module class. Definition at line 298 of file modules.cpp. +Default destructor destroys a module class. Definition at line 305 of file modules.cpp. .PP .nf -298 { } +305 { } .fi .SH "Member Function Documentation" .PP .SS "\fBVersion\fP Module::GetVersion ()\fC [virtual]\fP" .PP -Returns the version number of a Module. The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 309 of file modules.cpp. +Returns the version number of a Module. The method should return a \fBVersion\fP object with its version information assigned via \fBVersion::Version\fPDefinition at line 316 of file modules.cpp. +.PP +.nf +316 { return Version(1,0,0,0); } +.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. .PP .nf -309 { return Version(1,0,0,0); } +327 { }; .fi .SS "int Module::OnAccessCheck (\fBuserrec\fP * source, \fBuserrec\fP * dest, \fBchanrec\fP * channel, int access_type)\fC [virtual]\fP" .PP @@ -166,100 +185,114 @@ 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 317 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 324 of file modules.cpp. .PP References ACR_DEFAULT. .PP .nf -317 { return ACR_DEFAULT; }; +324 { 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 319 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 326 of file modules.cpp. .PP References string_list. .PP .nf -319 { string_list empty; return empty; } +326 { 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 -Called whenever an extended mode is to be processed. The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 308 of file modules.cpp. +Called whenever an extended mode is to be processed. The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with \fBServer::AddExtendedMode\fP If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.Definition at line 315 of file modules.cpp. .PP .nf -308 { return false; } +315 { return false; } .fi .SS "void Module::OnInfo (\fBuserrec\fP * user)\fC [virtual]\fP" .PP Called whenever a user types /INFO. The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format: .PP -<nick> :information hereDefinition at line 311 of file modules.cpp. +<nick> :information hereDefinition at line 318 of file modules.cpp. .PP .nf -311 { }; +318 { }; +.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. +.PP +.nf +328 { 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. +.PP +.nf +329 { }; .fi .SS "void Module::OnOper (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 310 of file modules.cpp. +Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 317 of file modules.cpp. .PP .nf -310 { }; +317 { }; .fi .SS "void Module::OnPacketReceive (char * p)\fC [virtual]\fP" .PP -Called after a packet is received from another irc server. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 304 of file modules.cpp. +Called after a packet is received from another irc server. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 311 of file modules.cpp. .PP .nf -304 { } +311 { } .fi .SS "void Module::OnPacketTransmit (char * p)\fC [virtual]\fP" .PP -Called before a packet is transmitted across the irc network between two irc servers. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 303 of file modules.cpp. +Called before a packet is transmitted across the irc network between two irc servers. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 310 of file modules.cpp. .PP .nf -303 { } +310 { } .fi .SS "void Module::OnRehash ()\fC [virtual]\fP" .PP -Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 305 of file modules.cpp. +Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 312 of file modules.cpp. .PP .nf -305 { } +312 { } .fi .SS "void Module::OnServerRaw (std::string & raw, bool inbound, \fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 306 of file modules.cpp. +Called when a raw command is transmitted or received. This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter 'raw'. If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.Definition at line 313 of file modules.cpp. .PP .nf -306 { } +313 { } .fi .SS "void Module::OnUserConnect (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user connects. The details of the connecting user are available to you in the parameter userrec *userDefinition at line 299 of file modules.cpp. +Called when a user connects. The details of the connecting user are available to you in the parameter userrec *userDefinition at line 306 of file modules.cpp. .PP .nf -299 { } +306 { } .fi .SS "void Module::OnUserJoin (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user joins a channel. The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 301 of file modules.cpp. +Called when a user joins a channel. The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channelDefinition at line 308 of file modules.cpp. .PP .nf -301 { } +308 { } .fi .SS "void Module::OnUserPart (\fBuserrec\fP * user, \fBchanrec\fP * channel)\fC [virtual]\fP" .PP -Called when a user parts a channel. The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 302 of file modules.cpp. +Called when a user parts a channel. The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channelDefinition at line 309 of file modules.cpp. .PP .nf -302 { } +309 { } .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 313 of file modules.cpp. +Called whenever a user is about to invite another user into a channel, before any processing is done. Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.Definition at line 320 of file modules.cpp. .PP .nf -313 { return 0; }; +320 { return 0; }; .fi .SS "int Module::OnUserPreJoin (\fBuserrec\fP * user, \fBchanrec\fP * chan, const char * cname)\fC [virtual]\fP" .PP @@ -267,54 +300,54 @@ Called whenever a user is about to join a channel, before any processing is done .PP IMPORTANT NOTE! .PP -If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 307 of file modules.cpp. +If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.Definition at line 314 of file modules.cpp. .PP .nf -307 { return 0; } +314 { return 0; } .fi .SS "int Module::OnUserPreMessage (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 314 of file modules.cpp. +Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.Definition at line 321 of file modules.cpp. .PP .nf -314 { return 0; }; +321 { return 0; }; .fi .SS "int Module::OnUserPreNick (\fBuserrec\fP * user, std::string newnick)\fC [virtual]\fP" .PP -Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output. 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 316 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. 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. .PP .nf -316 { return 0; }; +323 { return 0; }; .fi .SS "int Module::OnUserPreNotice (\fBuserrec\fP * user, void * dest, int target_type, std::string & text)\fC [virtual]\fP" .PP -Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 315 of file modules.cpp. +Called whenever a user is about to NOTICE A user or a channel, before any processing is done. Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.Definition at line 322 of file modules.cpp. .PP .nf -315 { return 0; }; +322 { return 0; }; .fi .SS "void Module::OnUserQuit (\fBuserrec\fP * user)\fC [virtual]\fP" .PP -Called when a user quits. The details of the exiting user are available to you in the parameter userrec *userDefinition at line 300 of file modules.cpp. +Called when a user quits. The details of the exiting user are available to you in the parameter userrec *userDefinition at line 307 of file modules.cpp. .PP .nf -300 { } +307 { } .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 318 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 325 of file modules.cpp. .PP References string_list. .PP .nf -318 { string_list empty; return empty; } +325 { string_list empty; return empty; } .fi .SS "void Module::OnWhois (\fBuserrec\fP * source, \fBuserrec\fP * dest)\fC [virtual]\fP" .PP -Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 312 of file modules.cpp. +Called whenever a /WHOIS is performed on a local user. The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.Definition at line 319 of file modules.cpp. .PP .nf -312 { }; +319 { }; .fi diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index fcecbc9ee..f97975e77 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "28 Mar 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 785 of file modules.h. +Definition at line 813 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 788 of file modules.h. +Definition at line 816 of file modules.h. .PP .nf -788 { } +816 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 789 of file modules.h. +Definition at line 817 of file modules.h. .PP .nf -789 { } +817 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index bef14dac0..d2348dfb6 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 93ea60a25..4a1d87703 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "28 Mar 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 337 of file modules.h. +Definition at line 365 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" .PP -Default constructor. Creates a Server object.Definition at line 326 of file modules.cpp. +Default constructor. Creates a Server object.Definition at line 336 of file modules.cpp. .PP .nf -327 { -328 } +337 { +338 } .fi .SS "Server::~\fBServer\fP ()\fC [virtual]\fP" .PP -Default destructor. Destroys a Server object.Definition at line 330 of file modules.cpp. +Default destructor. Destroys a Server object.Definition at line 340 of file modules.cpp. .PP .nf -331 { -332 } +341 { +342 } .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 407 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 417 of file modules.cpp. .PP References createcommand(). .PP .nf -408 { -409 createcommand(cmd,f,flags,minparams); -410 } +418 { +419 createcommand(cmd,f,flags,minparams); +420 } .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 552 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 562 of file modules.cpp. .PP References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL. .PP .nf -553 { -554 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); -555 if (res) -556 ModeMakeList(modechar); -557 return res; -558 } +563 { +564 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1); +565 if (res) +566 ModeMakeList(modechar); +567 return res; +568 } .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 532 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 542 of file modules.cpp. .PP References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER. .PP .nf -533 { -534 if (type == MT_SERVER) -535 { -536 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); -537 return false; -538 } -539 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT)) -540 { -541 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported'); -542 return false; -543 } -544 if ((params_when_on>1) || (params_when_off>1)) +543 { +544 if (type == MT_SERVER) 545 { -546 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported'); +546 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion'); 547 return false; 548 } -549 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off); -550 } +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 } .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 397 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 407 of file modules.cpp. .PP .nf -398 { -399 call_handler(commandname.c_str(),parameters,pcnt,user); -400 } +408 { +409 call_handler(commandname.c_str(),parameters,pcnt,user); +410 } .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 485 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 495 of file modules.cpp. .PP References ChangeName(). .PP .nf -486 { -487 ChangeName(user,gecos.c_str()); -488 } +496 { +497 ChangeName(user,gecos.c_str()); +498 } .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 480 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 490 of file modules.cpp. .PP References ChangeDisplayedHost(). .PP .nf -481 { -482 ChangeDisplayedHost(user,host.c_str()); -483 } +491 { +492 ChangeDisplayedHost(user,host.c_str()); +493 } .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 381 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 391 of file modules.cpp. .PP .nf -382 { -383 force_nickchange(user,nickname.c_str()); -384 } +392 { +393 force_nickchange(user,nickname.c_str()); +394 } .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 505 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 515 of file modules.cpp. .PP References cmode(). .PP .nf -506 { -507 return cmode(User,Chan); -508 } +516 { +517 return cmode(User,Chan); +518 } .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 458 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 468 of file modules.cpp. .PP References common_channels(). .PP .nf -459 { -460 return (common_channels(u1,u2) != 0); -461 } +469 { +470 return (common_channels(u1,u2) != 0); +471 } .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 560 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 570 of file modules.cpp. .PP .nf -561 { -562 return usercount(c); -563 } +571 { +572 return usercount(c); +573 } .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 500 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 510 of file modules.cpp. .PP .nf -501 { -502 return FindChan(channel.c_str()); -503 } +511 { +512 return FindChan(channel.c_str()); +513 } .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 495 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 505 of file modules.cpp. .PP .nf -496 { -497 return Find(nick); -498 } +506 { +507 return Find(nick); +508 } .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 525 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 535 of file modules.cpp. .PP .nf -526 { -527 return Admin(getadminname(),getadminemail(),getadminnick()); -528 } +536 { +537 return Admin(getadminname(),getadminemail(),getadminnick()); +538 } .fi .SS "std::string Server::GetNetworkName ()\fC [virtual]\fP" .PP -Returns the network name, global to all linked servers. Definition at line 520 of file modules.cpp. +Returns the network name, global to all linked servers. Definition at line 530 of file modules.cpp. .PP .nf -521 { -522 return getnetworkname(); -523 } +531 { +532 return getnetworkname(); +533 } .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 515 of file modules.cpp. +Returns the server name of the server where the module is loaded. Definition at line 525 of file modules.cpp. .PP .nf -516 { -517 return getservername(); -518 } +526 { +527 return getservername(); +528 } .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 362 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 372 of file modules.cpp. .PP References chanuserlist, clientlist, has_channel(), and isnick(). .PP .nf -363 { -364 chanuserlist userl; -365 userl.clear(); -366 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++) -367 { -368 if (i->second) -369 { -370 if (has_channel(i->second,chan)) -371 { -372 if (isnick(i->second->nick)) -373 { -374 userl.push_back(i->second); -375 } -376 } -377 } -378 } -379 return userl; -380 } +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 } .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 490 of file modules.cpp. +Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 500 of file modules.cpp. .PP References isnick(). .PP .nf -491 { -492 return (isnick(nick.c_str()) != 0); -493 } +501 { +502 return (isnick(nick.c_str()) != 0); +503 } .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 510 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 520 of file modules.cpp. .PP References has_channel(). .PP .nf -511 { -512 return has_channel(User,Chan); -513 } +521 { +522 return has_channel(User,Chan); +523 } .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 392 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 402 of file modules.cpp. .PP References is_uline(). .PP .nf -393 { -394 return is_uline(server.c_str()); -395 } +403 { +404 return is_uline(server.c_str()); +405 } .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 352 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 362 of file modules.cpp. .PP .nf -353 { -354 return add_channel(user,cname.c_str(),key.c_str(),true); -355 } +363 { +364 return add_channel(user,cname.c_str(),key.c_str(),true); +365 } .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 402 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 412 of file modules.cpp. .PP .nf -403 { -404 log(level,'%s',s.c_str()); -405 } +413 { +414 log(level,'%s',s.c_str()); +415 } .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 339 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 349 of file modules.cpp. .PP .nf -340 { -341 char literal[MAXBUF],pattern[MAXBUF]; -342 strlcpy(literal,sliteral.c_str(),MAXBUF); -343 strlcpy(pattern,spattern.c_str(),MAXBUF); -344 return match(literal,pattern); -345 } +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 } .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 357 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 367 of file modules.cpp. .PP .nf -358 { -359 return del_channel(user,cname.c_str(),reason.c_str(),false); -360 } +368 { +369 return del_channel(user,cname.c_str(),reason.c_str(),false); +370 } .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 386 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 396 of file modules.cpp. .PP References userrec::nick, and send_network_quit(). .PP .nf -387 { -388 send_network_quit(user->nick,reason.c_str()); -389 kill_link(user,reason.c_str()); -390 } +397 { +398 send_network_quit(user->nick,reason.c_str()); +399 kill_link(user,reason.c_str()); +400 } .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 417 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 427 of file modules.cpp. .PP .nf -418 { -419 Write(Socket,'%s',s.c_str()); -420 } +428 { +429 Write(Socket,'%s',s.c_str()); +430 } .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 446 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 456 of file modules.cpp. .PP .nf -447 { -448 if (IncludeSender) -449 { -450 WriteChannel(Channel,User,'%s',s.c_str()); -451 } -452 else -453 { -454 ChanExceptSender(Channel,User,'%s',s.c_str()); -455 } -456 } +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 } .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 463 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 473 of file modules.cpp. .PP .nf -464 { -465 if (IncludeSender) -466 { -467 WriteCommon(User,'%s',text.c_str()); -468 } -469 else -470 { -471 WriteCommonExcept(User,'%s',text.c_str()); -472 } -473 } +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 } .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 427 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 437 of file modules.cpp. .PP .nf -428 { -429 WriteFrom(Socket,User,'%s',s.c_str()); -430 } +438 { +439 WriteFrom(Socket,User,'%s',s.c_str()); +440 } .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 412 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 422 of file modules.cpp. .PP References server_mode(). .PP .nf -413 { -414 server_mode(parameters,pcnt,user); -415 } +423 { +424 server_mode(parameters,pcnt,user); +425 } .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 334 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 344 of file modules.cpp. .PP .nf -335 { -336 WriteOpers('%s',s.c_str()); -337 } +345 { +346 WriteOpers('%s',s.c_str()); +347 } .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 422 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 432 of file modules.cpp. .PP .nf -423 { -424 WriteServ(Socket,'%s',s.c_str()); -425 } +433 { +434 WriteServ(Socket,'%s',s.c_str()); +435 } .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 432 of file modules.cpp. +Which is useful for numerics and server notices to single users, etc.Definition at line 442 of file modules.cpp. .PP References connection::fd. .PP .nf -433 { -434 if (!Source) -435 { -436 // if source is NULL, then the message originates from the local server -437 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str()); -438 } -439 else -440 { -441 // otherwise it comes from the user specified -442 WriteTo(Source,Dest,'%s',s.c_str()); -443 } -444 } +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 } .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 347 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 357 of file modules.cpp. .PP .nf -348 { -349 WriteMode(modes.c_str(),flags,'%s',text.c_str()); -350 } +358 { +359 WriteMode(modes.c_str(),flags,'%s',text.c_str()); +360 } .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 475 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 485 of file modules.cpp. .PP .nf -476 { -477 WriteWallOps(User,false,'%s',text.c_str()); -478 } +486 { +487 WriteWallOps(User,false,'%s',text.c_str()); +488 } .fi diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 138cf2edb..8075bdb0b 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -17,15 +17,15 @@ StrHashComp \- .PP .SS "bool StrHashComp::operator() (const string & s1, const string & s2) const\fC [inline]\fP" .PP -Definition at line 137 of file modules.cpp. +Definition at line 144 of file modules.cpp. .PP .nf -138 { -139 char a[MAXBUF],b[MAXBUF]; -140 strlcpy(a,s1.c_str(),MAXBUF); -141 strlcpy(b,s2.c_str(),MAXBUF); -142 return (strcasecmp(a,b) == 0); -143 } +145 { +146 char a[MAXBUF],b[MAXBUF]; +147 strlcpy(a,s1.c_str(),MAXBUF); +148 strlcpy(b,s2.c_str(),MAXBUF); +149 return (strcasecmp(a,b) == 0); +150 } .fi diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index 2f44abcd1..5985dbbdd 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -46,10 +46,10 @@ Definition at line 102 of file modules.h. .PP .SS "Version::Version (int major, int minor, int revision, int build)" .PP -Definition at line 291 of file modules.cpp. +Definition at line 298 of file modules.cpp. .PP .nf -291 : Major(major), Minor(minor), Revision(revision), Build(build) { }; +298 : Major(major), Minor(minor), Revision(revision), Build(build) { }; .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 3dcffb0b1..3d5b6054f 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 99a67a12f..32e769183 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/base.h.3 b/docs/man/man3/base.h.3 index 3ab34e375..52cdcb283 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "28 Mar 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 929482350..5ec80e496 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -66,6 +66,8 @@ channels.cpp \- .br \fC#include 'xline.h'\fP .br +\fC#include 'inspstring.h'\fP +.br .SS "Namespaces" @@ -88,10 +90,10 @@ channels.cpp \- .RI "int \fBMODCOUNT\fP = -1" .br .ti -1c -.RI "vector< \fBModule\fP * > \fBmodules\fP" +.RI "std::vector< \fBModule\fP * > \fBmodules\fP" .br .ti -1c -.RI "vector< \fBircd_module\fP * > \fBfactory\fP" +.RI "std::vector< \fBircd_module\fP * > \fBfactory\fP" .br .ti -1c .RI "int \fBLogLevel\fP" @@ -200,124 +202,124 @@ channels.cpp \- .PP .SS "#define nspace std" .PP -Definition at line 57 of file channels.cpp. +Definition at line 58 of file channels.cpp. .SH "Variable Documentation" .PP .SS "char \fBAdminEmail\fP[MAXBUF]" .PP -Definition at line 71 of file channels.cpp. +Definition at line 72 of file channels.cpp. .SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 70 of file channels.cpp. +Definition at line 71 of file channels.cpp. .SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 72 of file channels.cpp. +Definition at line 73 of file channels.cpp. .SS "std::vector<long> \fBauth_cookies\fP" .PP -Definition at line 99 of file channels.cpp. +Definition at line 100 of file channels.cpp. .SS "int \fBboundPortCount\fP" .PP -Definition at line 93 of file channels.cpp. +Definition at line 94 of file channels.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 100 of file channels.cpp. +Definition at line 101 of file channels.cpp. .PP Referenced by userrec::HasPermission(). .SS "std::vector<\fBModeParameter\fP> \fBcustom_mode_params\fP" .PP -Definition at line 109 of file channels.cpp. +Definition at line 110 of file channels.cpp. .PP Referenced by chanrec::GetModeParameter(), and chanrec::SetCustomModeParam(). .SS "int \fBdebugging\fP" .PP -Definition at line 81 of file channels.cpp. +Definition at line 82 of file channels.cpp. .SS "int \fBdefaultRoute\fP" .PP -Definition at line 97 of file channels.cpp. +Definition at line 98 of file channels.cpp. .SS "int \fBDieDelay\fP" .PP -Definition at line 84 of file channels.cpp. +Definition at line 85 of file channels.cpp. .SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 73 of file channels.cpp. +Definition at line 74 of file channels.cpp. .SS "char \fBDieValue\fP[MAXBUF]" .PP -Definition at line 79 of file channels.cpp. -.SS "vector<\fBircd_module\fP*> factory" +Definition at line 80 of file channels.cpp. +.SS "std::vector<\fBircd_module\fP*> factory" .PP -Definition at line 64 of file channels.cpp. +Definition at line 65 of file channels.cpp. .SS "std::vector<int> \fBfd_reap\fP" .PP -Definition at line 90 of file channels.cpp. +Definition at line 91 of file channels.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 77 of file channels.cpp. +Definition at line 78 of file channels.cpp. .SS "FILE* \fBlog_file\fP" .PP -Definition at line 104 of file channels.cpp. +Definition at line 105 of file channels.cpp. .SS "int \fBLogLevel\fP" .PP -Definition at line 66 of file channels.cpp. +Definition at line 67 of file channels.cpp. .SS "int \fBMaxWhoResults\fP" .PP -Definition at line 87 of file channels.cpp. +Definition at line 88 of file channels.cpp. .SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 102 of file channels.cpp. +Definition at line 103 of file channels.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 763 of file modules.cpp. +Definition at line 773 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP -Definition at line 91 of file channels.cpp. -.SS "vector<\fBModule\fP*> modules" +Definition at line 92 of file channels.cpp. +.SS "std::vector<\fBModule\fP*> modules" .PP -Definition at line 63 of file channels.cpp. +Definition at line 64 of file channels.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 75 of file channels.cpp. +Definition at line 76 of file channels.cpp. .SS "time_t \fBnb_start\fP" .PP -Definition at line 88 of file channels.cpp. +Definition at line 89 of file channels.cpp. .SS "int \fBNetBufferSize\fP" .PP -Definition at line 86 of file channels.cpp. +Definition at line 87 of file channels.cpp. .SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 68 of file channels.cpp. +Definition at line 69 of file channels.cpp. .SS "int \fBportCount\fP" .PP -Definition at line 94 of file channels.cpp. +Definition at line 95 of file channels.cpp. .SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 96 of file channels.cpp. +Definition at line 97 of file channels.cpp. .SS "char \fBPrefixQuit\fP[MAXBUF]" .PP -Definition at line 78 of file channels.cpp. +Definition at line 79 of file channels.cpp. .SS "char \fBrestartpass\fP[MAXBUF]" .PP -Definition at line 74 of file channels.cpp. +Definition at line 75 of file channels.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP -Definition at line 76 of file channels.cpp. +Definition at line 77 of file channels.cpp. .SS "char \fBServerDesc\fP[MAXBUF]" .PP -Definition at line 69 of file channels.cpp. +Definition at line 70 of file channels.cpp. .SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 67 of file channels.cpp. +Definition at line 68 of file channels.cpp. .SS "time_t \fBstartup_time\fP" .PP -Definition at line 85 of file channels.cpp. +Definition at line 86 of file channels.cpp. .SS "int \fBUDPportCount\fP" .PP -Definition at line 95 of file channels.cpp. +Definition at line 96 of file channels.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP -Definition at line 83 of file channels.cpp. +Definition at line 84 of file channels.cpp. .SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 82 of file channels.cpp. +Definition at line 83 of file channels.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index fa8009f18..6049c3b97 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index afac25b94..1df9f409e 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -114,20 +114,20 @@ Definition at line 94 of file channels.h. .PP .SS "chanrec::chanrec ()" .PP -Creates a channel record and initialises it with default values. Definition at line 111 of file channels.cpp. +Creates a channel record and initialises it with default values. Definition at line 112 of file channels.cpp. .PP References c_private, created, custom_modes, inviteonly, key, limit, moderated, name, noexternal, secret, setby, topic, topiclock, and topicset. .PP .nf -112 { -113 strcpy(name,''); -114 strcpy(custom_modes,''); -115 strcpy(topic,''); -116 strcpy(setby,''); -117 strcpy(key,''); -118 created = topicset = limit = 0; -119 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; -120 } +113 { +114 strcpy(name,''); +115 strcpy(custom_modes,''); +116 strcpy(topic,''); +117 strcpy(setby,''); +118 strcpy(key,''); +119 created = topicset = limit = 0; +120 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; +121 } .fi .SS "virtual chanrec::~\fBchanrec\fP ()\fC [inline, virtual]\fP" .PP @@ -140,105 +140,105 @@ Definition at line 185 of file channels.h. .PP .SS "std::string chanrec::GetModeParameter (char mode)" .PP -Returns the parameter for a custom mode on a channel. For example if '+L #foo' is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.Definition at line 184 of file channels.cpp. +Returns the parameter for a custom mode on a channel. For example if '+L #foo' is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.Definition at line 185 of file channels.cpp. .PP References custom_mode_params. .PP .nf -185 { -186 if (custom_mode_params.size()) -187 { -188 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) -189 { -190 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) -191 { -192 return std::string(i->parameter); -193 } -194 } -195 } -196 return std::string(''); -197 } +186 { +187 if (custom_mode_params.size()) +188 { +189 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +190 { +191 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +192 { +193 return std::string(i->parameter); +194 } +195 } +196 } +197 return std::string(''); +198 } .fi .SS "bool chanrec::IsCustomModeSet (char mode)" .PP -Returns true if a custom mode is set on a channel. Definition at line 178 of file channels.cpp. +Returns true if a custom mode is set on a channel. Definition at line 179 of file channels.cpp. .PP References DEBUG. .PP .nf -179 { -180 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); -181 return (strchr(this->custom_modes,mode) != 0); -182 } +180 { +181 log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes); +182 return (strchr(this->custom_modes,mode) != 0); +183 } .fi .SS "void chanrec::SetCustomMode (char mode, bool mode_on)" .PP -Sets or unsets a custom mode in the channels info. Definition at line 122 of file channels.cpp. +Sets or unsets a custom mode in the channels info. Definition at line 123 of file channels.cpp. .PP References custom_modes, DEBUG, and SetCustomModeParam(). .PP .nf -123 { -124 if (mode_on) { -125 char m[3]; -126 m[0] = mode; -127 m[1] = '\0'; -128 if (!strchr(this->custom_modes,mode)) -129 { -130 strlcat(custom_modes,m,MAXMODES); -131 } -132 log(DEBUG,'Custom mode %c set',mode); -133 } -134 else { -135 -136 std::string a = this->custom_modes; -137 int pos = a.find(mode); -138 a.erase(pos,1); -139 strncpy(this->custom_modes,a.c_str(),MAXMODES); -140 -141 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes); -142 this->SetCustomModeParam(mode,'',false); -143 } -144 } +124 { +125 if (mode_on) { +126 char m[3]; +127 m[0] = mode; +128 m[1] = '\0'; +129 if (!strchr(this->custom_modes,mode)) +130 { +131 strlcat(custom_modes,m,MAXMODES); +132 } +133 log(DEBUG,'Custom mode %c set',mode); +134 } +135 else { +136 +137 std::string a = this->custom_modes; +138 int pos = a.find(mode); +139 a.erase(pos,1); +140 strncpy(this->custom_modes,a.c_str(),MAXMODES); +141 +142 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes); +143 this->SetCustomModeParam(mode,'',false); +144 } +145 } .fi .SS "void chanrec::SetCustomModeParam (char mode, char * parameter, bool mode_on)" .PP -Sets or unsets the parameters for a custom mode in a channels info. Definition at line 147 of file channels.cpp. +Sets or unsets the parameters for a custom mode in a channels info. Definition at line 148 of file channels.cpp. .PP References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter. .PP Referenced by SetCustomMode(). .PP .nf -148 { -149 -150 log(DEBUG,'SetCustomModeParam called'); -151 ModeParameter M; -152 M.mode = mode; -153 strlcpy(M.channel,this->name,CHANMAX); -154 strlcpy(M.parameter,parameter,MAXBUF); -155 if (mode_on) -156 { -157 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter); -158 custom_mode_params.push_back(M); -159 } -160 else -161 { -162 if (custom_mode_params.size()) -163 { -164 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) -165 { -166 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) -167 { -168 log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter); -169 custom_mode_params.erase(i); -170 return; -171 } -172 } -173 } -174 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!'); -175 } -176 } +149 { +150 +151 log(DEBUG,'SetCustomModeParam called'); +152 ModeParameter M; +153 M.mode = mode; +154 strlcpy(M.channel,this->name,CHANMAX); +155 strlcpy(M.parameter,parameter,MAXBUF); +156 if (mode_on) +157 { +158 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter); +159 custom_mode_params.push_back(M); +160 } +161 else +162 { +163 if (custom_mode_params.size()) +164 { +165 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) +166 { +167 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) +168 { +169 log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter); +170 custom_mode_params.erase(i); +171 return; +172 } +173 } +174 } +175 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!'); +176 } +177 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index 7cf12b51d..224750ca6 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "28 Mar 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 fd4aad7f1..66e93853b 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "28 Mar 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 d3a0c3c89..84ac9f721 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index 57d15f3d3..bfac322a2 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "28 Mar 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 557593211..60cae1c8c 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "28 Mar 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 3d5e395a6..97dcca9bd 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "28 Mar 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 e18142434..4e798af32 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "28 Mar 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 cdd851103..6cff66abd 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "28 Mar 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 71ef611fd..0d31d4cb9 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "28 Mar 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 8d1da1384..d6b4d814a 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -68,6 +68,8 @@ modules.cpp \- .br \fC#include 'commands.h'\fP .br +\fC#include 'inspstring.h'\fP +.br .SS "Namespaces" @@ -156,10 +158,10 @@ modules.cpp \- .RI "int \fBMODCOUNT\fP = -1" .br .ti -1c -.RI "vector< \fBModule\fP * > \fBmodules\fP" +.RI "std::vector< \fBModule\fP * > \fBmodules\fP" .br .ti -1c -.RI "vector< \fBircd_module\fP * > \fBfactory\fP" +.RI "std::vector< \fBircd_module\fP * > \fBfactory\fP" .br .ti -1c .RI "int \fBLogLevel\fP" @@ -289,165 +291,165 @@ modules.cpp \- .PP .SS "#define nspace std" .PP -Definition at line 58 of file modules.cpp. +Definition at line 59 of file modules.cpp. .SH "Typedef Documentation" .PP .SS "typedef nspace::hash_map<in_addr,string*, nspace::hash<in_addr>, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 166 of file modules.cpp. +Definition at line 173 of file modules.cpp. .SS "typedef nspace::hash_map<std::string, \fBchanrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBchan_hash\fP" .PP -Definition at line 165 of file modules.cpp. +Definition at line 172 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 167 of file modules.cpp. +Definition at line 174 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 193 of file modules.cpp. +Definition at line 200 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 194 of file modules.cpp. +Definition at line 201 of file modules.cpp. .PP Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "typedef nspace::hash_map<std::string, \fBuserrec\fP*, nspace::hash<string>, \fBStrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 164 of file modules.cpp. +Definition at line 171 of file modules.cpp. .SH "Function Documentation" .PP .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)" .PP -Definition at line 266 of file modules.cpp. +Definition at line 273 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -267 { -268 if (ModeDefined(modechar,type)) { -269 return false; -270 } -271 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -272 return true; -273 } +274 { +275 if (ModeDefined(modechar,type)) { +276 return false; +277 } +278 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +279 return true; +280 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 200 of file modules.cpp. +Definition at line 207 of file modules.cpp. .PP References DEBUG, EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -201 { -202 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -203 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -204 { -205 if ((i->modechar == modechar) && (i->type == type)) -206 { -207 return true; -208 } -209 } -210 return false; -211 } +208 { +209 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +210 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +211 { +212 if ((i->modechar == modechar) && (i->type == type)) +213 { +214 return true; +215 } +216 } +217 return false; +218 } .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 253 of file modules.cpp. +Definition at line 260 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -254 { -255 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -256 { -257 if ((i->modechar == modechar) && (i->type == type)) -258 { -259 return i->params_when_off; -260 } -261 } -262 return 0; -263 } +261 { +262 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +263 { +264 if ((i->modechar == modechar) && (i->type == type)) +265 { +266 return i->params_when_off; +267 } +268 } +269 return 0; +270 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 240 of file modules.cpp. +Definition at line 247 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -241 { -242 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -243 { -244 if ((i->modechar == modechar) && (i->type == type)) -245 { -246 return i->params_when_on; -247 } -248 } -249 return 0; -250 } +248 { +249 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +250 { +251 if ((i->modechar == modechar) && (i->type == type)) +252 { +253 return i->params_when_on; +254 } +255 } +256 return 0; +257 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 226 of file modules.cpp. +Definition at line 233 of file modules.cpp. .PP References DEBUG, EMode, and ExtModeListIter. .PP .nf -227 { -228 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -229 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -230 { -231 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) -232 { -233 return true; -234 } -235 } -236 return false; -237 } +234 { +235 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +236 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +237 { +238 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +239 { +240 return true; +241 } +242 } +243 return false; +244 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP -Definition at line 213 of file modules.cpp. +Definition at line 220 of file modules.cpp. .PP References DEBUG, EMode, and ExtModeListIter. .PP .nf -214 { -215 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -216 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -217 { -218 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) -219 { -220 return true; -221 } -222 } -223 return false; -224 } +221 { +222 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +223 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +224 { +225 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +226 { +227 return true; +228 } +229 } +230 return false; +231 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 276 of file modules.cpp. +Definition at line 283 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -277 { -278 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -279 { -280 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -281 { -282 i->list = true; -283 return; -284 } -285 } -286 return; -287 } +284 { +285 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +286 { +287 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +288 { +289 i->list = true; +290 return; +291 } +292 } +293 return; +294 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -455,140 +457,140 @@ Referenced by Server::AddExtendedListMode(). .PP .SS "char \fBAdminEmail\fP[MAXBUF]" .PP -Definition at line 72 of file modules.cpp. +Definition at line 73 of file modules.cpp. .SS "char \fBAdminName\fP[MAXBUF]" .PP -Definition at line 71 of file modules.cpp. +Definition at line 72 of file modules.cpp. .SS "char \fBAdminNick\fP[MAXBUF]" .PP -Definition at line 73 of file modules.cpp. +Definition at line 74 of file modules.cpp. .SS "std::vector<long> \fBauth_cookies\fP" .PP -Definition at line 100 of file modules.cpp. +Definition at line 101 of file modules.cpp. .SS "int \fBboundPortCount\fP" .PP -Definition at line 94 of file modules.cpp. +Definition at line 95 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 171 of file modules.cpp. +Definition at line 178 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 170 of file modules.cpp. +Definition at line 177 of file modules.cpp. .PP Referenced by Server::GetUsers(). .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 173 of file modules.cpp. +Definition at line 180 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 101 of file modules.cpp. +Definition at line 102 of file modules.cpp. .SS "int \fBdebugging\fP" .PP -Definition at line 82 of file modules.cpp. +Definition at line 83 of file modules.cpp. .SS "int \fBdefaultRoute\fP" .PP -Definition at line 98 of file modules.cpp. +Definition at line 99 of file modules.cpp. .SS "int \fBDieDelay\fP" .PP -Definition at line 85 of file modules.cpp. +Definition at line 86 of file modules.cpp. .SS "char \fBdiepass\fP[MAXBUF]" .PP -Definition at line 74 of file modules.cpp. +Definition at line 75 of file modules.cpp. .SS "char \fBDieValue\fP[MAXBUF]" .PP -Definition at line 80 of file modules.cpp. +Definition at line 81 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 197 of file modules.cpp. +Definition at line 204 of file modules.cpp. .PP Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). -.SS "vector<\fBircd_module\fP*> factory" +.SS "std::vector<\fBircd_module\fP*> factory" .PP -Definition at line 65 of file modules.cpp. +Definition at line 66 of file modules.cpp. .SS "std::vector<int> \fBfd_reap\fP" .PP -Definition at line 91 of file modules.cpp. +Definition at line 92 of file modules.cpp. .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 176 of file modules.cpp. +Definition at line 183 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP -Definition at line 78 of file modules.cpp. +Definition at line 79 of file modules.cpp. .SS "FILE* \fBlog_file\fP" .PP -Definition at line 105 of file modules.cpp. +Definition at line 106 of file modules.cpp. .SS "int \fBLogLevel\fP" .PP -Definition at line 67 of file modules.cpp. +Definition at line 68 of file modules.cpp. .SS "int \fBMaxWhoResults\fP" .PP -Definition at line 88 of file modules.cpp. +Definition at line 89 of file modules.cpp. .SS "\fBserverrec\fP* \fBme\fP[32]" .PP -Definition at line 103 of file modules.cpp. +Definition at line 104 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 763 of file modules.cpp. +Definition at line 773 of file modules.cpp. .SS "std::vector<std::string> \fBmodule_names\fP" .PP -Definition at line 92 of file modules.cpp. -.SS "vector<\fBModule\fP*> modules" +Definition at line 93 of file modules.cpp. +.SS "std::vector<\fBModule\fP*> modules" .PP -Definition at line 64 of file modules.cpp. +Definition at line 65 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 174 of file modules.cpp. +Definition at line 181 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP -Definition at line 76 of file modules.cpp. +Definition at line 77 of file modules.cpp. .SS "time_t \fBnb_start\fP" .PP -Definition at line 89 of file modules.cpp. +Definition at line 90 of file modules.cpp. .SS "int \fBNetBufferSize\fP" .PP -Definition at line 87 of file modules.cpp. +Definition at line 88 of file modules.cpp. .SS "char \fBNetwork\fP[MAXBUF]" .PP -Definition at line 69 of file modules.cpp. +Definition at line 70 of file modules.cpp. .SS "int \fBportCount\fP" .PP -Definition at line 95 of file modules.cpp. +Definition at line 96 of file modules.cpp. .SS "int \fBports\fP[MAXSOCKS]" .PP -Definition at line 97 of file modules.cpp. +Definition at line 98 of file modules.cpp. .SS "char \fBPrefixQuit\fP[MAXBUF]" .PP -Definition at line 79 of file modules.cpp. +Definition at line 80 of file modules.cpp. .SS "char \fBrestartpass\fP[MAXBUF]" .PP -Definition at line 75 of file modules.cpp. +Definition at line 76 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 175 of file modules.cpp. +Definition at line 182 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP -Definition at line 77 of file modules.cpp. +Definition at line 78 of file modules.cpp. .SS "char \fBServerDesc\fP[MAXBUF]" .PP -Definition at line 70 of file modules.cpp. +Definition at line 71 of file modules.cpp. .SS "char \fBServerName\fP[MAXBUF]" .PP -Definition at line 68 of file modules.cpp. +Definition at line 69 of file modules.cpp. .SS "time_t \fBstartup_time\fP" .PP -Definition at line 86 of file modules.cpp. +Definition at line 87 of file modules.cpp. .SS "int \fBUDPportCount\fP" .PP -Definition at line 96 of file modules.cpp. +Definition at line 97 of file modules.cpp. .SS "\fBuser_hash\fP \fBwhowas\fP" .PP -Definition at line 172 of file modules.cpp. +Definition at line 179 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP -Definition at line 84 of file modules.cpp. +Definition at line 85 of file modules.cpp. .SS "int \fBWHOWAS_STALE\fP" .PP -Definition at line 83 of file modules.cpp. +Definition at line 84 of file modules.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index 591d46a91..ab5b6073d 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "28 Mar 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 633 of file modules.h. +Definition at line 661 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 630 of file modules.h. +Definition at line 658 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 631 of file modules.h. +Definition at line 659 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 632 of file modules.h. +Definition at line 660 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 798 of file modules.h. +Definition at line 826 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 cb53b328e..44fc7b9e1 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "28 Mar 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 fcbba4004..627f54a1f 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 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,14 +20,14 @@ nspace::nspace::hash< in_addr > \- .PP .SS "size_t nspace::hash< in_addr >::operator() (const struct in_addr & a) const\fC [inline]\fP" .PP -Definition at line 112 of file modules.cpp. +Definition at line 117 of file modules.cpp. .PP .nf -113 { -114 size_t q; -115 memcpy(&q,&a,sizeof(size_t)); -116 return q; -117 } +118 { +119 size_t q; +120 memcpy(&q,&a,sizeof(size_t)); +121 return q; +122 } .fi diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index 6607065b5..da90cbe5f 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 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -20,16 +20,16 @@ nspace::nspace::hash< string > \- .PP .SS "size_t nspace::hash< string >::operator() (const string & s) const\fC [inline]\fP" .PP -Definition at line 122 of file modules.cpp. +Definition at line 130 of file modules.cpp. .PP .nf -123 { -124 char a[MAXBUF]; -125 static struct hash<const char *> strhash; -126 strlcpy(a,s.c_str(),MAXBUF); -127 strlower(a); -128 return strhash(a); -129 } +131 { +132 char a[MAXBUF]; +133 static struct hash<const char *> strhash; +134 strlcpy(a,s.c_str(),MAXBUF); +135 strlower(a); +136 return strhash(a); +137 } .fi diff --git a/docs/man/man3/packet.3 b/docs/man/man3/packet.3 index 72f475b24..37efe0bda 100644 --- a/docs/man/man3/packet.3 +++ b/docs/man/man3/packet.3 @@ -1,4 +1,4 @@ -.TH "packet" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "packet" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index bb8a99543..56b423f27 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -82,51 +82,51 @@ A class that defines the local server or a remote server. Definition at line 30 .PP .SS "serverrec::serverrec ()" .PP -Constructor. Definition at line 23 of file servers.cpp. +Constructor. Definition at line 24 of file servers.cpp. .PP References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, pingtime, connection::signon, sync_soon, usercount, usercount_i, and version. .PP .nf -24 { -25 strlcpy(name,'',256); -26 pingtime = 0; -27 lastping = time(NULL); -28 usercount_i = usercount = opercount = version = 0; -29 hops_away = 1; -30 signon = time(NULL); -31 jupiter = false; -32 fd = 0; -33 sync_soon = false; -34 strlcpy(nickserv,'',NICKMAX); -35 } +25 { +26 strlcpy(name,'',256); +27 pingtime = 0; +28 lastping = time(NULL); +29 usercount_i = usercount = opercount = version = 0; +30 hops_away = 1; +31 signon = time(NULL); +32 jupiter = false; +33 fd = 0; +34 sync_soon = false; +35 strlcpy(nickserv,'',NICKMAX); +36 } .fi .SS "serverrec::serverrec (char * n, long ver, bool jupe)" .PP -Constructor which initialises some of the main variables. Definition at line 42 of file servers.cpp. +Constructor which initialises some of the main variables. Definition at line 43 of file servers.cpp. .PP References connection::fd, hops_away, jupiter, connection::lastping, name, nickserv, opercount, connection::signon, sync_soon, usercount, usercount_i, and version. .PP .nf -43 { -44 strlcpy(name,n,256); -45 lastping = time(NULL); -46 usercount_i = usercount = opercount = 0; -47 version = ver; -48 hops_away = 1; -49 signon = time(NULL); -50 jupiter = jupe; -51 fd = 0; -52 sync_soon = false; -53 strlcpy(nickserv,'',NICKMAX); -54 } +44 { +45 strlcpy(name,n,256); +46 lastping = time(NULL); +47 usercount_i = usercount = opercount = 0; +48 version = ver; +49 hops_away = 1; +50 signon = time(NULL); +51 jupiter = jupe; +52 fd = 0; +53 sync_soon = false; +54 strlcpy(nickserv,'',NICKMAX); +55 } .fi .SS "serverrec::~\fBserverrec\fP ()" .PP -Destructor. Definition at line 38 of file servers.cpp. +Destructor. Definition at line 39 of file servers.cpp. .PP .nf -39 { -40 } +40 { +41 } .fi .SH "Member Data Documentation" .PP diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index 647c95365..49b6f9644 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -16,6 +16,8 @@ servers.cpp \- .br \fC#include <map>\fP .br +\fC#include 'inspstring.h'\fP +.br .SH "Author" .PP diff --git a/docs/man/man3/servers.h.3 b/docs/man/man3/servers.h.3 index 794e07b6a..847b2d3e2 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 267325c89..e1c2a2624 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 9036f983b..a10552373 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index dba632b51..d9ea1aa2e 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -116,35 +116,36 @@ Definition at line 89 of file users.h. .PP .SS "userrec::userrec ()" .PP -Definition at line 25 of file users.cpp. +Definition at line 26 of file users.cpp. .PP -References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. +References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. .PP .nf -26 { -27 // the PROPER way to do it, AVOID bzero at *ALL* costs -28 strcpy(nick,''); -29 strcpy(ip,'127.0.0.1'); -30 timeout = 0; -31 strcpy(ident,''); -32 strcpy(host,''); -33 strcpy(dhost,''); -34 strcpy(fullname,''); -35 strcpy(modes,''); -36 strcpy(inbuf,''); -37 strcpy(server,''); -38 strcpy(awaymsg,''); -39 fd = lastping = signon = idle_lastmsg = nping = registered = 0; -40 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; -41 haspassed = false; -42 strcpy(result,''); -43 for (int i = 0; i < MAXCHANS; i++) -44 { -45 this->chans[i].channel = NULL; -46 this->chans[i].uc_modes = 0; -47 } -48 invites.clear(); -49 } +27 { +28 // the PROPER way to do it, AVOID bzero at *ALL* costs +29 strcpy(nick,''); +30 strcpy(ip,'127.0.0.1'); +31 timeout = 0; +32 strcpy(ident,''); +33 strcpy(host,''); +34 strcpy(dhost,''); +35 strcpy(fullname,''); +36 strcpy(modes,''); +37 strcpy(inbuf,''); +38 strcpy(server,''); +39 strcpy(awaymsg,''); +40 strcpy(oper,''); +41 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +42 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +43 haspassed = false; +44 strcpy(result,''); +45 for (int i = 0; i < MAXCHANS; i++) +46 { +47 this->chans[i].channel = NULL; +48 this->chans[i].uc_modes = 0; +49 } +50 invites.clear(); +51 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP @@ -157,146 +158,146 @@ Definition at line 160 of file users.h. .PP .SS "char * userrec::GetFullHost ()\fC [virtual]\fP" .PP -Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 53 of file users.cpp. +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 55 of file users.cpp. .PP References dhost, ident, nick, and result. .PP .nf -54 { -55 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -56 return result; -57 } +56 { +57 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +58 return result; +59 } .fi .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP" .PP -Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 60 of file users.cpp. +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 62 of file users.cpp. .PP References connection::host, ident, nick, and result. .PP .nf -61 { -62 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -63 return result; -64 } +63 { +64 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +65 return result; +66 } .fi .SS "bool userrec::HasPermission (char * command)" .PP -Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 109 of file users.cpp. +Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 111 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -110 { -111 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -112 char* myclass; -113 char* mycmd; -114 char* savept; -115 char* savept2; -116 -117 // are they even an oper at all? -118 if (strchr(this->modes,'o')) -119 { -120 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -121 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -122 { -123 ConfValue('type','name',j,TypeName,&config_f); -124 if (!strcmp(TypeName,this->oper)) -125 { -126 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -127 ConfValue('type','classes',j,Classes,&config_f); -128 char* myclass = strtok_r(Classes,' ',&savept); -129 while (myclass) -130 { -131 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -132 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -133 { -134 ConfValue('class','name',k,ClassName,&config_f); -135 if (!strcmp(ClassName,myclass)) -136 { -137 ConfValue('class','commands',k,CommandList,&config_f); -138 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -139 -140 -141 mycmd = strtok_r(CommandList,' ',&savept2); -142 while (mycmd) -143 { -144 if (!strcasecmp(mycmd,command)) -145 { -146 log(DEBUG,'*** Command %s found, returning true',command); -147 return true; -148 } -149 mycmd = strtok_r(NULL,' ',&savept2); -150 } -151 } -152 } -153 myclass = strtok_r(NULL,' ',&savept); -154 } -155 } -156 } -157 } -158 return false; -159 } +112 { +113 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +114 char* myclass; +115 char* mycmd; +116 char* savept; +117 char* savept2; +118 +119 // are they even an oper at all? +120 if (strchr(this->modes,'o')) +121 { +122 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +123 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +124 { +125 ConfValue('type','name',j,TypeName,&config_f); +126 if (!strcmp(TypeName,this->oper)) +127 { +128 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +129 ConfValue('type','classes',j,Classes,&config_f); +130 char* myclass = strtok_r(Classes,' ',&savept); +131 while (myclass) +132 { +133 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +134 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +135 { +136 ConfValue('class','name',k,ClassName,&config_f); +137 if (!strcmp(ClassName,myclass)) +138 { +139 ConfValue('class','commands',k,CommandList,&config_f); +140 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); +141 +142 +143 mycmd = strtok_r(CommandList,' ',&savept2); +144 while (mycmd) +145 { +146 if (!strcasecmp(mycmd,command)) +147 { +148 log(DEBUG,'*** Command %s found, returning true',command); +149 return true; +150 } +151 mycmd = strtok_r(NULL,' ',&savept2); +152 } +153 } +154 } +155 myclass = strtok_r(NULL,' ',&savept); +156 } +157 } +158 } +159 } +160 return false; +161 } .fi .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP" .PP -Adds a channel to a users invite list (invites them to a channel). Definition at line 80 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 82 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -81 { -82 Invited i; -83 strlcpy(i.channel,channel,CHANMAX); -84 invites.push_back(i); -85 } +83 { +84 Invited i; +85 strlcpy(i.channel,channel,CHANMAX); +86 invites.push_back(i); +87 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 66 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 68 of file users.cpp. .PP References invites. .PP .nf -67 { -68 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -69 { -70 if (i->channel) { -71 if (!strcasecmp(i->channel,channel)) -72 { -73 return true; -74 } -75 } -76 } -77 return false; -78 } +69 { +70 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +71 { +72 if (i->channel) { +73 if (!strcasecmp(i->channel,channel)) +74 { +75 return true; +76 } +77 } +78 } +79 return false; +80 } .fi .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP" .PP -Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 87 of file users.cpp. +Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 89 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -88 { -89 log(DEBUG,'Removing invites'); -90 if (channel) -91 { -92 if (invites.size()) -93 { -94 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -95 { -96 if (i->channel) -97 { -98 if (!strcasecmp(i->channel,channel)) -99 { -100 invites.erase(i); -101 return; -102 } -103 } -104 } -105 } -106 } -107 } +90 { +91 log(DEBUG,'Removing invites'); +92 if (channel) +93 { +94 if (invites.size()) +95 { +96 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +97 { +98 if (i->channel) +99 { +100 if (!strcasecmp(i->channel,channel)) +101 { +102 invites.erase(i); +103 return; +104 } +105 } +106 } +107 } +108 } +109 } .fi .SH "Member Data Documentation" .PP @@ -348,6 +349,8 @@ Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Serv .SS "char \fBuserrec::oper\fP[NICKMAX]" .PP The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 156 of file users.h. +.PP +Referenced by userrec(). .SS "char \fBuserrec::result\fP[256]" .PP Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 137 of file users.h. diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index f10abbad6..d55c5a6d5 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -16,6 +16,8 @@ users.cpp \- .br \fC#include <stdio.h>\fP .br +\fC#include 'inspstring.h'\fP +.br .SS "Variables" @@ -28,7 +30,7 @@ users.cpp \- .PP .SS "std::stringstream \fBconfig_f\fP" .PP -Definition at line 23 of file users.cpp. +Definition at line 24 of file users.cpp. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/users.h.3 b/docs/man/man3/users.h.3 index 20e941809..d9bff1f1d 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -12,6 +12,8 @@ users.h \- .br \fC#include 'connection.h'\fP .br +\fC#include 'inspstring.h'\fP +.br \fC#include <string>\fP .br diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index a0b5fea50..445d39b1e 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME |