2016-03-12 08:13:55 +01:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
|
<html><head><title>Python: module ts6_common</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>ts6_common</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/ts6_common.py">/home/gl/pylink/protocols/ts6_common.py</a></font></td></tr></table>
|
|
|
|
|
<p><tt>ts6_common.py: Common base protocol class with functions shared by the UnrealIRCd, InspIRCd, and TS6 protocol modules.</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="hashlib.html">hashlib</a><br>
|
2016-05-12 06:56:02 +02:00
|
|
|
<a href="inspect.html">inspect</a><br>
|
2016-03-12 08:13:55 +01:00
|
|
|
<a href="logging.html">logging</a><br>
|
|
|
|
|
<a href="os.html">os</a><br>
|
|
|
|
|
</td><td width="25%" valign=top><a href="socket.html">socket</a><br>
|
|
|
|
|
<a href="ssl.html">ssl</a><br>
|
2016-05-12 06:56:02 +02:00
|
|
|
<a href="string.html">string</a><br>
|
|
|
|
|
<a href="structures.html">structures</a><br>
|
|
|
|
|
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
|
|
|
|
|
<a href="threading.html">threading</a><br>
|
2016-03-12 08:13:55 +01:00
|
|
|
<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>
|
2016-05-12 06:56:02 +02:00
|
|
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
|
|
|
|
</font></dt><dd>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><font face="helvetica, arial"><a href="ts6_common.html#TS6SIDGenerator">TS6SIDGenerator</a>
|
|
|
|
|
</font></dt></dl>
|
|
|
|
|
</dd>
|
2016-03-12 08:13:55 +01:00
|
|
|
<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="ts6_common.html#TS6BaseProtocol">TS6BaseProtocol</a>
|
|
|
|
|
</font></dt></dl>
|
|
|
|
|
</dd>
|
2016-05-12 06:56:02 +02:00
|
|
|
<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="ts6_common.html#TS6UIDGenerator">TS6UIDGenerator</a>
|
|
|
|
|
</font></dt></dl>
|
|
|
|
|
</dd>
|
2016-03-12 08:13:55 +01:00
|
|
|
</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"><a name="TS6BaseProtocol">class <strong>TS6BaseProtocol</strong></a>(<a href="classes.html#Protocol">classes.Protocol</a>)</font></td></tr>
|
|
|
|
|
|
2016-05-12 06:56:02 +02:00
|
|
|
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
2016-03-12 08:13:55 +01:00
|
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
|
|
|
<dd><a href="ts6_common.html#TS6BaseProtocol">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>
|
2016-05-12 06:56:02 +02:00
|
|
|
<dl><dt><a name="TS6BaseProtocol-__init__"><strong>__init__</strong></a>(self, irc)</dt></dl>
|
|
|
|
|
|
2016-03-12 08:13:55 +01:00
|
|
|
<dl><dt><a name="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-handle_events"><strong>handle_events</strong></a>(self, data)</dt><dd><tt>Event handler for TS6 protocols.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This passes most commands to the various handle_ABCD() functions<br>
|
|
|
|
|
elsewhere defined protocol modules, coersing various sender prefixes<br>
|
|
|
|
|
from nicks and server names to UIDs and SIDs respectively,<br>
|
|
|
|
|
whenever possible.<br>
|
|
|
|
|
<br>
|
|
|
|
|
Commands sent without an explicit sender prefix will have them set to<br>
|
|
|
|
|
the SID of the uplink server.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-handle_kick"><strong>handle_kick</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KICKs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-handle_kill"><strong>handle_kill</strong></a>(self, source, command, args)</dt><dd><tt>Handles incoming KILLs.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-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="TS6BaseProtocol-handle_notice"><strong>handle_notice</strong></a> = <a href="#TS6BaseProtocol-handle_privmsg">handle_privmsg</a>(self, source, command, args)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-handle_quit"><strong>handle_quit</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles incoming QUIT commands.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-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 (InspIRCd) are used instead.</tt></dd></dl>
|
|
|
|
|
|
2016-03-26 19:42:12 +01:00
|
|
|
<dl><dt><a name="TS6BaseProtocol-handle_version"><strong>handle_version</strong></a>(self, numeric, command, args)</dt><dd><tt>Handles requests for the PyLink server version.</tt></dd></dl>
|
|
|
|
|
|
2016-03-12 08:13:55 +01:00
|
|
|
<dl><dt><a name="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-numeric"><strong>numeric</strong></a>(self, source, numeric, target, text)</dt><dd><tt>Sends raw numerics from a server to a remote client, used for WHOIS<br>
|
|
|
|
|
replies.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-parseTS6Args"><strong>parseTS6Args</strong></a>(self, args)</dt><dd><tt>Similar to <a href="#TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-quit"><strong>quit</strong></a>(self, numeric, reason)</dt><dd><tt>Quits a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-topic"><strong>topic</strong></a>(self, numeric, target, text)</dt><dd><tt>Sends a TOPIC change from a PyLink client.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Methods inherited from <a href="classes.html#Protocol">classes.Protocol</a>:<br>
|
|
|
|
|
<dl><dt><a name="TS6BaseProtocol-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="TS6BaseProtocol-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="TS6BaseProtocol-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>
|
2016-05-12 06:56:02 +02:00
|
|
|
</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="TS6SIDGenerator">class <strong>TS6SIDGenerator</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
|
|
|
<td colspan=2><tt>TS6 SID Generator. <query> is a 3 character string with any combination of<br>
|
|
|
|
|
uppercase letters, digits, and #'s. it must contain at least one #,<br>
|
|
|
|
|
which are used by the generator as a wildcard. On every <a href="#TS6SIDGenerator-next_sid">next_sid</a>() call,<br>
|
|
|
|
|
the first available wildcard character (from the right) will be<br>
|
|
|
|
|
incremented to generate the next SID.<br>
|
|
|
|
|
<br>
|
|
|
|
|
When there are no more available SIDs left (SIDs are not reused, only<br>
|
|
|
|
|
incremented), RuntimeError is raised.<br>
|
|
|
|
|
<br>
|
|
|
|
|
Example queries:<br>
|
|
|
|
|
"1#A" would give: 10A, 11A, 12A ... 19A, 1AA, 1BA ... 1ZA (36 total results)<br>
|
|
|
|
|
"#BQ" would give: 0BQ, 1BQ, 2BQ ... 9BQ (10 total results)<br>
|
|
|
|
|
"6##" would give: 600, 601, 602, ... 60Y, 60Z, 610, 611, ... 6ZZ (1296 total results)<br> </tt></td></tr>
|
|
|
|
|
<tr><td> </td>
|
|
|
|
|
<td width="100%">Methods defined here:<br>
|
|
|
|
|
<dl><dt><a name="TS6SIDGenerator-__init__"><strong>__init__</strong></a>(self, irc)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6SIDGenerator-increment"><strong>increment</strong></a>(self, pos=2)</dt><dd><tt>Increments the SID generator to the next available SID.</tt></dd></dl>
|
|
|
|
|
|
|
|
|
|
<dl><dt><a name="TS6SIDGenerator-next_sid"><strong>next_sid</strong></a>(self)</dt><dd><tt>Returns the next unused TS6 SID for the server.</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="TS6UIDGenerator">class <strong>TS6UIDGenerator</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 TS6 UID Generator.<br> </tt></td></tr>
|
|
|
|
|
<tr><td> </td>
|
|
|
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
|
|
|
<dd><a href="ts6_common.html#TS6UIDGenerator">TS6UIDGenerator</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>
|
|
|
|
|
<dl><dt><a name="TS6UIDGenerator-__init__"><strong>__init__</strong></a>(self, sid)</dt></dl>
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Methods inherited from <a href="utils.html#IncrementalUIDGenerator">utils.IncrementalUIDGenerator</a>:<br>
|
|
|
|
|
<dl><dt><a name="TS6UIDGenerator-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="TS6UIDGenerator-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>
|
2016-03-12 08:13:55 +01:00
|
|
|
</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>
|
2016-05-12 06:56:02 +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 0x7f683a0b9d90>, {})}<br>
|
2016-03-12 08:13:55 +01: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>
|
