| Admin | Holds /ADMIN data This class contains the admin details of the local server |
| BanItem | A subclass of HostItem designed to hold channel bans (+b) |
| chanrec | Holds all relevent information for a channel |
| ConfigReader | Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file |
| ConnectClass | Holds information relevent to <connect allow> and <connect deny> tags in the config file |
| ExemptItem | A subclass of HostItem designed to hold channel exempts (+e) |
| FileReader | Caches a text file into memory and can be used to retrieve lines from it |
| HostItem | Holds an entry for a ban list, exemption list, or invite list |
| Invited | Holds a channel name to which a user has been invited |
| InviteItem | A subclass of HostItem designed to hold channel invites (+I) |
| Module | Base class for all InspIRCd modules This class is the base class for InspIRCd modules |
| ModuleFactory | Instantiates classes inherited from Module This class creates a class inherited from type Module, using new |
| Server | 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 |
| ucrec | Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class |
| userrec | Holds all information about a user This class stores all information about a user connected to the irc server |
| Version | Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module |
1.3-rc2
+
+
diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html
new file mode 100644
index 000000000..ba7592c81
--- /dev/null
+++ b/docs/module-doc/channels_8h-source.html
@@ -0,0 +1,146 @@
+
+
+00001 /* +00002 +00003 $Log$ +00003 Revision 1.1 2003/01/23 19:45:57 brain +00003 Initial revision +00003 +00003 Revision 1.6 2003/01/22 20:59:12 brain +00003 Added FileReader class documentation +00003 +00004 Revision 1.7 2003/01/22 00:44:26 brain +00005 Added documentation comments +00006 +00007 Revision 1.6 2003/01/21 21:11:17 brain +00008 Added documentation +00009 +00010 Revision 1.5 2003/01/16 20:11:55 brain +00011 fixed some ugly pointer bugs (thanks dblack and a|KK|y!) +00012 +00013 Revision 1.4 2003/01/15 22:47:44 brain +00014 Changed user and channel structs to classes (finally) +00015 +00016 +00017 */ +00018 +00019 #include "inspircd_config.h" +00020 #include <time.h> +00021 #include <vector> +00022 +00023 #ifndef __CHANNELS_H__ +00024 #define __CHANNELS_H__ +00025 +00029 class HostItem +00030 { +00031 public: +00032 time_t set_time; +00033 char set_by[NICKMAX]; +00034 char data[MAXBUF]; +00035 +00036 HostItem() { /* stub */ } +00037 virtual ~HostItem() { /* stub */ } +00038 }; +00039 +00040 // banlist is inherited from HostList mainly for readability +00041 // reasons only +00042 +00045 class BanItem : public HostItem +00046 { +00047 }; +00048 +00049 // same with this... +00050 +00053 class ExemptItem : public HostItem +00054 { +00055 }; +00056 +00057 // and this... +00058 +00061 class InviteItem : public HostItem +00062 { +00063 }; +00064 +00065 +00068 typedef vector<BanItem> BanList; +00069 +00072 typedef vector<ExemptItem> ExemptList; +00073 +00076 typedef vector<InviteItem> InviteList; +00077 +00082 class chanrec +00083 { +00084 public: +00087 char name[CHANMAX]; /* channel name */ +00091 char custom_modes[MAXMODES]; /* modes handled by modules */ +00095 char topic[MAXBUF]; +00098 time_t created; +00102 time_t topicset; +00106 char setby[NICKMAX]; +00107 +00111 long limit; +00112 +00116 char key[32]; +00117 +00120 short int topiclock; +00121 +00124 short int noexternal; +00125 +00128 short int inviteonly; +00129 +00132 short int moderated; +00133 +00137 short int secret; +00138 +00142 short int c_private; +00143 +00146 BanList bans; +00147 +00150 chanrec() +00151 { +00152 strcpy(name,""); +00153 strcpy(custom_modes,""); +00154 strcpy(topic,""); +00155 strcpy(setby,""); +00156 strcpy(key,""); +00157 created = topicset = limit = 0; +00158 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; +00159 } +00160 +00161 virtual ~chanrec() { /* stub */ } +00162 }; +00163 +00164 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o +00165 * needs to come AFTER struct chanrec */ +00166 +00167 #define UCMODE_OP 1 +00168 #define UCMODE_VOICE 2 +00169 #define UCMODE_HOP 4 +00170 #define UCMODE_PROTECT 8 +00171 #define UCMODE_FOUNDER 16 +00172 +00178 class ucrec +00179 { +00180 public: +00184 long uc_modes; +00185 +00189 chanrec *channel; +00190 +00191 ucrec() { /* stub */ } +00192 virtual ~ucrec() { /* stub */ } +00193 }; +00194 +00195 #endif +00196 +
1.3-rc2
+
+
diff --git a/docs/module-doc/channels_8h.html b/docs/module-doc/channels_8h.html
new file mode 100644
index 000000000..1eadc5857
--- /dev/null
+++ b/docs/module-doc/channels_8h.html
@@ -0,0 +1,248 @@
+
+
+#include "inspircd_config.h"#include <time.h>#include <vector>+Go to the source code of this file.
Compounds | |
| class | BanItem |
| A subclass of HostItem designed to hold channel bans (+b). More... | |
| class | chanrec |
| Holds all relevent information for a channel. More... | |
| class | ExemptItem |
| A subclass of HostItem designed to hold channel exempts (+e). More... | |
| class | HostItem |
| Holds an entry for a ban list, exemption list, or invite list. More... | |
| class | InviteItem |
| A subclass of HostItem designed to hold channel invites (+I). More... | |
| class | ucrec |
| Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class. More... | |
Defines | |
| #define | UCMODE_OP 1 |
| #define | UCMODE_VOICE 2 |
| #define | UCMODE_HOP 4 |
| #define | UCMODE_PROTECT 8 |
| #define | UCMODE_FOUNDER 16 |
Typedefs | |
| typedef vector< BanItem > | BanList |
| Holds a complete ban list. | |
| typedef vector< ExemptItem > | ExemptList |
| Holds a complete exempt list. | |
| typedef vector< InviteItem > | InviteList |
| Holds a complete invite list. | |
+
+
|
+
| + + | +
+
+ + + +Definition at line 171 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 169 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 167 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 170 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 168 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Holds a complete ban list. + + + +Definition at line 68 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Holds a complete exempt list. + + + +Definition at line 72 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Holds a complete invite list. + + + +Definition at line 76 of file channels.h. |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classAdmin-members.html b/docs/module-doc/classAdmin-members.html
new file mode 100644
index 000000000..39b406601
--- /dev/null
+++ b/docs/module-doc/classAdmin-members.html
@@ -0,0 +1,19 @@
+
+
+| Admin(string name, string email, string nick) | Admin | |
| Admin | ||
| Name | Admin | |
| Nick | Admin |
1.3-rc2
+
+
diff --git a/docs/module-doc/classAdmin.html b/docs/module-doc/classAdmin.html
new file mode 100644
index 000000000..663193311
--- /dev/null
+++ b/docs/module-doc/classAdmin.html
@@ -0,0 +1,160 @@
+
+
+
+#include <modules.h>
+
Public Methods | |
| Admin (string name, string email, string nick) | |
Public Attributes | |
| const string | Name |
| const string | |
| const string | Nick |
+It is constructed by class Server, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running. +
+ +
+Definition at line 67 of file modules.h.
+
+
|
+ ||||||||||||||||
| + + | +
+
+ + + +Definition at line 33 of file modules.cpp. + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classBanItem-members.html b/docs/module-doc/classBanItem-members.html
new file mode 100644
index 000000000..11295cdc7
--- /dev/null
+++ b/docs/module-doc/classBanItem-members.html
@@ -0,0 +1,20 @@
+
+
+| data | HostItem | |
| HostItem() | HostItem | [inline] |
| set_by | HostItem | |
| set_time | HostItem | |
| ~HostItem() | HostItem | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classBanItem.html b/docs/module-doc/classBanItem.html
new file mode 100644
index 000000000..194010968
--- /dev/null
+++ b/docs/module-doc/classBanItem.html
@@ -0,0 +1,34 @@
+
+
+
+#include <channels.h>
+
+
Inheritance diagram for BanItem: +
+ +
+Definition at line 45 of file channels.h.
1.3-rc2
+
+
diff --git a/docs/module-doc/classBanItem.png b/docs/module-doc/classBanItem.png
new file mode 100644
index 000000000..e0a7f35b2
Binary files /dev/null and b/docs/module-doc/classBanItem.png differ
diff --git a/docs/module-doc/classConfigReader-members.html b/docs/module-doc/classConfigReader-members.html
new file mode 100644
index 000000000..d27bbd43e
--- /dev/null
+++ b/docs/module-doc/classConfigReader-members.html
@@ -0,0 +1,22 @@
+
+
+| ConfigReader() | ConfigReader | |
| ConfigReader(string filename) | ConfigReader | |
| Enumerate(string tag) | ConfigReader | |
| fname | ConfigReader | [protected] |
| ReadValue(string tag, string name, int index) | ConfigReader | |
| Verify() | ConfigReader | |
| ~ConfigReader() | ConfigReader |
1.3-rc2
+
+
diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html
new file mode 100644
index 000000000..f0221a1a1
--- /dev/null
+++ b/docs/module-doc/classConfigReader.html
@@ -0,0 +1,324 @@
+
+
+
+#include <modules.h>
+
Public Methods | |
| ConfigReader () | |
| Default constructor. | |
| ConfigReader (string filename) | |
| Overloaded constructor. | |
| ~ConfigReader () | |
| Default destructor. | |
| string | ReadValue (string tag, string name, int index) |
| Retrieves a value from the config file. | |
| int | Enumerate (string tag) |
| Counts the number of times a given tag appears in the config file. | |
| bool | Verify () |
| Returns true if a config file is valid. | |
Protected Attributes | |
| string | fname |
| The filename of the configuration file, as set by the constructor. | |
+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. +
+ +
+Definition at line 226 of file modules.h.
+
+
|
+
| + + | +
+
+ +Default constructor. + +This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure. + +Definition at line 161 of file modules.cpp. + +References fname. + + 00162 {
+00163 fname = CONFIG_FILE;
+00164 }
+ |
+
+
+
|
+
| + + | +
+
+ +Overloaded constructor. + +This constructor initialises the ConfigReader class to read a user-specified config file + +Definition at line 172 of file modules.cpp. + + 00172 : fname(filename) { }; + |
+
+
+
|
+
| + + | +
+
+ +Default destructor. + +This method destroys the ConfigReader class. + +Definition at line 167 of file modules.cpp. + + 00168 {
+00169 }
+ |
+
+
+
|
+
| + + | +
+
+ +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 ConfigReader::ReadValue to loop through all copies of a multiple instance tag. + +Definition at line 183 of file modules.cpp. + +References fname. + + 00184 {
+00185 return EnumConf(fname.c_str(),tag.c_str());
+00186 }
+ |
+
+
+
|
+ ||||||||||||||||
| + + | +
+
+ +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 174 of file modules.cpp. + +References fname. + + 00175 {
+00176 char val[MAXBUF];
+00177 ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val);
+00178 string s = val;
+00179 return s;
+00180 }
+ |
+
+
+
|
+
| + + | +
+
+ +Returns true if a config file is valid. + +This method is unimplemented and will always return true. + +Definition at line 189 of file modules.cpp. + + 00190 {
+00191 return true;
+00192 }
+ |
+
+
+
|
+
| + + | +
+
+ +The filename of the configuration file, as set by the constructor. + + + +Definition at line 231 of file modules.h. + +Referenced by ConfigReader(), Enumerate(), and ReadValue(). |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classConnectClass-members.html b/docs/module-doc/classConnectClass-members.html
new file mode 100644
index 000000000..f8b7a913a
--- /dev/null
+++ b/docs/module-doc/classConnectClass-members.html
@@ -0,0 +1,18 @@
+
+
+| host | ConnectClass | |
| pass | ConnectClass | |
| type | ConnectClass |
1.3-rc2
+
+
diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html
new file mode 100644
index 000000000..7fd64062e
--- /dev/null
+++ b/docs/module-doc/classConnectClass.html
@@ -0,0 +1,106 @@
+
+
+
+#include <users.h>
+
Public Attributes | |
| int | type |
| char | host [MAXBUF] |
| char | pass [MAXBUF] |
+ +
+Definition at line 56 of file users.h.
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classExemptItem-members.html b/docs/module-doc/classExemptItem-members.html
new file mode 100644
index 000000000..37ac533e3
--- /dev/null
+++ b/docs/module-doc/classExemptItem-members.html
@@ -0,0 +1,20 @@
+
+
+| data | HostItem | |
| HostItem() | HostItem | [inline] |
| set_by | HostItem | |
| set_time | HostItem | |
| ~HostItem() | HostItem | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classExemptItem.html b/docs/module-doc/classExemptItem.html
new file mode 100644
index 000000000..de865231d
--- /dev/null
+++ b/docs/module-doc/classExemptItem.html
@@ -0,0 +1,34 @@
+
+
+
+#include <channels.h>
+
+
Inheritance diagram for ExemptItem: +
+ +
+Definition at line 53 of file channels.h.
1.3-rc2
+
+
diff --git a/docs/module-doc/classExemptItem.png b/docs/module-doc/classExemptItem.png
new file mode 100644
index 000000000..6aa67a9ef
Binary files /dev/null and b/docs/module-doc/classExemptItem.png differ
diff --git a/docs/module-doc/classFileReader-members.html b/docs/module-doc/classFileReader-members.html
new file mode 100644
index 000000000..e61cf78d8
--- /dev/null
+++ b/docs/module-doc/classFileReader-members.html
@@ -0,0 +1,22 @@
+
+
+| fc | FileReader | [private] |
| FileReader() | FileReader | |
| FileReader(string filename) | FileReader | |
| FileSize() | FileReader | |
| GetLine(int x) | FileReader | |
| LoadFile(string filename) | FileReader | |
| ~FileReader() | FileReader |
1.3-rc2
+
+
diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html
new file mode 100644
index 000000000..ee84a6d74
--- /dev/null
+++ b/docs/module-doc/classFileReader.html
@@ -0,0 +1,312 @@
+
+
+
+#include <modules.h>
+
Public Methods | |
| FileReader () | |
| Default constructor. | |
| FileReader (string filename) | |
| Secondary constructor. | |
| ~FileReader () | |
| Default destructor. | |
| void | LoadFile (string filename) |
| Used to load a file. | |
| string | GetLine (int x) |
| Retrieve one line from the file. | |
| int | FileSize () |
| Returns the size of the file in lines. | |
Private Attributes | |
| file_cache | fc |
+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. +
+ +
+Definition at line 271 of file modules.h.
+
+
|
+
| + + | +
+
+ +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 202 of file modules.cpp. + + 00203 {
+00204 }
+ |
+
+
+
|
+
| + + | +
+
+ +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, FileReader::FileSize returns 0. + +Definition at line 195 of file modules.cpp. + +References fc, and file_cache. + + 00196 {
+00197 file_cache c;
+00198 readfile(c,filename.c_str());
+00199 this->fc = c;
+00200 }
+ |
+
+
+
|
+
| + + | +
+
+ +Default destructor. + +This deletes the memory allocated to the file. + +Definition at line 213 of file modules.cpp. + + 00214 {
+00215 }
+ |
+
+
+
|
+
| + + | +
+
+ +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 224 of file modules.cpp. + +References fc. + + 00225 {
+00226 return fc.size();
+00227 }
+ |
+
+
+
|
+
| + + | +
+
+ +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 217 of file modules.cpp. + +References fc. + + |
+
+
+
|
+
| + + | +
+
+ +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, FileReader::FileSize returns 0. + +Definition at line 206 of file modules.cpp. + +References fc, and file_cache. + + 00207 {
+00208 file_cache c;
+00209 readfile(c,filename.c_str());
+00210 this->fc = c;
+00211 }
+ |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 273 of file modules.h. + +Referenced by FileReader(), FileSize(), GetLine(), and LoadFile(). |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classHostItem-members.html b/docs/module-doc/classHostItem-members.html
new file mode 100644
index 000000000..bf8242760
--- /dev/null
+++ b/docs/module-doc/classHostItem-members.html
@@ -0,0 +1,20 @@
+
+
+| data | HostItem | |
| HostItem() | HostItem | [inline] |
| set_by | HostItem | |
| set_time | HostItem | |
| ~HostItem() | HostItem | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classHostItem.html b/docs/module-doc/classHostItem.html
new file mode 100644
index 000000000..de0e216f6
--- /dev/null
+++ b/docs/module-doc/classHostItem.html
@@ -0,0 +1,185 @@
+
+
+
+#include <channels.h>
+
+
Inheritance diagram for HostItem: +
Public Methods | |
| HostItem () | |
| virtual | ~HostItem () |
Public Attributes | |
| time_t | set_time |
| char | set_by [NICKMAX] |
| char | data [MAXBUF] |
+This class contains a single element in a channel list, such as a banlist. +
+ +
+Definition at line 29 of file channels.h.
+
+
|
+
| + + | +
+
+ + + +Definition at line 36 of file channels.h. + + 00036 { /* stub */ }
+ |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 37 of file channels.h. + + 00037 { /* stub */ }
+ |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 34 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 33 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 32 of file channels.h. |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classHostItem.png b/docs/module-doc/classHostItem.png
new file mode 100644
index 000000000..99f88aacd
Binary files /dev/null and b/docs/module-doc/classHostItem.png differ
diff --git a/docs/module-doc/classInviteItem-members.html b/docs/module-doc/classInviteItem-members.html
new file mode 100644
index 000000000..a65d27fc8
--- /dev/null
+++ b/docs/module-doc/classInviteItem-members.html
@@ -0,0 +1,20 @@
+
+
+| data | HostItem | |
| HostItem() | HostItem | [inline] |
| set_by | HostItem | |
| set_time | HostItem | |
| ~HostItem() | HostItem | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classInviteItem.html b/docs/module-doc/classInviteItem.html
new file mode 100644
index 000000000..80336bca9
--- /dev/null
+++ b/docs/module-doc/classInviteItem.html
@@ -0,0 +1,34 @@
+
+
+
+#include <channels.h>
+
+
Inheritance diagram for InviteItem: +
+ +
+Definition at line 61 of file channels.h.
1.3-rc2
+
+
diff --git a/docs/module-doc/classInviteItem.png b/docs/module-doc/classInviteItem.png
new file mode 100644
index 000000000..8ebdd8403
Binary files /dev/null and b/docs/module-doc/classInviteItem.png differ
diff --git a/docs/module-doc/classInvited-members.html b/docs/module-doc/classInvited-members.html
new file mode 100644
index 000000000..bd4003b69
--- /dev/null
+++ b/docs/module-doc/classInvited-members.html
@@ -0,0 +1,16 @@
+
+
+| channel | Invited |
1.3-rc2
+
+
diff --git a/docs/module-doc/classInvited.html b/docs/module-doc/classInvited.html
new file mode 100644
index 000000000..c6d945068
--- /dev/null
+++ b/docs/module-doc/classInvited.html
@@ -0,0 +1,58 @@
+
+
+
+#include <users.h>
+
Public Attributes | |
| char | channel [CHANMAX] |
+ +
+Definition at line 47 of file users.h.
+
+
|
+
| + + | +
+
+ + + +Definition at line 50 of file users.h. + +Referenced by userrec::InviteTo(). |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classModule-members.html b/docs/module-doc/classModule-members.html
new file mode 100644
index 000000000..3a1f87ed4
--- /dev/null
+++ b/docs/module-doc/classModule-members.html
@@ -0,0 +1,22 @@
+
+
+| GetVersion() | Module | [virtual] |
| Module() | Module | |
| OnUserConnect(userrec *user) | Module | [virtual] |
| OnUserJoin(userrec *user, chanrec *channel) | Module | [virtual] |
| OnUserPart(userrec *user, chanrec *channel) | Module | [virtual] |
| OnUserQuit(userrec *user) | Module | [virtual] |
| ~Module() | Module | [virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html
new file mode 100644
index 000000000..519fbeb27
--- /dev/null
+++ b/docs/module-doc/classModule.html
@@ -0,0 +1,315 @@
+
+
+
+#include <modules.h>
+
Public Methods | |
| Module () | |
| Default constructor creates a module class. | |
| virtual | ~Module () |
| Default destructor destroys a module class. | |
| virtual Version | GetVersion () |
| Returns the version number of a Module. | |
| virtual void | OnUserConnect (userrec *user) |
| Called when a user connects. | |
| virtual void | OnUserQuit (userrec *user) |
| Called when a user quits. | |
| virtual void | OnUserJoin (userrec *user, chanrec *channel) |
| Called when a user joins a channel. | |
| virtual void | OnUserPart (userrec *user, chanrec *channel) |
| Called when a user parts a channel. | |
+All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised. +
+ +
+Definition at line 79 of file modules.h.
+
+
|
+
| + + | +
+
+ +Default constructor creates a module class. + + + +Definition at line 40 of file modules.cpp. + + 00040 { }
+ |
+
+
+
|
+
| + + | +
+
+ +Default destructor destroys a module class. + + + +Definition at line 41 of file modules.cpp. + + 00041 { }
+ |
+
+
+
|
+
| + + | +
+
+ +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 46 of file modules.cpp. + + 00046 { return Version(1,0,0,0); }
+ |
+
+
+
|
+
| + + | +
+
+ +Called when a user connects. + +The details of the connecting user are available to you in the parameter userrec *user + +Definition at line 42 of file modules.cpp. + + 00042 { }
+ |
+
+
+
|
+ ||||||||||||
| + + | +
+
+ +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 44 of file modules.cpp. + + 00044 { }
+ |
+
+
+
|
+ ||||||||||||
| + + | +
+
+ +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 45 of file modules.cpp. + + 00045 { }
+ |
+
+
+
|
+
| + + | +
+
+ +Called when a user quits. + +The details of the exiting user are available to you in the parameter userrec *user + +Definition at line 43 of file modules.cpp. + + 00043 { }
+ |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classModuleFactory-members.html b/docs/module-doc/classModuleFactory-members.html
new file mode 100644
index 000000000..bd8a7618c
--- /dev/null
+++ b/docs/module-doc/classModuleFactory-members.html
@@ -0,0 +1,18 @@
+
+
+| CreateModule()=0 | ModuleFactory | [pure virtual] |
| ModuleFactory() | ModuleFactory | [inline] |
| ~ModuleFactory() | ModuleFactory | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classModuleFactory.html b/docs/module-doc/classModuleFactory.html
new file mode 100644
index 000000000..12bf82cef
--- /dev/null
+++ b/docs/module-doc/classModuleFactory.html
@@ -0,0 +1,134 @@
+
+
+
+#include <modules.h>
+
Public Methods | |
| ModuleFactory () | |
| virtual | ~ModuleFactory () |
| virtual Module * | CreateModule ()=0 |
| Creates a new module. | |
+This is to allow for modules to create many different variants of Module, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules. +
+ +
+Definition at line 316 of file modules.h.
+
+
|
+
| + + | +
+
+ + + +Definition at line 319 of file modules.h. + + 00319 { }
+ |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 320 of file modules.h. + + 00320 { }
+ |
+
+
+
|
+
| + + | +
+
+ +Creates a new module. + +Your inherited class of ModuleFactory must return a pointer to your Module class using this method. |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classServer-members.html b/docs/module-doc/classServer-members.html
new file mode 100644
index 000000000..63c331106
--- /dev/null
+++ b/docs/module-doc/classServer-members.html
@@ -0,0 +1,34 @@
+
+
+| ChanMode(userrec *User, chanrec *Chan) | Server | [virtual] |
| CommonChannels(userrec *u1, userrec *u2) | Server | [virtual] |
| Debug(string s) | Server | [virtual] |
| FindChannel(string channel) | Server | [virtual] |
| FindNick(string nick) | Server | [virtual] |
| GetAdmin() | Server | [virtual] |
| GetNetworkName() | Server | [virtual] |
| GetServerName() | Server | [virtual] |
| IsNick(string nick) | Server | [virtual] |
| Send(int Socket, string s) | Server | [virtual] |
| SendChannel(userrec *User, chanrec *Channel, string s, bool IncludeSender) | Server | [virtual] |
| SendCommon(userrec *User, string text, bool IncludeSender) | Server | [virtual] |
| SendFrom(int Socket, userrec *User, string s) | Server | [virtual] |
| SendOpers(string s) | Server | [virtual] |
| SendServ(int Socket, string s) | Server | [virtual] |
| SendTo(userrec *Source, userrec *Dest, string s) | Server | [virtual] |
| SendWallops(userrec *User, string text) | Server | [virtual] |
| Server() | Server | |
| ~Server() | Server | [virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classServer.html b/docs/module-doc/classServer.html
new file mode 100644
index 000000000..d7a809046
--- /dev/null
+++ b/docs/module-doc/classServer.html
@@ -0,0 +1,913 @@
+
+
+
+#include <modules.h>
+
Public Methods | |
| Server () | |
| Default constructor. | |
| virtual | ~Server () |
| Default destructor. | |
| virtual void | SendOpers (string s) |
| Sends text to all opers. | |
| virtual void | Debug (string s) |
| Sends a debug string. | |
| virtual void | Send (int Socket, string s) |
| Sends a line of text down a TCP/IP socket. | |
| virtual void | SendServ (int Socket, string s) |
| Sends text from the server to a socket. | |
| virtual void | SendFrom (int Socket, userrec *User, string s) |
| Sends text from a user to a socket. | |
| virtual void | SendTo (userrec *Source, userrec *Dest, string s) |
| Sends text from a user to another user. | |
| virtual void | SendChannel (userrec *User, chanrec *Channel, string s, bool IncludeSender) |
| Sends text from a user to a channel (mulicast). | |
| virtual bool | CommonChannels (userrec *u1, userrec *u2) |
| Returns true if two users share a common channel. | |
| virtual void | SendCommon (userrec *User, string text, bool IncludeSender) |
| Sends text from a user to one or more channels (mulicast). | |
| virtual void | SendWallops (userrec *User, string text) |
| Sends a WALLOPS message. | |
| virtual bool | IsNick (string nick) |
| Returns true if a nick is valid. | |
| virtual userrec * | FindNick (string nick) |
| Attempts to look up a nick and return a pointer to it. | |
| virtual chanrec * | FindChannel (string channel) |
| Attempts to look up a channel and return a pointer to it. | |
| virtual string | ChanMode (userrec *User, chanrec *Chan) |
| Attempts to look up a user's privilages on a channel. | |
| virtual string | GetServerName () |
| Returns the server name of the server where the module is loaded. | |
| virtual string | GetNetworkName () |
| Returns the network name, global to all linked servers. | |
| virtual Admin | GetAdmin () |
| Returns the information of the server as returned by the /ADMIN command. | |
+All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. +
+ +
+Definition at line 121 of file modules.h.
+
+
|
+
| + + | +
+
+ +Default constructor. + +Creates a Server object. + +Definition at line 52 of file modules.cpp. + + 00053 {
+00054 }
+ |
+
+
+
|
+
| + + | +
+
+ +Default destructor. + +Destroys a Server object. + +Definition at line 56 of file modules.cpp. + + 00057 {
+00058 }
+ |
+
+
+
|
+ ||||||||||||
| + + | +
+
+ +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 139 of file modules.cpp. + + 00140 {
+00141 string mode = cmode(User,Chan);
+00142 return mode;
+00143 }
+ |
+
+
+
|
+ ||||||||||||
| + + | +
+
+ +Returns true if two users share a common channel. + +This method is used internally by the NICK and QUIT commands, and the Server::SendCommon method. + +Definition at line 102 of file modules.cpp. + + 00103 {
+00104 return (common_channels(u1,u2) != 0);
+00105 }
+ |
+
+
+
|
+
| + + | +
+
+ +Sends a debug string. + +This method writes a line of text to the debug log. If debugging is disabled in the configuration, this command has no effect. + +Definition at line 65 of file modules.cpp. + + 00066 {
+00067 debug("%s",s.c_str());
+00068 }
+ |
+
+
+
|
+
| + + | +
+
+ +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 134 of file modules.cpp. + + 00135 {
+00136 return FindChan(channel.c_str());
+00137 }
+ |
+
+
+
|
+
| + + | +
+
+ +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 129 of file modules.cpp. + + 00130 {
+00131 return Find(nick);
+00132 }
+ |
+
+
+
|
+
| + + | +
+
+ +Returns the information of the server as returned by the /ADMIN command. + +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 155 of file modules.cpp. + + 00156 {
+00157 return Admin(getadminname(),getadminemail(),getadminnick());
+00158 }
+ |
+
+
+
|
+
| + + | +
+
+ +Returns the network name, global to all linked servers. + + + +Definition at line 150 of file modules.cpp. + + 00151 {
+00152 return getnetworkname();
+00153 }
+ |
+
+
+
|
+
| + + | +
+
+ +Returns the server name of the server where the module is loaded. + + + +Definition at line 145 of file modules.cpp. + + 00146 {
+00147 return getservername();
+00148 }
+ |
+
+
+
|
+
| + + | +
+
+ +Returns true if a nick is valid. + +Nicks for unregistered connections will return false. + +Definition at line 124 of file modules.cpp. + + 00125 {
+00126 return (isnick(nick.c_str()) != 0);
+00127 }
+ |
+
+
+
|
+ ||||||||||||
| + + | +
+
+ +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 70 of file modules.cpp. + + 00071 {
+00072 Write(Socket,"%s",s.c_str());
+00073 }
+ |
+
+
+
|
+ ||||||||||||||||||||
| + + | +
+
+ +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 90 of file modules.cpp. + + 00091 {
+00092 if (IncludeSender)
+00093 {
+00094 WriteChannel(Channel,User,"%s",s.c_str());
+00095 }
+00096 else
+00097 {
+00098 ChanExceptSender(Channel,User,"%s",s.c_str());
+00099 }
+00100 }
+ |
+
+
+
|
+ ||||||||||||||||
| + + | +
+
+ +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 107 of file modules.cpp. + + 00108 {
+00109 if (IncludeSender)
+00110 {
+00111 WriteCommon(User,"%s",text.c_str());
+00112 }
+00113 else
+00114 {
+00115 WriteCommonExcept(User,"%s",text.c_str());
+00116 }
+00117 }
+ |
+
+
+
|
+ ||||||||||||||||
| + + | +
+
+ +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 80 of file modules.cpp. + + 00081 {
+00082 WriteFrom(Socket,User,"%s",s.c_str());
+00083 }
+ |
+
+
+
|
+
| + + | +
+
+ +Sends text to all opers. + +This method sends a server notice to all opers with the usermode +s. + +Definition at line 60 of file modules.cpp. + + 00061 {
+00062 WriteOpers("%s",s.c_str());
+00063 }
+ |
+
+
+
|
+ ||||||||||||
| + + | +
+
+ +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 75 of file modules.cpp. + + 00076 {
+00077 WriteServ(Socket,"%s",s.c_str());
+00078 }
+ |
+
+
+
|
+ ||||||||||||||||
| + + | +
+
+ +Sends text from a user to another user. + +This method writes a line of text to a user, with a user's nick/ident /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459) + +Definition at line 85 of file modules.cpp. + + 00086 {
+00087 WriteTo(Source,Dest,"%s",s.c_str());
+00088 }
+ |
+
+
+
|
+ ||||||||||||
| + + | +
+
+ +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 119 of file modules.cpp. + + 00120 {
+00121 WriteWallOps(User,"%s",text.c_str());
+00122 }
+ |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classVersion-members.html b/docs/module-doc/classVersion-members.html
new file mode 100644
index 000000000..438f2645f
--- /dev/null
+++ b/docs/module-doc/classVersion-members.html
@@ -0,0 +1,20 @@
+
+
+| Build | Version | |
| Major | Version | |
| Minor | Version | |
| Revision | Version | |
| Version(int major, int minor, int revision, int build) | Version |
1.3-rc2
+
+
diff --git a/docs/module-doc/classVersion.html b/docs/module-doc/classVersion.html
new file mode 100644
index 000000000..3c3e53d8c
--- /dev/null
+++ b/docs/module-doc/classVersion.html
@@ -0,0 +1,191 @@
+
+
+
+#include <modules.h>
+
Public Methods | |
| Version (int major, int minor, int revision, int build) | |
Public Attributes | |
| const int | Major |
| const int | Minor |
| const int | Revision |
| const int | Build |
+A class of type Version is returned by the GetVersion method of the Module class. +
+ +
+Definition at line 54 of file modules.h.
+
+
|
+ ||||||||||||||||||||
| + + | +
+
+ + + +Definition at line 29 of file modules.cpp. + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classchanrec-members.html b/docs/module-doc/classchanrec-members.html
new file mode 100644
index 000000000..7d34a88a0
--- /dev/null
+++ b/docs/module-doc/classchanrec-members.html
@@ -0,0 +1,32 @@
+
+
+| bans | chanrec | |
| c_private | chanrec | |
| chanrec() | chanrec | [inline] |
| created | chanrec | |
| custom_modes | chanrec | |
| inviteonly | chanrec | |
| key | chanrec | |
| limit | chanrec | |
| moderated | chanrec | |
| name | chanrec | |
| noexternal | chanrec | |
| secret | chanrec | |
| setby | chanrec | |
| topic | chanrec | |
| topiclock | chanrec | |
| topicset | chanrec | |
| ~chanrec() | chanrec | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html
new file mode 100644
index 000000000..bf8299560
--- /dev/null
+++ b/docs/module-doc/classchanrec.html
@@ -0,0 +1,534 @@
+
+
+
+#include <channels.h>
+
Public Methods | |
| chanrec () | |
| Creates a channel record and initialises it with default values. | |
| virtual | ~chanrec () |
Public Attributes | |
| char | name [CHANMAX] |
| The channels name. | |
| char | custom_modes [MAXMODES] |
| Custom modes for the channel. | |
| char | topic [MAXBUF] |
| Channel topic. | |
| time_t | created |
| Creation time. | |
| time_t | topicset |
| Time topic was set. | |
| char | setby [NICKMAX] |
| The last user to set the topic. | |
| long | limit |
| Contains the channel user limit. | |
| char | key [32] |
| Contains the channel key. | |
| short int | topiclock |
| Nonzero if the mode +t is set. | |
| short int | noexternal |
| Nonzero if the mode +n is set. | |
| short int | inviteonly |
| Nonzero if the mode +i is set. | |
| short int | moderated |
| Nonzero if the mode +m is set. | |
| short int | secret |
| Nonzero if the mode +s is set. | |
| short int | c_private |
| Nonzero if the mode +p is set. | |
| BanList | bans |
| The list of all bans set on the channel. | |
+This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type. +
+ +
+Definition at line 82 of file channels.h.
+
+
|
+
| + + | +
+
+ +Creates a channel record and initialises it with default values. + + + +Definition at line 150 of file channels.h. + + 00151 {
+00152 strcpy(name,"");
+00153 strcpy(custom_modes,"");
+00154 strcpy(topic,"");
+00155 strcpy(setby,"");
+00156 strcpy(key,"");
+00157 created = topicset = limit = 0;
+00158 topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
+00159 }
+ |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 161 of file channels.h. + + 00161 { /* stub */ }
+ |
+
+
+
|
+
| + + | +
+
+ +The list of all bans set on the channel. + + + +Definition at line 146 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Nonzero if the mode +p is set. + +This value cannot be set at the same time as chanrec::secret + +Definition at line 142 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Creation time. + + + +Definition at line 98 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Custom modes for the channel. + +Plugins may use this field in any way they see fit. + +Definition at line 91 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Nonzero if the mode +i is set. + + + +Definition at line 128 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Contains the channel key. + +If this value is an empty string, there is no channel key in place. + +Definition at line 116 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Contains the channel user limit. + +If this value is zero, there is no limit in place. + +Definition at line 111 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Nonzero if the mode +m is set. + + + +Definition at line 132 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +The channels name. + + + +Definition at line 87 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Nonzero if the mode +n is set. + + + +Definition at line 124 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Nonzero if the mode +s is set. + +This value cannot be set at the same time as chanrec::c_private + +Definition at line 137 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +The last user to set the topic. + +If this member is an empty string, no topic was ever set. + +Definition at line 106 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Channel topic. + +If this is an empty string, no channel topic is set. + +Definition at line 95 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Nonzero if the mode +t is set. + + + +Definition at line 120 of file channels.h. |
+
+
+
|
+
| + + | +
+
+ +Time topic was set. + +If no topic was ever set, this will be equal to chanrec::created + +Definition at line 102 of file channels.h. |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classes.html b/docs/module-doc/classes.html
new file mode 100644
index 000000000..d305624f7
--- /dev/null
+++ b/docs/module-doc/classes.html
@@ -0,0 +1,26 @@
+
+
+
| ConfigReader |
|
|
| ||||
| Admin | ConnectClass | HostItem | Module | ucrec | ||||
|
|
| ModuleFactory | userrec | ||||
| BanItem | ExemptItem | Invited |
|
| ||||
|
| InviteItem | Server | Version | ||||
| chanrec | FileReader |
1.3-rc2
+
+
diff --git a/docs/module-doc/classucrec-members.html b/docs/module-doc/classucrec-members.html
new file mode 100644
index 000000000..43e5c1cca
--- /dev/null
+++ b/docs/module-doc/classucrec-members.html
@@ -0,0 +1,19 @@
+
+
+| channel | ucrec | |
| uc_modes | ucrec | |
| ucrec() | ucrec | [inline] |
| ~ucrec() | ucrec | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classucrec.html b/docs/module-doc/classucrec.html
new file mode 100644
index 000000000..c95b8a3b6
--- /dev/null
+++ b/docs/module-doc/classucrec.html
@@ -0,0 +1,161 @@
+
+
+
+#include <channels.h>
+
Public Methods | |
| ucrec () | |
| virtual | ~ucrec () |
Public Attributes | |
| long | uc_modes |
| Contains a bitmask of the UCMODE_OP ... | |
| chanrec * | channel |
| Points to the channel record where the given modes apply. | |
+The uc_modes member holds a bitmask of which privilages the user has on the channel, such as op, voice, etc. +
+ +
+Definition at line 178 of file channels.h.
+
+
|
+
| + + | +
+
+ + + +Definition at line 191 of file channels.h. + + 00191 { /* stub */ }
+ |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 192 of file channels.h. + + 00192 { /* stub */ }
+ |
+
+
+
|
+
| + + | +
+
+ +Points to the channel record where the given modes apply. + +If the record is not in use, this value will be NULL. + +Definition at line 189 of file channels.h. + +Referenced by userrec::userrec(). |
+
+
+
|
+
| + + | +
+
+ +Contains a bitmask of the UCMODE_OP ... + +UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel. + +Definition at line 184 of file channels.h. |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/classuserrec-members.html b/docs/module-doc/classuserrec-members.html
new file mode 100644
index 000000000..78781c9e8
--- /dev/null
+++ b/docs/module-doc/classuserrec-members.html
@@ -0,0 +1,47 @@
+
+
+| awaymsg | userrec | |
| bytes_in | userrec | |
| bytes_out | userrec | |
| chans | userrec | |
| cmds_in | userrec | |
| cmds_out | userrec | |
| dhost | userrec | |
| fd | userrec | |
| fullname | userrec | |
| GetFullHost() | userrec | [virtual] |
| GetFullRealHost() | userrec | [virtual] |
| haspassed | userrec | |
| host | userrec | |
| ident | userrec | |
| idle_lastmsg | userrec | |
| inbuf | userrec | |
| invites | userrec | [private] |
| InviteTo(char *channel) | userrec | [virtual] |
| ip | userrec | |
| IsInvited(char *channel) | userrec | [virtual] |
| lastping | userrec | |
| modes | userrec | |
| nick | userrec | |
| nping | userrec | |
| port | userrec | |
| registered | userrec | |
| RemoveInvite(char *channel) | userrec | [virtual] |
| result | userrec | |
| server | userrec | |
| signon | userrec | |
| userrec() | userrec | |
| ~userrec() | userrec | [inline, virtual] |
1.3-rc2
+
+
diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html
new file mode 100644
index 000000000..d4be7912e
--- /dev/null
+++ b/docs/module-doc/classuserrec.html
@@ -0,0 +1,1085 @@
+
+
+
+#include <users.h>
+
Public Methods | |
| userrec () | |
| virtual | ~userrec () |
| virtual char * | GetFullHost () |
| Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. | |
| virtual char * | GetFullRealHost () |
| Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. | |
| virtual bool | IsInvited (char *channel) |
| Returns true if a user is invited to a channel. | |
| virtual void | InviteTo (char *channel) |
| Adds a channel to a users invite list (invites them to a channel). | |
| virtual void | RemoveInvite (char *channel) |
| Removes a channel from a users invite list. | |
Public Attributes | |
| char | nick [NICKMAX] |
| The users nickname. | |
| unsigned long | ip |
| The users ip address in network order. | |
| char | ident [64] |
| The users ident reply. | |
| char | host [256] |
| The users hostname, or ip address in string form. | |
| char | dhost [256] |
| The host displayed to non-opers (used for cloaking etc). | |
| char | fullname [128] |
| The users full name. | |
| int | fd |
| The users file descriptor. | |
| char | modes [32] |
| The user's mode string. | |
| char | inbuf [MAXBUF] |
| The users input buffer. | |
| time_t | lastping |
| The last time the user was pinged by the core. | |
| time_t | signon |
| The users signon time. | |
| time_t | idle_lastmsg |
| The time the user last sent a message. | |
| time_t | nping |
| True if the user replied to their last ping. | |
| int | registered |
| Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command. | |
| ucrec | chans [MAXCHANS] |
| A list of the channels the user is currently on. | |
| char | server [256] |
| The server the user is connected to. | |
| char | awaymsg [512] |
| The user's away message. | |
| int | port |
| The port that the user connected to. | |
| long | bytes_in |
| Stores the number of incoming bytes from the connection. | |
| long | bytes_out |
| Stores the number of outgoing bytes to the connection. | |
| long | cmds_in |
| Stores the number of incoming commands from the connection. | |
| long | cmds_out |
| Stores the number of outgoing commands to the connection. | |
| char | result [256] |
| Stores the result of the last GetFullHost or GetRealHost call. | |
| bool | haspassed |
| True if a correct password has been given using PASS command. | |
Private Attributes | |
| InvitedList | invites |
| A list of channels the user has a pending invite to. | |
+Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname. +
+ +
+Definition at line 80 of file users.h.
+
+
|
+
| + + | +
+
+ + + +Definition at line 23 of file users.cpp. + +References bytes_in, bytes_out, ucrec::channel, chans, cmds_in, cmds_out, fd, haspassed, idle_lastmsg, invites, ip, lastping, nping, port, registered, and signon. + + 00024 {
+00025 // the PROPER way to do it, AVOID bzero at *ALL* costs
+00026 strcpy(nick,"");
+00027 ip = 0;
+00028 strcpy(ident,"");
+00029 strcpy(host,"");
+00030 strcpy(dhost,"");
+00031 strcpy(fullname,"");
+00032 strcpy(modes,"");
+00033 strcpy(inbuf,"");
+00034 strcpy(server,"");
+00035 strcpy(awaymsg,"");
+00036 fd = lastping = signon = idle_lastmsg = nping = registered = 0;
+00037 port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
+00038 haspassed = false;
+00039 strcpy(result,"");
+00040 for (int i = 0; i < MAXCHANS; i++)
+00041 {
+00042 chans[i].channel = NULL;
+00043 }
+00044 invites.clear();
+00045 }
+ |
+
+
+
|
+
| + + | +
+
+ + + +Definition at line 213 of file users.h. + + 00213 { }
+ |
+
+
+
|
+
| + + | +
+
+ +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. + + + +Definition at line 48 of file users.cpp. + +References result. + + 00049 {
+00050 sprintf(result,"%s!%s@%s",nick,ident,dhost);
+00051 return result;
+00052 }
+ |
+
+
+
|
+
| + + | +
+
+ +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. + +If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname. + +Definition at line 55 of file users.cpp. + +References result. + + 00056 {
+00057 sprintf(result,"%s!%s@%s",nick,ident,host);
+00058 return result;
+00059 }
+ |
+
+
+
|
+
| + + | +
+
+ +Adds a channel to a users invite list (invites them to a channel). + + + +Definition at line 72 of file users.cpp. + +References Invited::channel, and invites. + + |
+
+
+
|
+
| + + | +
+
+ +Returns true if a user is invited to a channel. + + + +Definition at line 61 of file users.cpp. + +References invites. + + |
+
+
+
|
+
| + + | +
+
+ +Removes a channel from a users invite list. + +This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation. + +Definition at line 79 of file users.cpp. + +References invites. + + |
+
+
+
|
+
| + + | +
+
+ +The user's away message. + +If this string is empty, the user is not marked as away. + |
+
+
+
|
+
| + + | +
+
+ +Stores the number of incoming bytes from the connection. + +Used by /STATS + +Definition at line 183 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +Stores the number of outgoing bytes to the connection. + +Used by /STATS + +Definition at line 188 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +A list of the channels the user is currently on. + +If any of these values are NULL, the record is not in use and may be associated with a channel by the JOIN command. see RFC 1459. + +Definition at line 165 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +Stores the number of incoming commands from the connection. + +Used by /STATS + +Definition at line 193 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +Stores the number of outgoing commands to the connection. + +Used by /STATS + +Definition at line 198 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +The host displayed to non-opers (used for cloaking etc). + +This usually matches the value of userrec::host. + |
+
+
+
|
+
| + + | +
+
+ +The users file descriptor. + +If this is zero, the socket has been closed and the core has not yet realised and removed the record from memory. + +Definition at line 120 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +The users full name. + + + |
+
+
+
|
+
| + + | +
+
+ +True if a correct password has been given using PASS command. + +If the user is a member of a connection class that does not require a password, the value stored here is of no use. + +Definition at line 209 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +The users hostname, or ip address in string form. + + + |
+
+
+
|
+
| + + | +
+
+ +The users ident reply. + + + |
+
+
+
|
+
| + + | +
+
+ +The time the user last sent a message. + +See also userrec::lastping and userrec::signon + +Definition at line 147 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +The users input buffer. + +Used by the C recv() function. + |
+
+
+
|
+
| + + | +
+
+ +A list of channels the user has a pending invite to. + + + +Definition at line 86 of file users.h. + +Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). |
+
+
+
|
+
| + + | +
+
+ +The users ip address in network order. + + + +Definition at line 97 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +The last time the user was pinged by the core. + +When this value is more than 120 seconds difference from 'time(NULL)', a ping is sent to the client. If the user has an outstanding PING request the next time this event occurs after 4 total minutes, they are disconnected. + +Definition at line 138 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +The user's mode string. + +This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit. + |
+
+
+
|
+
| + + | +
+
+ +The users nickname. + +An invalid nickname indicates an unregistered connection prior to the NICK command. + |
+
+
+
|
+
| + + | +
+
+ +True if the user replied to their last ping. + +If this is true, the user can be sent another ping at the specified time, otherwise they will be discnnected. See also userrec::lastping + +Definition at line 153 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +The port that the user connected to. + + + +Definition at line 178 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command. + +If both bits are set then the connection is awaiting MOTD. Sending of MOTD sets bit 3, and makes the value of userrec::registered == 7, showing a fully established client session. + +Definition at line 159 of file users.h. + +Referenced by userrec(). |
+
+
+
|
+
| + + | +
+
+ +Stores the result of the last GetFullHost or GetRealHost call. + +You may use this to increase the speed of use of this class. + +Definition at line 203 of file users.h. + +Referenced by GetFullHost(), and GetFullRealHost(). |
+
+
+
|
+
| + + | +
+
+ +The server the user is connected to. + + + |
+
+
+
|
+
| + + | +
+
+ +The users signon time. + + + +Definition at line 142 of file users.h. + +Referenced by userrec(). |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/doxygen.css b/docs/module-doc/doxygen.css
new file mode 100644
index 000000000..8cb8b2e5b
--- /dev/null
+++ b/docs/module-doc/doxygen.css
@@ -0,0 +1,49 @@
+H1 { text-align: center; }
+CAPTION { font-weight: bold }
+A.qindex {}
+A.qindexRef {}
+A.el { text-decoration: none; font-weight: bold }
+A.elRef { font-weight: bold }
+A.code { text-decoration: none; font-weight: normal; color: #4444ee }
+A.codeRef { font-weight: normal; color: #4444ee }
+A:hover { text-decoration: none; background-color: #f2f2ff }
+DL.el { margin-left: -1cm }
+DIV.fragment { width: 100%; border: none; background-color: #eeeeee }
+DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
+TD.md { background-color: #f2f2ff; font-weight: bold; }
+TD.mdname1 { background-color: #f2f2ff; font-weight: bold; color: #602020; }
+TD.mdname { background-color: #f2f2ff; font-weight: bold; color: #602020; width: 600px; }
+DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }
+DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }
+BODY { background: white; color: black }
+TD.indexkey {
+ background-color: #eeeeff;
+ font-weight: bold;
+ padding-right : 10px;
+ padding-top : 2px;
+ padding-left : 10px;
+ padding-bottom : 2px;
+ margin-left : 0px;
+ margin-right : 0px;
+ margin-top : 2px;
+ margin-bottom : 2px
+}
+TD.indexvalue {
+ background-color: #eeeeff;
+ font-style: italic;
+ padding-right : 10px;
+ padding-top : 2px;
+ padding-left : 10px;
+ padding-bottom : 2px;
+ margin-left : 0px;
+ margin-right : 0px;
+ margin-top : 2px;
+ margin-bottom : 2px
+}
+span.keyword { color: #008000 }
+span.keywordtype { color: #604020 }
+span.keywordflow { color: #e08000 }
+span.comment { color: #800000 }
+span.preprocessor { color: #806020 }
+span.stringliteral { color: #002080 }
+span.charliteral { color: #008080 }
diff --git a/docs/module-doc/doxygen.png b/docs/module-doc/doxygen.png
new file mode 100644
index 000000000..5bb475e23
Binary files /dev/null and b/docs/module-doc/doxygen.png differ
diff --git a/docs/module-doc/files.html b/docs/module-doc/files.html
new file mode 100644
index 000000000..ba6de9b92
--- /dev/null
+++ b/docs/module-doc/files.html
@@ -0,0 +1,21 @@
+
+
+| channels.h [code] | |
| modules.cpp [code] | |
| modules.h [code] | |
| users.cpp [code] | |
| users.h [code] |
1.3-rc2
+
+
diff --git a/docs/module-doc/ftv2blank.png b/docs/module-doc/ftv2blank.png
new file mode 100644
index 000000000..3f626d64f
Binary files /dev/null and b/docs/module-doc/ftv2blank.png differ
diff --git a/docs/module-doc/ftv2doc.png b/docs/module-doc/ftv2doc.png
new file mode 100644
index 000000000..2d16532a6
Binary files /dev/null and b/docs/module-doc/ftv2doc.png differ
diff --git a/docs/module-doc/ftv2folderclosed.png b/docs/module-doc/ftv2folderclosed.png
new file mode 100644
index 000000000..fc9426819
Binary files /dev/null and b/docs/module-doc/ftv2folderclosed.png differ
diff --git a/docs/module-doc/ftv2folderopen.png b/docs/module-doc/ftv2folderopen.png
new file mode 100644
index 000000000..30e9a2c37
Binary files /dev/null and b/docs/module-doc/ftv2folderopen.png differ
diff --git a/docs/module-doc/ftv2lastnode.png b/docs/module-doc/ftv2lastnode.png
new file mode 100644
index 000000000..f1fc64e48
Binary files /dev/null and b/docs/module-doc/ftv2lastnode.png differ
diff --git a/docs/module-doc/ftv2link.png b/docs/module-doc/ftv2link.png
new file mode 100644
index 000000000..f2549516c
Binary files /dev/null and b/docs/module-doc/ftv2link.png differ
diff --git a/docs/module-doc/ftv2mlastnode.png b/docs/module-doc/ftv2mlastnode.png
new file mode 100644
index 000000000..0de7e451f
Binary files /dev/null and b/docs/module-doc/ftv2mlastnode.png differ
diff --git a/docs/module-doc/ftv2mnode.png b/docs/module-doc/ftv2mnode.png
new file mode 100644
index 000000000..72f185b0b
Binary files /dev/null and b/docs/module-doc/ftv2mnode.png differ
diff --git a/docs/module-doc/ftv2node.png b/docs/module-doc/ftv2node.png
new file mode 100644
index 000000000..c23e9f943
Binary files /dev/null and b/docs/module-doc/ftv2node.png differ
diff --git a/docs/module-doc/ftv2plastnode.png b/docs/module-doc/ftv2plastnode.png
new file mode 100644
index 000000000..1bc6181ab
Binary files /dev/null and b/docs/module-doc/ftv2plastnode.png differ
diff --git a/docs/module-doc/ftv2pnode.png b/docs/module-doc/ftv2pnode.png
new file mode 100644
index 000000000..2f6070ca2
Binary files /dev/null and b/docs/module-doc/ftv2pnode.png differ
diff --git a/docs/module-doc/ftv2vertline.png b/docs/module-doc/ftv2vertline.png
new file mode 100644
index 000000000..f5a03787b
Binary files /dev/null and b/docs/module-doc/ftv2vertline.png differ
diff --git a/docs/module-doc/functions.html b/docs/module-doc/functions.html
new file mode 100644
index 000000000..668617b78
--- /dev/null
+++ b/docs/module-doc/functions.html
@@ -0,0 +1,191 @@
+
+
++Here is a list of all class members with links to the classes they belong to:
1.3-rc2
+
+
diff --git a/docs/module-doc/globals.html b/docs/module-doc/globals.html
new file mode 100644
index 000000000..6a9878c0d
--- /dev/null
+++ b/docs/module-doc/globals.html
@@ -0,0 +1,57 @@
+
+
++Here is a list of all file members with links to the files they belong to:
1.3-rc2
+
+
diff --git a/docs/module-doc/hierarchy.html b/docs/module-doc/hierarchy.html
new file mode 100644
index 000000000..35e1d316c
--- /dev/null
+++ b/docs/module-doc/hierarchy.html
@@ -0,0 +1,34 @@
+
+
+1.3-rc2
+
+
diff --git a/docs/module-doc/index.html b/docs/module-doc/index.html
new file mode 100644
index 000000000..752d21b2d
--- /dev/null
+++ b/docs/module-doc/index.html
@@ -0,0 +1,7 @@
+
++
1.3-rc2
+
+
diff --git a/docs/module-doc/modules_8cpp-source.html b/docs/module-doc/modules_8cpp-source.html
new file mode 100644
index 000000000..b651919d5
--- /dev/null
+++ b/docs/module-doc/modules_8cpp-source.html
@@ -0,0 +1,249 @@
+
+
+00001 /* +00002 +00003 $Log$ +00003 Revision 1.1 2003/01/23 19:45:58 brain +00003 Initial revision +00003 +00003 Revision 1.9 2003/01/22 20:59:12 brain +00003 Added FileReader class documentation +00003 +00004 Revision 1.7 2003/01/22 20:49:16 brain +00005 Added FileReader file-caching class +00006 Changed m_randquote to use FileReader class +00007 +00008 Revision 1.6 2003/01/21 20:31:24 brain +00009 Modified to add documentation +00010 Added ConfigReader class for modules +00011 +00012 Revision 1.5 2003/01/13 22:30:50 brain +00013 Added Admin class (holds /admin info for modules) +00014 Added methods to Server class +00015 +00016 +00017 */ +00018 +00019 +00020 +00021 #include <typeinfo> +00022 #include <iostream.h> +00023 #include "globals.h" +00024 #include "modules.h" +00025 #include "inspircd_io.h" +00026 +00027 // version is a simple class for holding a modules version number +00028 +00029 Version::Version(int major, int minor, int revision, int build) : Major(major), Minor(minor), Revision(revision), Build(build) { }; +00030 +00031 // admin is a simple class for holding a server's administrative info +00032 +00033 Admin::Admin(string name, string email, string nick) : Name(name), Email(email), Nick(nick) { }; +00034 +00035 // +00036 // Announce to the world that the Module base +00037 // class has been created or destroyed +00038 // +00039 +00040 Module::Module() { } +00041 Module::~Module() { } +00042 void Module::OnUserConnect(userrec* user) { } +00043 void Module::OnUserQuit(userrec* user) { } +00044 void Module::OnUserJoin(userrec* user, chanrec* channel) { } +00045 void Module::OnUserPart(userrec* user, chanrec* channel) { } +00046 Version Module::GetVersion() { return Version(1,0,0,0); } +00047 +00048 // server is a wrapper class that provides methods to all of the C-style +00049 // exports in the core +00050 // +00051 +00052 Server::Server() +00053 { +00054 } +00055 +00056 Server::~Server() +00057 { +00058 } +00059 +00060 void Server::SendOpers(string s) +00061 { +00062 WriteOpers("%s",s.c_str()); +00063 } +00064 +00065 void Server::Debug(string s) +00066 { +00067 debug("%s",s.c_str()); +00068 } +00069 +00070 void Server::Send(int Socket, string s) +00071 { +00072 Write(Socket,"%s",s.c_str()); +00073 } +00074 +00075 void Server::SendServ(int Socket, string s) +00076 { +00077 WriteServ(Socket,"%s",s.c_str()); +00078 } +00079 +00080 void Server::SendFrom(int Socket, userrec* User, string s) +00081 { +00082 WriteFrom(Socket,User,"%s",s.c_str()); +00083 } +00084 +00085 void Server::SendTo(userrec* Source, userrec* Dest, string s) +00086 { +00087 WriteTo(Source,Dest,"%s",s.c_str()); +00088 } +00089 +00090 void Server::SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender) +00091 { +00092 if (IncludeSender) +00093 { +00094 WriteChannel(Channel,User,"%s",s.c_str()); +00095 } +00096 else +00097 { +00098 ChanExceptSender(Channel,User,"%s",s.c_str()); +00099 } +00100 } +00101 +00102 bool Server::CommonChannels(userrec* u1, userrec* u2) +00103 { +00104 return (common_channels(u1,u2) != 0); +00105 } +00106 +00107 void Server::SendCommon(userrec* User, string text,bool IncludeSender) +00108 { +00109 if (IncludeSender) +00110 { +00111 WriteCommon(User,"%s",text.c_str()); +00112 } +00113 else +00114 { +00115 WriteCommonExcept(User,"%s",text.c_str()); +00116 } +00117 } +00118 +00119 void Server::SendWallops(userrec* User, string text) +00120 { +00121 WriteWallOps(User,"%s",text.c_str()); +00122 } +00123 +00124 bool Server::IsNick(string nick) +00125 { +00126 return (isnick(nick.c_str()) != 0); +00127 } +00128 +00129 userrec* Server::FindNick(string nick) +00130 { +00131 return Find(nick); +00132 } +00133 +00134 chanrec* Server::FindChannel(string channel) +00135 { +00136 return FindChan(channel.c_str()); +00137 } +00138 +00139 string Server::ChanMode(userrec* User, chanrec* Chan) +00140 { +00141 string mode = cmode(User,Chan); +00142 return mode; +00143 } +00144 +00145 string Server::GetServerName() +00146 { +00147 return getservername(); +00148 } +00149 +00150 string Server::GetNetworkName() +00151 { +00152 return getnetworkname(); +00153 } +00154 +00155 Admin Server::GetAdmin() +00156 { +00157 return Admin(getadminname(),getadminemail(),getadminnick()); +00158 } +00159 +00160 +00161 ConfigReader::ConfigReader() +00162 { +00163 fname = CONFIG_FILE; +00164 } +00165 +00166 +00167 ConfigReader::~ConfigReader() +00168 { +00169 } +00170 +00171 +00172 ConfigReader::ConfigReader(string filename) : fname(filename) { }; +00173 +00174 string ConfigReader::ReadValue(string tag, string name, int index) +00175 { +00176 char val[MAXBUF]; +00177 ReadConf(fname.c_str(),tag.c_str(),name.c_str(),index,val); +00178 string s = val; +00179 return s; +00180 } +00181 +00182 +00183 int ConfigReader::Enumerate(string tag) +00184 { +00185 return EnumConf(fname.c_str(),tag.c_str()); +00186 } +00187 +00188 +00189 bool ConfigReader::Verify() +00190 { +00191 return true; +00192 } +00193 +00194 +00195 FileReader::FileReader(string filename) +00196 { +00197 file_cache c; +00198 readfile(c,filename.c_str()); +00199 this->fc = c; +00200 } +00201 +00202 FileReader::FileReader() +00203 { +00204 } +00205 +00206 void FileReader::LoadFile(string filename) +00207 { +00208 file_cache c; +00209 readfile(c,filename.c_str()); +00210 this->fc = c; +00211 } +00212 +00213 FileReader::~FileReader() +00214 { +00215 } +00216 +00217 string FileReader::GetLine(int x) +00218 { +00219 if ((x<0) || (x>fc.size())) +00220 return ""; +00221 return fc[x]; +00222 } +00223 +00224 int FileReader::FileSize() +00225 { +00226 return fc.size(); +00227 } +00228 +00229 +
1.3-rc2
+
+
diff --git a/docs/module-doc/modules_8cpp.html b/docs/module-doc/modules_8cpp.html
new file mode 100644
index 000000000..cfa3fa3a3
--- /dev/null
+++ b/docs/module-doc/modules_8cpp.html
@@ -0,0 +1,24 @@
+
+
+#include <typeinfo>#include <iostream.h>#include "globals.h"#include "modules.h"#include "inspircd_io.h"+Go to the source code of this file.
1.3-rc2
+
+
diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html
new file mode 100644
index 000000000..9f80e2ea5
--- /dev/null
+++ b/docs/module-doc/modules_8h-source.html
@@ -0,0 +1,159 @@
+
+
+00001 /* +00002 +00003 $Log$ +00003 Revision 1.1 2003/01/23 19:45:58 brain +00003 Initial revision +00003 +00003 Revision 1.9 2003/01/22 20:59:12 brain +00003 Added FileReader class documentation +00003 +00004 Revision 1.11 2003/01/22 20:49:16 brain +00005 Added FileReader file-caching class +00006 Changed m_randquote to use FileReader class +00007 +00008 Revision 1.10 2003/01/22 00:57:27 brain +00009 Changes to documentation +00010 +00011 Revision 1.9 2003/01/22 00:44:26 brain +00012 Added documentation comments +00013 +00014 Revision 1.8 2003/01/21 20:31:24 brain +00015 Modified to add documentation +00016 Added ConfigReader class for modules +00017 +00018 Revision 1.7 2003/01/15 22:47:44 brain +00019 Changed user and channel structs to classes (finally) +00020 +00021 Revision 1.6 2003/01/13 22:30:50 brain +00022 Added Admin class (holds /admin info for modules) +00023 Added methods to Server class +00024 +00025 +00026 */ +00027 +00028 +00029 #ifndef __PLUGIN_H +00030 #define __PLUGIN_H +00031 +00032 #include "dynamic.h" +00033 #include <string> +00034 #include <deque> +00035 +00038 typedef deque<string> file_cache; +00039 +00040 +00041 // This #define allows us to call a method in all +00042 // loaded modules in a readable simple way, e.g.: +00043 // 'FOREACH_MOD OnConnect(user);' +00044 +00045 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-> +00046 +00047 // class Version holds the version information of a Module, returned +00048 // by Module::GetVersion (thanks RD) +00049 +00054 class Version +00055 { +00056 public: +00057 const int Major, Minor, Revision, Build; +00058 Version(int major, int minor, int revision, int build); +00059 }; +00060 +00061 +00067 class Admin +00068 { +00069 public: +00070 const string Name, Email, Nick; +00071 Admin(string name,string email,string nick); +00072 }; +00073 +00079 class Module +00080 { +00081 public: +00085 Module(); +00089 virtual ~Module(); +00094 virtual Version GetVersion(); +00098 virtual void OnUserConnect(userrec* user); +00102 virtual void OnUserQuit(userrec* user); +00107 virtual void OnUserJoin(userrec* user, chanrec* channel); +00112 virtual void OnUserPart(userrec* user, chanrec* channel); +00113 }; +00114 +00115 +00121 class Server +00122 { +00123 public: +00127 Server(); +00131 virtual ~Server(); +00132 +00136 virtual void SendOpers(string s); +00141 virtual void Debug(string s); +00146 virtual void Send(int Socket, string s); +00151 virtual void SendServ(int Socket, string s); +00156 virtual void SendFrom(int Socket, userrec* User, string s); +00161 virtual void SendTo(userrec* Source, userrec* Dest, string s); +00168 virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender); +00173 virtual bool CommonChannels(userrec* u1, userrec* u2); +00181 virtual void SendCommon(userrec* User, string text,bool IncludeSender); +00186 virtual void SendWallops(userrec* User, string text); +00187 +00191 virtual bool IsNick(string nick); +00195 virtual userrec* FindNick(string nick); +00199 virtual chanrec* FindChannel(string channel); +00204 virtual string ChanMode(userrec* User, chanrec* Chan); +00207 virtual string GetServerName(); +00210 virtual string GetNetworkName(); +00216 virtual Admin GetAdmin(); +00217 +00218 }; +00219 +00226 class ConfigReader +00227 { +00228 protected: +00231 string fname; +00232 public: +00237 ConfigReader(); // default constructor reads ircd.conf +00241 ConfigReader(string filename); // read a module-specific config +00245 ~ConfigReader(); +00250 string ReadValue(string tag, string name, int index); +00257 int Enumerate(string tag); +00261 bool Verify(); +00262 }; +00263 +00264 +00265 +00271 class FileReader +00272 { +00273 file_cache fc; +00274 public: +00279 FileReader(); +00285 FileReader(string filename); +00289 ~FileReader(); +00295 void LoadFile(string filename); +00300 string GetLine(int x); +00306 int FileSize(); +00307 }; +00308 +00309 +00316 class ModuleFactory +00317 { +00318 public: +00319 ModuleFactory() { } +00320 virtual ~ModuleFactory() { } +00325 virtual Module * CreateModule() = 0; +00326 }; +00327 +00328 #endif +
1.3-rc2
+
+
diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html
new file mode 100644
index 000000000..6c9237a27
--- /dev/null
+++ b/docs/module-doc/modules_8h.html
@@ -0,0 +1,96 @@
+
+
+#include "dynamic.h"#include <string>#include <deque>+Go to the source code of this file.
Compounds | |
| class | Admin |
| Holds /ADMIN data This class contains the admin details of the local server. More... | |
| class | ConfigReader |
| Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. More... | |
| class | FileReader |
| Caches a text file into memory and can be used to retrieve lines from it. More... | |
| class | Module |
| Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More... | |
| class | ModuleFactory |
| Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. More... | |
| class | Server |
| 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... | |
| class | Version |
| Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. More... | |
Defines | |
| #define | FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-> |
Typedefs | |
| typedef deque< string > | file_cache |
| Low level definition of a FileReader classes file cache area. | |
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ +Low level definition of a FileReader classes file cache area. + + + +Definition at line 38 of file modules.h. + +Referenced by FileReader::FileReader(), and FileReader::LoadFile(). |
+
1.3-rc2
+
+
diff --git a/docs/module-doc/tree.html b/docs/module-doc/tree.html
new file mode 100644
index 000000000..ca32b1db7
--- /dev/null
+++ b/docs/module-doc/tree.html
@@ -0,0 +1,11 @@
+
+
+
+
+
+
+
+
+
diff --git a/docs/module-doc/tree.js b/docs/module-doc/tree.js
new file mode 100644
index 000000000..ff40787d6
--- /dev/null
+++ b/docs/module-doc/tree.js
@@ -0,0 +1,44 @@
+foldersTree = gFld("InspIRCd", "", "")
+ insDoc(foldersTree, gLnk("Main Page", "", "main.html"))
+aux1 = insFld(foldersTree, gFld("File List", "", "files.html"))
+ insDoc(aux1, gLnk("channels.h", "", "channels_8h.html"))
+ insDoc(aux1, gLnk("modules.cpp", "", "modules_8cpp.html"))
+ insDoc(aux1, gLnk("modules.h", "", "modules_8h.html"))
+ insDoc(aux1, gLnk("users.cpp", "", "users_8cpp.html"))
+ insDoc(aux1, gLnk("users.h", "", "users_8h.html"))
+aux1 = insFld(foldersTree, gFld("Compound List", "", "annotated.html"))
+ insDoc(aux1, gLnk("Admin", "", "classAdmin.html"))
+ insDoc(aux1, gLnk("BanItem", "", "classBanItem.html"))
+ insDoc(aux1, gLnk("chanrec", "", "classchanrec.html"))
+ insDoc(aux1, gLnk("ConfigReader", "", "classConfigReader.html"))
+ insDoc(aux1, gLnk("ConnectClass", "", "classConnectClass.html"))
+ insDoc(aux1, gLnk("ExemptItem", "", "classExemptItem.html"))
+ insDoc(aux1, gLnk("FileReader", "", "classFileReader.html"))
+ insDoc(aux1, gLnk("HostItem", "", "classHostItem.html"))
+ insDoc(aux1, gLnk("Invited", "", "classInvited.html"))
+ insDoc(aux1, gLnk("InviteItem", "", "classInviteItem.html"))
+ insDoc(aux1, gLnk("Module", "", "classModule.html"))
+ insDoc(aux1, gLnk("ModuleFactory", "", "classModuleFactory.html"))
+ insDoc(aux1, gLnk("Server", "", "classServer.html"))
+ insDoc(aux1, gLnk("ucrec", "", "classucrec.html"))
+ insDoc(aux1, gLnk("userrec", "", "classuserrec.html"))
+ insDoc(aux1, gLnk("Version", "", "classVersion.html"))
+aux1 = insFld(foldersTree, gFld("Class Hierarchy", "", "hierarchy.html"))
+ insDoc(aux1, gLnk("Admin", "", "classAdmin.html"))
+ insDoc(aux1, gLnk("chanrec", "", "classchanrec.html"))
+ insDoc(aux1, gLnk("ConfigReader", "", "classConfigReader.html"))
+ insDoc(aux1, gLnk("ConnectClass", "", "classConnectClass.html"))
+ insDoc(aux1, gLnk("FileReader", "", "classFileReader.html"))
+ aux2 = insFld(aux1, gFld("HostItem", "", "classHostItem.html"))
+ insDoc(aux2, gLnk("BanItem", "", "classBanItem.html"))
+ insDoc(aux2, gLnk("ExemptItem", "", "classExemptItem.html"))
+ insDoc(aux2, gLnk("InviteItem", "", "classInviteItem.html"))
+ insDoc(aux1, gLnk("Invited", "", "classInvited.html"))
+ insDoc(aux1, gLnk("Module", "", "classModule.html"))
+ insDoc(aux1, gLnk("ModuleFactory", "", "classModuleFactory.html"))
+ insDoc(aux1, gLnk("Server", "", "classServer.html"))
+ insDoc(aux1, gLnk("ucrec", "", "classucrec.html"))
+ insDoc(aux1, gLnk("userrec", "", "classuserrec.html"))
+ insDoc(aux1, gLnk("Version", "", "classVersion.html"))
+ insDoc(foldersTree, gLnk("Compound Members", "", "functions.html"))
+ insDoc(foldersTree, gLnk("File Members", "", "globals.html"))
diff --git a/docs/module-doc/treeview.js b/docs/module-doc/treeview.js
new file mode 100644
index 000000000..6b5ef5110
--- /dev/null
+++ b/docs/module-doc/treeview.js
@@ -0,0 +1,500 @@
+//****************************************************************
+// You are free to copy the "Folder-Tree" script as long as you
+// keep this copyright notice:
+// Script found in: http://www.geocities.com/Paris/LeftBank/2178/
+// Author: Marcelino Alves Martins (martins@hks.com) December '97.
+//****************************************************************
+
+//Log of changes:
+// 17 Feb 98 - Fix initialization flashing problem with Netscape
+//
+// 27 Jan 98 - Root folder starts open; support for USETEXTLINKS;
+// make the ftien4 a js file
+//
+// DvH: Dec 2000 - Made some minor changes to support external
+// references
+
+// Definition of class Folder
+// *****************************************************************
+
+function Folder(folderDescription, tagName, hreference) //constructor
+{
+ //constant data
+ this.desc = folderDescription
+ this.tagName = tagName
+ this.hreference = hreference
+ this.id = -1
+ this.navObj = 0
+ this.iconImg = 0
+ this.nodeImg = 0
+ this.isLastNode = 0
+
+ //dynamic data
+ this.isOpen = true
+ this.iconSrc = "ftv2folderopen.png"
+ this.children = new Array
+ this.nChildren = 0
+
+ //methods
+ this.initialize = initializeFolder
+ this.setState = setStateFolder
+ this.addChild = addChild
+ this.createIndex = createEntryIndex
+ this.hide = hideFolder
+ this.display = display
+ this.renderOb = drawFolder
+ this.totalHeight = totalHeight
+ this.subEntries = folderSubEntries
+ this.outputLink = outputFolderLink
+}
+
+function setStateFolder(isOpen)
+{
+ var subEntries
+ var totalHeight
+ var fIt = 0
+ var i=0
+
+ if (isOpen == this.isOpen)
+ return
+
+ if (browserVersion == 2)
+ {
+ totalHeight = 0
+ for (i=0; i < this.nChildren; i++)
+ totalHeight = totalHeight + this.children[i].navObj.clip.height
+ subEntries = this.subEntries()
+ if (this.isOpen)
+ totalHeight = 0 - totalHeight
+ for (fIt = this.id + subEntries + 1; fIt < nEntries; fIt++)
+ indexOfEntries[fIt].navObj.moveBy(0, totalHeight)
+ }
+ this.isOpen = isOpen
+ propagateChangesInState(this)
+}
+
+function propagateChangesInState(folder)
+{
+ var i=0
+
+ if (folder.isOpen)
+ {
+ if (folder.nodeImg)
+ if (folder.isLastNode)
+ folder.nodeImg.src = "ftv2mlastnode.png"
+ else
+ folder.nodeImg.src = "ftv2mnode.png"
+ folder.iconImg.src = "ftv2folderopen.png"
+ for (i=0; i
")
+ leftSide = leftSide + "
"
+ this.isLastNode = 1
+ }
+ else
+ {
+ this.renderOb(leftSide + auxEv + "
")
+ leftSide = leftSide + "
"
+ this.isLastNode = 0
+ }
+ else
+ this.renderOb("")
+
+ if (nc > 0)
+ {
+ level = level + 1
+ for (i=0 ; i < this.nChildren; i++)
+ {
+ if (i == this.nChildren-1)
+ this.children[i].initialize(level, 1, leftSide)
+ else
+ this.children[i].initialize(level, 0, leftSide)
+ }
+ }
+}
+
+function drawFolder(leftSide)
+{
+ if (browserVersion == 2) {
+ if (!doc.yPos)
+ doc.yPos=8
+ doc.write("| ")
+ doc.write(leftSide)
+ this.outputLink()
+ doc.write(" | \n") + if (USETEXTLINKS) + { + this.outputLink() + doc.write(this.desc + "") + } + else + doc.write(this.desc) + if (this.tagName!="") + { + doc.write(" [external]") + } + doc.write(" | ") + doc.write("\n
")
+ leftSide = leftSide + ""
+ }
+ else
+ {
+ this.renderOb(leftSide + "
")
+ leftSide = leftSide + ""
+ }
+ else
+ this.renderOb("")
+}
+
+function drawItem(leftSide)
+{
+ if (browserVersion == 2)
+ doc.write("| ")
+ doc.write(leftSide)
+ if (this.link!="")
+ {
+ doc.write("")
+ }
+ doc.write(" | \n") + if (USETEXTLINKS && this.link!="") + doc.write("" + this.desc + "") + else + doc.write(this.desc) + if (this.tagName!="") + { + doc.write(" [external]"); + } + doc.write("\n |
00001 /* +00002 +00003 $Log$ +00003 Revision 1.1 2003/01/23 19:45:58 brain +00003 Initial revision +00003 +00003 Revision 1.6 2003/01/22 20:59:12 brain +00003 Added FileReader class documentation +00003 +00004 Revision 1.3 2003/01/17 13:21:38 brain +00005 Added CONNECT ALLOW and CONNECT DENY config tags +00006 Added PASS command +00007 +00008 Revision 1.2 2003/01/17 10:37:55 brain +00009 Added /INVITE command and relevent structures +00010 +00011 Revision 1.1 2003/01/16 01:10:04 brain +00012 forgot to add this +00013 +00014 +00015 */ +00016 +00017 #include "inspircd_config.h" +00018 #include "channels.h" +00019 #include "users.h" +00020 #include "inspircd.h" +00021 #include <stdio.h> +00022 +00023 userrec::userrec() +00024 { +00025 // the PROPER way to do it, AVOID bzero at *ALL* costs +00026 strcpy(nick,""); +00027 ip = 0; +00028 strcpy(ident,""); +00029 strcpy(host,""); +00030 strcpy(dhost,""); +00031 strcpy(fullname,""); +00032 strcpy(modes,""); +00033 strcpy(inbuf,""); +00034 strcpy(server,""); +00035 strcpy(awaymsg,""); +00036 fd = lastping = signon = idle_lastmsg = nping = registered = 0; +00037 port = bytes_in = bytes_out = cmds_in = cmds_out = 0; +00038 haspassed = false; +00039 strcpy(result,""); +00040 for (int i = 0; i < MAXCHANS; i++) +00041 { +00042 chans[i].channel = NULL; +00043 } +00044 invites.clear(); +00045 } +00046 +00047 +00048 char* userrec::GetFullHost() +00049 { +00050 sprintf(result,"%s!%s@%s",nick,ident,dhost); +00051 return result; +00052 } +00053 +00054 +00055 char* userrec::GetFullRealHost() +00056 { +00057 sprintf(result,"%s!%s@%s",nick,ident,host); +00058 return result; +00059 } +00060 +00061 bool userrec::IsInvited(char* channel) +00062 { +00063 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +00064 { +00065 if (!strcasecmp(i->channel,channel)) +00066 { +00067 return true; +00068 } +00069 } +00070 } +00071 +00072 void userrec::InviteTo(char* channel) +00073 { +00074 Invited i; +00075 strcpy(i.channel,channel); +00076 invites.push_back(i); +00077 } +00078 +00079 void userrec::RemoveInvite(char* channel) +00080 { +00081 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +00082 { +00083 if (!strcasecmp(i->channel,channel)) +00084 { +00085 invites.erase(i); +00086 return; +00087 } +00088 } +00089 } +
1.3-rc2
+
+
diff --git a/docs/module-doc/users_8cpp.html b/docs/module-doc/users_8cpp.html
new file mode 100644
index 000000000..10c198675
--- /dev/null
+++ b/docs/module-doc/users_8cpp.html
@@ -0,0 +1,24 @@
+
+
+#include "inspircd_config.h"#include "channels.h"#include "users.h"#include "inspircd.h"#include <stdio.h>+Go to the source code of this file.
1.3-rc2
+
+
diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html
new file mode 100644
index 000000000..446423af1
--- /dev/null
+++ b/docs/module-doc/users_8h-source.html
@@ -0,0 +1,158 @@
+
+
+00001 /* +00002 +00003 $Log$ +00003 Revision 1.1 2003/01/23 19:45:58 brain +00003 Initial revision +00003 +00003 Revision 1.6 2003/01/22 20:59:12 brain +00003 Added FileReader class documentation +00003 +00004 Revision 1.9 2003/01/22 00:44:26 brain +00005 Added documentation comments +00006 +00007 Revision 1.8 2003/01/21 21:11:17 brain +00008 Added documentation +00009 +00010 Revision 1.7 2003/01/17 13:21:38 brain +00011 Added CONNECT ALLOW and CONNECT DENY config tags +00012 Added PASS command +00013 +00014 Revision 1.6 2003/01/17 10:37:55 brain +00015 Added /INVITE command and relevent structures +00016 +00017 Revision 1.5 2003/01/16 20:11:56 brain +00018 fixed some ugly pointer bugs (thanks dblack and a|KK|y!) +00019 +00020 Revision 1.4 2003/01/15 22:47:44 brain +00021 Changed user and channel structs to classes (finally) +00022 +00023 Revision 1.3 2003/01/14 21:14:30 brain +00024 added /ISON command (for mIRC etc basic notify) +00025 +00026 +00027 */ +00028 +00029 #include "inspircd_config.h" +00030 #include "channels.h" +00031 +00032 #include <string> +00033 +00034 #ifndef __USERS_H__ +00035 #define __USERS_H__ +00036 +00037 #define STATUS_OP 4 +00038 #define STATUS_HOP 2 +00039 #define STATUS_VOICE 1 +00040 #define STATUS_NORMAL 0 +00041 +00042 #define CC_ALLOW 0 +00043 #define CC_DENY 1 +00044 +00047 class Invited +00048 { +00049 public: +00050 char channel[CHANMAX]; +00051 }; +00052 +00053 +00056 class ConnectClass +00057 { +00058 public: +00059 int type; +00060 char host[MAXBUF]; +00061 char pass[MAXBUF]; +00062 }; +00063 +00066 typedef vector<Invited> InvitedList; +00067 +00068 +00069 +00072 typedef vector<ConnectClass> ClassVector; +00073 +00080 class userrec +00081 { +00082 private: +00083 +00086 InvitedList invites; +00087 public: +00088 +00093 char nick[NICKMAX]; +00094 +00097 unsigned long ip; +00098 +00101 char ident[64]; +00102 +00105 char host[256]; +00106 +00110 char dhost[256]; +00111 +00114 char fullname[128]; +00115 +00120 int fd; +00121 +00126 char modes[32]; +00127 +00131 char inbuf[MAXBUF]; +00132 +00138 time_t lastping; +00139 +00142 time_t signon; +00143 +00147 time_t idle_lastmsg; +00148 +00153 time_t nping; +00154 +00159 int registered; +00160 +00165 ucrec chans[MAXCHANS]; +00166 +00169 char server[256]; +00170 +00174 char awaymsg[512]; +00175 +00178 int port; +00179 +00183 long bytes_in; +00184 +00188 long bytes_out; +00189 +00193 long cmds_in; +00194 +00198 long cmds_out; +00199 +00203 char result[256]; +00204 +00209 bool haspassed; +00210 +00211 userrec(); +00212 +00213 virtual ~userrec() { } +00214 +00219 virtual char* GetFullHost(); +00220 +00226 virtual char* GetFullRealHost(); +00227 +00230 virtual bool IsInvited(char* channel); +00231 +00234 virtual void InviteTo(char* channel); +00235 +00240 virtual void RemoveInvite(char* channel); +00241 +00242 }; +00243 +00244 +00245 #endif +
1.3-rc2
+
+
diff --git a/docs/module-doc/users_8h.html b/docs/module-doc/users_8h.html
new file mode 100644
index 000000000..2593a2dcb
--- /dev/null
+++ b/docs/module-doc/users_8h.html
@@ -0,0 +1,239 @@
+
+
+#include "inspircd_config.h"#include "channels.h"#include <string>+Go to the source code of this file.
Compounds | |
| class | ConnectClass |
| Holds information relevent to <connect allow> and <connect deny> tags in the config file. More... | |
| class | Invited |
| Holds a channel name to which a user has been invited. More... | |
| class | userrec |
| Holds all information about a user This class stores all information about a user connected to the irc server. More... | |
Defines | |
| #define | STATUS_OP 4 |
| #define | STATUS_HOP 2 |
| #define | STATUS_VOICE 1 |
| #define | STATUS_NORMAL 0 |
| #define | CC_ALLOW 0 |
| #define | CC_DENY 1 |
Typedefs | |
| typedef vector< Invited > | InvitedList |
| Holds a complete list of all channels to which a user has been invited and has not yet joined. | |
| typedef vector< ConnectClass > | ClassVector |
| Holds a complete list of all allow and deny tags from the configuration file (connection classes). | |
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ + + |
+
+
+
|
+
| + + | +
+
+ +Holds a complete list of all allow and deny tags from the configuration file (connection classes). + + + |
+
+
+
|
+
| + + | +
+
+ +Holds a complete list of all channels to which a user has been invited and has not yet joined. + + + |
+
1.3-rc2
+
+
--
cgit v1.3.1-10-gc9f91