mirror of
https://github.com/jlu5/PyLink.git
synced 2024-11-24 03:29:28 +01:00
docs: add auto-generated InspIRCd protocol spec, and finish off most of writing-plugins.md
This commit is contained in:
James Lu
parent
394d4f7f1d
commit
bd9a857042
@ -3,6 +3,8 @@
|
|||||||
Please note that as PyLink is still in its development phase, the API is subject to change.
|
Please note that as PyLink is still in its development phase, the API is subject to change.
|
||||||
Any documentation here is provided for reference only.
|
Any documentation here is provided for reference only.
|
||||||
|
|
||||||
|
It is also really incomplete (contributors welcome!)
|
||||||
|
|
||||||
### Introduction
|
### Introduction
|
||||||
|
|
||||||
PyLink is an a modular, plugin-based IRC PseudoService framework. It uses swappable protocol modules and a hook-based system for calling plugins, allowing them to function regardless of the IRCd used.
|
PyLink is an a modular, plugin-based IRC PseudoService framework. It uses swappable protocol modules and a hook-based system for calling plugins, allowing them to function regardless of the IRCd used.
|
||||||
@ -12,7 +14,10 @@ PyLink is an a modular, plugin-based IRC PseudoService framework. It uses swappa
|
|||||||
### Contents
|
### Contents
|
||||||
|
|
||||||
- [Writing plugins for PyLink](writing-plugins.md)
|
- [Writing plugins for PyLink](writing-plugins.md)
|
||||||
- [PyLink hooks reference](hooks-reference.md)
|
|
||||||
- [PyLink protocol module specification](pmodule-spec.md)
|
- [PyLink protocol module specification](pmodule-spec.md)
|
||||||
|
|
||||||
|
#### Future topics (not yet available)
|
||||||
|
|
||||||
|
- [PyLink hooks reference](hooks-reference.md)
|
||||||
- [Writing tests for PyLink modules](writing-tests.md)
|
- [Writing tests for PyLink modules](writing-tests.md)
|
||||||
- [Using PyLink's utils module](using-utils.md)
|
- [Using PyLink's utils module](using-utils.md)
|
||||||
|
|||||||
405
docs/technical/inspircd_protocol.html
Normal file
405
docs/technical/inspircd_protocol.html
Normal file
@ -0,0 +1,405 @@
|
|||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||||
|
<html><head><title>Python: module inspircd</title>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||||
|
</head><body bgcolor="#f0f0f8">
|
||||||
|
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||||||
|
<tr bgcolor="#7799ee">
|
||||||
|
<td valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>inspircd</strong></big></big></font></td
|
||||||
|
><td align=right valign=bottom
|
||||||
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/gl/pylink/protocols/inspircd.py">/home/gl/pylink/protocols/inspircd.py</a></font></td></tr></table>
|
||||||
|
<p></p>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#aa55cc">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="hashlib.html">hashlib</a><br>
|
||||||
|
<a href="os.html">os</a><br>
|
||||||
|
<a href="re.html">re</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="socket.html">socket</a><br>
|
||||||
|
<a href="ssl.html">ssl</a><br>
|
||||||
|
<a href="sys.html">sys</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="threading.html">threading</a><br>
|
||||||
|
<a href="time.html">time</a><br>
|
||||||
|
<a href="utils.html">utils</a><br>
|
||||||
|
</td><td width="25%" valign=top><a href="world.html">world</a><br>
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ee77aa">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="ts6_common.html#TS6BaseProtocol">ts6_common.TS6BaseProtocol</a>(<a href="classes.html#Protocol">classes.Protocol</a>)
|
||||||
|
</font></dt><dd>
|
||||||
|
<dl>
|
||||||
|
<dt><font face="helvetica, arial"><a href="inspircd.html#InspIRCdProtocol">InspIRCdProtocol</a>
|
||||||
|
</font></dt></dl>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><strong>Class</strong> = <a name="Class">class InspIRCdProtocol</a>(<a href="ts6_common.html#TS6BaseProtocol">ts6_common.TS6BaseProtocol</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||||
|
<dd><a href="inspircd.html#InspIRCdProtocol">InspIRCdProtocol</a></dd>
|
||||||
|
<dd><a href="ts6_common.html#TS6BaseProtocol">ts6_common.TS6BaseProtocol</a></dd>
|
||||||
|
<dd><a href="classes.html#Protocol">classes.Protocol</a></dd>
|
||||||
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Methods defined here:<br>
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-__init__"><strong>__init__</strong></a>(self, irc)</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-awayClient"><strong>awayClient</strong></a>(self, source, text)</dt><dd><tt>Sends an AWAY message from a PyLink client. <text> can be an empty string<br>
|
||||||
|
to unset AWAY status.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-connect"><strong>connect</strong></a>(self)</dt><dd><tt>Initializes a connection to a server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_away"><strong>handle_away</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming AWAY messages.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_encap"><strong>handle_encap</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming encapsulated commands (ENCAP). Hook arguments<br>
|
||||||
|
returned by this should have a parse_as field, that sets the correct<br>
|
||||||
|
hook name for the message.<br>
|
||||||
|
<br>
|
||||||
|
For InspIRCd, the only ENCAP command we handle right now is KNOCK.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_endburst"><strong>handle_endburst</strong></a>(self, numeric, command, args)</dt><dd><tt>ENDBURST handler; sends a hook with empty contents.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_events"><strong>handle_events</strong></a>(self, data)</dt><dd><tt>Event handler for the InspIRCd protocol. This passes most commands to<br>
|
||||||
|
the various handle_ABCD() functions elsewhere in this module, but also<br>
|
||||||
|
handles commands sent in the initial server linking phase.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fhost"><strong>handle_fhost</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles FHOST, used for denoting hostname changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fident"><strong>handle_fident</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles FIDENT, used for denoting ident changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fjoin"><strong>handle_fjoin</strong></a>(self, servernumeric, command, args)</dt><dd><tt>Handles incoming FJOIN commands (InspIRCd equivalent of JOIN/SJOIN).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fmode"><strong>handle_fmode</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles the FMODE command, used for channel mode changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fname"><strong>handle_fname</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles FNAME, used for denoting real name/gecos changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_ftopic"><strong>handle_ftopic</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming FTOPIC (sets topic on burst).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_idle"><strong>handle_idle</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles the IDLE command, sent between servers in remote WHOIS queries.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_invite"><strong>handle_invite</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming INVITEs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_opertype"><strong>handle_opertype</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming OPERTYPE, which is used to denote an oper up.<br>
|
||||||
|
<br>
|
||||||
|
This calls the internal hook PYLINK_CLIENT_OPERED, sets the internal<br>
|
||||||
|
opertype of the client, and assumes setting user mode +o on the caller.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_ping"><strong>handle_ping</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PING commands, so we don't time out.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_pong"><strong>handle_pong</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PONG commands. This is used to keep track of whether<br>
|
||||||
|
the uplink is alive by the Irc() internals - a server that fails to reply<br>
|
||||||
|
to our PINGs eventually times out and is disconnected.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_server"><strong>handle_server</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SERVER commands (introduction of servers).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_uid"><strong>handle_uid</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming UID commands (user introduction).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-inviteClient"><strong>inviteClient</strong></a>(self, numeric, target, channel)</dt><dd><tt>Sends an INVITE from a PyLink client..</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-joinClient"><strong>joinClient</strong></a>(self, client, channel)</dt><dd><tt>Joins an internal spawned client <client> to a channel.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-killClient"><strong>killClient</strong></a>(self, numeric, target, reason)</dt><dd><tt><self.<strong>irc</strong> object> <client numeric> <target> <reason><br>
|
||||||
|
<br>
|
||||||
|
Sends a kill to <target> from a PyLink PseudoClient.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-killServer"><strong>killServer</strong></a>(self, numeric, target, reason)</dt><dd><tt><self.<strong>irc</strong> object> <server SID> <target> <reason><br>
|
||||||
|
<br>
|
||||||
|
Sends a kill to <target> from a PyLink PseudoServer.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-knockClient"><strong>knockClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a KNOCK from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-modeClient"><strong>modeClient</strong></a>(self, numeric, target, modes, ts=None)</dt><dd><tt>Sends modes from a PyLink client. <modes> should be<br>
|
||||||
|
a list of (mode, arg) tuples, i.e. the format of utils.parseModes() output.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-modeServer"><strong>modeServer</strong></a>(self, numeric, target, modes, ts=None)</dt><dd><tt>Sends modes from a PyLink server. <list of modes> should be<br>
|
||||||
|
a list of (mode, arg) tuples, i.e. the format of utils.parseModes() output.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-numericServer"><strong>numericServer</strong></a>(self, source, numeric, text)</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-pingServer"><strong>pingServer</strong></a>(self, source=None, target=None)</dt><dd><tt>Sends a PING to a target server. Periodic PINGs are sent to our uplink<br>
|
||||||
|
automatically by the Irc() internals; plugins shouldn't have to use this.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-sjoinServer"><strong>sjoinServer</strong></a>(self, server, channel, users, ts=None)</dt><dd><tt>Sends an SJOIN for a group of users to a channel.<br>
|
||||||
|
<br>
|
||||||
|
The sender should always be a Server ID (SID). TS is optional, and defaults<br>
|
||||||
|
to the one we've stored in the channel state if not given.<br>
|
||||||
|
<users> is a list of (prefix mode, UID) pairs:<br>
|
||||||
|
<br>
|
||||||
|
Example uses:<br>
|
||||||
|
<a href="#Class-sjoinServer">sjoinServer</a>(self.<strong>irc</strong>, '100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])<br>
|
||||||
|
<a href="#Class-sjoinServer">sjoinServer</a>(self.<strong>irc</strong>, self.<strong>irc</strong>.sid, '#test', [('o', self.<strong>irc</strong>.pseudoclient.uid)])</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-spawnClient"><strong>spawnClient</strong></a>(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype=None)</dt><dd><tt>Spawns a client with nick <nick> on the given IRC connection.<br>
|
||||||
|
<br>
|
||||||
|
Note: No nick collision / valid nickname checks are done here; it is<br>
|
||||||
|
up to plugins to make sure they don't introduce anything invalid.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-spawnServer"><strong>spawnServer</strong></a>(self, name, sid=None, uplink=None, desc=None)</dt><dd><tt>Spawns a server off a PyLink server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-squitServer"><strong>squitServer</strong></a>(self, source, target, text='No reason given')</dt><dd><tt>SQUITs a PyLink server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-topicServer"><strong>topicServer</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a burst topic from a PyLink server. This is usally used on burst.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-updateClient"><strong>updateClient</strong></a>(self, numeric, field, text)</dt><dd><tt>Updates the ident, host, or realname of a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Methods inherited from <a href="ts6_common.html#TS6BaseProtocol">ts6_common.TS6BaseProtocol</a>:<br>
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_error"><strong>handle_error</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles ERROR messages - these mean that our uplink has disconnected us!</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_kick"><strong>handle_kick</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KICKs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_kill"><strong>handle_kill</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KILLs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_mode"><strong>handle_mode</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming user mode changes. For channel mode changes,<br>
|
||||||
|
TMODE (TS6/charybdis) and FMODE (Inspself.ircd) are used instead.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_nick"><strong>handle_nick</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming NICK changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_notice"><strong>handle_notice</strong></a> = handle_privmsg(self, source, command, args)</dt><dd><tt>Handles incoming PRIVMSG/NOTICE.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_part"><strong>handle_part</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PART commands.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_privmsg"><strong>handle_privmsg</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PRIVMSG/NOTICE.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_quit"><strong>handle_quit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming QUITs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_save"><strong>handle_save</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SAVE messages, used to handle nick collisions.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_squit"><strong>handle_squit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SQUITs (netsplits).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_topic"><strong>handle_topic</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming TOPIC changes from clients. For topic bursts,<br>
|
||||||
|
TB (TS6/charybdis) and FTOPIC (Inspself.ircd) are used instead.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-kickClient"><strong>kickClient</strong></a>(self, numeric, channel, target, reason=None)</dt><dd><tt>Sends a kick from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-kickServer"><strong>kickServer</strong></a>(self, numeric, channel, target, reason=None)</dt><dd><tt>Sends a kick from a PyLink server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-messageClient"><strong>messageClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a PRIVMSG from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-nickClient"><strong>nickClient</strong></a>(self, numeric, newnick)</dt><dd><tt>Changes the nick of a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-noticeClient"><strong>noticeClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a NOTICE from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-parseArgs"><strong>parseArgs</strong></a>(self, args)</dt><dd><tt>Parses a string of <a href="http://www.rfc-editor.org/rfc/rfc1459.txt">RFC1459</a>-style arguments split into a list, where ":" may<br>
|
||||||
|
be used for multi-word arguments that last until the end of a line.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-parseTS6Args"><strong>parseTS6Args</strong></a>(self, args)</dt><dd><tt>Similar to <a href="#Class-parseArgs">parseArgs</a>(), but stripping leading colons from the first argument<br>
|
||||||
|
of a line (usually the sender field).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-partClient"><strong>partClient</strong></a>(self, client, channel, reason=None)</dt><dd><tt>Sends a part from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-quitClient"><strong>quitClient</strong></a>(self, numeric, reason)</dt><dd><tt>Quits a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-removeClient"><strong>removeClient</strong></a>(self, numeric)</dt><dd><tt>Internal function to remove a client from our internal state.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-topicClient"><strong>topicClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a TOPIC change from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors inherited from <a href="classes.html#Protocol">classes.Protocol</a>:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
</td></tr></table> <p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#ffc8d8">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#000000" face="helvetica, arial"><a name="InspIRCdProtocol">class <strong>InspIRCdProtocol</strong></a>(<a href="ts6_common.html#TS6BaseProtocol">ts6_common.TS6BaseProtocol</a>)</font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||||
|
<dd><a href="inspircd.html#InspIRCdProtocol">InspIRCdProtocol</a></dd>
|
||||||
|
<dd><a href="ts6_common.html#TS6BaseProtocol">ts6_common.TS6BaseProtocol</a></dd>
|
||||||
|
<dd><a href="classes.html#Protocol">classes.Protocol</a></dd>
|
||||||
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
||||||
|
</dl>
|
||||||
|
<hr>
|
||||||
|
Methods defined here:<br>
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-__init__"><strong>__init__</strong></a>(self, irc)</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-awayClient"><strong>awayClient</strong></a>(self, source, text)</dt><dd><tt>Sends an AWAY message from a PyLink client. <text> can be an empty string<br>
|
||||||
|
to unset AWAY status.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-connect"><strong>connect</strong></a>(self)</dt><dd><tt>Initializes a connection to a server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_away"><strong>handle_away</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming AWAY messages.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_encap"><strong>handle_encap</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming encapsulated commands (ENCAP). Hook arguments<br>
|
||||||
|
returned by this should have a parse_as field, that sets the correct<br>
|
||||||
|
hook name for the message.<br>
|
||||||
|
<br>
|
||||||
|
For InspIRCd, the only ENCAP command we handle right now is KNOCK.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_endburst"><strong>handle_endburst</strong></a>(self, numeric, command, args)</dt><dd><tt>ENDBURST handler; sends a hook with empty contents.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_events"><strong>handle_events</strong></a>(self, data)</dt><dd><tt>Event handler for the InspIRCd protocol. This passes most commands to<br>
|
||||||
|
the various handle_ABCD() functions elsewhere in this module, but also<br>
|
||||||
|
handles commands sent in the initial server linking phase.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fhost"><strong>handle_fhost</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles FHOST, used for denoting hostname changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fident"><strong>handle_fident</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles FIDENT, used for denoting ident changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fjoin"><strong>handle_fjoin</strong></a>(self, servernumeric, command, args)</dt><dd><tt>Handles incoming FJOIN commands (InspIRCd equivalent of JOIN/SJOIN).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fmode"><strong>handle_fmode</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles the FMODE command, used for channel mode changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_fname"><strong>handle_fname</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles FNAME, used for denoting real name/gecos changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_ftopic"><strong>handle_ftopic</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming FTOPIC (sets topic on burst).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_idle"><strong>handle_idle</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles the IDLE command, sent between servers in remote WHOIS queries.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_invite"><strong>handle_invite</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming INVITEs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_opertype"><strong>handle_opertype</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming OPERTYPE, which is used to denote an oper up.<br>
|
||||||
|
<br>
|
||||||
|
This calls the internal hook PYLINK_CLIENT_OPERED, sets the internal<br>
|
||||||
|
opertype of the client, and assumes setting user mode +o on the caller.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_ping"><strong>handle_ping</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PING commands, so we don't time out.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_pong"><strong>handle_pong</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PONG commands. This is used to keep track of whether<br>
|
||||||
|
the uplink is alive by the Irc() internals - a server that fails to reply<br>
|
||||||
|
to our PINGs eventually times out and is disconnected.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_server"><strong>handle_server</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SERVER commands (introduction of servers).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_uid"><strong>handle_uid</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming UID commands (user introduction).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-inviteClient"><strong>inviteClient</strong></a>(self, numeric, target, channel)</dt><dd><tt>Sends an INVITE from a PyLink client..</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-joinClient"><strong>joinClient</strong></a>(self, client, channel)</dt><dd><tt>Joins an internal spawned client <client> to a channel.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-killClient"><strong>killClient</strong></a>(self, numeric, target, reason)</dt><dd><tt><self.<strong>irc</strong> object> <client numeric> <target> <reason><br>
|
||||||
|
<br>
|
||||||
|
Sends a kill to <target> from a PyLink PseudoClient.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-killServer"><strong>killServer</strong></a>(self, numeric, target, reason)</dt><dd><tt><self.<strong>irc</strong> object> <server SID> <target> <reason><br>
|
||||||
|
<br>
|
||||||
|
Sends a kill to <target> from a PyLink PseudoServer.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-knockClient"><strong>knockClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a KNOCK from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-modeClient"><strong>modeClient</strong></a>(self, numeric, target, modes, ts=None)</dt><dd><tt>Sends modes from a PyLink client. <modes> should be<br>
|
||||||
|
a list of (mode, arg) tuples, i.e. the format of utils.parseModes() output.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-modeServer"><strong>modeServer</strong></a>(self, numeric, target, modes, ts=None)</dt><dd><tt>Sends modes from a PyLink server. <list of modes> should be<br>
|
||||||
|
a list of (mode, arg) tuples, i.e. the format of utils.parseModes() output.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-numericServer"><strong>numericServer</strong></a>(self, source, numeric, text)</dt></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-pingServer"><strong>pingServer</strong></a>(self, source=None, target=None)</dt><dd><tt>Sends a PING to a target server. Periodic PINGs are sent to our uplink<br>
|
||||||
|
automatically by the Irc() internals; plugins shouldn't have to use this.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-sjoinServer"><strong>sjoinServer</strong></a>(self, server, channel, users, ts=None)</dt><dd><tt>Sends an SJOIN for a group of users to a channel.<br>
|
||||||
|
<br>
|
||||||
|
The sender should always be a Server ID (SID). TS is optional, and defaults<br>
|
||||||
|
to the one we've stored in the channel state if not given.<br>
|
||||||
|
<users> is a list of (prefix mode, UID) pairs:<br>
|
||||||
|
<br>
|
||||||
|
Example uses:<br>
|
||||||
|
<a href="#InspIRCdProtocol-sjoinServer">sjoinServer</a>(self.<strong>irc</strong>, '100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])<br>
|
||||||
|
<a href="#InspIRCdProtocol-sjoinServer">sjoinServer</a>(self.<strong>irc</strong>, self.<strong>irc</strong>.sid, '#test', [('o', self.<strong>irc</strong>.pseudoclient.uid)])</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-spawnClient"><strong>spawnClient</strong></a>(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype=None)</dt><dd><tt>Spawns a client with nick <nick> on the given IRC connection.<br>
|
||||||
|
<br>
|
||||||
|
Note: No nick collision / valid nickname checks are done here; it is<br>
|
||||||
|
up to plugins to make sure they don't introduce anything invalid.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-spawnServer"><strong>spawnServer</strong></a>(self, name, sid=None, uplink=None, desc=None)</dt><dd><tt>Spawns a server off a PyLink server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-squitServer"><strong>squitServer</strong></a>(self, source, target, text='No reason given')</dt><dd><tt>SQUITs a PyLink server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-topicServer"><strong>topicServer</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a burst topic from a PyLink server. This is usally used on burst.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-updateClient"><strong>updateClient</strong></a>(self, numeric, field, text)</dt><dd><tt>Updates the ident, host, or realname of a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Methods inherited from <a href="ts6_common.html#TS6BaseProtocol">ts6_common.TS6BaseProtocol</a>:<br>
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_error"><strong>handle_error</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles ERROR messages - these mean that our uplink has disconnected us!</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_kick"><strong>handle_kick</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KICKs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_kill"><strong>handle_kill</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KILLs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_mode"><strong>handle_mode</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming user mode changes. For channel mode changes,<br>
|
||||||
|
TMODE (TS6/charybdis) and FMODE (Inspself.ircd) are used instead.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_nick"><strong>handle_nick</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming NICK changes.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_notice"><strong>handle_notice</strong></a> = handle_privmsg(self, source, command, args)</dt><dd><tt>Handles incoming PRIVMSG/NOTICE.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_part"><strong>handle_part</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PART commands.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_privmsg"><strong>handle_privmsg</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PRIVMSG/NOTICE.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_quit"><strong>handle_quit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming QUITs.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_save"><strong>handle_save</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SAVE messages, used to handle nick collisions.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_squit"><strong>handle_squit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SQUITs (netsplits).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-handle_topic"><strong>handle_topic</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming TOPIC changes from clients. For topic bursts,<br>
|
||||||
|
TB (TS6/charybdis) and FTOPIC (Inspself.ircd) are used instead.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-kickClient"><strong>kickClient</strong></a>(self, numeric, channel, target, reason=None)</dt><dd><tt>Sends a kick from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-kickServer"><strong>kickServer</strong></a>(self, numeric, channel, target, reason=None)</dt><dd><tt>Sends a kick from a PyLink server.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-messageClient"><strong>messageClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a PRIVMSG from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-nickClient"><strong>nickClient</strong></a>(self, numeric, newnick)</dt><dd><tt>Changes the nick of a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-noticeClient"><strong>noticeClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a NOTICE from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-parseArgs"><strong>parseArgs</strong></a>(self, args)</dt><dd><tt>Parses a string of <a href="http://www.rfc-editor.org/rfc/rfc1459.txt">RFC1459</a>-style arguments split into a list, where ":" may<br>
|
||||||
|
be used for multi-word arguments that last until the end of a line.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-parseTS6Args"><strong>parseTS6Args</strong></a>(self, args)</dt><dd><tt>Similar to <a href="#InspIRCdProtocol-parseArgs">parseArgs</a>(), but stripping leading colons from the first argument<br>
|
||||||
|
of a line (usually the sender field).</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-partClient"><strong>partClient</strong></a>(self, client, channel, reason=None)</dt><dd><tt>Sends a part from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-quitClient"><strong>quitClient</strong></a>(self, numeric, reason)</dt><dd><tt>Quits a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-removeClient"><strong>removeClient</strong></a>(self, numeric)</dt><dd><tt>Internal function to remove a client from our internal state.</tt></dd></dl>
|
||||||
|
|
||||||
|
<dl><dt><a name="InspIRCdProtocol-topicClient"><strong>topicClient</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a TOPIC change from a PyLink client.</tt></dd></dl>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
Data descriptors inherited from <a href="classes.html#Protocol">classes.Protocol</a>:<br>
|
||||||
|
<dl><dt><strong>__dict__</strong></dt>
|
||||||
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
<dl><dt><strong>__weakref__</strong></dt>
|
||||||
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||||
|
</dl>
|
||||||
|
</td></tr></table></td></tr></table><p>
|
||||||
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||||
|
<tr bgcolor="#55aa55">
|
||||||
|
<td colspan=3 valign=bottom> <br>
|
||||||
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||||
|
|
||||||
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||||
|
<td width="100%"><strong>conf</strong> = {'bot': {'loglevel': 'CRITICAL', 'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'servers': defaultdict(<function <lambda> at 0x7f47d93ddc80>, {})}<br>
|
||||||
|
<strong>curdir</strong> = 'protocols'<br>
|
||||||
|
<strong>log</strong> = <logging.RootLogger object></td></tr></table>
|
||||||
|
</body></html>
|
||||||
27
docs/technical/pmodule-spec.md
Normal file
27
docs/technical/pmodule-spec.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
This page is still incomplete. See [inspircd_protocol.html](inspircd_protocol.html) for an auto-generated specification of the protocol module. Any camelCase `ABCServer/Client` functions are outgoing commands, and include the following:
|
||||||
|
|
||||||
|
- `awayClient`
|
||||||
|
- `inviteClient`
|
||||||
|
- `joinClient`
|
||||||
|
- `kickClient`
|
||||||
|
- `kickServer`
|
||||||
|
- `killClient`
|
||||||
|
- `killServer`
|
||||||
|
- `knockClient`
|
||||||
|
- `messageClient`
|
||||||
|
- `modeClient`
|
||||||
|
- `modeServer`
|
||||||
|
- `nickClient`
|
||||||
|
- `noticeClient`
|
||||||
|
- `numericServer`
|
||||||
|
- `partClient`
|
||||||
|
- `pingServer`
|
||||||
|
- `quitClient`
|
||||||
|
- `removeClient`
|
||||||
|
- `sjoinServer`
|
||||||
|
- `spawnClient`
|
||||||
|
- `spawnServer`
|
||||||
|
- `squitServer`
|
||||||
|
- `topicClient`
|
||||||
|
- `topicServer`
|
||||||
|
- `updateClient`
|
||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
PyLink plugins are modules that extend its functionality by giving it something to do. Without any plugins loaded, PyLink can only sit on a server and do absolutely nothing.
|
PyLink plugins are modules that extend its functionality by giving it something to do. Without any plugins loaded, PyLink can only sit on a server and do absolutely nothing.
|
||||||
|
|
||||||
This guide, along with the sample plugin [`plugin-example.py`](plugin-example.py), aim to show the basics of writing plugins for PyLink.
|
This guide, along with the sample plugin [`plugin_example.py`](plugin_example.py), aim to show the basics of writing plugins for PyLink.
|
||||||
|
|
||||||
### Receiving data from IRC
|
### Receiving data from IRC
|
||||||
|
|
||||||
@ -38,12 +38,33 @@ Each command function takes 3 arguments: `irc, source, args`.
|
|||||||
- **source**: The numeric of the sender. This will usually be a UID (for users) or a SID (for server).
|
- **source**: The numeric of the sender. This will usually be a UID (for users) or a SID (for server).
|
||||||
- **args**: A `list` of space-separated command args (excluding the command name) that the command was called with. For example, `/msg PyLink hello world 1234` would give an `args` list of `['world', '1234']`
|
- **args**: A `list` of space-separated command args (excluding the command name) that the command was called with. For example, `/msg PyLink hello world 1234` would give an `args` list of `['world', '1234']`
|
||||||
|
|
||||||
Command handlers do not return anything, and can raise exceptions to be caught by the core.
|
Command handlers do not return anything and can raise exceptions, which are caught by the core and automatically return an error message.
|
||||||
|
|
||||||
### WHOIS handlers
|
### WHOIS handlers
|
||||||
|
|
||||||
The third option, `WHOIS` handlers, are a lot more limited compared to the other options. They are solely used for `WHOIS` replies, **and only work on IRCds where WHOIS commands are sent to remote servers!** This includes Charybdis and UnrealIRCd, but **not** InspIRCd, which handles all `WHOIS` requests locally (the only thing sent between servers is an IDLE time query).
|
The third option, `WHOIS` handlers, are a lot more limited compared to the other options. They are solely used for `WHOIS` replies, **and only work on IRCds where WHOIS commands are sent to remote servers!** This includes Charybdis and UnrealIRCd, but **not** InspIRCd, which handles all `WHOIS` requests locally (the only thing sent between servers is an IDLE time query).
|
||||||
|
|
||||||
WHOIS replies are special in that any plugins wishing to add lines to a WHOIS reply must do so after the regular WHOIS lines (handled by the core), but before a special "End of WHOIS" line. This means that the regular hooks mechanism, which are only called after core handling, won't work here.
|
WHOIS replies are special in that any plugins wishing to add lines to a WHOIS reply must do so after the regular WHOIS lines (handled by the core), but before a special "End of WHOIS" line. This means that the regular hooks mechanism, which are only called after core handling, doesn't work here.
|
||||||
|
|
||||||
\- section under construction -
|
An example of a plugin WHOIS handler is in the relay plugin. WHOIS handler functions are added to the `world.whois_handlers` list using a simple `append()`. They should return either nothing or a two-length list: the first item being the WHOIS numeric, and the second the raw whois text.
|
||||||
|
|
||||||
|
```
|
||||||
|
def relayWhoisHandler(irc, target):
|
||||||
|
user = irc.users[target]
|
||||||
|
orig = getLocalUser(irc, target)
|
||||||
|
if orig:
|
||||||
|
network, remoteuid = orig
|
||||||
|
remotenick = world.networkobjects[network].users[remoteuid].nick
|
||||||
|
return [320, "%s :is a remote user connected via PyLink Relay. Home "
|
||||||
|
"network: %s; Home nick: %s" % (user.nick, network,
|
||||||
|
remotenick)]
|
||||||
|
world.whois_handlers.append(relayWhoisHandler)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sending data to IRC
|
||||||
|
|
||||||
|
Plugins receive data from the underlying protocol module, and communicate back using outgoing [command functions](pmodule-spec.md) implemented by the protocol module. They should *never* send raw data directly back to IRC, because that wouldn't be portable across different IRCds.
|
||||||
|
|
||||||
|
These functions are usually called in this fashion: `irc.proto.abcdClient(arg1, arg2)`. For example, the command `irc.proto.joinClient('10XAAAAAB', '#bots')` would join a PyLink client with UID `10XAAAAAB` to channel `#bots`.
|
||||||
|
|
||||||
|
For sending messages (e.g. replies to commands), a simpler form of `irc.msg(targetUID, text, notice=False, source=None)` is also used. The sender UID can be set here with the `source` argument, and defaults to the main PyLink client.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user