1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>InspIRCd: Server class Reference</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3.3 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
8 <h1>Server Class Reference</h1>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.
9 <a href="#_details">More...</a>
11 <code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code>
13 Inherits <a class="el" href="classclassbase.html">classbase</a>.
15 <a href="classServer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
17 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a0">Server</a> ()</td></tr>
20 <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. </em> <a href="#a0"></a><em><br><br></td></tr>
21 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a1">~Server</a> ()</td></tr>
23 <tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. </em> <a href="#a1"></a><em><br><br></td></tr>
24 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a2">SendOpers</a> (std::string s)</td></tr>
26 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text to all opers. </em> <a href="#a2"></a><em><br><br></td></tr>
27 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a3">Log</a> (int level, std::string s)</td></tr>
29 <tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a log string. </em> <a href="#a3"></a><em><br><br></td></tr>
30 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a4">Send</a> (int Socket, std::string s)</td></tr>
32 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a line of text down a TCP/IP socket. </em> <a href="#a4"></a><em><br><br></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a5">SendServ</a> (int Socket, std::string s)</td></tr>
35 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from the server to a socket. </em> <a href="#a5"></a><em><br><br></td></tr>
36 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a6">SendFrom</a> (int Socket, <a class="el" href="classuserrec.html">userrec</a> *User, std::string s)</td></tr>
38 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to a socket. </em> <a href="#a6"></a><em><br><br></td></tr>
39 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a7">SendTo</a> (<a class="el" href="classuserrec.html">userrec</a> *Source, <a class="el" href="classuserrec.html">userrec</a> *Dest, std::string s)</td></tr>
41 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to another user. </em> <a href="#a7"></a><em><br><br></td></tr>
42 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a8">SendChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Channel, std::string s, bool IncludeSender)</td></tr>
44 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to a channel (mulicast). </em> <a href="#a8"></a><em><br><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a9">CommonChannels</a> (<a class="el" href="classuserrec.html">userrec</a> *u1, <a class="el" href="classuserrec.html">userrec</a> *u2)</td></tr>
47 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if two users share a common channel. </em> <a href="#a9"></a><em><br><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a10">SendCommon</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text, bool IncludeSender)</td></tr>
50 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends text from a user to one or more channels (mulicast). </em> <a href="#a10"></a><em><br><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a11">SendWallops</a> (<a class="el" href="classuserrec.html">userrec</a> *User, std::string text)</td></tr>
53 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a WALLOPS message. </em> <a href="#a11"></a><em><br><br></td></tr>
54 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a12">IsNick</a> (std::string nick)</td></tr>
56 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a nick is valid. </em> <a href="#a12"></a><em><br><br></td></tr>
57 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a13">CountUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *c)</td></tr>
59 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a count of the number of users on a channel. </em> <a href="#a13"></a><em><br><br></td></tr>
60 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classuserrec.html">userrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a14">FindNick</a> (std::string nick)</td></tr>
62 <tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to look up a nick and return a pointer to it. </em> <a href="#a14"></a><em><br><br></td></tr>
63 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a15">FindChannel</a> (std::string channel)</td></tr>
65 <tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to look up a channel and return a pointer to it. </em> <a href="#a15"></a><em><br><br></td></tr>
66 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a16">ChanMode</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr>
68 <tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to look up a user's privilages on a channel. </em> <a href="#a16"></a><em><br><br></td></tr>
69 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a17">IsOnChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *User, <a class="el" href="classchanrec.html">chanrec</a> *Chan)</td></tr>
71 <tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if a user is on a channel. </em> <a href="#a17"></a><em><br><br></td></tr>
72 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a18">GetServerName</a> ()</td></tr>
74 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the server name of the server where the module is loaded. </em> <a href="#a18"></a><em><br><br></td></tr>
75 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a19">GetNetworkName</a> ()</td></tr>
77 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the network name, global to all linked servers. </em> <a href="#a19"></a><em><br><br></td></tr>
78 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classAdmin.html">Admin</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a20">GetAdmin</a> ()</td></tr>
80 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the information of the server as returned by the /ADMIN command. </em> <a href="#a20"></a><em><br><br></td></tr>
81 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a21">AddExtendedMode</a> (char modechar, int type, bool requires_oper, int params_when_on, int params_when_off)</td></tr>
83 <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an extended mode letter which is parsed by a module. </em> <a href="#a21"></a><em><br><br></td></tr>
84 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a22">AddExtendedListMode</a> (char modechar)</td></tr>
86 <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an extended mode letter which is parsed by a module and handled in a list fashion. </em> <a href="#a22"></a><em><br><br></td></tr>
87 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a23">AddCommand</a> (char *cmd, handlerfunc f, char flags, int minparams, char *source)</td></tr>
89 <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a command to the command table. </em> <a href="#a23"></a><em><br><br></td></tr>
90 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a24">SendMode</a> (char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
92 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a servermode. </em> <a href="#a24"></a><em><br><br></td></tr>
93 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a25">SendToModeMask</a> (std::string modes, int flags, std::string text)</td></tr>
95 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter. </em> <a href="#a25"></a><em><br><br></td></tr>
96 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a26">JoinUserToChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string key)</td></tr>
98 <tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user to join a channel. </em> <a href="#a26"></a><em><br><br></td></tr>
99 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classchanrec.html">chanrec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a27">PartUserFromChannel</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string cname, std::string reason)</td></tr>
101 <tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user to part a channel. </em> <a href="#a27"></a><em><br><br></td></tr>
102 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a28">ChangeUserNick</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string nickname)</td></tr>
104 <tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user nickchange. </em> <a href="#a28"></a><em><br><br></td></tr>
105 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a29">QuitUser</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string reason)</td></tr>
107 <tr><td class="mdescLeft"> </td><td class="mdescRight">Forces a user to quit with the specified reason. </em> <a href="#a29"></a><em><br><br></td></tr>
108 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a30">MatchText</a> (std::string sliteral, std::string spattern)</td></tr>
110 <tr><td class="mdescLeft"> </td><td class="mdescRight">Matches text against a glob pattern. </em> <a href="#a30"></a><em><br><br></td></tr>
111 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a31">CallCommandHandler</a> (std::string commandname, char **parameters, int pcnt, <a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
113 <tr><td class="mdescLeft"> </td><td class="mdescRight">Calls the handler for a command, either implemented by the core or by another module. </em> <a href="#a31"></a><em><br><br></td></tr>
114 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a32">ChangeHost</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string host)</td></tr>
116 <tr><td class="mdescLeft"> </td><td class="mdescRight">Change displayed hostname of a user. </em> <a href="#a32"></a><em><br><br></td></tr>
117 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a33">ChangeGECOS</a> (<a class="el" href="classuserrec.html">userrec</a> *user, std::string gecos)</td></tr>
119 <tr><td class="mdescLeft"> </td><td class="mdescRight">Change GECOS (fullname) of a user. </em> <a href="#a33"></a><em><br><br></td></tr>
120 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a34">IsUlined</a> (std::string server)</td></tr>
122 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the servername you give is ulined. </em> <a href="#a34"></a><em><br><br></td></tr>
123 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="modules_8h.html#a32">chanuserlist</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html#a35">GetUsers</a> (<a class="el" href="classchanrec.html">chanrec</a> *chan)</td></tr>
125 <tr><td class="mdescLeft"> </td><td class="mdescRight">Fetches the userlist of a channel. </em> <a href="#a35"></a><em><br><br></td></tr>
127 <hr><a name="_details"></a><h2>Detailed Description</h2>
128 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.
130 All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks.
134 Definition at line <a class="el" href="modules_8h-source.html#l00376">376</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
135 <a name="a0" doxytag="Server::Server"></a><p>
136 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
139 <table cellpadding="0" cellspacing="0" border="0">
141 <td class="md" nowrap valign="top"> Server::Server </td>
142 <td class="md" valign="top">( </td>
143 <td class="mdname1" valign="top" nowrap> </td>
144 <td class="md" valign="top"> ) </td>
145 <td class="md" nowrap></td>
152 <table cellspacing=5 cellpadding=0 border=0>
162 Creates a Server object.
164 Definition at line <a class="el" href="modules_8cpp-source.html#l00339">339</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
166 <div class="fragment"><pre>00340 {
171 <a name="a1" doxytag="Server::~Server"></a><p>
172 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
175 <table cellpadding="0" cellspacing="0" border="0">
177 <td class="md" nowrap valign="top"> Server::~<a class="el" href="classServer.html">Server</a> </td>
178 <td class="md" valign="top">( </td>
179 <td class="mdname1" valign="top" nowrap> </td>
180 <td class="md" valign="top"> ) </td>
181 <td class="md" nowrap><code> [virtual]</code></td>
188 <table cellspacing=5 cellpadding=0 border=0>
198 Destroys a Server object.
200 Definition at line <a class="el" href="modules_8cpp-source.html#l00343">343</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
202 <div class="fragment"><pre>00344 {
207 <hr><h2>Member Function Documentation</h2>
208 <a name="a23" doxytag="Server::AddCommand"></a><p>
209 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
212 <table cellpadding="0" cellspacing="0" border="0">
214 <td class="md" nowrap valign="top"> void Server::AddCommand </td>
215 <td class="md" valign="top">( </td>
216 <td class="md" nowrap valign="top">char * </td>
217 <td class="mdname" nowrap> <em>cmd</em>, </td>
222 <td class="md" nowrap>handlerfunc </td>
223 <td class="mdname" nowrap> <em>f</em>, </td>
228 <td class="md" nowrap>char </td>
229 <td class="mdname" nowrap> <em>flags</em>, </td>
234 <td class="md" nowrap>int </td>
235 <td class="mdname" nowrap> <em>minparams</em>, </td>
240 <td class="md" nowrap>char * </td>
241 <td class="mdname" nowrap> <em>source</em></td>
245 <td class="md">) </td>
246 <td class="md" colspan="2"><code> [virtual]</code></td>
253 <table cellspacing=5 cellpadding=0 border=0>
261 Adds a command to the command table.
263 This allows modules to add extra commands into the command table. You must place a function within your module which is is of type handlerfunc:<p>
264 typedef void (handlerfunc) (char**, int, userrec*); ... void <a class="el" href="commands_8h.html#a5">handle_kill(char **parameters, int pcnt, userrec *user)</a><p>
265 When the command is typed, the parameters will be placed into the parameters array (similar to argv) and the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters than the 'minparams' value you specified when creating the command. The *user parameter is the class of the user which caused the command to trigger, who will always have the flag you specified in 'flags' when creating the initial command. For example to create an oper only command create the commands with flags='o'. The source parameter is used for resource tracking, and should contain the name of your module (with file extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module is unloaded.
267 Definition at line <a class="el" href="modules_8cpp-source.html#l00420">420</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
269 References <a class="el" href="modules_8h.html#a34">createcommand()</a>.
271 <div class="fragment"><pre>00421 {
272 00422 <a class="code" href="modules_8h.html#a34">createcommand</a>(cmd,f,flags,minparams,source);
277 <a name="a22" doxytag="Server::AddExtendedListMode"></a><p>
278 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
281 <table cellpadding="0" cellspacing="0" border="0">
283 <td class="md" nowrap valign="top"> bool Server::AddExtendedListMode </td>
284 <td class="md" valign="top">( </td>
285 <td class="md" nowrap valign="top">char </td>
286 <td class="mdname1" valign="top" nowrap> <em>modechar</em> </td>
287 <td class="md" valign="top"> ) </td>
288 <td class="md" nowrap><code> [virtual]</code></td>
295 <table cellspacing=5 cellpadding=0 border=0>
303 Adds an extended mode letter which is parsed by a module and handled in a list fashion.
305 This call is used to implement modes like +q and +a. The characteristics of these modes are as follows:<p>
306 (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL<p>
307 (2) They always take exactly one parameter when being added or removed<p>
308 (3) They can be set multiple times, usually on users in channels<p>
309 (4) The mode and its parameter are NOT stored in the channels modes structure<p>
310 It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users, or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user' (in for example +a) you must use Server::Find to locate the user the mode is operating on. Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g. '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change, so the above example would become '+aa one three' after processing.
312 Definition at line <a class="el" href="modules_8cpp-source.html#l00565">565</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
314 References <a class="el" href="modules_8cpp-source.html#l00275">DoAddExtendedMode()</a>, <a class="el" href="modules_8cpp-source.html#l00285">ModeMakeList()</a>, and <a class="el" href="modules_8h-source.html#l00031">MT_CHANNEL</a>.
316 <div class="fragment"><pre>00566 {
317 00567 <span class="keywordtype">bool</span> res = <a class="code" href="modules_8cpp.html#a57">DoAddExtendedMode</a>(modechar,MT_CHANNEL,<span class="keyword">false</span>,1,1);
318 00568 <span class="keywordflow">if</span> (res)
319 00569 <a class="code" href="modules_8cpp.html#a58">ModeMakeList</a>(modechar);
320 00570 <span class="keywordflow">return</span> res;
325 <a name="a21" doxytag="Server::AddExtendedMode"></a><p>
326 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
329 <table cellpadding="0" cellspacing="0" border="0">
331 <td class="md" nowrap valign="top"> bool Server::AddExtendedMode </td>
332 <td class="md" valign="top">( </td>
333 <td class="md" nowrap valign="top">char </td>
334 <td class="mdname" nowrap> <em>modechar</em>, </td>
339 <td class="md" nowrap>int </td>
340 <td class="mdname" nowrap> <em>type</em>, </td>
345 <td class="md" nowrap>bool </td>
346 <td class="mdname" nowrap> <em>requires_oper</em>, </td>
351 <td class="md" nowrap>int </td>
352 <td class="mdname" nowrap> <em>params_when_on</em>, </td>
357 <td class="md" nowrap>int </td>
358 <td class="mdname" nowrap> <em>params_when_off</em></td>
362 <td class="md">) </td>
363 <td class="md" colspan="2"><code> [virtual]</code></td>
370 <table cellspacing=5 cellpadding=0 border=0>
378 Adds an extended mode letter which is parsed by a module.
380 This allows modules to add extra mode letters, e.g. +x for hostcloak. the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to indicate wether the mode is a channel mode, a client mode, or a server mode. requires_oper is used with MT_CLIENT type modes only to indicate the mode can only be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored. params_when_on is the number of modes to expect when the mode is turned on (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1. the params_when_off value has a similar value to params_when_on, except it indicates the number of parameters to expect when the mode is disabled. Modes which act in a similar way to channel mode +l (e.g. require a parameter to enable, but not to disable) should use this parameter. The function returns false if the mode is unavailable, and will not attempt to allocate another character, as this will confuse users. This also means that as only one module can claim a specific mode character, the core does not need to keep track of which modules own which modes, which speeds up operation of the server. In this version, a mode can have at most one parameter, attempting to use more parameters will have undefined effects.
382 Definition at line <a class="el" href="modules_8cpp-source.html#l00545">545</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
384 References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="modules_8cpp-source.html#l00275">DoAddExtendedMode()</a>, <a class="el" href="modules_8h-source.html#l00032">MT_CLIENT</a>, and <a class="el" href="modules_8h-source.html#l00033">MT_SERVER</a>.
386 <div class="fragment"><pre>00546 {
387 00547 <span class="keywordflow">if</span> (type == <a class="code" href="modules_8h.html#a7">MT_SERVER</a>)
389 00549 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Modes of type MT_SERVER are reserved for future expansion"</span>);
390 00550 <span class="keywordflow">return</span> <span class="keyword">false</span>;
392 00552 <span class="keywordflow">if</span> (((params_when_on>0) || (params_when_off>0)) && (type == <a class="code" href="modules_8h.html#a6">MT_CLIENT</a>))
394 00554 log(DEBUG,<span class="stringliteral">"*** API ERROR *** Parameters on MT_CLIENT modes are not supported"</span>);
395 00555 <span class="keywordflow">return</span> <span class="keyword">false</span>;
397 00557 <span class="keywordflow">if</span> ((params_when_on>1) || (params_when_off>1))
399 00559 log(DEBUG,<span class="stringliteral">"*** API ERROR *** More than one parameter for an MT_CHANNEL mode is not yet supported"</span>);
400 00560 <span class="keywordflow">return</span> <span class="keyword">false</span>;
402 00562 <span class="keywordflow">return</span> <a class="code" href="modules_8cpp.html#a57">DoAddExtendedMode</a>(modechar,type,requires_oper,params_when_on,params_when_off);
407 <a name="a31" doxytag="Server::CallCommandHandler"></a><p>
408 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
411 <table cellpadding="0" cellspacing="0" border="0">
413 <td class="md" nowrap valign="top"> void Server::CallCommandHandler </td>
414 <td class="md" valign="top">( </td>
415 <td class="md" nowrap valign="top">std::string </td>
416 <td class="mdname" nowrap> <em>commandname</em>, </td>
421 <td class="md" nowrap>char ** </td>
422 <td class="mdname" nowrap> <em>parameters</em>, </td>
427 <td class="md" nowrap>int </td>
428 <td class="mdname" nowrap> <em>pcnt</em>, </td>
433 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
434 <td class="mdname" nowrap> <em>user</em></td>
438 <td class="md">) </td>
439 <td class="md" colspan="2"><code> [virtual]</code></td>
446 <table cellspacing=5 cellpadding=0 border=0>
454 Calls the handler for a command, either implemented by the core or by another module.
456 You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN, KICK etc, or even as a method of callback. By defining command names that are untypeable for users on irc (e.g. those which contain a or <br>
457 ) you may use them as callback identifiers. The first parameter to this method is the name of the command handler you wish to call, e.g. PRIVMSG. This will be a command handler previously registered by the core or wih <a class="el" href="classServer.html#a23">AddCommand()</a>. The second parameter is an array of parameters, and the third parameter is a count of parameters in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the functiom will silently ignore it. The final parameter is the user executing the command handler, used for privilage checks, etc.
459 Definition at line <a class="el" href="modules_8cpp-source.html#l00410">410</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
461 <div class="fragment"><pre>00411 {
462 00412 call_handler(commandname.c_str(),parameters,pcnt,user);
467 <a name="a33" doxytag="Server::ChangeGECOS"></a><p>
468 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
471 <table cellpadding="0" cellspacing="0" border="0">
473 <td class="md" nowrap valign="top"> void Server::ChangeGECOS </td>
474 <td class="md" valign="top">( </td>
475 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
476 <td class="mdname" nowrap> <em>user</em>, </td>
481 <td class="md" nowrap>std::string </td>
482 <td class="mdname" nowrap> <em>gecos</em></td>
486 <td class="md">) </td>
487 <td class="md" colspan="2"><code> [virtual]</code></td>
494 <table cellspacing=5 cellpadding=0 border=0>
502 Change GECOS (fullname) of a user.
504 You should always call this method to change a user's GECOS rather than writing directly to the fullname member of userrec, as any change applied via this method will be propogated to any linked servers.
506 Definition at line <a class="el" href="modules_8cpp-source.html#l00498">498</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
508 References <a class="el" href="message_8h.html#a10">ChangeName()</a>.
510 <div class="fragment"><pre>00499 {
511 00500 <a class="code" href="message_8h.html#a10">ChangeName</a>(user,gecos.c_str());
516 <a name="a32" doxytag="Server::ChangeHost"></a><p>
517 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
520 <table cellpadding="0" cellspacing="0" border="0">
522 <td class="md" nowrap valign="top"> void Server::ChangeHost </td>
523 <td class="md" valign="top">( </td>
524 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
525 <td class="mdname" nowrap> <em>user</em>, </td>
530 <td class="md" nowrap>std::string </td>
531 <td class="mdname" nowrap> <em>host</em></td>
535 <td class="md">) </td>
536 <td class="md" colspan="2"><code> [virtual]</code></td>
543 <table cellspacing=5 cellpadding=0 border=0>
551 Change displayed hostname of a user.
553 You should always call this method to change a user's host rather than writing directly to the dhost member of userrec, as any change applied via this method will be propogated to any linked servers.
555 Definition at line <a class="el" href="modules_8cpp-source.html#l00493">493</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
557 References <a class="el" href="message_8h.html#a11">ChangeDisplayedHost()</a>.
559 <div class="fragment"><pre>00494 {
560 00495 <a class="code" href="message_8h.html#a11">ChangeDisplayedHost</a>(user,host.c_str());
565 <a name="a28" doxytag="Server::ChangeUserNick"></a><p>
566 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
569 <table cellpadding="0" cellspacing="0" border="0">
571 <td class="md" nowrap valign="top"> void Server::ChangeUserNick </td>
572 <td class="md" valign="top">( </td>
573 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
574 <td class="mdname" nowrap> <em>user</em>, </td>
579 <td class="md" nowrap>std::string </td>
580 <td class="mdname" nowrap> <em>nickname</em></td>
584 <td class="md">) </td>
585 <td class="md" colspan="2"><code> [virtual]</code></td>
592 <table cellspacing=5 cellpadding=0 border=0>
600 Forces a user nickchange.
602 This command works similarly to SVSNICK, and can be used to implement Q-lines etc. If you specify an invalid nickname, the nick change will be dropped and the target user will receive the error numeric for it.
604 Definition at line <a class="el" href="modules_8cpp-source.html#l00394">394</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
606 <div class="fragment"><pre>00395 {
607 00396 force_nickchange(user,nickname.c_str());
612 <a name="a16" doxytag="Server::ChanMode"></a><p>
613 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
616 <table cellpadding="0" cellspacing="0" border="0">
618 <td class="md" nowrap valign="top"> std::string Server::ChanMode </td>
619 <td class="md" valign="top">( </td>
620 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
621 <td class="mdname" nowrap> <em>User</em>, </td>
626 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
627 <td class="mdname" nowrap> <em>Chan</em></td>
631 <td class="md">) </td>
632 <td class="md" colspan="2"><code> [virtual]</code></td>
639 <table cellspacing=5 cellpadding=0 border=0>
647 Attempts to look up a user's privilages on a channel.
649 This function will return a string containing either @, , +, or an empty string, representing the user's privilages upon the channel you specify.
651 Definition at line <a class="el" href="modules_8cpp-source.html#l00518">518</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
653 References <a class="el" href="message_8h.html#a14">cmode()</a>.
655 <div class="fragment"><pre>00519 {
656 00520 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#a14">cmode</a>(User,Chan);
661 <a name="a9" doxytag="Server::CommonChannels"></a><p>
662 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
665 <table cellpadding="0" cellspacing="0" border="0">
667 <td class="md" nowrap valign="top"> bool Server::CommonChannels </td>
668 <td class="md" valign="top">( </td>
669 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
670 <td class="mdname" nowrap> <em>u1</em>, </td>
675 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
676 <td class="mdname" nowrap> <em>u2</em></td>
680 <td class="md">) </td>
681 <td class="md" colspan="2"><code> [virtual]</code></td>
688 <table cellspacing=5 cellpadding=0 border=0>
696 Returns true if two users share a common channel.
698 This method is used internally by the NICK and QUIT commands, and the <a class="el" href="classServer.html#a10">Server::SendCommon</a> method.
700 Definition at line <a class="el" href="modules_8cpp-source.html#l00471">471</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
702 References <a class="el" href="message_8h.html#a0">common_channels()</a>.
704 <div class="fragment"><pre>00472 {
705 00473 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a0">common_channels</a>(u1,u2) != 0);
710 <a name="a13" doxytag="Server::CountUsers"></a><p>
711 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
714 <table cellpadding="0" cellspacing="0" border="0">
716 <td class="md" nowrap valign="top"> int Server::CountUsers </td>
717 <td class="md" valign="top">( </td>
718 <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * </td>
719 <td class="mdname1" valign="top" nowrap> <em>c</em> </td>
720 <td class="md" valign="top"> ) </td>
721 <td class="md" nowrap><code> [virtual]</code></td>
728 <table cellspacing=5 cellpadding=0 border=0>
736 Returns a count of the number of users on a channel.
738 This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
740 Definition at line <a class="el" href="modules_8cpp-source.html#l00573">573</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
742 <div class="fragment"><pre>00574 {
743 00575 <span class="keywordflow">return</span> usercount(c);
748 <a name="a15" doxytag="Server::FindChannel"></a><p>
749 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
752 <table cellpadding="0" cellspacing="0" border="0">
754 <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::FindChannel </td>
755 <td class="md" valign="top">( </td>
756 <td class="md" nowrap valign="top">std::string </td>
757 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
758 <td class="md" valign="top"> ) </td>
759 <td class="md" nowrap><code> [virtual]</code></td>
766 <table cellspacing=5 cellpadding=0 border=0>
774 Attempts to look up a channel and return a pointer to it.
776 This function will return NULL if the channel does not exist.
778 Definition at line <a class="el" href="modules_8cpp-source.html#l00513">513</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
780 <div class="fragment"><pre>00514 {
781 00515 <span class="keywordflow">return</span> FindChan(channel.c_str());
786 <a name="a14" doxytag="Server::FindNick"></a><p>
787 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
790 <table cellpadding="0" cellspacing="0" border="0">
792 <td class="md" nowrap valign="top"> <a class="el" href="classuserrec.html">userrec</a> * Server::FindNick </td>
793 <td class="md" valign="top">( </td>
794 <td class="md" nowrap valign="top">std::string </td>
795 <td class="mdname1" valign="top" nowrap> <em>nick</em> </td>
796 <td class="md" valign="top"> ) </td>
797 <td class="md" nowrap><code> [virtual]</code></td>
804 <table cellspacing=5 cellpadding=0 border=0>
812 Attempts to look up a nick and return a pointer to it.
814 This function will return NULL if the nick does not exist.
816 Definition at line <a class="el" href="modules_8cpp-source.html#l00508">508</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
818 <div class="fragment"><pre>00509 {
819 00510 <span class="keywordflow">return</span> Find(nick);
824 <a name="a20" doxytag="Server::GetAdmin"></a><p>
825 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
828 <table cellpadding="0" cellspacing="0" border="0">
830 <td class="md" nowrap valign="top"> <a class="el" href="classAdmin.html">Admin</a> Server::GetAdmin </td>
831 <td class="md" valign="top">( </td>
832 <td class="mdname1" valign="top" nowrap> </td>
833 <td class="md" valign="top"> ) </td>
834 <td class="md" nowrap><code> [virtual]</code></td>
841 <table cellspacing=5 cellpadding=0 border=0>
849 Returns the information of the server as returned by the /ADMIN command.
851 See the <a class="el" href="classAdmin.html">Admin</a> class for further information of the return value. The members <a class="el" href="classAdmin.html#o2">Admin::Nick</a>, <a class="el" href="classAdmin.html#o1">Admin::Email</a> and <a class="el" href="classAdmin.html#o0">Admin::Name</a> contain the information for the server where the module is loaded.
853 Definition at line <a class="el" href="modules_8cpp-source.html#l00538">538</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
855 <div class="fragment"><pre>00539 {
856 00540 <span class="keywordflow">return</span> <a class="code" href="classAdmin.html">Admin</a>(getadminname(),getadminemail(),getadminnick());
861 <a name="a19" doxytag="Server::GetNetworkName"></a><p>
862 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
865 <table cellpadding="0" cellspacing="0" border="0">
867 <td class="md" nowrap valign="top"> std::string Server::GetNetworkName </td>
868 <td class="md" valign="top">( </td>
869 <td class="mdname1" valign="top" nowrap> </td>
870 <td class="md" valign="top"> ) </td>
871 <td class="md" nowrap><code> [virtual]</code></td>
878 <table cellspacing=5 cellpadding=0 border=0>
886 Returns the network name, global to all linked servers.
890 Definition at line <a class="el" href="modules_8cpp-source.html#l00533">533</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
892 <div class="fragment"><pre>00534 {
893 00535 <span class="keywordflow">return</span> getnetworkname();
898 <a name="a18" doxytag="Server::GetServerName"></a><p>
899 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
902 <table cellpadding="0" cellspacing="0" border="0">
904 <td class="md" nowrap valign="top"> std::string Server::GetServerName </td>
905 <td class="md" valign="top">( </td>
906 <td class="mdname1" valign="top" nowrap> </td>
907 <td class="md" valign="top"> ) </td>
908 <td class="md" nowrap><code> [virtual]</code></td>
915 <table cellspacing=5 cellpadding=0 border=0>
923 Returns the server name of the server where the module is loaded.
927 Definition at line <a class="el" href="modules_8cpp-source.html#l00528">528</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
929 <div class="fragment"><pre>00529 {
930 00530 <span class="keywordflow">return</span> getservername();
935 <a name="a35" doxytag="Server::GetUsers"></a><p>
936 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
939 <table cellpadding="0" cellspacing="0" border="0">
941 <td class="md" nowrap valign="top"> <a class="el" href="modules_8h.html#a32">chanuserlist</a> Server::GetUsers </td>
942 <td class="md" valign="top">( </td>
943 <td class="md" nowrap valign="top"><a class="el" href="classchanrec.html">chanrec</a> * </td>
944 <td class="mdname1" valign="top" nowrap> <em>chan</em> </td>
945 <td class="md" valign="top"> ) </td>
946 <td class="md" nowrap><code> [virtual]</code></td>
953 <table cellspacing=5 cellpadding=0 border=0>
961 Fetches the userlist of a channel.
963 This function must be here and not a member of userrec or chanrec due to include constraints.
965 Definition at line <a class="el" href="modules_8cpp-source.html#l00375">375</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
967 References <a class="el" href="modules_8h-source.html#l00072">chanuserlist</a>, <a class="el" href="modules_8cpp-source.html#l00179">clientlist</a>, <a class="el" href="message_8h.html#a16">has_channel()</a>, and <a class="el" href="message_8h.html#a13">isnick()</a>.
969 <div class="fragment"><pre>00376 {
970 00377 <a class="code" href="modules_8h.html#a32">chanuserlist</a> userl;
972 00379 <span class="keywordflow">for</span> (user_hash::const_iterator i = <a class="code" href="modules_8cpp.html#a42">clientlist</a>.begin(); i != <a class="code" href="modules_8cpp.html#a42">clientlist</a>.end(); i++)
974 00381 <span class="keywordflow">if</span> (i->second)
976 00383 <span class="keywordflow">if</span> (<a class="code" href="message_8h.html#a16">has_channel</a>(i->second,chan))
978 00385 <span class="keywordflow">if</span> (<a class="code" href="message_8h.html#a13">isnick</a>(i->second->nick))
980 00387 userl.push_back(i->second);
985 00392 <span class="keywordflow">return</span> userl;
990 <a name="a12" doxytag="Server::IsNick"></a><p>
991 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
994 <table cellpadding="0" cellspacing="0" border="0">
996 <td class="md" nowrap valign="top"> bool Server::IsNick </td>
997 <td class="md" valign="top">( </td>
998 <td class="md" nowrap valign="top">std::string </td>
999 <td class="mdname1" valign="top" nowrap> <em>nick</em> </td>
1000 <td class="md" valign="top"> ) </td>
1001 <td class="md" nowrap><code> [virtual]</code></td>
1008 <table cellspacing=5 cellpadding=0 border=0>
1016 Returns true if a nick is valid.
1018 Nicks for unregistered connections will return false.
1020 Definition at line <a class="el" href="modules_8cpp-source.html#l00503">503</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1022 References <a class="el" href="message_8h.html#a13">isnick()</a>.
1024 <div class="fragment"><pre>00504 {
1025 00505 <span class="keywordflow">return</span> (<a class="code" href="message_8h.html#a13">isnick</a>(nick.c_str()) != 0);
1030 <a name="a17" doxytag="Server::IsOnChannel"></a><p>
1031 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1034 <table cellpadding="0" cellspacing="0" border="0">
1036 <td class="md" nowrap valign="top"> bool Server::IsOnChannel </td>
1037 <td class="md" valign="top">( </td>
1038 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1039 <td class="mdname" nowrap> <em>User</em>, </td>
1044 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
1045 <td class="mdname" nowrap> <em>Chan</em></td>
1049 <td class="md">) </td>
1050 <td class="md" colspan="2"><code> [virtual]</code></td>
1057 <table cellspacing=5 cellpadding=0 border=0>
1065 Checks if a user is on a channel.
1067 This function will return true or false to indicate if user 'User' is on channel 'Chan'.
1069 Definition at line <a class="el" href="modules_8cpp-source.html#l00523">523</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1071 References <a class="el" href="message_8h.html#a16">has_channel()</a>.
1073 <div class="fragment"><pre>00524 {
1074 00525 <span class="keywordflow">return</span> <a class="code" href="message_8h.html#a16">has_channel</a>(User,Chan);
1079 <a name="a34" doxytag="Server::IsUlined"></a><p>
1080 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1083 <table cellpadding="0" cellspacing="0" border="0">
1085 <td class="md" nowrap valign="top"> bool Server::IsUlined </td>
1086 <td class="md" valign="top">( </td>
1087 <td class="md" nowrap valign="top">std::string </td>
1088 <td class="mdname1" valign="top" nowrap> <em>server</em> </td>
1089 <td class="md" valign="top"> ) </td>
1090 <td class="md" nowrap><code> [virtual]</code></td>
1097 <table cellspacing=5 cellpadding=0 border=0>
1105 Returns true if the servername you give is ulined.
1107 ULined servers have extra privilages. They are allowed to change nicknames on remote servers, change modes of clients which are on remote servers and set modes of channels where there are no channel operators for that channel on the ulined server, amongst other things. Ulined server data is also broadcast across the mesh at all times as opposed to selectively messaged in the case of normal servers, as many ulined server types (such as services) do not support meshed links and must operate in this manner.
1109 Definition at line <a class="el" href="modules_8cpp-source.html#l00405">405</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1111 References <a class="el" href="commands_8h.html#a74">is_uline()</a>.
1113 <div class="fragment"><pre>00406 {
1114 00407 <span class="keywordflow">return</span> <a class="code" href="commands_8h.html#a74">is_uline</a>(server.c_str());
1119 <a name="a26" doxytag="Server::JoinUserToChannel"></a><p>
1120 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1123 <table cellpadding="0" cellspacing="0" border="0">
1125 <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::JoinUserToChannel </td>
1126 <td class="md" valign="top">( </td>
1127 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1128 <td class="mdname" nowrap> <em>user</em>, </td>
1133 <td class="md" nowrap>std::string </td>
1134 <td class="mdname" nowrap> <em>cname</em>, </td>
1139 <td class="md" nowrap>std::string </td>
1140 <td class="mdname" nowrap> <em>key</em></td>
1144 <td class="md">) </td>
1145 <td class="md" colspan="2"><code> [virtual]</code></td>
1152 <table cellspacing=5 cellpadding=0 border=0>
1160 Forces a user to join a channel.
1162 This is similar to svsjoin and can be used to implement redirection, etc. On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to. On failure, the result is NULL.
1164 Definition at line <a class="el" href="modules_8cpp-source.html#l00365">365</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1166 <div class="fragment"><pre>00366 {
1167 00367 <span class="keywordflow">return</span> add_channel(user,cname.c_str(),key.c_str(),<span class="keyword">true</span>);
1172 <a name="a3" doxytag="Server::Log"></a><p>
1173 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1176 <table cellpadding="0" cellspacing="0" border="0">
1178 <td class="md" nowrap valign="top"> void Server::Log </td>
1179 <td class="md" valign="top">( </td>
1180 <td class="md" nowrap valign="top">int </td>
1181 <td class="mdname" nowrap> <em>level</em>, </td>
1186 <td class="md" nowrap>std::string </td>
1187 <td class="mdname" nowrap> <em>s</em></td>
1191 <td class="md">) </td>
1192 <td class="md" colspan="2"><code> [virtual]</code></td>
1199 <table cellspacing=5 cellpadding=0 border=0>
1207 Writes a log string.
1209 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.
1211 Definition at line <a class="el" href="modules_8cpp-source.html#l00415">415</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1213 <div class="fragment"><pre>00416 {
1214 00417 log(level,<span class="stringliteral">"%s"</span>,s.c_str());
1219 <a name="a30" doxytag="Server::MatchText"></a><p>
1220 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1223 <table cellpadding="0" cellspacing="0" border="0">
1225 <td class="md" nowrap valign="top"> bool Server::MatchText </td>
1226 <td class="md" valign="top">( </td>
1227 <td class="md" nowrap valign="top">std::string </td>
1228 <td class="mdname" nowrap> <em>sliteral</em>, </td>
1233 <td class="md" nowrap>std::string </td>
1234 <td class="mdname" nowrap> <em>spattern</em></td>
1238 <td class="md">) </td>
1239 <td class="md" colspan="2"><code> [virtual]</code></td>
1246 <table cellspacing=5 cellpadding=0 border=0>
1254 Matches text against a glob pattern.
1256 Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com Returns true if the literal successfully matches the pattern, false if otherwise.
1258 Definition at line <a class="el" href="modules_8cpp-source.html#l00352">352</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1260 <div class="fragment"><pre>00353 {
1261 00354 <span class="keywordtype">char</span> literal[MAXBUF],pattern[MAXBUF];
1262 00355 strlcpy(literal,sliteral.c_str(),MAXBUF);
1263 00356 strlcpy(pattern,spattern.c_str(),MAXBUF);
1264 00357 <span class="keywordflow">return</span> match(literal,pattern);
1269 <a name="a27" doxytag="Server::PartUserFromChannel"></a><p>
1270 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1273 <table cellpadding="0" cellspacing="0" border="0">
1275 <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a> * Server::PartUserFromChannel </td>
1276 <td class="md" valign="top">( </td>
1277 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1278 <td class="mdname" nowrap> <em>user</em>, </td>
1283 <td class="md" nowrap>std::string </td>
1284 <td class="mdname" nowrap> <em>cname</em>, </td>
1289 <td class="md" nowrap>std::string </td>
1290 <td class="mdname" nowrap> <em>reason</em></td>
1294 <td class="md">) </td>
1295 <td class="md" colspan="2"><code> [virtual]</code></td>
1302 <table cellspacing=5 cellpadding=0 border=0>
1310 Forces a user to part a channel.
1312 This is similar to svspart and can be used to implement redirection, etc. Although the return value of this function is a pointer to a channel record, the returned data is undefined and should not be read or written to. This behaviour may be changed in a future version.
1314 Definition at line <a class="el" href="modules_8cpp-source.html#l00370">370</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1316 <div class="fragment"><pre>00371 {
1317 00372 <span class="keywordflow">return</span> del_channel(user,cname.c_str(),reason.c_str(),<span class="keyword">false</span>);
1322 <a name="a29" doxytag="Server::QuitUser"></a><p>
1323 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1326 <table cellpadding="0" cellspacing="0" border="0">
1328 <td class="md" nowrap valign="top"> void Server::QuitUser </td>
1329 <td class="md" valign="top">( </td>
1330 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1331 <td class="mdname" nowrap> <em>user</em>, </td>
1336 <td class="md" nowrap>std::string </td>
1337 <td class="mdname" nowrap> <em>reason</em></td>
1341 <td class="md">) </td>
1342 <td class="md" colspan="2"><code> [virtual]</code></td>
1349 <table cellspacing=5 cellpadding=0 border=0>
1357 Forces a user to quit with the specified reason.
1359 To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function may bypass the quit prefix specified in the config file.<p>
1361 Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of action after calling this method is to immediately bail from your handler.
1363 Definition at line <a class="el" href="modules_8cpp-source.html#l00399">399</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1365 References <a class="el" href="users_8h-source.html#l00106">userrec::nick</a>, and <a class="el" href="message_8h.html#a19">send_network_quit()</a>.
1367 <div class="fragment"><pre>00400 {
1368 00401 <a class="code" href="message_8h.html#a19">send_network_quit</a>(user-><a class="code" href="classuserrec.html#o0">nick</a>,reason.c_str());
1369 00402 kill_link(user,reason.c_str());
1374 <a name="a4" doxytag="Server::Send"></a><p>
1375 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1378 <table cellpadding="0" cellspacing="0" border="0">
1380 <td class="md" nowrap valign="top"> void Server::Send </td>
1381 <td class="md" valign="top">( </td>
1382 <td class="md" nowrap valign="top">int </td>
1383 <td class="mdname" nowrap> <em>Socket</em>, </td>
1388 <td class="md" nowrap>std::string </td>
1389 <td class="mdname" nowrap> <em>s</em></td>
1393 <td class="md">) </td>
1394 <td class="md" colspan="2"><code> [virtual]</code></td>
1401 <table cellspacing=5 cellpadding=0 border=0>
1409 Sends a line of text down a TCP/IP socket.
1411 This method writes a line of text to an established socket, cutting it to 510 characters plus a carriage return and linefeed if required.
1413 Definition at line <a class="el" href="modules_8cpp-source.html#l00430">430</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1415 <div class="fragment"><pre>00431 {
1416 00432 Write(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
1421 <a name="a8" doxytag="Server::SendChannel"></a><p>
1422 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1425 <table cellpadding="0" cellspacing="0" border="0">
1427 <td class="md" nowrap valign="top"> void Server::SendChannel </td>
1428 <td class="md" valign="top">( </td>
1429 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1430 <td class="mdname" nowrap> <em>User</em>, </td>
1435 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
1436 <td class="mdname" nowrap> <em>Channel</em>, </td>
1441 <td class="md" nowrap>std::string </td>
1442 <td class="mdname" nowrap> <em>s</em>, </td>
1447 <td class="md" nowrap>bool </td>
1448 <td class="mdname" nowrap> <em>IncludeSender</em></td>
1452 <td class="md">) </td>
1453 <td class="md" colspan="2"><code> [virtual]</code></td>
1460 <table cellspacing=5 cellpadding=0 border=0>
1468 Sends text from a user to a channel (mulicast).
1470 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).
1472 Definition at line <a class="el" href="modules_8cpp-source.html#l00459">459</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1474 <div class="fragment"><pre>00460 {
1475 00461 <span class="keywordflow">if</span> (IncludeSender)
1477 00463 WriteChannel(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
1479 00465 <span class="keywordflow">else</span>
1481 00467 ChanExceptSender(Channel,User,<span class="stringliteral">"%s"</span>,s.c_str());
1487 <a name="a10" doxytag="Server::SendCommon"></a><p>
1488 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1491 <table cellpadding="0" cellspacing="0" border="0">
1493 <td class="md" nowrap valign="top"> void Server::SendCommon </td>
1494 <td class="md" valign="top">( </td>
1495 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1496 <td class="mdname" nowrap> <em>User</em>, </td>
1501 <td class="md" nowrap>std::string </td>
1502 <td class="mdname" nowrap> <em>text</em>, </td>
1507 <td class="md" nowrap>bool </td>
1508 <td class="mdname" nowrap> <em>IncludeSender</em></td>
1512 <td class="md">) </td>
1513 <td class="md" colspan="2"><code> [virtual]</code></td>
1520 <table cellspacing=5 cellpadding=0 border=0>
1528 Sends text from a user to one or more channels (mulicast).
1530 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.
1532 Definition at line <a class="el" href="modules_8cpp-source.html#l00476">476</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1534 <div class="fragment"><pre>00477 {
1535 00478 <span class="keywordflow">if</span> (IncludeSender)
1537 00480 WriteCommon(User,<span class="stringliteral">"%s"</span>,text.c_str());
1539 00482 <span class="keywordflow">else</span>
1541 00484 WriteCommonExcept(User,<span class="stringliteral">"%s"</span>,text.c_str());
1547 <a name="a6" doxytag="Server::SendFrom"></a><p>
1548 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1551 <table cellpadding="0" cellspacing="0" border="0">
1553 <td class="md" nowrap valign="top"> void Server::SendFrom </td>
1554 <td class="md" valign="top">( </td>
1555 <td class="md" nowrap valign="top">int </td>
1556 <td class="mdname" nowrap> <em>Socket</em>, </td>
1561 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
1562 <td class="mdname" nowrap> <em>User</em>, </td>
1567 <td class="md" nowrap>std::string </td>
1568 <td class="mdname" nowrap> <em>s</em></td>
1572 <td class="md">) </td>
1573 <td class="md" colspan="2"><code> [virtual]</code></td>
1580 <table cellspacing=5 cellpadding=0 border=0>
1588 Sends text from a user to a socket.
1590 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)
1592 Definition at line <a class="el" href="modules_8cpp-source.html#l00440">440</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1594 <div class="fragment"><pre>00441 {
1595 00442 WriteFrom(Socket,User,<span class="stringliteral">"%s"</span>,s.c_str());
1600 <a name="a24" doxytag="Server::SendMode"></a><p>
1601 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1604 <table cellpadding="0" cellspacing="0" border="0">
1606 <td class="md" nowrap valign="top"> void Server::SendMode </td>
1607 <td class="md" valign="top">( </td>
1608 <td class="md" nowrap valign="top">char ** </td>
1609 <td class="mdname" nowrap> <em>parameters</em>, </td>
1614 <td class="md" nowrap>int </td>
1615 <td class="mdname" nowrap> <em>pcnt</em>, </td>
1620 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
1621 <td class="mdname" nowrap> <em>user</em></td>
1625 <td class="md">) </td>
1626 <td class="md" colspan="2"><code> [virtual]</code></td>
1633 <table cellspacing=5 cellpadding=0 border=0>
1643 you must format the parameters array with the target, modes and parameters for those modes.<p>
1646 modes[0] = ChannelName;<p>
1648 modes[2] = user->nick;<p>
1649 Srv->SendMode(modes,3,user);<p>
1650 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!
1652 Definition at line <a class="el" href="modules_8cpp-source.html#l00425">425</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1654 References <a class="el" href="modules_8h.html#a35">server_mode()</a>.
1656 <div class="fragment"><pre>00426 {
1657 00427 <a class="code" href="modules_8h.html#a35">server_mode</a>(parameters,pcnt,user);
1662 <a name="a2" doxytag="Server::SendOpers"></a><p>
1663 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1666 <table cellpadding="0" cellspacing="0" border="0">
1668 <td class="md" nowrap valign="top"> void Server::SendOpers </td>
1669 <td class="md" valign="top">( </td>
1670 <td class="md" nowrap valign="top">std::string </td>
1671 <td class="mdname1" valign="top" nowrap> <em>s</em> </td>
1672 <td class="md" valign="top"> ) </td>
1673 <td class="md" nowrap><code> [virtual]</code></td>
1680 <table cellspacing=5 cellpadding=0 border=0>
1688 Sends text to all opers.
1690 This method sends a server notice to all opers with the usermode +s.
1692 Definition at line <a class="el" href="modules_8cpp-source.html#l00347">347</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1694 <div class="fragment"><pre>00348 {
1695 00349 WriteOpers(<span class="stringliteral">"%s"</span>,s.c_str());
1700 <a name="a5" doxytag="Server::SendServ"></a><p>
1701 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1704 <table cellpadding="0" cellspacing="0" border="0">
1706 <td class="md" nowrap valign="top"> void Server::SendServ </td>
1707 <td class="md" valign="top">( </td>
1708 <td class="md" nowrap valign="top">int </td>
1709 <td class="mdname" nowrap> <em>Socket</em>, </td>
1714 <td class="md" nowrap>std::string </td>
1715 <td class="mdname" nowrap> <em>s</em></td>
1719 <td class="md">) </td>
1720 <td class="md" colspan="2"><code> [virtual]</code></td>
1727 <table cellspacing=5 cellpadding=0 border=0>
1735 Sends text from the server to a socket.
1737 This method writes a line of text to an established socket, with the servername prepended as used by numerics (see RFC 1459)
1739 Definition at line <a class="el" href="modules_8cpp-source.html#l00435">435</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1741 <div class="fragment"><pre>00436 {
1742 00437 WriteServ(Socket,<span class="stringliteral">"%s"</span>,s.c_str());
1747 <a name="a7" doxytag="Server::SendTo"></a><p>
1748 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1751 <table cellpadding="0" cellspacing="0" border="0">
1753 <td class="md" nowrap valign="top"> void Server::SendTo </td>
1754 <td class="md" valign="top">( </td>
1755 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1756 <td class="mdname" nowrap> <em>Source</em>, </td>
1761 <td class="md" nowrap><a class="el" href="classuserrec.html">userrec</a> * </td>
1762 <td class="mdname" nowrap> <em>Dest</em>, </td>
1767 <td class="md" nowrap>std::string </td>
1768 <td class="mdname" nowrap> <em>s</em></td>
1772 <td class="md">) </td>
1773 <td class="md" colspan="2"><code> [virtual]</code></td>
1780 <table cellspacing=5 cellpadding=0 border=0>
1788 Sends text from a user to another user.
1790 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) If you specify NULL as the source, then the data will originate from the local server, e.g. instead of:<p>
1792 The format will become:<p>
1793 :localserver TEXT<p>
1794 Which is useful for numerics and server notices to single users, etc.
1796 Definition at line <a class="el" href="modules_8cpp-source.html#l00445">445</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1798 References <a class="el" href="connection_8h-source.html#l00178">connection::fd</a>.
1800 <div class="fragment"><pre>00446 {
1801 00447 <span class="keywordflow">if</span> (!Source)
1803 00449 <span class="comment">// if source is NULL, then the message originates from the local server</span>
1804 00450 Write(Dest-><a class="code" href="classconnection.html#o0">fd</a>,<span class="stringliteral">":%s %s"</span>,this->GetServerName().c_str(),s.c_str());
1806 00452 <span class="keywordflow">else</span>
1808 00454 <span class="comment">// otherwise it comes from the user specified</span>
1809 00455 WriteTo(Source,Dest,<span class="stringliteral">"%s"</span>,s.c_str());
1815 <a name="a25" doxytag="Server::SendToModeMask"></a><p>
1816 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1819 <table cellpadding="0" cellspacing="0" border="0">
1821 <td class="md" nowrap valign="top"> void Server::SendToModeMask </td>
1822 <td class="md" valign="top">( </td>
1823 <td class="md" nowrap valign="top">std::string </td>
1824 <td class="mdname" nowrap> <em>modes</em>, </td>
1829 <td class="md" nowrap>int </td>
1830 <td class="mdname" nowrap> <em>flags</em>, </td>
1835 <td class="md" nowrap>std::string </td>
1836 <td class="mdname" nowrap> <em>text</em></td>
1840 <td class="md">) </td>
1841 <td class="md" colspan="2"><code> [virtual]</code></td>
1848 <table cellspacing=5 cellpadding=0 border=0>
1856 Sends to all users matching a mode mask You must specify one or more usermodes as the first parameter.
1858 These can be RFC specified modes such as +i, or module provided modes, including ones provided by your own module. In the second parameter you must place a flag value which indicates wether the modes you have given will be logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR. for example, if you were to use:<p>
1859 Serv->SendToModeMask("xi", WM_OR, "m00");<p>
1860 Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the user must have both modes set to receive the message.
1862 Definition at line <a class="el" href="modules_8cpp-source.html#l00360">360</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1864 <div class="fragment"><pre>00361 {
1865 00362 WriteMode(modes.c_str(),flags,<span class="stringliteral">"%s"</span>,text.c_str());
1870 <a name="a11" doxytag="Server::SendWallops"></a><p>
1871 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1874 <table cellpadding="0" cellspacing="0" border="0">
1876 <td class="md" nowrap valign="top"> void Server::SendWallops </td>
1877 <td class="md" valign="top">( </td>
1878 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
1879 <td class="mdname" nowrap> <em>User</em>, </td>
1884 <td class="md" nowrap>std::string </td>
1885 <td class="mdname" nowrap> <em>text</em></td>
1889 <td class="md">) </td>
1890 <td class="md" colspan="2"><code> [virtual]</code></td>
1897 <table cellspacing=5 cellpadding=0 border=0>
1905 Sends a WALLOPS message.
1907 This method writes a WALLOPS message to all users with the +w flag, originating from the specified user.
1909 Definition at line <a class="el" href="modules_8cpp-source.html#l00488">488</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
1911 <div class="fragment"><pre>00489 {
1912 00490 WriteWallOps(User,<span class="keyword">false</span>,<span class="stringliteral">"%s"</span>,text.c_str());
1917 <hr>The documentation for this class was generated from the following files:<ul>
1918 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
1919 <hr size="1"><address style="align: right;"><small>Generated on Sat Apr 9 14:38:30 2005 for InspIRCd by
1920 <a href="http://www.doxygen.org/index.html">
1921 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
1922 </a>1.3.3 </small></address>