summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-04-15 19:31:08 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-04-15 19:31:08 +0000
commit674c868b225f0c2c0a8f7879dbaa322a8c539bec (patch)
tree38ad38d48e66179583ae02912c327f54779615ab /docs/man
parent517dd987a78aafda52057f1f6b763a278e3384b2 (diff)
New docs for API:
int Module::OnRawMode(userrec* user, char mode, std::string param, bool adding, int pcnt); int Module::OnCheckInvite(userrec* user, chanrec* chan); int Module::OnCheckKey(userrec* user, chanrec* chan, std::string keygiven); int Module::OnCheckLimit(userrec* user, chanrec* chan); int Module::OnCheckBan(userrec* user, chanrec* chan); void Module::OnStats(char symbol); int Module::OnChangeLocalUserHost(userrec* user, std::string newhost); int Module::OnChangeLocalUserGECOS(userrec* user, std::string newhost); int Module::OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic); git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1106 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/man3/ConfigReader.3260
-rw-r--r--docs/man/man3/FileReader.382
-rw-r--r--docs/man/man3/Module.399
-rw-r--r--docs/man/man3/ModuleFactory.310
-rw-r--r--docs/man/man3/Server.3628
-rw-r--r--docs/man/man3/channels.cpp.32
-rw-r--r--docs/man/man3/modules.cpp.32
-rw-r--r--docs/man/man3/modules.h.310
8 files changed, 596 insertions, 497 deletions
diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3
index d7f37e966..5cfb4804d 100644
--- a/docs/man/man3/ConfigReader.3
+++ b/docs/man/man3/ConfigReader.3
@@ -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 835 of file modules.h.
+Definition at line 891 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 708 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 717 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
-709 {
-710 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-711 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-712 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-713 if (!this->readerror)
-714 this->error = CONF_FILE_NOT_FOUND;
-715 }
+718 {
+719 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+720 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+721 this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+722 if (!this->readerror)
+723 this->error = CONF_FILE_NOT_FOUND;
+724 }
.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 727 of file modules.cpp.
+Overloaded constructor. This constructor initialises the ConfigReader class to read a user-specified config fileDefinition at line 736 of file modules.cpp.
.PP
References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
.PP
.nf
-728 {
-729 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-730 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-731 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-732 if (!this->readerror)
-733 this->error = CONF_FILE_NOT_FOUND;
-734 };
+737 {
+738 this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+739 this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+740 this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+741 if (!this->readerror)
+742 this->error = CONF_FILE_NOT_FOUND;
+743 };
.fi
.SS "ConfigReader::~\fBConfigReader\fP ()"
.PP
-Default destructor. This method destroys the ConfigReader class.Definition at line 718 of file modules.cpp.
+Default destructor. This method destroys the ConfigReader class.Definition at line 727 of file modules.cpp.
.PP
References cache, and errorlog.
.PP
.nf
-719 {
-720 if (this->cache)
-721 delete this->cache;
-722 if (this->errorlog)
-723 delete this->errorlog;
-724 }
+728 {
+729 if (this->cache)
+730 delete this->cache;
+731 if (this->errorlog)
+732 delete this->errorlog;
+733 }
.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 805 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 814 of file modules.cpp.
.PP
References errorlog, connection::fd, and userrec::nick.
.PP
.nf
-806 {
-807 if (bail)
-808 {
-809 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
-810 exit(0);
-811 }
-812 else
-813 {
-814 char dataline[1024];
-815 if (user)
-816 {
-817 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
-818 while (!errorlog->eof())
-819 {
-820 errorlog->getline(dataline,1024);
-821 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
-822 }
-823 }
-824 else
+815 {
+816 if (bail)
+817 {
+818 printf('There were errors in your configuration:\n%s',errorlog->str().c_str());
+819 exit(0);
+820 }
+821 else
+822 {
+823 char dataline[1024];
+824 if (user)
825 {
-826 WriteOpers('There were errors in the configuration file:',user->nick);
+826 WriteServ(user->fd,'NOTICE %s :There were errors in the configuration file:',user->nick);
827 while (!errorlog->eof())
828 {
829 errorlog->getline(dataline,1024);
-830 WriteOpers(dataline);
+830 WriteServ(user->fd,'NOTICE %s :%s',user->nick,dataline);
831 }
832 }
-833 return;
-834 }
-835 }
+833 else
+834 {
+835 WriteOpers('There were errors in the configuration file:',user->nick);
+836 while (!errorlog->eof())
+837 {
+838 errorlog->getline(dataline,1024);
+839 WriteOpers(dataline);
+840 }
+841 }
+842 return;
+843 }
+844 }
.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 838 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 847 of file modules.cpp.
.PP
References cache.
.PP
.nf
-839 {
-840 return EnumConf(cache,tag.c_str());
-841 }
+848 {
+849 return EnumConf(cache,tag.c_str());
+850 }
.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 843 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 852 of file modules.cpp.
.PP
References cache.
.PP
.nf
-844 {
-845 return EnumValues(cache, tag.c_str(), index);
-846 }
+853 {
+854 return EnumValues(cache, tag.c_str(), index);
+855 }
.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 798 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 807 of file modules.cpp.
.PP
References error.
.PP
.nf
-799 {
-800 long olderr = this->error;
-801 this->error = 0;
-802 return olderr;
-803 }
+808 {
+809 long olderr = this->error;
+810 this->error = 0;
+811 return olderr;
+812 }
.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 752 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 761 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-753 {
-754 char val[MAXBUF];
-755 char t[MAXBUF];
-756 char n[MAXBUF];
-757 strlcpy(t,tag.c_str(),MAXBUF);
-758 strlcpy(n,name.c_str(),MAXBUF);
-759 int res = ReadConf(cache,t,n,index,val);
-760 if (!res)
-761 {
-762 this->error = CONF_VALUE_NOT_FOUND;
-763 return false;
-764 }
-765 std::string s = val;
-766 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
-767 }
+762 {
+763 char val[MAXBUF];
+764 char t[MAXBUF];
+765 char n[MAXBUF];
+766 strlcpy(t,tag.c_str(),MAXBUF);
+767 strlcpy(n,name.c_str(),MAXBUF);
+768 int res = ReadConf(cache,t,n,index,val);
+769 if (!res)
+770 {
+771 this->error = CONF_VALUE_NOT_FOUND;
+772 return false;
+773 }
+774 std::string s = val;
+775 return ((s == 'yes') || (s == 'YES') || (s == 'true') || (s == 'TRUE') || (s == '1'));
+776 }
.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 769 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 778 of file modules.cpp.
.PP
References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-770 {
-771 char val[MAXBUF];
-772 char t[MAXBUF];
-773 char n[MAXBUF];
-774 strlcpy(t,tag.c_str(),MAXBUF);
-775 strlcpy(n,name.c_str(),MAXBUF);
-776 int res = ReadConf(cache,t,n,index,val);
-777 if (!res)
-778 {
-779 this->error = CONF_VALUE_NOT_FOUND;
-780 return 0;
-781 }
-782 for (int i = 0; i < strlen(val); i++)
-783 {
-784 if (!isdigit(val[i]))
-785 {
-786 this->error = CONF_NOT_A_NUMBER;
-787 return 0;
-788 }
-789 }
-790 if ((needs_unsigned) && (atoi(val)<0))
-791 {
-792 this->error = CONF_NOT_UNSIGNED;
-793 return 0;
-794 }
-795 return atoi(val);
-796 }
+779 {
+780 char val[MAXBUF];
+781 char t[MAXBUF];
+782 char n[MAXBUF];
+783 strlcpy(t,tag.c_str(),MAXBUF);
+784 strlcpy(n,name.c_str(),MAXBUF);
+785 int res = ReadConf(cache,t,n,index,val);
+786 if (!res)
+787 {
+788 this->error = CONF_VALUE_NOT_FOUND;
+789 return 0;
+790 }
+791 for (int i = 0; i < strlen(val); i++)
+792 {
+793 if (!isdigit(val[i]))
+794 {
+795 this->error = CONF_NOT_A_NUMBER;
+796 return 0;
+797 }
+798 }
+799 if ((needs_unsigned) && (atoi(val)<0))
+800 {
+801 this->error = CONF_NOT_UNSIGNED;
+802 return 0;
+803 }
+804 return atoi(val);
+805 }
.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 736 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 745 of file modules.cpp.
.PP
References cache, CONF_VALUE_NOT_FOUND, and error.
.PP
.nf
-737 {
-738 char val[MAXBUF];
-739 char t[MAXBUF];
-740 char n[MAXBUF];
-741 strlcpy(t,tag.c_str(),MAXBUF);
-742 strlcpy(n,name.c_str(),MAXBUF);
-743 int res = ReadConf(cache,t,n,index,val);
-744 if (!res)
-745 {
-746 this->error = CONF_VALUE_NOT_FOUND;
-747 return '';
-748 }
-749 return std::string(val);
-750 }
+746 {
+747 char val[MAXBUF];
+748 char t[MAXBUF];
+749 char n[MAXBUF];
+750 strlcpy(t,tag.c_str(),MAXBUF);
+751 strlcpy(n,name.c_str(),MAXBUF);
+752 int res = ReadConf(cache,t,n,index,val);
+753 if (!res)
+754 {
+755 this->error = CONF_VALUE_NOT_FOUND;
+756 return '';
+757 }
+758 return std::string(val);
+759 }
.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 848 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 857 of file modules.cpp.
.PP
References readerror.
.PP
.nf
-849 {
-850 return this->readerror;
-851 }
+858 {
+859 return this->readerror;
+860 }
.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 843 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 899 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 848 of file modules.h.
+Definition at line 904 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 844 of file modules.h.
+Definition at line 900 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 847 of file modules.h.
+Used to store errors. Definition at line 903 of file modules.h.
.PP
Referenced by ConfigReader(), and Verify().
diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3
index ebfdece4a..2921a6001 100644
--- a/docs/man/man3/FileReader.3
+++ b/docs/man/man3/FileReader.3
@@ -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 924 of file modules.h.
+Definition at line 980 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 861 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 870 of file modules.cpp.
.PP
.nf
-862 {
-863 }
+871 {
+872 }
.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 854 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 863 of file modules.cpp.
.PP
References fc, and file_cache.
.PP
.nf
-855 {
-856 file_cache c;
-857 readfile(c,filename.c_str());
-858 this->fc = c;
-859 }
+864 {
+865 file_cache c;
+866 readfile(c,filename.c_str());
+867 this->fc = c;
+868 }
.fi
.SS "FileReader::~\fBFileReader\fP ()"
.PP
-Default destructor. This deletes the memory allocated to the file.Definition at line 873 of file modules.cpp.
+Default destructor. This deletes the memory allocated to the file.Definition at line 882 of file modules.cpp.
.PP
.nf
-874 {
-875 }
+883 {
+884 }
.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 877 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 886 of file modules.cpp.
.PP
References fc.
.PP
.nf
-878 {
-879 if (fc.size() == 0)
-880 {
-881 return(false);
-882 }
-883 else
-884 {
-885 return(true);
-886 }
-887 }
+887 {
+888 if (fc.size() == 0)
+889 {
+890 return(false);
+891 }
+892 else
+893 {
+894 return(true);
+895 }
+896 }
.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 896 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 905 of file modules.cpp.
.PP
References fc.
.PP
.nf
-897 {
-898 return fc.size();
-899 }
+906 {
+907 return fc.size();
+908 }
.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 889 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 898 of file modules.cpp.
.PP
References fc.
.PP
.nf
-890 {
-891 if ((x<0) || (x>fc.size()))
-892 return '';
-893 return fc[x];
-894 }
+899 {
+900 if ((x<0) || (x>fc.size()))
+901 return '';
+902 return fc[x];
+903 }
.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 865 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 874 of file modules.cpp.
.PP
References fc, and file_cache.
.PP
.nf
-866 {
-867 file_cache c;
-868 readfile(c,filename.c_str());
-869 this->fc = c;
-870 }
+875 {
+876 file_cache c;
+877 readfile(c,filename.c_str());
+878 this->fc = c;
+879 }
.fi
.SH "Member Data Documentation"
.PP
.SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
.PP
-Definition at line 926 of file modules.h.
+Definition at line 982 of file modules.h.
.PP
Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().
diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3
index 617c89215..a36e96e73 100644
--- a/docs/man/man3/Module.3
+++ b/docs/man/man3/Module.3
@@ -151,6 +151,42 @@ Inherits \fBclassbase\fP.
.RI "virtual void \fBOnUserRegister\fP (\fBuserrec\fP *user)"
.br
.RI "\fICalled whenever a user is about to register their connection (e.g. \fP"
+.ti -1c
+.RI "virtual int \fBOnRawMode\fP (\fBuserrec\fP *user, char mode, std::string param, bool adding, int pcnt)"
+.br
+.RI "\fICalled whenever a mode character is processed. \fP"
+.ti -1c
+.RI "virtual int \fBOnCheckInvite\fP (\fBuserrec\fP *user, \fBchanrec\fP *chan)"
+.br
+.RI "\fICalled whenever a user joins a channel, to determine if invite checks should go ahead or not. \fP"
+.ti -1c
+.RI "virtual int \fBOnCheckKey\fP (\fBuserrec\fP *user, \fBchanrec\fP *chan, std::string keygiven)"
+.br
+.RI "\fICalled whenever a user joins a channel, to determine if key checks should go ahead or not. \fP"
+.ti -1c
+.RI "virtual int \fBOnCheckLimit\fP (\fBuserrec\fP *user, \fBchanrec\fP *chan)"
+.br
+.RI "\fICalled whenever a user joins a channel, to determine if channel limit checks should go ahead or not. \fP"
+.ti -1c
+.RI "virtual int \fBOnCheckBan\fP (\fBuserrec\fP *user, \fBchanrec\fP *chan)"
+.br
+.RI "\fICalled whenever a user joins a channel, to determine if banlist checks should go ahead or not. \fP"
+.ti -1c
+.RI "virtual void \fBOnStats\fP (char symbol)"
+.br
+.RI "\fICalled on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. \fP"
+.ti -1c
+.RI "virtual int \fBOnChangeLocalUserHost\fP (\fBuserrec\fP *user, std::string newhost)"
+.br
+.RI "\fICalled whenever a change of a local users displayed host is attempted. \fP"
+.ti -1c
+.RI "virtual int \fBOnChangeLocalUserGECOS\fP (\fBuserrec\fP *user, std::string newhost)"
+.br
+.RI "\fICalled whenever a change of a local users GECOS (fullname field) is attempted. \fP"
+.ti -1c
+.RI "virtual int \fBOnLocalTopicChange\fP (\fBuserrec\fP *user, \fBchanrec\fP *chan, std::string topic)"
+.br
+.RI "\fICalled whenever a topic is changed by a local user. \fP"
.in -1c
.SH "Detailed Description"
.PP
@@ -233,6 +269,20 @@ Called once every five seconds for background processing. This timer can be used
.nf
333 { };
.fi
+.SS "int Module::OnChangeLocalUserGECOS (\fBuserrec\fP * user, std::string newhost)\fC [virtual]\fP"
+.PP
+Called whenever a change of a local users GECOS (fullname field) is attempted. return 1 to deny the name change, or 0 to allow it.Definition at line 347 of file modules.cpp.
+.PP
+.nf
+347 { return 0; };
+.fi
+.SS "int Module::OnChangeLocalUserHost (\fBuserrec\fP * user, std::string newhost)\fC [virtual]\fP"
+.PP
+Called whenever a change of a local users displayed host is attempted. Return 1 to deny the host change, or 0 to allow it.Definition at line 346 of file modules.cpp.
+.PP
+.nf
+346 { return 0; };
+.fi
.SS "\fBstring_list\fP Module::OnChannelSync (\fBchanrec\fP * chan)\fC [virtual]\fP"
.PP
Called during a netburst to sync channel data. This is called during the netburst on a per-channel basis. You should use this call to up any special channel-related things which are implemented by your module, e.g. sending listmodes. You may return multiple commands in the string_list.Definition at line 329 of file modules.cpp.
@@ -242,6 +292,34 @@ References string_list.
.nf
329 { string_list empty; return empty; }
.fi
+.SS "int Module::OnCheckBan (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP"
+.PP
+Called whenever a user joins a channel, to determine if banlist checks should go ahead or not. This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 344 of file modules.cpp.
+.PP
+.nf
+344 { return 0; };
+.fi
+.SS "int Module::OnCheckInvite (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP"
+.PP
+Called whenever a user joins a channel, to determine if invite checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.Definition at line 341 of file modules.cpp.
+.PP
+.nf
+341 { return 0; };
+.fi
+.SS "int Module::OnCheckKey (\fBuserrec\fP * user, \fBchanrec\fP * chan, std::string keygiven)\fC [virtual]\fP"
+.PP
+Called whenever a user joins a channel, to determine if key checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 342 of file modules.cpp.
+.PP
+.nf
+342 { return 0; };
+.fi
+.SS "int Module::OnCheckLimit (\fBuserrec\fP * user, \fBchanrec\fP * chan)\fC [virtual]\fP"
+.PP
+Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event. Definition at line 343 of file modules.cpp.
+.PP
+.nf
+343 { return 0; };
+.fi
.SS "bool Module::OnCheckReady (\fBuserrec\fP * user)\fC [virtual]\fP"
.PP
Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true. For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.Definition at line 336 of file modules.cpp.
@@ -279,6 +357,13 @@ Called whenever a module is loaded. mod will contain a pointer to the module, an
.nf
332 { };
.fi
+.SS "int Module::OnLocalTopicChange (\fBuserrec\fP * user, \fBchanrec\fP * chan, std::string topic)\fC [virtual]\fP"
+.PP
+Called whenever a topic is changed by a local user. Return 1 to deny the topic change, or 0 to allow it.Definition at line 348 of file modules.cpp.
+.PP
+.nf
+348 { return 0; };
+.fi
.SS "void Module::OnOper (\fBuserrec\fP * user)\fC [virtual]\fP"
.PP
Called whenever a user opers locally. The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.Definition at line 319 of file modules.cpp.
@@ -307,6 +392,13 @@ Called whenever any command is about to be executed. This event occurs for all r
.nf
335 { return 0; };
.fi
+.SS "int Module::OnRawMode (\fBuserrec\fP * user, char mode, std::string param, bool adding, int pcnt)\fC [virtual]\fP"
+.PP
+Called whenever a mode character is processed. Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!Definition at line 340 of file modules.cpp.
+.PP
+.nf
+340 { return 0; };
+.fi
.SS "void Module::OnRehash ()\fC [virtual]\fP"
.PP
Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.Definition at line 314 of file modules.cpp.
@@ -328,6 +420,13 @@ Called when a raw command is transmitted or received. This method is the lowest
.nf
315 { }
.fi
+.SS "void Module::OnStats (char symbol)\fC [virtual]\fP"
+.PP
+Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. Definition at line 345 of file modules.cpp.
+.PP
+.nf
+345 { };
+.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 308 of file modules.cpp.
diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3
index 7c9ee6f00..b8ecf879f 100644
--- a/docs/man/man3/ModuleFactory.3
+++ b/docs/man/man3/ModuleFactory.3
@@ -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 979 of file modules.h.
+Definition at line 1035 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP"
.PP
-Definition at line 982 of file modules.h.
+Definition at line 1038 of file modules.h.
.PP
.nf
-982 { }
+1038 { }
.fi
.SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP"
.PP
-Definition at line 983 of file modules.h.
+Definition at line 1039 of file modules.h.
.PP
.nf
-983 { }
+1039 { }
.fi
.SH "Member Function Documentation"
.PP
diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3
index a042d511b..81b4ab269 100644
--- a/docs/man/man3/Server.3
+++ b/docs/man/man3/Server.3
@@ -222,24 +222,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 437 of file modules.h.
+Definition at line 493 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "Server::Server ()"
.PP
-Default constructor. Creates a Server object.Definition at line 345 of file modules.cpp.
+Default constructor. Creates a Server object.Definition at line 354 of file modules.cpp.
.PP
.nf
-346 {
-347 }
+355 {
+356 }
.fi
.SS "Server::~\fBServer\fP ()\fC [virtual]\fP"
.PP
-Default destructor. Destroys a Server object.Definition at line 349 of file modules.cpp.
+Default destructor. Destroys a Server object.Definition at line 358 of file modules.cpp.
.PP
.nf
-350 {
-351 }
+359 {
+360 }
.fi
.SH "Member Function Documentation"
.PP
@@ -249,25 +249,25 @@ Adds a command to the command table. This allows modules to add extra commands i
.PP
typedef void (handlerfunc) (char**, int, userrec*); ... void \fBhandle_kill(char **parameters, int pcnt, userrec *user)\fP
.PP
-When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. 'm_blarp.so'. If you place the wrong identifier here, you can cause crashes if your module is unloaded.Definition at line 426 of file modules.cpp.
+When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. 'm_blarp.so'. If you place the wrong identifier here, you can cause crashes if your module is unloaded.Definition at line 435 of file modules.cpp.
.PP
References createcommand().
.PP
.nf
-427 {
-428 createcommand(cmd,f,flags,minparams,source);
-429 }
+436 {
+437 createcommand(cmd,f,flags,minparams,source);
+438 }
.fi
.SS "void Server::AddELine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
.PP
-Adds a E-line The E-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 644 of file modules.cpp.
+Adds a E-line The E-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 653 of file modules.cpp.
.PP
References add_eline(), and duration().
.PP
.nf
-645 {
-646 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-647 }
+654 {
+655 add_eline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+656 }
.fi
.SS "bool Server::AddExtendedListMode (char modechar)\fC [virtual]\fP"
.PP
@@ -281,438 +281,438 @@ 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 571 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 580 of file modules.cpp.
.PP
References DoAddExtendedMode(), ModeMakeList(), and MT_CHANNEL.
.PP
.nf
-572 {
-573 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
-574 if (res)
-575 ModeMakeList(modechar);
-576 return res;
-577 }
+581 {
+582 bool res = DoAddExtendedMode(modechar,MT_CHANNEL,false,1,1);
+583 if (res)
+584 ModeMakeList(modechar);
+585 return res;
+586 }
.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 551 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 560 of file modules.cpp.
.PP
References DEBUG, DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
.PP
.nf
-552 {
-553 if (type == MT_SERVER)
-554 {
-555 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
-556 return false;
-557 }
-558 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
-559 {
-560 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
-561 return false;
-562 }
-563 if ((params_when_on>1) || (params_when_off>1))
-564 {
-565 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
-566 return false;
-567 }
-568 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
-569 }
+561 {
+562 if (type == MT_SERVER)
+563 {
+564 log(DEBUG,'*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion');
+565 return false;
+566 }
+567 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+568 {
+569 log(DEBUG,'*** API ERROR *** Parameters on MT_CLIENT modes are not supported');
+570 return false;
+571 }
+572 if ((params_when_on>1) || (params_when_off>1))
+573 {
+574 log(DEBUG,'*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported');
+575 return false;
+576 }
+577 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+578 }
.fi
.SS "void Server::AddGLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
.PP
-Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.Definition at line 624 of file modules.cpp.
+Adds a G-line The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name.Definition at line 633 of file modules.cpp.
.PP
References add_gline(), and duration().
.PP
.nf
-625 {
-626 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-627 }
+634 {
+635 add_gline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+636 }
.fi
.SS "void Server::AddKLine (long duration, std::string source, std::string reason, std::string hostmask)\fC [virtual]\fP"
.PP
-Adds a K-line The K-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 639 of file modules.cpp.
+Adds a K-line The K-line is enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 648 of file modules.cpp.
.PP
References add_kline(), and duration().
.PP
.nf
-640 {
-641 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
-642 }
+649 {
+650 add_kline(duration, source.c_str(), reason.c_str(), hostmask.c_str());
+651 }
.fi
.SS "void Server::AddQLine (long duration, std::string source, std::string reason, std::string nickname)\fC [virtual]\fP"
.PP
-Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 629 of file modules.cpp.
+Adds a Q-line The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 638 of file modules.cpp.
.PP
References add_qline(), and duration().
.PP
.nf
-630 {
-631 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
-632 }
+639 {
+640 add_qline(duration, source.c_str(), reason.c_str(), nickname.c_str());
+641 }
.fi
.SS "void Server::AddZLine (long duration, std::string source, std::string reason, std::string ipaddr)\fC [virtual]\fP"
.PP
-Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 634 of file modules.cpp.
+Adds a Z-line The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added. The duration must be in seconds, however you can use the \fBServer::CalcDuration\fP method to convert durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used to indicate who or what sent the data, usually this is the nickname of a person, or a server name. Definition at line 643 of file modules.cpp.
.PP
References add_zline(), and duration().
.PP
.nf
-635 {
-636 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
-637 }
+644 {
+645 add_zline(duration, source.c_str(), reason.c_str(), ipaddr.c_str());
+646 }
.fi
.SS "long Server::CalcDuration (std::string duration)\fC [virtual]\fP"
.PP
-Calculates a duration This method will take a string containing a formatted duration (e.g. '1w2d') and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.Definition at line 674 of file modules.cpp.
+Calculates a duration This method will take a string containing a formatted duration (e.g. '1w2d') and return its value as a total number of seconds. This is the same function used internally by /GLINE etc to set the ban times.Definition at line 683 of file modules.cpp.
.PP
References duration().
.PP
.nf
-675 {
-676 return duration(delta.c_str());
-677 }
+684 {
+685 return duration(delta.c_str());
+686 }
.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 416 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 425 of file modules.cpp.
.PP
.nf
-417 {
-418 call_handler(commandname.c_str(),parameters,pcnt,user);
-419 }
+426 {
+427 call_handler(commandname.c_str(),parameters,pcnt,user);
+428 }
.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 504 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 513 of file modules.cpp.
.PP
References ChangeName().
.PP
.nf
-505 {
-506 ChangeName(user,gecos.c_str());
-507 }
+514 {
+515 ChangeName(user,gecos.c_str());
+516 }
.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 499 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 508 of file modules.cpp.
.PP
References ChangeDisplayedHost().
.PP
.nf
-500 {
-501 ChangeDisplayedHost(user,host.c_str());
-502 }
+509 {
+510 ChangeDisplayedHost(user,host.c_str());
+511 }
.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 400 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 409 of file modules.cpp.
.PP
.nf
-401 {
-402 force_nickchange(user,nickname.c_str());
-403 }
+410 {
+411 force_nickchange(user,nickname.c_str());
+412 }
.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 524 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 533 of file modules.cpp.
.PP
References cmode().
.PP
.nf
-525 {
-526 return cmode(User,Chan);
-527 }
+534 {
+535 return cmode(User,Chan);
+536 }
.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 477 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 486 of file modules.cpp.
.PP
References common_channels().
.PP
.nf
-478 {
-479 return (common_channels(u1,u2) != 0);
-480 }
+487 {
+488 return (common_channels(u1,u2) != 0);
+489 }
.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 579 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 588 of file modules.cpp.
.PP
.nf
-580 {
-581 return usercount(c);
-582 }
+589 {
+590 return usercount(c);
+591 }
.fi
.SS "bool Server::DelELine (std::string hostmask)\fC [virtual]\fP"
.PP
-Deletes a local E-Line. Definition at line 669 of file modules.cpp.
+Deletes a local E-Line. Definition at line 678 of file modules.cpp.
.PP
References del_eline().
.PP
.nf
-670 {
-671 del_eline(hostmask.c_str());
-672 }
+679 {
+680 del_eline(hostmask.c_str());
+681 }
.fi
.SS "bool Server::DelGLine (std::string hostmask)\fC [virtual]\fP"
.PP
-Deletes a G-Line from all servers on the mesh. Definition at line 649 of file modules.cpp.
+Deletes a G-Line from all servers on the mesh. Definition at line 658 of file modules.cpp.
.PP
References del_gline().
.PP
.nf
-650 {
-651 del_gline(hostmask.c_str());
-652 }
+659 {
+660 del_gline(hostmask.c_str());
+661 }
.fi
.SS "bool Server::DelKLine (std::string hostmask)\fC [virtual]\fP"
.PP
-Deletes a local K-Line. Definition at line 664 of file modules.cpp.
+Deletes a local K-Line. Definition at line 673 of file modules.cpp.
.PP
References del_kline().
.PP
.nf
-665 {
-666 del_kline(hostmask.c_str());
-667 }
+674 {
+675 del_kline(hostmask.c_str());
+676 }
.fi
.SS "bool Server::DelQLine (std::string nickname)\fC [virtual]\fP"
.PP
-Deletes a Q-Line from all servers on the mesh. Definition at line 654 of file modules.cpp.
+Deletes a Q-Line from all servers on the mesh. Definition at line 663 of file modules.cpp.
.PP
References del_qline().
.PP
.nf
-655 {
-656 del_qline(nickname.c_str());
-657 }
+664 {
+665 del_qline(nickname.c_str());
+666 }
.fi
.SS "bool Server::DelZLine (std::string ipaddr)\fC [virtual]\fP"
.PP
-Deletes a Z-Line from all servers on the mesh. Definition at line 659 of file modules.cpp.
+Deletes a Z-Line from all servers on the mesh. Definition at line 668 of file modules.cpp.
.PP
References del_zline().
.PP
.nf
-660 {
-661 del_zline(ipaddr.c_str());
-662 }
+669 {
+670 del_zline(ipaddr.c_str());
+671 }
.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 519 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 528 of file modules.cpp.
.PP
.nf
-520 {
-521 return FindChan(channel.c_str());
-522 }
+529 {
+530 return FindChan(channel.c_str());
+531 }
.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 514 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 523 of file modules.cpp.
.PP
.nf
-515 {
-516 return Find(nick);
-517 }
+524 {
+525 return Find(nick);
+526 }
.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 544 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 553 of file modules.cpp.
.PP
.nf
-545 {
-546 return Admin(getadminname(),getadminemail(),getadminnick());
-547 }
+554 {
+555 return Admin(getadminname(),getadminemail(),getadminnick());
+556 }
.fi
.SS "std::string Server::GetNetworkName ()\fC [virtual]\fP"
.PP
-Returns the network name, global to all linked servers. Definition at line 539 of file modules.cpp.
+Returns the network name, global to all linked servers. Definition at line 548 of file modules.cpp.
.PP
.nf
-540 {
-541 return getnetworkname();
-542 }
+549 {
+550 return getnetworkname();
+551 }
.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 534 of file modules.cpp.
+Returns the server name of the server where the module is loaded. Definition at line 543 of file modules.cpp.
.PP
.nf
-535 {
-536 return getservername();
-537 }
+544 {
+545 return getservername();
+546 }
.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 381 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 390 of file modules.cpp.
.PP
References chanuserlist, clientlist, has_channel(), and isnick().
.PP
.nf
-382 {
-383 chanuserlist userl;
-384 userl.clear();
-385 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
-386 {
-387 if (i->second)
-388 {
-389 if (has_channel(i->second,chan))
-390 {
-391 if (isnick(i->second->nick))
-392 {
-393 userl.push_back(i->second);
-394 }
-395 }
-396 }
-397 }
-398 return userl;
-399 }
+391 {
+392 chanuserlist userl;
+393 userl.clear();
+394 for (user_hash::const_iterator i = clientlist.begin(); i != clientlist.end(); i++)
+395 {
+396 if (i->second)
+397 {
+398 if (has_channel(i->second,chan))
+399 {
+400 if (isnick(i->second->nick))
+401 {
+402 userl.push_back(i->second);
+403 }
+404 }
+405 }
+406 }
+407 return userl;
+408 }
.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 509 of file modules.cpp.
+Returns true if a nick is valid. Nicks for unregistered connections will return false.Definition at line 518 of file modules.cpp.
.PP
References isnick().
.PP
.nf
-510 {
-511 return (isnick(nick.c_str()) != 0);
-512 }
+519 {
+520 return (isnick(nick.c_str()) != 0);
+521 }
.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 529 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 538 of file modules.cpp.
.PP
References has_channel().
.PP
.nf
-530 {
-531 return has_channel(User,Chan);
-532 }
+539 {
+540 return has_channel(User,Chan);
+541 }
.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 411 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 420 of file modules.cpp.
.PP
References is_uline().
.PP
.nf
-412 {
-413 return is_uline(server.c_str());
-414 }
+421 {
+422 return is_uline(server.c_str());
+423 }
.fi
.SS "bool Server::IsValidMask (std::string mask)\fC [virtual]\fP"
.PP
-Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 679 of file modules.cpp.
-.PP
-.nf
-680 {
-681 const char* dest = mask.c_str();
-682 if (strchr(dest,'!')==0)
-683 return false;
-684 if (strchr(dest,'@')==0)
-685 return false;
-686 for (int i = 0; i < strlen(dest); i++)
-687 if (dest[i] < 32)
-688 return false;
-689 for (int i = 0; i < strlen(dest); i++)
-690 if (dest[i] > 126)
-691 return false;
-692 int c = 0;
-693 for (int i = 0; i < strlen(dest); i++)
-694 if (dest[i] == '!')
-695 c++;
-696 if (c>1)
-697 return false;
-698 c = 0;
-699 for (int i = 0; i < strlen(dest); i++)
-700 if (dest[i] == '@')
-701 c++;
-702 if (c>1)
-703 return false;
-704
-705 return true;
-706 }
+Returns true if a nick!ident string is correctly formatted, false if otherwise. Definition at line 688 of file modules.cpp.
+.PP
+.nf
+689 {
+690 const char* dest = mask.c_str();
+691 if (strchr(dest,'!')==0)
+692 return false;
+693 if (strchr(dest,'@')==0)
+694 return false;
+695 for (int i = 0; i < strlen(dest); i++)
+696 if (dest[i] < 32)
+697 return false;
+698 for (int i = 0; i < strlen(dest); i++)
+699 if (dest[i] > 126)
+700 return false;
+701 int c = 0;
+702 for (int i = 0; i < strlen(dest); i++)
+703 if (dest[i] == '!')
+704 c++;
+705 if (c>1)
+706 return false;
+707 c = 0;
+708 for (int i = 0; i < strlen(dest); i++)
+709 if (dest[i] == '@')
+710 c++;
+711 if (c>1)
+712 return false;
+713
+714 return true;
+715 }
.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 371 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 380 of file modules.cpp.
.PP
.nf
-372 {
-373 return add_channel(user,cname.c_str(),key.c_str(),true);
-374 }
+381 {
+382 return add_channel(user,cname.c_str(),key.c_str(),true);
+383 }
.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 421 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 430 of file modules.cpp.
.PP
.nf
-422 {
-423 log(level,'%s',s.c_str());
-424 }
+431 {
+432 log(level,'%s',s.c_str());
+433 }
.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 358 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 367 of file modules.cpp.
.PP
.nf
-359 {
-360 char literal[MAXBUF],pattern[MAXBUF];
-361 strlcpy(literal,sliteral.c_str(),MAXBUF);
-362 strlcpy(pattern,spattern.c_str(),MAXBUF);
-363 return match(literal,pattern);
-364 }
+368 {
+369 char literal[MAXBUF],pattern[MAXBUF];
+370 strlcpy(literal,sliteral.c_str(),MAXBUF);
+371 strlcpy(pattern,spattern.c_str(),MAXBUF);
+372 return match(literal,pattern);
+373 }
.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 376 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 385 of file modules.cpp.
.PP
.nf
-377 {
-378 return del_channel(user,cname.c_str(),reason.c_str(),false);
-379 }
+386 {
+387 return del_channel(user,cname.c_str(),reason.c_str(),false);
+388 }
.fi
.SS "bool Server::PseudoToUser (\fBuserrec\fP * alive, \fBuserrec\fP * zombie, std::string message)\fC [virtual]\fP"
.PP
-This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.Definition at line 594 of file modules.cpp.
+This user takes one user, and switches their file descriptor with another user, so that one user 'becomes' the other. The user in 'alive' is booted off the server with the given message. The user referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.Definition at line 603 of file modules.cpp.
.PP
References ucrec::channel, userrec::chans, chanrec::created, connection::fd, FD_MAGIC_NUMBER, connection::host, userrec::ident, chanrec::name, userrec::nick, chanrec::setby, chanrec::topic, and chanrec::topicset.
.PP
.nf
-595 {
-596 zombie->fd = alive->fd;
-597 alive->fd = FD_MAGIC_NUMBER;
-598 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
-599 kill_link(alive,message.c_str());
-600 for (int i = 0; i != MAXCHANS; i++)
-601 {
-602 if (zombie->chans[i].channel != NULL)
-603 {
-604 if (zombie->chans[i].channel->name)
-605 {
-606 chanrec* Ptr = zombie->chans[i].channel;
-607 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
-608 if (Ptr->topicset)
-609 {
-610 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
-611 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
-612 }
-613 userlist(zombie,Ptr);
-614 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
-615 WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr));
-616 WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created);
-617
-618 }
-619 }
-620 }
-621
-622 }
+604 {
+605 zombie->fd = alive->fd;
+606 alive->fd = FD_MAGIC_NUMBER;
+607 Write(zombie->fd,':%s!%s@%s NICK %s',alive->nick,alive->ident,alive->host,zombie->nick);
+608 kill_link(alive,message.c_str());
+609 for (int i = 0; i != MAXCHANS; i++)
+610 {
+611 if (zombie->chans[i].channel != NULL)
+612 {
+613 if (zombie->chans[i].channel->name)
+614 {
+615 chanrec* Ptr = zombie->chans[i].channel;
+616 WriteFrom(zombie->fd,zombie,'JOIN %s',Ptr->name);
+617 if (Ptr->topicset)
+618 {
+619 WriteServ(zombie->fd,'332 %s %s :%s', zombie->nick, Ptr->name, Ptr->topic);
+620 WriteServ(zombie->fd,'333 %s %s %s %d', zombie->nick, Ptr->name, Ptr->setby, Ptr->topicset);
+621 }
+622 userlist(zombie,Ptr);
+623 WriteServ(zombie->fd,'366 %s %s :End of /NAMES list.', zombie->nick, Ptr->name);
+624 WriteServ(zombie->fd,'324 %s %s +%s',zombie->nick, Ptr->name,chanmodes(Ptr));
+625 WriteServ(zombie->fd,'329 %s %s %d', zombie->nick, Ptr->name, Ptr->created);
+626
+627 }
+628 }
+629 }
+630
+631 }
.fi
.SS "void Server::QuitUser (\fBuserrec\fP * user, std::string reason)\fC [virtual]\fP"
.PP
@@ -720,65 +720,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 405 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 414 of file modules.cpp.
.PP
References userrec::nick, and send_network_quit().
.PP
.nf
-406 {
-407 send_network_quit(user->nick,reason.c_str());
-408 kill_link(user,reason.c_str());
-409 }
+415 {
+416 send_network_quit(user->nick,reason.c_str());
+417 kill_link(user,reason.c_str());
+418 }
.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 436 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 445 of file modules.cpp.
.PP
.nf
-437 {
-438 Write(Socket,'%s',s.c_str());
-439 }
+446 {
+447 Write(Socket,'%s',s.c_str());
+448 }
.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 465 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 474 of file modules.cpp.
.PP
.nf
-466 {
-467 if (IncludeSender)
-468 {
-469 WriteChannel(Channel,User,'%s',s.c_str());
-470 }
-471 else
-472 {
-473 ChanExceptSender(Channel,User,'%s',s.c_str());
-474 }
-475 }
+475 {
+476 if (IncludeSender)
+477 {
+478 WriteChannel(Channel,User,'%s',s.c_str());
+479 }
+480 else
+481 {
+482 ChanExceptSender(Channel,User,'%s',s.c_str());
+483 }
+484 }
.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 482 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 491 of file modules.cpp.
.PP
.nf
-483 {
-484 if (IncludeSender)
-485 {
-486 WriteCommon(User,'%s',text.c_str());
-487 }
-488 else
-489 {
-490 WriteCommonExcept(User,'%s',text.c_str());
-491 }
-492 }
+492 {
+493 if (IncludeSender)
+494 {
+495 WriteCommon(User,'%s',text.c_str());
+496 }
+497 else
+498 {
+499 WriteCommonExcept(User,'%s',text.c_str());
+500 }
+501 }
.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 446 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 455 of file modules.cpp.
.PP
.nf
-447 {
-448 WriteFrom(Socket,User,'%s',s.c_str());
-449 }
+456 {
+457 WriteFrom(Socket,User,'%s',s.c_str());
+458 }
.fi
.SS "void Server::SendMode (char ** parameters, int pcnt, \fBuserrec\fP * user)\fC [virtual]\fP"
.PP
@@ -796,32 +796,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 431 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 440 of file modules.cpp.
.PP
References server_mode().
.PP
.nf
-432 {
-433 server_mode(parameters,pcnt,user);
-434 }
+441 {
+442 server_mode(parameters,pcnt,user);
+443 }
.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 353 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 362 of file modules.cpp.
.PP
.nf
-354 {
-355 WriteOpers('%s',s.c_str());
-356 }
+363 {
+364 WriteOpers('%s',s.c_str());
+365 }
.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 441 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 450 of file modules.cpp.
.PP
.nf
-442 {
-443 WriteServ(Socket,'%s',s.c_str());
-444 }
+451 {
+452 WriteServ(Socket,'%s',s.c_str());
+453 }
.fi
.SS "void Server::SendTo (\fBuserrec\fP * Source, \fBuserrec\fP * Dest, std::string s)\fC [virtual]\fP"
.PP
@@ -833,23 +833,23 @@ The format will become:
.PP
:localserver TEXT
.PP
-Which is useful for numerics and server notices to single users, etc.Definition at line 451 of file modules.cpp.
+Which is useful for numerics and server notices to single users, etc.Definition at line 460 of file modules.cpp.
.PP
References connection::fd.
.PP
.nf
-452 {
-453 if (!Source)
-454 {
-455 // if source is NULL, then the message originates from the local server
-456 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
-457 }
-458 else
-459 {
-460 // otherwise it comes from the user specified
-461 WriteTo(Source,Dest,'%s',s.c_str());
-462 }
-463 }
+461 {
+462 if (!Source)
+463 {
+464 // if source is NULL, then the message originates from the local server
+465 Write(Dest->fd,':%s %s',this->GetServerName().c_str(),s.c_str());
+466 }
+467 else
+468 {
+469 // otherwise it comes from the user specified
+470 WriteTo(Source,Dest,'%s',s.c_str());
+471 }
+472 }
.fi
.SS "void Server::SendToModeMask (std::string modes, int flags, std::string text)\fC [virtual]\fP"
.PP
@@ -857,36 +857,36 @@ 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 366 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 375 of file modules.cpp.
.PP
.nf
-367 {
-368 WriteMode(modes.c_str(),flags,'%s',text.c_str());
-369 }
+376 {
+377 WriteMode(modes.c_str(),flags,'%s',text.c_str());
+378 }
.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 494 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 503 of file modules.cpp.
.PP
.nf
-495 {
-496 WriteWallOps(User,false,'%s',text.c_str());
-497 }
+504 {
+505 WriteWallOps(User,false,'%s',text.c_str());
+506 }
.fi
.SS "bool Server::UserToPseudo (\fBuserrec\fP * user, std::string message)\fC [virtual]\fP"
.PP
-Remove a user's connection to the irc server, but leave their client in existence in the user hash. When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.Definition at line 585 of file modules.cpp.
+Remove a user's connection to the irc server, but leave their client in existence in the user hash. When you call this function, the user's file descriptor will be replaced with the value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will remain until it is restored with a valid file descriptor, or is removed from IRC by an operator After this call, the pointer to user will be invalid.Definition at line 594 of file modules.cpp.
.PP
References connection::fd, FD_MAGIC_NUMBER, connection::host, and userrec::ident.
.PP
.nf
-586 {
-587 unsigned int old_fd = user->fd;
-588 user->fd = FD_MAGIC_NUMBER;
-589 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
-590 close(old_fd);
-591 shutdown (old_fd,2);
-592 }
+595 {
+596 unsigned int old_fd = user->fd;
+597 user->fd = FD_MAGIC_NUMBER;
+598 Write(old_fd,'ERROR :Closing link (%s@%s) [%s]',user->ident,user->host,message.c_str());
+599 close(old_fd);
+600 shutdown (old_fd,2);
+601 }
.fi
diff --git a/docs/man/man3/channels.cpp.3 b/docs/man/man3/channels.cpp.3
index 3d4120362..2862899e2 100644
--- a/docs/man/man3/channels.cpp.3
+++ b/docs/man/man3/channels.cpp.3
@@ -271,7 +271,7 @@ Definition at line 88 of file channels.cpp.
Definition at line 103 of file channels.cpp.
.SS "int \fBMODCOUNT\fP = -1"
.PP
-Definition at line 905 of file modules.cpp.
+Definition at line 914 of file modules.cpp.
.SS "std::vector<std::string> \fBmodule_names\fP"
.PP
Definition at line 92 of file channels.cpp.
diff --git a/docs/man/man3/modules.cpp.3 b/docs/man/man3/modules.cpp.3
index 8e282568a..e4ab55f29 100644
--- a/docs/man/man3/modules.cpp.3
+++ b/docs/man/man3/modules.cpp.3
@@ -533,7 +533,7 @@ Definition at line 91 of file modules.cpp.
Definition at line 106 of file modules.cpp.
.SS "int \fBMODCOUNT\fP = -1"
.PP
-Definition at line 905 of file modules.cpp.
+Definition at line 914 of file modules.cpp.
.SS "std::vector<std::string> \fBmodule_names\fP"
.PP
Definition at line 95 of file modules.cpp.
diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3
index 39f6c6f4c..4e27488c7 100644
--- a/docs/man/man3/modules.h.3
+++ b/docs/man/man3/modules.h.3
@@ -218,22 +218,22 @@ Referenced by Module::OnAccessCheck().
Definition at line 38 of file modules.h.
.SS "#define CONF_FILE_NOT_FOUND 0x000200"
.PP
-Definition at line 827 of file modules.h.
+Definition at line 883 of file modules.h.
.PP
Referenced by ConfigReader::ConfigReader().
.SS "#define CONF_NOT_A_NUMBER 0x000010"
.PP
-Definition at line 824 of file modules.h.
+Definition at line 880 of file modules.h.
.PP
Referenced by ConfigReader::ReadInteger().
.SS "#define CONF_NOT_UNSIGNED 0x000080"
.PP
-Definition at line 825 of file modules.h.
+Definition at line 881 of file modules.h.
.PP
Referenced by ConfigReader::ReadInteger().
.SS "#define CONF_VALUE_NOT_FOUND 0x000100"
.PP
-Definition at line 826 of file modules.h.
+Definition at line 882 of file modules.h.
.PP
Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
.SS "#define DEBUG 10"
@@ -319,7 +319,7 @@ Low level definition of a \fBFileReader\fP classes file cache area. Definition a
Referenced by FileReader::FileReader(), and FileReader::LoadFile().
.SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP"
.PP
-Definition at line 992 of file modules.h.
+Definition at line 1048 of file modules.h.
.SS "typedef \fBfile_cache\fP \fBstring_list\fP"
.PP
Definition at line 68 of file modules.h.
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-27 22:53:16 +0000