2016-05-12 06:56:02 +02:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
|
<html><head><title>Python: module nefarious</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>nefarious</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/nefarious.py">/home/gl/pylink/protocols/nefarious.py</a></font></td></tr></table>
|
|
|
|
|
<p><tt>nefarious.py: Nefarious IRCu protocol module for PyLink.</tt></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="base64.html">base64</a><br>
|
|
|
|
|
<a href="hashlib.html">hashlib</a><br>
|
|
|
|
|
<a href="inspect.html">inspect</a><br>
|
|
|
|
|
<a href="logging.html">logging</a><br>
|
|
|
|
|
</td><td width="25%" valign=top><a href="os.html">os</a><br>
|
|
|
|
|
<a href="socket.html">socket</a><br>
|
|
|
|
|
<a href="ssl.html">ssl</a><br>
|
|
|
|
|
<a href="struct.html">struct</a><br>
|
|
|
|
|
</td><td width="25%" valign=top><a href="structures.html">structures</a><br>
|
|
|
|
|
<a href="sys.html">sys</a><br>
|
|
|
|
|
<a href="threading.html">threading</a><br>
|
|
|
|
|
<a href="time.html">time</a><br>
|
|
|
|
|
</td><td width="25%" valign=top><a href="utils.html">utils</a><br>
|
|
|
|
|
<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="builtins.html#object">builtins.object</a>
|
|
|
|
|
</font></dt><dd>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><font face="helvetica, arial"><a href="nefarious.html#P10SIDGenerator">P10SIDGenerator</a>
|
|
|
|
|
</font></dt></dl>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><font face="helvetica, arial"><a href="classes.html#Protocol">classes.Protocol</a>(<a href="builtins.html#object">builtins.object</a>)
|
|
|
|
|
</font></dt><dd>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><font face="helvetica, arial"><a href="nefarious.html#P10Protocol">P10Protocol</a>
|
|
|
|
|
</font></dt></dl>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><font face="helvetica, arial"><a href="utils.html#IncrementalUIDGenerator">utils.IncrementalUIDGenerator</a>(<a href="builtins.html#object">builtins.object</a>)
|
|
|
|
|
</font></dt><dd>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><font face="helvetica, arial"><a href="nefarious.html#P10UIDGenerator">P10UIDGenerator</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 P10Protocol</a>(<a href="classes.html#Protocol">classes.Protocol</a>)</font></td></tr>
|
|
|
|
|
|
2016-05-28 07:39:27 +02:00
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
|
|
|
<td colspan=2><tt>Base <a href="classes.html#Protocol">Protocol</a> module class for PyLink.<br> </tt></td></tr>
|
|
|
|
|
<tr><td> </td>
|
2016-05-12 06:56:02 +02:00
|
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
|
|
|
<dd><a href="nefarious.html#P10Protocol">P10Protocol</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>
|
2016-05-28 07:39:27 +02:00
|
|
|
<dl><dt><a name="P10Protocol-__init__"><strong>__init__</strong></a>(self, irc)</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
2016-05-12 06:56:02 +02:00
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-away"><strong>away</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="P10Protocol-checkCloakChange"><strong>checkCloakChange</strong></a>(self, uid)</dt><dd><tt>Checks for cloak changes on the given UID.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-connect"><strong>connect</strong></a>(self)</dt><dd><tt>Initializes a connection to a server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_account"><strong>handle_account</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles services account changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-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="P10Protocol-handle_burst"><strong>handle_burst</strong></a>(self, source, command, args)</dt><dd><tt>Handles the BURST command, used for bursting channels on link.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This is equivalent to SJOIN on most IRCds.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_clearmode"><strong>handle_clearmode</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles CLEARMODE, which is used to clear a channel's modes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_create"><strong>handle_create</strong></a> = <a href="#P10Protocol-handle_join">handle_join</a>(self, source, command, args)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_end_of_burst"><strong>handle_end_of_burst</strong></a>(self, source, command, args)</dt><dd><tt>Handles end of burst from our uplink.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_events"><strong>handle_events</strong></a>(self, data)</dt><dd><tt>Event handler for the P10 protocol.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This passes most commands to the various handle_ABCD() functions defined elsewhere in the<br>
|
|
|
|
|
protocol modules, coersing various sender prefixes from nicks and server names to P10<br>
|
|
|
|
|
"numeric nicks", whenever possible.<br>
|
|
|
|
|
<br>
|
|
|
|
|
Commands sent without an explicit sender prefix are treated as originating from the uplink<br>
|
|
|
|
|
server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_fake"><strong>handle_fake</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming FAKE hostmask changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_invite"><strong>handle_invite</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming INVITEs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_join"><strong>handle_join</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming JOINs and channel creations.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_kick"><strong>handle_kick</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KICKs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_kill"><strong>handle_kill</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming KILLs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_mode"><strong>handle_mode</strong></a>(self, source, command, args)</dt><dd><tt>Handles mode changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_nick"><strong>handle_nick</strong></a>(self, source, command, args)</dt><dd><tt>Handles the NICK command, used for user introductions and nick changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_notice"><strong>handle_notice</strong></a> = <a href="#P10Protocol-handle_privmsg">handle_privmsg</a>(self, source, command, args)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_opmode"><strong>handle_opmode</strong></a> = <a href="#P10Protocol-handle_mode">handle_mode</a>(self, source, command, args)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_part"><strong>handle_part</strong></a>(self, source, command, args)</dt><dd><tt>Handles user parts.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_pass"><strong>handle_pass</strong></a>(self, source, command, args)</dt><dd><tt>Handles authentication with our uplink.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_ping"><strong>handle_ping</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PING requests.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_pong"><strong>handle_pong</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PONGs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-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="P10Protocol-handle_quit"><strong>handle_quit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming QUITs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_server"><strong>handle_server</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming server introductions.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_squit"><strong>handle_squit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SQUITs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_topic"><strong>handle_topic</strong></a>(self, source, command, args)</dt><dd><tt>Handles TOPIC changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_version"><strong>handle_version</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles requests for the PyLink server version.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_whois"><strong>handle_whois</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming WHOIS requests.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-invite"><strong>invite</strong></a>(self, numeric, target, channel)</dt><dd><tt>Sends INVITEs from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-join"><strong>join</strong></a>(self, client, channel)</dt><dd><tt>Joins a PyLink client to a channel.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-kick"><strong>kick</strong></a>(self, numeric, channel, target, reason=None)</dt><dd><tt>Sends kicks from a PyLink client/server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-kill"><strong>kill</strong></a>(self, numeric, target, reason)</dt><dd><tt>Sends a kill from a PyLink client/server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-knock"><strong>knock</strong></a>(self, numeric, target, text)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-message"><strong>message</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a PRIVMSG from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-mode"><strong>mode</strong></a>(self, numeric, target, modes, ts=None)</dt><dd><tt>Sends mode changes from a PyLink client/server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-nick"><strong>nick</strong></a>(self, numeric, newnick)</dt><dd><tt>Changes the nick of a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-notice"><strong>notice</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a NOTICE from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-numeric"><strong>numeric</strong></a>(self, source, numeric, target, text)</dt><dd><tt>Sends raw numerics from a server to a remote client. This is used for WHOIS<br>
|
|
|
|
|
replies.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-part"><strong>part</strong></a>(self, client, channel, reason=None)</dt><dd><tt>Sends a part from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-ping"><strong>ping</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="P10Protocol-quit"><strong>quit</strong></a>(self, numeric, reason)</dt><dd><tt>Quits a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-sjoin"><strong>sjoin</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-sjoin">sjoin</a>('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])<br>
|
|
|
|
|
<a href="#Class-sjoin">sjoin</a>(self.<strong>irc</strong>.sid, '#test', [('o', self.<strong>irc</strong>.pseudoclient.uid)])</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-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='IRC Operator', manipulatable=False)</dt><dd><tt>Spawns a new client with the given options.<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="P10Protocol-spawnServer"><strong>spawnServer</strong></a>(self, name, sid=None, uplink=None, desc=None, endburst_delay=0)</dt><dd><tt>Spawns a server off a PyLink server. desc (server description)<br>
|
|
|
|
|
defaults to the one in the config. uplink defaults to the main PyLink<br>
|
|
|
|
|
server, and sid (the server ID) is automatically generated if not<br>
|
|
|
|
|
given.<br>
|
|
|
|
|
<br>
|
|
|
|
|
Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay<br>
|
|
|
|
|
option will be ignored if given.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-squit"><strong>squit</strong></a>(self, source, target, text='No reason given')</dt><dd><tt>SQUITs a PyLink server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-topic"><strong>topic</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a TOPIC change from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-topicBurst"><strong>topicBurst</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a TOPIC change from a PyLink server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-updateClient"><strong>updateClient</strong></a>(self, target, field, text)</dt><dd><tt>Updates the ident or host of any connected client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Static methods defined here:<br>
|
|
|
|
|
<dl><dt><a name="P10Protocol-decode_p10_ip"><strong>decode_p10_ip</strong></a>(ip)</dt><dd><tt>Decodes a P10 IP.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Methods inherited from <a href="classes.html#Protocol">classes.Protocol</a>:<br>
|
|
|
|
|
<dl><dt><a name="P10Protocol-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="P10Protocol-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="P10Protocol-updateTS"><strong>updateTS</strong></a>(self, channel, their_ts)</dt><dd><tt>Compares the current TS of the channel given with the new TS, resetting<br>
|
|
|
|
|
all modes we have if the one given is older.</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="P10Protocol">class <strong>P10Protocol</strong></a>(<a href="classes.html#Protocol">classes.Protocol</a>)</font></td></tr>
|
|
|
|
|
|
2016-05-28 07:39:27 +02:00
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
|
|
|
<td colspan=2><tt>Base <a href="classes.html#Protocol">Protocol</a> module class for PyLink.<br> </tt></td></tr>
|
|
|
|
|
<tr><td> </td>
|
2016-05-12 06:56:02 +02:00
|
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
|
|
|
<dd><a href="nefarious.html#P10Protocol">P10Protocol</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>
|
2016-05-28 07:39:27 +02:00
|
|
|
<dl><dt><a name="P10Protocol-__init__"><strong>__init__</strong></a>(self, irc)</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
2016-05-12 06:56:02 +02:00
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-away"><strong>away</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="P10Protocol-checkCloakChange"><strong>checkCloakChange</strong></a>(self, uid)</dt><dd><tt>Checks for cloak changes on the given UID.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-connect"><strong>connect</strong></a>(self)</dt><dd><tt>Initializes a connection to a server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_account"><strong>handle_account</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles services account changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-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="P10Protocol-handle_burst"><strong>handle_burst</strong></a>(self, source, command, args)</dt><dd><tt>Handles the BURST command, used for bursting channels on link.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This is equivalent to SJOIN on most IRCds.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_clearmode"><strong>handle_clearmode</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles CLEARMODE, which is used to clear a channel's modes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_create"><strong>handle_create</strong></a> = <a href="#P10Protocol-handle_join">handle_join</a>(self, source, command, args)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_end_of_burst"><strong>handle_end_of_burst</strong></a>(self, source, command, args)</dt><dd><tt>Handles end of burst from our uplink.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_events"><strong>handle_events</strong></a>(self, data)</dt><dd><tt>Event handler for the P10 protocol.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This passes most commands to the various handle_ABCD() functions defined elsewhere in the<br>
|
|
|
|
|
protocol modules, coersing various sender prefixes from nicks and server names to P10<br>
|
|
|
|
|
"numeric nicks", whenever possible.<br>
|
|
|
|
|
<br>
|
|
|
|
|
Commands sent without an explicit sender prefix are treated as originating from the uplink<br>
|
|
|
|
|
server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_fake"><strong>handle_fake</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming FAKE hostmask changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_invite"><strong>handle_invite</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming INVITEs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_join"><strong>handle_join</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming JOINs and channel creations.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_kick"><strong>handle_kick</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KICKs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_kill"><strong>handle_kill</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming KILLs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_mode"><strong>handle_mode</strong></a>(self, source, command, args)</dt><dd><tt>Handles mode changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_nick"><strong>handle_nick</strong></a>(self, source, command, args)</dt><dd><tt>Handles the NICK command, used for user introductions and nick changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_notice"><strong>handle_notice</strong></a> = <a href="#P10Protocol-handle_privmsg">handle_privmsg</a>(self, source, command, args)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_opmode"><strong>handle_opmode</strong></a> = <a href="#P10Protocol-handle_mode">handle_mode</a>(self, source, command, args)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_part"><strong>handle_part</strong></a>(self, source, command, args)</dt><dd><tt>Handles user parts.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_pass"><strong>handle_pass</strong></a>(self, source, command, args)</dt><dd><tt>Handles authentication with our uplink.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_ping"><strong>handle_ping</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PING requests.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_pong"><strong>handle_pong</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming PONGs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-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="P10Protocol-handle_quit"><strong>handle_quit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming QUITs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_server"><strong>handle_server</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming server introductions.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_squit"><strong>handle_squit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming SQUITs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_topic"><strong>handle_topic</strong></a>(self, source, command, args)</dt><dd><tt>Handles TOPIC changes.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_version"><strong>handle_version</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles requests for the PyLink server version.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-handle_whois"><strong>handle_whois</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming WHOIS requests.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-invite"><strong>invite</strong></a>(self, numeric, target, channel)</dt><dd><tt>Sends INVITEs from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-join"><strong>join</strong></a>(self, client, channel)</dt><dd><tt>Joins a PyLink client to a channel.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-kick"><strong>kick</strong></a>(self, numeric, channel, target, reason=None)</dt><dd><tt>Sends kicks from a PyLink client/server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-kill"><strong>kill</strong></a>(self, numeric, target, reason)</dt><dd><tt>Sends a kill from a PyLink client/server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-knock"><strong>knock</strong></a>(self, numeric, target, text)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-message"><strong>message</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a PRIVMSG from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-mode"><strong>mode</strong></a>(self, numeric, target, modes, ts=None)</dt><dd><tt>Sends mode changes from a PyLink client/server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-nick"><strong>nick</strong></a>(self, numeric, newnick)</dt><dd><tt>Changes the nick of a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-notice"><strong>notice</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a NOTICE from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-numeric"><strong>numeric</strong></a>(self, source, numeric, target, text)</dt><dd><tt>Sends raw numerics from a server to a remote client. This is used for WHOIS<br>
|
|
|
|
|
replies.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-part"><strong>part</strong></a>(self, client, channel, reason=None)</dt><dd><tt>Sends a part from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-ping"><strong>ping</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="P10Protocol-quit"><strong>quit</strong></a>(self, numeric, reason)</dt><dd><tt>Quits a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-sjoin"><strong>sjoin</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="#P10Protocol-sjoin">sjoin</a>('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])<br>
|
|
|
|
|
<a href="#P10Protocol-sjoin">sjoin</a>(self.<strong>irc</strong>.sid, '#test', [('o', self.<strong>irc</strong>.pseudoclient.uid)])</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-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='IRC Operator', manipulatable=False)</dt><dd><tt>Spawns a new client with the given options.<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="P10Protocol-spawnServer"><strong>spawnServer</strong></a>(self, name, sid=None, uplink=None, desc=None, endburst_delay=0)</dt><dd><tt>Spawns a server off a PyLink server. desc (server description)<br>
|
|
|
|
|
defaults to the one in the config. uplink defaults to the main PyLink<br>
|
|
|
|
|
server, and sid (the server ID) is automatically generated if not<br>
|
|
|
|
|
given.<br>
|
|
|
|
|
<br>
|
|
|
|
|
Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay<br>
|
|
|
|
|
option will be ignored if given.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-squit"><strong>squit</strong></a>(self, source, target, text='No reason given')</dt><dd><tt>SQUITs a PyLink server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-topic"><strong>topic</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a TOPIC change from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-topicBurst"><strong>topicBurst</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a TOPIC change from a PyLink server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10Protocol-updateClient"><strong>updateClient</strong></a>(self, target, field, text)</dt><dd><tt>Updates the ident or host of any connected client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Static methods defined here:<br>
|
|
|
|
|
<dl><dt><a name="P10Protocol-decode_p10_ip"><strong>decode_p10_ip</strong></a>(ip)</dt><dd><tt>Decodes a P10 IP.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Methods inherited from <a href="classes.html#Protocol">classes.Protocol</a>:<br>
|
|
|
|
|
<dl><dt><a name="P10Protocol-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="P10Protocol-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="P10Protocol-updateTS"><strong>updateTS</strong></a>(self, channel, their_ts)</dt><dd><tt>Compares the current TS of the channel given with the new TS, resetting<br>
|
|
|
|
|
all modes we have if the one given is older.</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="P10SIDGenerator">class <strong>P10SIDGenerator</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
|
|
|
|
<td width="100%">Methods defined here:<br>
|
2016-05-28 07:39:27 +02:00
|
|
|
<dl><dt><a name="P10SIDGenerator-__init__"><strong>__init__</strong></a>(self, irc)</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
2016-05-12 06:56:02 +02:00
|
|
|
|
|
|
|
|
<dl><dt><a name="P10SIDGenerator-next_sid"><strong>next_sid</strong></a>(self)</dt><dd><tt>Returns the next available SID.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Data descriptors defined here:<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="P10UIDGenerator">class <strong>P10UIDGenerator</strong></a>(<a href="utils.html#IncrementalUIDGenerator">utils.IncrementalUIDGenerator</a>)</font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
|
|
|
<td colspan=2><tt>Implements an incremental P10 UID Generator.<br> </tt></td></tr>
|
|
|
|
|
<tr><td> </td>
|
|
|
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
|
|
|
<dd><a href="nefarious.html#P10UIDGenerator">P10UIDGenerator</a></dd>
|
|
|
|
|
<dd><a href="utils.html#IncrementalUIDGenerator">utils.IncrementalUIDGenerator</a></dd>
|
|
|
|
|
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<hr>
|
|
|
|
|
Methods defined here:<br>
|
2016-05-28 07:39:27 +02:00
|
|
|
<dl><dt><a name="P10UIDGenerator-__init__"><strong>__init__</strong></a>(self, sid)</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
2016-05-12 06:56:02 +02:00
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Methods inherited from <a href="utils.html#IncrementalUIDGenerator">utils.IncrementalUIDGenerator</a>:<br>
|
|
|
|
|
<dl><dt><a name="P10UIDGenerator-increment"><strong>increment</strong></a>(self, pos=None)</dt><dd><tt>Increments the UID generator to the next available UID.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="P10UIDGenerator-next_uid"><strong>next_uid</strong></a>(self)</dt><dd><tt>Returns the next unused UID for the server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Data descriptors inherited from <a href="utils.html#IncrementalUIDGenerator">utils.IncrementalUIDGenerator</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="#eeaa77">
|
|
|
|
|
<td colspan=3 valign=bottom> <br>
|
|
|
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
|
|
|
|
<td width="100%"><dl><dt><a name="-p10b64encode"><strong>p10b64encode</strong></a>(num, length=2)</dt><dd><tt>Encodes a given numeric using P10 Base64 numeric nicks, as documented at<br>
|
|
|
|
|
https://github.com/evilnet/nefarious2/blob/a29b63144/doc/p10.txt#L69-L92</tt></dd></dl>
|
|
|
|
|
</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>
|
2016-05-28 07:39:27 +02:00
|
|
|
<td width="100%"><strong>conf</strong> = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fcf7b6db510>, {})}<br>
|
2016-05-12 06:56:02 +02:00
|
|
|
<strong>confname</strong> = 'testconf'<br>
|
|
|
|
|
<strong>curdir</strong> = '/home/gl/pylink'<br>
|
|
|
|
|
<strong>files</strong> = None<br>
|
|
|
|
|
<strong>log</strong> = <logging.RootLogger object><br>
|
|
|
|
|
<strong>logdir</strong> = '/home/gl/pylink/log'<br>
|
|
|
|
|
<strong>logformatter</strong> = <logging.Formatter object><br>
|
|
|
|
|
<strong>stdout_level</strong> = 'CRITICAL'</td></tr></table>
|
|
|
|
|
</body></html>
|
