twisted.protocols.ftp.FTPAnonymousShell.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.protocols.ftp.FTPAnonymousShell</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.ftp.html">Module ftp</a> ::
Class FTPAnonymousShell
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.ftp.FTPAnonymousShell.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class FTPAnonymousShell</h2>
<pre class="base-tree">
<code>object</code> --+
|
<b>FTPAnonymousShell</b>
</pre><br />
<hr/>
Only works on POSIX platforms at the moment.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.ftp.FTPAnonymousShell.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>tld</span>)</span></code>
<br />
Constructor</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="cdup"></a><span class="summary-sig"><span class="summary-sig-name">cdup</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="cwd"></a><span class="summary-sig"><span class="summary-sig-name">cwd</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="dele"></a><span class="summary-sig"><span class="summary-sig-name">dele</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.ftp.FTPAnonymousShell.html#getUnixLongListString" class="summary-sig-name"><code>getUnixLongListString</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>spath</span>)</span></code>
<br />
generates the equivalent output of a unix ls -l path, but using
python-native code.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.ftp.FTPAnonymousShell.html#getUserUIDAndGID" class="summary-sig-name"><code>getUserUIDAndGID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
used to set up permissions checking.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="list"></a><span class="summary-sig"><span class="summary-sig-name">list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="mapCPathToSPath"></a><span class="summary-sig"><span class="summary-sig-name">mapCPathToSPath</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rpath</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="mdtm"></a><span class="summary-sig"><span class="summary-sig-name">mdtm</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="mkd"></a><span class="summary-sig"><span class="summary-sig-name">mkd</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.ftp.FTPAnonymousShell.html#myjoin" class="summary-sig-name"><code>myjoin</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>lpath</span>,
<span class=summary-sig-arg>rpath</span>)</span></code>
<br />
does a dumb join between two path elements, ensuring there is only one
'/' between them.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="nlist"></a><span class="summary-sig"><span class="summary-sig-name">nlist</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="pwd"></a><span class="summary-sig"><span class="summary-sig-name">pwd</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="retr"></a><span class="summary-sig"><span class="summary-sig-name">retr</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="rmd"></a><span class="summary-sig"><span class="summary-sig-name">rmd</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.ftp.FTPAnonymousShell.html#size" class="summary-sig-name"><code>size</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
<br />
returns the size in bytes of path</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="stor"></a><span class="summary-sig"><span class="summary-sig-name">stor</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>params</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from object</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__delattr__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__getattribute__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__hash__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__reduce__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__setattr__</span>(...)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__str__</span>(...)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from type</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><span class="summary-sig-name">__new__</span>(...)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.protocols.ftp.FTPAnonymousShell.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.protocols.ftp.IFTPShell at 0x87e5554>,)"><code>(<class twisted.protocols.ftp.IFTPShell<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.protocols.ftp.FTPAnonymousShell.html#clientwd"><code>clientwd</code></a></b> = <span title="'/'"><code><span class="variable-quote">'</span>/<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.ftp.FTPAnonymousShell.html#filepath"><code>filepath</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.ftp.FTPAnonymousShell.html#gid"><code>gid</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.ftp.FTPAnonymousShell.html#uid"><code>uid</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>=<span class=sig-default>None</span>,
<span class=sig-arg>tld</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Constructor
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>user</b></code> -
the name of the user whose permissions we'll be using
<br /><i>
(type=string)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><code>__builtin__.object.__init__</code></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUnixLongListString"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUnixLongListString</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>spath</span>)</span>
</h3>
generates the equivalent output of a unix ls -l path, but using
python-native code.
<dl><dt></dt><dd>
<p><b>Attention:</b> this has only been tested on posix systems, I don't know at this point
whether or not it will work on win32
</p>
</dd></dl>
</td></tr></table>
<a name="getUserUIDAndGID"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUserUIDAndGID</span>(<span class=sig-arg>self</span>)</span>
</h3>
used to set up permissions checking. finds the uid and gid of the
shell.user. called during __init__
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="myjoin"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">myjoin</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>lpath</span>,
<span class=sig-arg>rpath</span>)</span>
</h3>
does a dumb join between two path elements, ensuring there is only
one '/' between them. pays no attention to the filesystem, unlike
os.path.join
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lpath</b></code> -
path element to the left of the '/' in the result
<br /><i>
(type=string)</i>
<dd><code><b>rpath</b></code> -
path element to the right of the '/' in the result
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="size"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">size</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>path</span>)</span>
</h3>
returns the size in bytes of path
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__implements__"></a>
<h3>__implements__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(<class twisted.protocols.ftp.IFTPShell at 0x87e5554>,)"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(<class twisted.protocols.ftp.IFTPShell at 0x87e5554>,) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="clientwd"></a>
<h3>clientwd</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'/'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>/<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="filepath"></a>
<h3>filepath</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="gid"></a>
<h3>gid</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="uid"></a>
<h3>uid</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:57 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>