00093 { }
+
@@ -121,9 +121,9 @@ Default destructor destroys a module class.
-Definition at line 94 of file modules.cpp.
+Definition at line 108 of file modules.cpp.
-
00094 { }
+
@@ -157,9 +157,9 @@ Returns the version number of a Module.
The method should return a Version object with its version information assigned via Version::Version
-Definition at line 105 of file modules.cpp.
+Definition at line 119 of file modules.cpp.
-
00105 { return Version(1,0,0,0); }
+
@@ -274,9 +274,9 @@ Called whenever an extended mode is to be processed.
The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with Server::AddExtendedMode If the mode is not a channel mode, chanrec* chan is null, and should not be read from or written to.
-Definition at line 104 of file modules.cpp.
+Definition at line 118 of file modules.cpp.
-
00104 { }
+
@@ -310,9 +310,9 @@ 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 100 of file modules.cpp.
+Definition at line 114 of file modules.cpp.
-
00100 { }
+
@@ -346,9 +346,9 @@ Called before a packet is transmitted across the irc network between two irc ser
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 99 of file modules.cpp.
+Definition at line 113 of file modules.cpp.
-
00099 { }
+
@@ -381,9 +381,9 @@ Called on rehash.
This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.
-Definition at line 101 of file modules.cpp.
+Definition at line 115 of file modules.cpp.
-
00101 { }
+
@@ -426,9 +426,9 @@ Called when a raw command is transmitted or received.
This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed.
-Definition at line 102 of file modules.cpp.
+Definition at line 116 of file modules.cpp.
-
00102 { }
+
@@ -462,9 +462,9 @@ Called when a user connects.
The details of the connecting user are available to you in the parameter userrec *user
-Definition at line 95 of file modules.cpp.
+Definition at line 109 of file modules.cpp.
-
00095 { }
+
@@ -507,9 +507,9 @@ Called when a user joins a channel.
The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel
-Definition at line 97 of file modules.cpp.
+Definition at line 111 of file modules.cpp.
-
00097 { }
+
@@ -552,9 +552,9 @@ Called when a user parts a channel.
The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel
-Definition at line 98 of file modules.cpp.
+Definition at line 112 of file modules.cpp.
-
00098 { }
+
@@ -588,15 +588,15 @@ Called when a user quits.
The details of the exiting user are available to you in the parameter userrec *user
-Definition at line 96 of file modules.cpp.
+Definition at line 110 of file modules.cpp.
-
00096 { }
+
The documentation for this class was generated from the following files:
-
Generated on Sat Apr 3 16:36:16 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:29 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/classModuleFactory-members.html b/docs/module-doc/classModuleFactory-members.html
index c978d4158..dd7c5a1cb 100644
--- a/docs/module-doc/classModuleFactory-members.html
+++ b/docs/module-doc/classModuleFactory-members.html
@@ -5,7 +5,7 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
ModuleFactory Member List
This is the complete list of members for ModuleFactory, including all inherited members.
Generated on Sat Apr 3 16:36:17 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:30 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/classModuleFactory.html b/docs/module-doc/classModuleFactory.html
index 95eeb5b0d..c880edcd0 100644
--- a/docs/module-doc/classModuleFactory.html
+++ b/docs/module-doc/classModuleFactory.html
@@ -5,7 +5,7 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
ModuleFactory Class Reference
Instantiates classes inherited from Module This class creates a class inherited from type Module, using new.
More...
@@ -34,7 +34,7 @@ This is to allow for modules to create many different variants of
-Definition at line 448 of file modules.h.
Constructor & Destructor Documentation
+Definition at line 449 of file modules.h.
Constructor & Destructor Documentation
@@ -95,9 +95,9 @@ Definition at line 451 of
-Definition at line 452 of file modules.h.
+Definition at line 453 of file modules.h.
-
00452 { }
+
@@ -134,7 +134,7 @@ Your inherited class of ModuleFactory must return a pointer to your modules.h
-
Generated on Sat Apr 3 16:36:17 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:30 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/classServer-members.html b/docs/module-doc/classServer-members.html
index c1233c02a..ed3ed4091 100644
--- a/docs/module-doc/classServer-members.html
+++ b/docs/module-doc/classServer-members.html
@@ -5,10 +5,10 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
Server Member List
This is the complete list of members for Server, including all inherited members.
| AddCommand(char *cmd, handlerfunc f, char flags, int minparams) | Server | [virtual] |
- | AddExtendedMode(char modechar, int type, bool default_on, int params_when_on, int params_when_off) | Server | [virtual] |
+ | AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off) | Server | [virtual] |
| age | classbase | |
| ChanMode(userrec *User, chanrec *Chan) | Server | [virtual] |
| classbase() | classbase | [inline] |
@@ -32,7 +32,7 @@
| Server() | Server | |
| ~classbase() | classbase | [inline] |
| ~Server() | Server | [virtual] |
-
Generated on Sat Apr 3 16:36:18 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:31 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html
index aaef1907f..bd4fd72ff 100644
--- a/docs/module-doc/classServer.html
+++ b/docs/module-doc/classServer.html
@@ -5,7 +5,7 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
Server Class Reference
Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers.
More...
@@ -60,7 +60,7 @@ Inheritance diagram for Server:
| virtual Admin | GetAdmin () |
| | Returns the information of the server as returned by the /ADMIN command.
|
-| virtual bool | AddExtendedMode (char modechar, int type, bool default_on, int params_when_on, int params_when_off) |
+| virtual bool | AddExtendedMode (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off) |
| | Adds an extended mode letter which is parsed by a module This allows modules to add extra mode letters, e.g.
|
| virtual void | AddCommand (char *cmd, handlerfunc f, char flags, int minparams) |
| | Adds a command to the command table.
|
@@ -104,10 +104,10 @@ Default constructor.
Creates a Server object.
-Definition at line 111 of file modules.cpp.
+Definition at line 125 of file modules.cpp.
-
00112 {
-00113 }
+
@@ -140,10 +140,10 @@ Default destructor.
Destroys a Server object.
-Definition at line 115 of file modules.cpp.
+Definition at line 129 of file modules.cpp.
-
00116 {
-00117 }
+
@@ -201,13 +201,13 @@ This allows modules to add extra commands into the command table. You must place
typedef void (handlerfunc) (char**, int, userrec*); ... void handle_kill(char **parameters, int pcnt, userrec *user)
When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'.
-Definition at line 129 of file modules.cpp.
+Definition at line 143 of file modules.cpp.
References createcommand().
-
00130 {
-00131 createcommand(cmd,f,flags,minparams);
-00132 }
+
@@ -232,7 +232,7 @@ References createcommand().
|
|
bool |
- default_on, |
+ requires_oper, |
|
@@ -266,15 +266,30 @@ References createcommand().
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. default_on is true if the mode is to be applied to default connections. 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 +b, 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 230 of file modules.cpp.
-
-References DoAddExtendedMode().
-
-
00231 {
-00232 return DoAddExtendedMode(modechar,type,default_on,params_when_on,params_when_off);
-00233 }
++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 244 of file modules.cpp.
+
+References DoAddExtendedMode(), MT_CLIENT, and MT_SERVER.
+
+
00245 {
+00246 if (type == MT_SERVER)
+00247 {
+00248 log(DEBUG,"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion");
+00249 return false;
+00250 }
+00251 if (((params_when_on>0) || (params_when_off>0)) && (type == MT_CLIENT))
+00252 {
+00253 log(DEBUG,"*** API ERROR *** Parameters on MT_CLIENT modes are not supported");
+00254 return false;
+00255 }
+00256 if ((params_when_on>1) || (params_when_off>1))
+00257 {
+00258 log(DEBUG,"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported");
+00259 return false;
+00260 }
+00261 return DoAddExtendedMode(modechar,type,requires_oper,params_when_on,params_when_off);
+00262 }
@@ -317,11 +332,11 @@ 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 208 of file modules.cpp.
+Definition at line 222 of file modules.cpp.
-
00209 {
-00210 return cmode(User,Chan);
-00211 }
+00223 {
+00224 return cmode(User,Chan);
+00225 }
This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method.
-Definition at line 171 of file modules.cpp.
+Definition at line 185 of file modules.cpp.
-
00172 {
-00173 return (common_channels(u1,u2) != 0);
-00174 }
+00186 {
+00187 return (common_channels(u1,u2) != 0);
+00188 }
This function will return NULL if the channel does not exist.
-Definition at line 203 of file modules.cpp.
+Definition at line 217 of file modules.cpp.
-
00204 {
-00205 return FindChan(channel.c_str());
-00206 }
+00218 {
+00219 return FindChan(channel.c_str());
+00220 }
This function will return NULL if the nick does not exist.
-Definition at line 198 of file modules.cpp.
+Definition at line 212 of file modules.cpp.
-
00199 {
-00200 return Find(nick);
-00201 }
+00213 {
+00214 return Find(nick);
+00215 }
See the Admin class for further information of the return value. The members Admin::Nick, Admin::Email and Admin::Name contain the information for the server where the module is loaded.
-Definition at line 223 of file modules.cpp.
+Definition at line 237 of file modules.cpp.
-
00224 {
-00225 return Admin(getadminname(),getadminemail(),getadminnick());
-00226 }
+00238 {
+00239 return Admin(getadminname(),getadminemail(),getadminnick());
+00240 }
-Definition at line 218 of file modules.cpp.
+Definition at line 232 of file modules.cpp.
-
00219 {
-00220 return getnetworkname();
-00221 }
+00233 {
+00234 return getnetworkname();
+00235 }
-Definition at line 213 of file modules.cpp.
+Definition at line 227 of file modules.cpp.
-
00214 {
-00215 return getservername();
-00216 }
+00228 {
+00229 return getservername();
+00230 }
Nicks for unregistered connections will return false.
-Definition at line 193 of file modules.cpp.
+Definition at line 207 of file modules.cpp.
-
00194 {
-00195 return (isnick(nick.c_str()) != 0);
-00196 }
+00208 {
+00209 return (isnick(nick.c_str()) != 0);
+00210 }
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 124 of file modules.cpp.
+Definition at line 138 of file modules.cpp.
-
00125 {
-00126 log(level,"%s",s.c_str());
-00127 }
+00139 {
+00140 log(level,"%s",s.c_str());
+00141 }
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 139 of file modules.cpp.
+Definition at line 153 of file modules.cpp.
-
00140 {
-00141 Write(Socket,"%s",s.c_str());
-00142 }
+00154 {
+00155 Write(Socket,"%s",s.c_str());
+00156 }
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 159 of file modules.cpp.
-
-
00160 {
-00161 if (IncludeSender)
-00162 {
-00163 WriteChannel(Channel,User,"%s",s.c_str());
-00164 }
-00165 else
-00166 {
-00167 ChanExceptSender(Channel,User,"%s",s.c_str());
-00168 }
-00169 }
+Definition at line 173 of file modules.cpp.
+
+
00174 {
+00175 if (IncludeSender)
+00176 {
+00177 WriteChannel(Channel,User,"%s",s.c_str());
+00178 }
+00179 else
+00180 {
+00181 ChanExceptSender(Channel,User,"%s",s.c_str());
+00182 }
+00183 }
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 176 of file modules.cpp.
-
-
00177 {
-00178 if (IncludeSender)
-00179 {
-00180 WriteCommon(User,"%s",text.c_str());
-00181 }
-00182 else
-00183 {
-00184 WriteCommonExcept(User,"%s",text.c_str());
-00185 }
-00186 }
+Definition at line 190 of file modules.cpp.
+
+
00191 {
+00192 if (IncludeSender)
+00193 {
+00194 WriteCommon(User,"%s",text.c_str());
+00195 }
+00196 else
+00197 {
+00198 WriteCommonExcept(User,"%s",text.c_str());
+00199 }
+00200 }
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 149 of file modules.cpp.
+Definition at line 163 of file modules.cpp.
-
00150 {
-00151 WriteFrom(Socket,User,"%s",s.c_str());
-00152 }
+00164 {
+00165 WriteFrom(Socket,User,"%s",s.c_str());
+00166 }
Srv->SendMode(modes,3,user);
The modes will originate from the server where the command was issued, however responses (e.g. numerics) will be sent to the user you provide as the third parameter. You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave your server in an unstable state!
-Definition at line 134 of file modules.cpp.
+Definition at line 148 of file modules.cpp.
References server_mode().
-
00135 {
-00136 server_mode(parameters,pcnt,user);
-00137 }
+00149 {
+00150 server_mode(parameters,pcnt,user);
+00151 }
This method sends a server notice to all opers with the usermode +s.
-Definition at line 119 of file modules.cpp.
+Definition at line 133 of file modules.cpp.
-
00120 {
-00121 WriteOpers("%s",s.c_str());
-00122 }
+00134 {
+00135 WriteOpers("%s",s.c_str());
+00136 }
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 144 of file modules.cpp.
+Definition at line 158 of file modules.cpp.
-
diff --git a/docs/module-doc/users_8cpp-source.html b/docs/module-doc/users_8cpp-source.html
index 692328224..2c4d80069 100644
--- a/docs/module-doc/users_8cpp-source.html
+++ b/docs/module-doc/users_8cpp-source.html
@@ -5,7 +5,7 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
users.cpp
Go to the documentation of this file.00001
00002
00003
@@ -77,18 +77,22 @@
00069
00070 void userrec::RemoveInvite(char* channel)
00071 {
-00072 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
-00073 {
-00074 if (i->channel) {
-00075 if (!strcasecmp(i->channel,channel))
-00076 {
-00077 invites.erase(i);
-00078 return;
-00079 }
-00080 }
-00081 }
-00082 }
-
Generated on Sat Apr 3 16:36:03 2004 for InspIRCd by
+00072 log(DEBUG,"Removing invites");
+00073 if (invites.size())
+00074 {
+00075 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
+00076 {
+00077 if (i->channel) {
+00078 if (!strcasecmp(i->channel,channel))
+00079 {
+00080 invites.erase(i);
+00081 return;
+00082 }
+00083 }
+00084 }
+00085 }
+00086 }
+
Generated on Sun Apr 4 23:02:14 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/users_8cpp.html b/docs/module-doc/users_8cpp.html
index 8368c0d9a..dd871ec7c 100644
--- a/docs/module-doc/users_8cpp.html
+++ b/docs/module-doc/users_8cpp.html
@@ -5,7 +5,7 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
users.cpp File Reference
#include "inspircd_config.h"
#include "channels.h"
#include "users.h"
@@ -15,17 +15,17 @@
Include dependency graph for users.cpp:
Go to the source code of this file.
-
Generated on Sat Apr 3 16:36:08 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:20 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/users_8cpp__incl.gif b/docs/module-doc/users_8cpp__incl.gif
index 531db1ebb..8b2adf33d 100644
Binary files a/docs/module-doc/users_8cpp__incl.gif and b/docs/module-doc/users_8cpp__incl.gif differ
diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html
index 9edbfa2da..e3b4b4ddf 100644
--- a/docs/module-doc/users_8h-source.html
+++ b/docs/module-doc/users_8h-source.html
@@ -5,7 +5,7 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
users.h
Go to the documentation of this file.
Generated on Sat Apr 3 16:36:03 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:14 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/users_8h.html b/docs/module-doc/users_8h.html
index 6e0f0e5e8..b00362508 100644
--- a/docs/module-doc/users_8h.html
+++ b/docs/module-doc/users_8h.html
@@ -5,7 +5,7 @@
-Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
+Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
users.h File Reference
#include "inspircd_config.h"
#include "channels.h"
#include "connection.h"
@@ -245,7 +245,7 @@ Holds a complete list of all channels to which a user has been invited and has n
Definition at line 44 of file users.h.
-
Generated on Sat Apr 3 16:36:08 2004 for InspIRCd by
+
Generated on Sun Apr 4 23:02:21 2004 for InspIRCd by
1.3-rc3
diff --git a/docs/module-doc/users_8h__incl.gif b/docs/module-doc/users_8h__incl.gif
index 132ac7120..2a8e2eacc 100644
Binary files a/docs/module-doc/users_8h__incl.gif and b/docs/module-doc/users_8h__incl.gif differ
--
cgit v1.3.1-10-gc9f91
