Server : Apache/2.4.52 (Ubuntu) System : Linux webserver 6.8.0-49-generic #49~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Nov 6 17:42:15 UTC 2 x86_64 User : www-data ( 33) PHP Version : 8.1.2-1ubuntu2.21 Disable Function : NONE Directory : /lib/python3/dist-packages/twisted/protocols/__pycache__/ |
o
�b� � @ s� d Z ddlZddlZddlZddlZddlZddlZz
ddlZddlZW n
e y1 d ZZY nw ddl
m Z m Z ddl
mZ ddlmZmZmZmZ ddlmZmZmZmZmZ ddlmZm Z ddl m Z m Z m Z d Z!d
Z"d Z#d Z$d
Z%dZ&dZ'dZ(dZ)dZ*dZ+dZ,dZ-dZ.dZ/dZ0dZ1dZ2dZ3d Z4d Z5d Z6d Z7d Z8d!Z9d"Z:d#Z;d$Z<d%Z=d&Z>d'Z?d(Z@d)ZAd*ZBd+ZCd,ZDd-ZEd.ZFd/ZGd0ZHd1ZId2ZJd3ZKd4ZLd5ZMd6ZNd7ZOd8ZPd9ZQd:ZRd;ZSd<ZTd=ZUd>ZVd?ZWd@ZXdAZYdBZZi e!dC�e"dD�e#dE�e$dF�e%dG�e&dH�e'dI�e(dJ�e)dK�e*dLdMg�e+dN�e,dO�e-dP�e.dQ�e0dR�e/dS�e1dT�i e2dU�e3dV�e4dW�e5dX�e6dY�e7dZ�e8d[�e9d\�e:d]�e;d^�e<d_�e=d`�e>da�e?db�e@dc�eAdd�eBde��i eCdf�eDdg�eEdh�eFdi�eGdj�eHdk�eIdl�eJdm�eKdn�eLdo�eMdp�eNdq�eOdr�ePds�eQdt�eRdu�eSdv��eTdweVdxeWdyeUdzeXd{eYd|eZd}i�Z[G d~d� de\�Z]d�d�� Z^d�d�� Z_e�`d��Zad�d�d��ZbG d�d�� d�e\�ZcG d�d�� d�ec�ZdG d�d�� d�ec�ZeG d�d�� d�ec�ZfG d�d�� d�ec�ZgG d�d�� d�ec�ZhG d�d�� d�ec�ZiG d�d�� d�ec�ZjG d�d�� d�ec�ZkG d�d�� d�ec�ZlG d�d�� d�ec�ZmG d�d�� d�e\�ZnG d�d�� d�e\�ZoG d�d�� d�ec�ZpG d�d�� d�ec�Zqd�d�� Zrg d��Zse ejt�G d�d�� d�eju��ZvG d�d�� d�ejw�ZxG d�d�� d��Zye ejt�G d�d�� d���ZzG d�d�� d�ej{�Z|G d�d�� d�ej{e j}�Z~G d�d�� d�e j�Z�G d�d�� d�e �Z�G d�d�� d�e �Z�G d�d�� d�e �Z�d�d�� Z�d�d�d��Z�e e��G d�d d�Z�e e��G d�dĄ dă�Z�G d�dƄ d�e��Z�e e��G d�dȄ dȃ�Z�e ej��G d�dʄ dʃ�Z�G d�d̄ d�e��Z�G d�d΄ d�e��Z�G d�dЄ d�en�Z�G d�d҄ d�en�Z�G d�dԄ d�en�Z�G d�dք d�en�Z�G d�d d�en�Z�G d�dڄ dڃZ�G d�d܄ d�eju�Z�G d�dބ d�ejt�Z�e e��G d�d� d�eju��Z�d�d� Z�d�d� Z�d�d� Z�G d�d� d�ej��Z�G d�d� d�ej{�Z�G d�d� d�ejw�Z�G d�d� d�e��Z�G d�d� d�ej{�Z�d�d� Z�dS )�z
An FTP protocol implementation
� N)� Interface� implementer)� copyright)�checkers� credentials�error�portal)�deferr �
interfaces�protocol�reactor)�basic�policies)�failure�filepath�log�100�120�125�150z200.1z200.2z200.3�202z211.1z211.2�212�213�214�215z220.1z220.2z221.1z221.2�225z226.1z226.2�227�229z230.1z230.2�250z257.1z257.2z331.1z331.2�332�350z421.1z421.2�425�426�450�451�452�500�501z502.1z502.2�503�504z530.1z530.2�532z550.1z550.2z550.3z550.4z550.5z550.6z550.7�551�552�553z110 MARK yyyy-mmmmz 120 service ready in %s minutesz3125 Data connection already open, starting transferz4150 File status okay; about to open data connection.z200 Command OKz200 Type set to %s.z 200 PORT OKz5202 Command not implemented, superfluous at this sitez211 System status replyz
211-Features:z211 Endz212 %sz213 %sz 214 help: %sz215 UNIX Type: L8z220 %sz220 Service readyz&221 Service closing control connectionz 221 Goodbye.z1225 data connection open, no transfer in progressz226 Abort successfulz226 Transfer Complete.z 227 Entering Passive Mode (%s).z,229 Entering Extended Passive Mode (|||%s|).z230 User logged in, proceedz2230 Anonymous login ok, access restrictions apply.z&250 Requested File Action Completed OKz257 "%s"z257 "%s" createdz 331 Password required for %s.z8331 Guest login ok, type your email address as password.z332 Need account for login.z6350 Requested file action pending further information.z6421 Service not available, closing control connection.z9421 Too many users right now, try again in a few minutes.z 425 Can't open data connection.z.426 Transfer aborted. Data connection closed.z/450 Requested action aborted. File unavailable.z8451 Requested action aborted. Local error in processing.z3452 Requested action aborted. Insufficient storage.z500 Syntax error: %sz#501 syntax error in argument(s) %s.z 502 Command '%s' not implementedz 502 Option '%s' not implemented.z&503 Incorrect sequence of commands: %sz'504 Not implemented for parameter '%s'.z$530 Please login with USER and PASS.z!530 Sorry, Authentication failed.z%532 Need an account for storing filesz"550 %s: No such file or directory.z550 %s: Permission denied.z:550 Anonymous users are forbidden to change the filesystemz%550 Cannot rmd, %s is not a directoryz550 %s: File existsz550 %s: is a directoryz"550 Requested action not taken: %sz551 Page type unknownzC552 Requested file action aborted, exceeded file storage allocationz5553 Requested action not taken, file name not allowedc @ s e Zd ZdZdS )� InvalidPathzL
Internal exception used to signify an error during parsing a path.
N)�__name__�
__module__� __qualname__�__doc__� r3 r3 �7/usr/lib/python3/dist-packages/twisted/protocols/ftp.pyr. � s r. c C s� |� d�rg }n| dd� }|�d�D ]-}|dks |dkr q|dkr.|r)|�� qt| |��d|v s6d|v r;t| |��|�|� q|S )zn
Normalize a path, as represented by a list of strings each
representing one segment of the path.
�/N�.� �..� )�
startswith�split�popr. �append)�cwd�path�segs�sr3 r3 r4 �
toSegments� s
rB c C s� | t jkr t�t|��S | t jks| t jkr t�t|��S | t jkr)t�t |��S | t j
kr5t�t |��S | t j krAt�t
|��S t�� S )z?
Map C{OSError} and C{IOError} to standard FTP errors.
)�errno�ENOENTr �fail�FileNotFoundError�EACCES�EPERM�PermissionDeniedError�ENOTDIR�IsNotADirectoryError�EEXIST�FileExistsError�EISDIR�IsADirectoryError)�er? r3 r3 r4 �errnoToFailure� s
rQ �TESTc C s8 | sdS | d }t �|�}t�d|d�}||krdS dS )a�
Helper for checking if a FTPShell `segments` contains a wildcard Unix
expression.
Only filename globbing is supported.
This means that wildcards can only be presents in the last element of
`segments`.
@type segments: C{list}
@param segments: List of path elements as used by the FTP server protocol.
@rtype: Boolean
@return: True if `segments` contains a globbing expression.
F���rR � T)�fnmatch� translate�_testTranslation�replace)�segments�
globCandidate�globTranslations�nonGlobTranslationsr3 r3 r4 �_isGlobbingExpression� s
r] c @ � e Zd ZdZdd� Zdd� ZdS )� FTPCmdErrorz-
Generic exception for FTP commands.
c G s t j| g|�R � || _d S �N)� Exception�__init__� errorMessage)�self�msgr3 r3 r4 rb s
zFTPCmdError.__init__c C s t | j | j S )zA
Generate a FTP response message for this error.
)�RESPONSE� errorCoderc �rd r3 r3 r4 �response s zFTPCmdError.responseN)r/ r0 r1 r2 rb ri r3 r3 r3 r4 r_
s r_ c @ � e Zd ZdZeZdS )rF zH
Raised when trying to access a non existent file or directory.
N)r/ r0 r1 r2 �FILE_NOT_FOUNDrg r3 r3 r3 r4 rF � rF c @ rj )�AnonUserDeniedErrorz[
Raised when an anonymous user issues a command that will alter the
filesystem
N)r/ r0 r1 r2 �ANON_USER_DENIEDrg r3 r3 r3 r4 rm " � rm c @ rj )rI z[
Raised when access is attempted to a resource to which access is
not allowed.
N)r/ r0 r1 r2 �PERMISSION_DENIEDrg r3 r3 r3 r4 rI + ro rI c @ rj )rK zE
Raised when RMD is called on a path that isn't a directory.
N)r/ r0 r1 r2 � IS_NOT_A_DIRrg r3 r3 r3 r4 rK 4 rl rK c @ rj )rM zA
Raised when attempted to override an existing resource.
N)r/ r0 r1 r2 � FILE_EXISTSrg r3 r3 r3 r4 rM < rl rM c @ rj )rO zC
Raised when DELE is called on a path that is a directory.
N)r/ r0 r1 r2 �IS_A_DIRrg r3 r3 r3 r4 rO D rl rO c @ rj )�CmdSyntaxErrorz0
Raised when a command syntax is wrong.
N)r/ r0 r1 r2 �
SYNTAX_ERRrg r3 r3 r3 r4 rt L rl rt c @ rj )�CmdArgSyntaxErrorz^
Raised when a command is called with wrong value or a wrong number of
arguments.
N)r/ r0 r1 r2 �SYNTAX_ERR_IN_ARGSrg r3 r3 r3 r4 rv T ro rv c @ rj )�CmdNotImplementedErrorzF
Raised when an unimplemented command is given to the server.
N)r/ r0 r1 r2 �CMD_NOT_IMPLMNTDrg r3 r3 r3 r4 rx ] rl rx c @ rj )� CmdNotImplementedForArgErrorze
Raised when the handling of a parameter for a command is not implemented by
the server.
N)r/ r0 r1 r2 �CMD_NOT_IMPLMNTD_FOR_PARAMrg r3 r3 r3 r4 rz e ro rz c @ � e Zd ZdS )�FTPErrorN�r/ r0 r1 r3 r3 r3 r4 r} n � r} c @ r| )�PortConnectionErrorNr~ r3 r3 r3 r4 r� r r r� c @ rj )�BadCmdSequenceErrorzS
Raised when a client sends a series of commands in an illogical sequence.
N)r/ r0 r1 r2 � BAD_CMD_SEQrg r3 r3 r3 r4 r� v rl r� c @ rj )�AuthorizationErrorz2
Raised when client authentication fails.
N)r/ r0 r1 r2 � AUTH_FAILURErg r3 r3 r3 r4 r� ~ rl r� c G s t jdt|� dd� d S )NzdebugDeferred(): %sT��debug)r re �str)rd �_r3 r3 r4 �
debugDeferred� s r� )
N�Jan�Feb�Mar�Apr�May�Jun�Jul�Aug�Sep�Oct�Nov�Decc @ s� e Zd ZdZdZdZdZdZdd� Zdd� Z dd � Z
d
d � Z d d
� Z dd� Z
dd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� ZdS )"�DTPFN�latin-1c C s d| _ | jj�d � g | _d S �NT)� isConnected�factory�deferred�callback�_bufferrh r3 r3 r4 �connectionMade� s
zDTP.connectionMadec C s$ d| _ | jd ur| j�d � d S d S �NF)r� � _onConnLostr� �rd �reasonr3 r3 r4 �connectionLost� s
�zDTP.connectionLostc C s | j �|d � dS )zv
Send a line to data channel.
@param line: The line to be sent.
@type line: L{bytes}
s
N�� transport�write�rd �liner3 r3 r4 �sendLine� s z DTP.sendLinec C sZ dd� } d}
|
|r dp d|� � ||dd� |dd� || t�|��d� �| j�} | | S ) a
Helper method to format one entry's info into a text entry like:
'drwxrwxrwx 0 user group 0 Jan 01 1970 filename.txt'
@param name: C{bytes} name of the entry (file or directory or link)
@param size: C{int} size of the entry
@param directory: evals to C{bool} - whether the entry is a directory
@param permissions: L{twisted.python.filepath.Permissions} object
representing that entry's permissions
@param hardlinks: C{int} number of hardlinks
@param modified: C{float} - entry's last modified time in seconds
since the epoch
@param owner: C{str} username of the owner
@param group: C{str} group name of the owner
@return: C{str} in the requisite format
c S sB t �� }t| j | j| j| j| jd�}|j| jkr d| S d| S )N)�month�day�year�hour�minutez %(month)s %(day)02d %(year)5dz+%(month)s %(day)02d %(hour)02d:%(minute)02d)�time�gmtime�_months�tm_mon�tm_mday�tm_year�tm_hour�tm_min)�mtime�now�infor3 r3 r4 �
formatDate� s � z.DTP._formatOneListResponse.<locals>.formatDatezY%(directory)s%(permissions)s%(hardlinks)4d %(owner)-9s %(group)-9s %(size)15d %(date)12s �d�-N� )� directory� permissions� hardlinks�owner�group�size�date)� shorthandr� r� �encode� _encoding) rd �namer� r� r� r� �modifiedr� r� r� �formatre r3 r3 r4 �_formatOneListResponse� s �
��
� zDTP._formatOneListResponsec C s | � | j|g|�R � � d S r` )r� r� )rd r� ri r3 r3 r4 �sendListResponse� s zDTP.sendListResponsec C s | j �||�S r` �r� �registerProducer�rd �producer� streamingr3 r3 r4 r� � � zDTP.registerProducerc C s | j �� | j �� d S r` )r� �unregisterProducer�loseConnectionrh r3 r3 r4 r� � s
zDTP.unregisterProducerc C s | j r | j�|�S td��)Nz Crap damn crap damn crap damn)r� r� r� ra �rd �datar3 r3 r4 r� � s z DTP.writec C s2 z | j �|� W d S ty | j�� Y d S w r` )�_consr� �
BaseExceptionr� �errback�rd �bytesr3 r3 r4 �
_conswrite s
�zDTP._conswritec C s( | j d ur | �|� d S | j�|� d S r` )r� r� r� r= r� r3 r3 r4 � dataReceived s
zDTP.dataReceivedc C s | j �� d | _ | `|S r` )r� r� r� �rd �ignoredr3 r3 r4 �_unregConsumer
s
zDTP._unregConsumerc C s| | j d u sJ �|| _ | j �| d� | jD ]}| �|� qd | _| jr1t�� | _}|�| j � |S | j �
� d | _ t� d �S r� ) r� r� r� r� r� r �Deferredr� �addBothr� r� �succeed)rd �cons�chunkr� r3 r3 r4 �registerConsumer s
zDTP.registerConsumerc C � | j �� d S r` )r� �resumeProducingrh r3 r3 r4 r� # r� zDTP.resumeProducingc C r� r` )r� �pauseProducingrh r3 r3 r4 r� & r� zDTP.pauseProducingc C r� r` )r� �
stopProducingrh r3 r3 r4 r� ) r� zDTP.stopProducing)r/ r0 r1 r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r3 r3 r3 r4 r� � s* 6 r� c @ sd e Zd ZdZe� Ze� Ze� ZeZdZ ddd�Z
dd� Z dd � Z d
d � Z
d d
� Zdd� Zdd� ZdS )�
DTPFactorya
Client factory for I{data transfer process} protocols.
@ivar peerCheck: perform checks to make sure the ftp-pi's peer is the same
as the dtp's
@ivar pi: a reference to this factory's protocol interpreter
@ivar _state: Indicates the current state of the DTPFactory. Initially,
this is L{_IN_PROGRESS}. If the connection fails or times out, it is
L{_FAILED}. If the connection succeeds before the timeout, it is
L{_FINISHED}.
@cvar _IN_PROGRESS: Token to signal that connection is active.
@type _IN_PROGRESS: L{object}.
@cvar _FAILED: Token to signal that connection has failed.
@type _FAILED: L{object}.
@cvar _FINISHED: Token to signal that connection was successfully closed.
@type _FINISHED: L{object}.
FNc C s: || _ || _t�� | _d| _|du rddlm} || _dS )z�
Constructor
@param pi: this factory's protocol interpreter
@param peerHost: if peerCheck is True, this is the tuple that the
generated instance will use to perform security checks
Nr �r ) �pi�peerHostr r� r� � delayedCall�twisted.internetr �_reactor)rd r� r� r r3 r3 r4 rb N s
zDTPFactory.__init__c C sN t jddd� | j| jurd S | j| _| �� t� }| |_| j|_|| j_ |S )N�DTPFactory.buildProtocolTr� )
r re �_state� _IN_PROGRESS� _FINISHED�
cancelTimeoutr� r� r� � dtpInstance�rd �addr�pr3 r3 r4 �
buildProtocol_ s r� c C s t jddd� | �� d S )NzdtpFactory.stopFactoryTr� )r re r� rh r3 r3 r4 � stopFactorym s zDTPFactory.stopFactoryc C sF t �d� | j| jur
d S | j| _| j}d | _|�tt� d��� d S )Nz$timed out waiting for DTP connectionzDTPFactory timeout)
r re r� r� �_FAILEDr� r� r� r � TimeoutError)rd r� r3 r3 r4 �timeoutFactoryq s
zDTPFactory.timeoutFactoryc C s8 | j d ur| j �� rtjddd� | j �� d S d S d S )Nzcancelling DTP timeoutTr� )r� �activer re �cancelrh r3 r3 r4 r� { s �zDTPFactory.cancelTimeoutc C s$ t �d| � | j�|| j�| _d S )Nz'DTPFactory.setTimeout set to %s seconds)r re r� � callLaterr� r� )rd �secondsr3 r3 r4 �
setTimeout� s zDTPFactory.setTimeoutc C s6 | j | jurd S | j| _ | j}d | _|�t|�� d S r` )r� r� r� r� r� r� )rd � connectorr� r� r3 r3 r4 �clientConnectionFailed� s z!DTPFactory.clientConnectionFailed)NN)r/ r0 r1 r2 �objectr� r� r� r� � peerCheckrb r� r� r� r� r r r3 r3 r3 r4 r� - s
r� c @ s e Zd Zdd� Zdd� ZdS )�ASCIIConsumerWrapperc C sP || _ |j| _|j| _tjdksttj�dksJ d��tjdkr&|j| _d S d S )N�
rT z6Unsupported platform (yea right like this even exists))r� r� r� �os�linesep�lenr� )rd r� r3 r3 r4 rb � s �
�z ASCIIConsumerWrapper.__init__c C s | j �|�tjd��S )Nr
)r� r� rX r r r� r3 r3 r4 r� � s zASCIIConsumerWrapper.writeN)r/ r0 r1 rb r� r3 r3 r3 r4 r � s r c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) � FileConsumerz�
A consumer for FTP input that writes data to a file.
@ivar fObj: a file object opened for writing, used to write data received.
@type fObj: C{file}
c C �
|| _ d S r` )�fObj�rd r r3 r3 r4 rb � �
zFileConsumer.__init__c C s || _ |sJ �d S r` )r� r� r3 r3 r4 r� � � z FileConsumer.registerProducerc C s d | _ | j�� d S r` )r� r �closerh r3 r3 r4 r� � s z FileConsumer.unregisterProducerc C � | j �|� d S r` )r r� r� r3 r3 r4 r� � � zFileConsumer.writeN)r/ r0 r1 r2 rb r� r� r� r3 r3 r3 r4 r � s r c @ � e Zd ZdZdZdd� ZdS )�FTPOverflowProtocolz:FTP mini-protocol for when there are too many connections.r� c C s$ | � tt �| j�� | j�� d S r` )r� rf �TOO_MANY_CONNECTIONSr� r� r� r� rh r3 r3 r4 r� � s z"FTPOverflowProtocol.connectionMadeN)r/ r0 r1 r2 r� r� r3 r3 r3 r4 r � s r c s� e Zd ZdZdZed�\ZZZZ dZ
dZ dZ dZ
dZdZdZddgZg d �Zed
d �ZejZd Zd
d� Z� fdd�Zdd� Zdd� Zdd� Z dd� Z dd� Z dd � Z d d � Z d d � Z!d!d"� Z"d#d$� Z#d%d&� Z$d\d(d)�Z%d*d+� Z&d,d-� Z'd.d/� Z(d0d1� Z)d2d3� Z*d4d5� Z+d6d7� Z,d8d9� Z-d:d;� Z.d<d=� Z/d>d?� Z0d@dA� Z1dBdC� Z2dDdE� Z3dFdG� Z4dHdI� Z5dJdK� Z6dLdM� Z7dNdO� Z8dPdQ� Z9dRdS� Z:dTdU� Z;dVdW� Z<dXdY� Z=dZd[� Z>� Z?S )]�FTPa;
Protocol Interpreter for the File Transfer Protocol
@ivar state: The current server state. One of L{UNAUTH},
L{INAUTH}, L{AUTHED}, L{RENAMING}.
@ivar shell: The connected avatar
@ivar binary: The transfer mode. If false, ASCII.
@ivar dtpFactory: Generates a single DTP for this session
@ivar dtpPort: Port returned from listenTCP
@ivar listenFactory: A callable with the signature of
L{twisted.internet.interfaces.IReactorTCP.listenTCP} which will be used
to create Ports for passive connections (mainly for testing).
@ivar passivePortRange: iterator used as source of passive port numbers.
@type passivePortRange: C{iterator}
@cvar UNAUTH: Command channel is not yet authenticated.
@type UNAUTH: L{int}
@cvar INAUTH: Command channel is in the process of being authenticated.
@type INAUTH: L{int}
@cvar AUTHED: Command channel was successfully authenticated.
@type AUTHED: L{int}
@cvar RENAMING: Command channel is between the renaming command sequence.
@type RENAMING: L{int}
F� �
NT�FEAT�QUIT)r �MDTM�PASV�SIZEzTYPE A;Ir rT r� c G s t | | }| �|� d S r` )rf r� )rd �key�argsre r3 r3 r4 �reply� s z FTP.replyc s& t |t�r |�| j�}t� �|� dS )za
(Private) Encodes and sends a line
@param line: L{bytes} or L{unicode}
N)�
isinstancer� r� r� �superr� r� �� __class__r3 r4 r� � s
z FTP.sendLinec C s( | j | _| �| j� | �t| jj� d S r` )�UNAUTH�stater �timeOutr$ � WELCOME_MSGr� �welcomeMessagerh r3 r3 r4 r� s zFTP.connectionMadec C sJ | j r| �� | �d � t| jd�r | jjd ur | j�� d | _d | _d S )N�logout)�
dtpFactory�
cleanupDTPr �hasattr�shellr. r� r� r3 r3 r4 r� s
zFTP.connectionLostc C r� r` �r� r� rh r3 r3 r4 �timeoutConnection r� zFTP.timeoutConnectionc s� �� � ��� ttkr|��j�}� �fdd�}�fdd�}�fdd�}|�d�}|dkr>|d |� � ||d d � f}n|� d
}tj�j � g|�R � }|�
||� |� t j
� d d lm} |�d |j|� d S )
Nc sx � � t�r��� j�� � d S � � t�r*t� fdd�dD ��r*��t�� d�� d S t �
d� t � � � ��t d� d S )Nc 3 s � | ] }|� j jd v V qdS )r N)�valuer# )�.0re ��errr3 r4 � <genexpr># s
� �
�z:FTP.lineReceived.<locals>.processFailed.<locals>.<genexpr>)z
takes exactlyz required positional argumentz requires an argument.zUnexpected FTP errorzinternal server error)
�checkr_ r� r5 ri � TypeError�anyr$ ru r re r8 �REQ_ACTN_NOT_TAKENr7 ��cmdrd r7 r4 �
processFailed s
�
z'FTP.lineReceived.<locals>.processFailedc s2 t | t�r � j| � d S | d ur� �| � d S d S r` )r% �tupler$ ��resultrh r3 r4 �processSucceeded- s
�z*FTP.lineReceived.<locals>.processSucceededc s � j s � �� d S d S r` )� disconnectedr� �r� rh r3 r4 �allDone3 s �z!FTP.lineReceived.<locals>.allDone� rS rT r3 r r� )� resetTimeoutr� r� r� �decoder� �findr �
maybeDeferred�processCommand� addCallbacks�
addErrbackr r8 r� r r r� ) rd r� r@ rD rG �
spaceIndexr# r� r r3 r> r4 � lineReceived s$
zFTP.lineReceivedc s� � �fdd�}|� � }|�jv r||�S �j�jkr-|dkr#�j� � S |dkr+tdfS tS �j�jkr@|dkr<�j� � S tdfS �j�j krJ||�S �j�j
kr]|dkrY�j � � S tdfS d S ) Nc s. t �d| d �}|d ur|� � S t�t| ��S )N�ftp_)�getattrr rE rx )�command�method��paramsrd r3 r4 �call_ftp_commandJ s z,FTP.processCommand.<locals>.call_ftp_command�USER�PASSzUSER required before PASSzPASS required after USER�RNTOzRNTO required after RNFR) �upper�PUBLIC_COMMANDSr* r) �ftp_USERr� �
NOT_LOGGED_IN�INAUTH�ftp_PASS�AUTHED�RENAMING�ftp_RNTO)rd r? rW rX r3 rV r4 rM I s*
�zFTP.processCommandc C sL | j D ]}z | �||�}W | S tjy Y qw t�d|d| j � ���)ze
Return a port for passive access, using C{self.passivePortRange}
attribute.
r7 zNo port available in range )�passivePortRange�
listenFactoryr �CannotListenError)rd r� �portn�dtpPortr3 r3 r4 �
getDTPPortl s
���zFTP.getDTPPortc C sB |s t �td��S || _| j| _| jjr | j| jjkr t S t
|fS )zc
First part of login. Get the username the peer wants to
authenticate as.
zUSER requires an argument) r rE rt �_userr` r* r� �allowAnonymous�
userAnonymous�GUEST_NAME_OK_NEED_EMAIL�USR_NAME_OK_NEED_PASS)rd �usernamer3 r3 r4 r^ | s z FTP.ftp_USERc st �j jr�j�j jkrt�� }t� n t��j|�}t� �`� �fdd�}�fdd�}�j �
|dt �}|� ||� |S )zf
Second part of login. Get the password the peer wants to
authenticate with.
c s8 | \}}}|t u s
J d��|�_|�_g �_�j�_� S )NzThe realm is busted, jerk.)� IFTPShellr2 r. �workingDirectoryrb r* )rC � interface�avatarr. �r$ rd r3 r4 �_cbLogin� s
z FTP.ftp_PASS.<locals>._cbLoginc s | � tjtj� � j� _t�r` )�trap�
cred_error�UnauthorizedLogin�UnhandledCredentialsr) r* r� �r rh r3 r4 �_ebLogin� s z FTP.ftp_PASS.<locals>._ebLoginN)
r� rl rk rm r � Anonymous�GUEST_LOGGED_IN_PROCEED�UsernamePassword�USR_LOGGED_IN_PROCEEDr �loginrq rN )rd �password�credsrv r| r� r3 ru r4 ra � s z FTP.ftp_PASSc C sv | j dur | �� t| d�| _ | j �| j� | �| j �| _| j�� j }| j�� j
}| � t t
||�� | j j�dd� �S )a�
Request for a passive connection
from the rfc::
This command requests the server-DTP to "listen" on a data port
(which is not its default data port) and to wait for a connection
rather than initiate one upon receipt of a transfer command. The
response to this command includes the host and port address this
server is listening on.
N)r� c S � d S r` r3 ��ignr3 r3 r4 �<lambda>� � z FTP.ftp_PASV.<locals>.<lambda>)r/ r0 r� r �
dtpTimeoutrj ri r� �getHost�host�portr$ �ENTERING_PASV_MODE�encodeHostPortr� � addCallback)rd r� r� r3 r3 r4 �ftp_PASV� s
z FTP.ftp_PASVc C s� t tt|�d���}dt |d d� � }|d d> |d B }| jd ur'| �� t| | j�� j d�| _| j�
| j � t �
||| j�| _dd� }d d
� }| jj�||�S ) N�,z %d.%d.%d.%dr r� � )r� r� c S � t S r` )�ENTERING_PORT_MODErF r3 r3 r4 � connected� � z FTP.ftp_PORT.<locals>.connectedc S s | � t� tS r` )rw r� �CANT_OPEN_DATA_CNXr7 r3 r3 r4 �
connFailed� s
z FTP.ftp_PORT.<locals>.connFailed)rA �map�intr; r/ r0 r� r� �getPeerr� r r� r �
connectTCPri r� rN )rd �addressr� �ipr� r� r� r3 r3 r4 �ftp_PORT� s
z FTP.ftp_PORTc C s t |t�r
|�d�S |S )a�
Encode C{name} to be sent over the wire.
This encodes L{unicode} objects as UTF-8 and leaves L{bytes} as-is.
As described by U{RFC 3659 section
2.2<https://tools.ietf.org/html/rfc3659#section-2.2>}::
Various FTP commands take pathnames as arguments, or return
pathnames in responses. When the MLST command is supported, as
indicated in the response to the FEAT command, pathnames are to be
transferred in one of the following two formats.
pathname = utf-8-name / raw
utf-8-name = <a UTF-8 encoded Unicode string>
raw = <any string that is not a valid UTF-8 encoding>
Which format is used is at the option of the user-PI or server-PI
sending the pathname.
@param name: Name to be encoded.
@type name: L{bytes} or L{unicode}
@return: Wire format of C{name}.
@rtype: L{bytes}
zutf-8)r% r� r� )rd r� r3 r3 r4 � _encodeName� s
zFTP._encodeNamer7 c s� � j du s � j jst�td��S |�� dv rd}� fdd�}zt� j|�}W n ty6 t�t |�� Y S w � j
� |d�}|� |� |S )a� This command causes a list to be sent from the server to the
passive DTP. If the pathname specifies a directory or other
group of files, the server should transfer a list of files
in the specified directory. If the pathname specifies a
file then the server should send current information on the
file. A null argument implies the user's current working or
default directory.
N�"must send PORT or PASV before RETR)z-az-lz-laz-alr7 c sB � � t� | D ]\}}� �|�}� j�||� q� jj�� tfS r` )r$ � DATA_CNX_ALREADY_OPEN_START_XFRr� r� r� r� r� �TXFR_COMPLETE_OK)�resultsr� �attrsrh r3 r4 �
gotListing s
z FTP.ftp_LIST.<locals>.gotListing)r� r� r� r� r� r� r� )
r� r� r rE r� �lowerrB rr r. rF r2 �listr� )rd r? r� rY r� r3 rh r4 �ftp_LIST� s
��
z FTP.ftp_LISTc s� � j du s � j jst�td��S zt� j|�}W n ty( t�t|�� Y S w � fdd�}� fdd�}t |�r>|�
� }nd}� j � |�}|�
||� |�|� |S )a\
This command causes a directory listing to be sent from the server to
the client. The pathname should specify a directory or other
system-specific file group descriptor. An empty path implies the
current working directory. If the path is non-existent, send nothing.
If the path is to a file, send only the file name.
@type path: C{str}
@param path: The path for which a directory listing should be returned.
@rtype: L{Deferred}
@return: a L{Deferred} which will be fired when the listing request
is finished.
Nr� c sT � � t� | D ]\}}|r|r t�||�r � �|�}� j�|� q� jj�� tfS )a�
Send, line by line, each matching file in the directory listing,
and then close the connection.
@type results: A C{list} of C{tuple}. The first element of each
C{tuple} is a C{str} and the second element is a C{list}.
@param results: The names of the files in the directory.
@param glob: A shell-style glob through which to filter results
(see U{http://docs.python.org/2/library/fnmatch.html}), or
L{None} for no filtering.
@type glob: L{str} or L{None}
@return: A C{tuple} containing the status code for a successful
transfer.
@rtype: C{tuple}
) r$ r� rU r� r� r� r� r� r� )r� �globr� r� rh r3 r4 �cbListC s
� z FTP.ftp_NLST.<locals>.cbListc s � j j�� tfS )a
RFC 959 specifies that an NLST request may only return directory
listings. Thus, send nothing and just close the connection.
@type results: L{Failure}
@param results: The L{Failure} wrapping a L{FileNotFoundError} that
occurred while trying to list the contents of a nonexistent
directory.
@returns: A C{tuple} containing the status code for a successful
transfer.
@rtype: C{tuple}
)r� r� r� r� )r� rh r3 r4 �listErr] s z FTP.ftp_NLST.<locals>.listErr)r� r� r rE r� rB rr r. rF r] r< r2 r� r� rO )rd r? rY r� r� r� r� r3 rh r4 �ftp_NLST+ s �
z FTP.ftp_NLSTc sR zt �j|�� W n ty t�t|�� Y S w � �fdd�}�j�� ��|�S )Nc s � �_ tfS r` )rr �REQ_FILE_ACTN_COMPLETED_OKrB �rY rd r3 r4 �
accessGranted� s z"FTP.ftp_CWD.<locals>.accessGranted) rB rr r. r rE rF r2 �accessr� )rd r? r� r3 r� r4 �ftp_CWD{ s �z FTP.ftp_CWDc C �
| � d�S )Nr8 )r� rh r3 r3 r4 �ftp_CDUP� r z FTP.ftp_CDUPc C s t dd�| j� fS )Nr5 )� PWD_REPLY�joinrr rh r3 r3 r4 �ftp_PWD� s z FTP.ftp_PWDc s� �j du r td��zt�j|��W n ty! t�t|�� Y S w ��d� �fdd�}�j s6t
�j ��n�j �dd� � dd� �� ���fd d
�}�fd d �}�j � ��}|�
||� |�|� |S )
a�
This command causes the content of a file to be sent over the data
transfer channel. If the path is to a folder, an error will be raised.
@type path: C{str}
@param path: The path to the file which should be transferred over the
data transfer channel.
@rtype: L{Deferred}
@return: a L{Deferred} which will be fired when the transfer is done.
Nz!PORT or PASV required before RETRc � � � � jj� | S r` �r r� r+ rB rh r3 r4 �
enableTimeout� � z#FTP.ftp_RETR.<locals>.enableTimeoutc S � t fS r` �r� rB r3 r3 r4 �cbSent� � z FTP.ftp_RETR.<locals>.cbSentc S s( t �d� t �| � | �t�r| S tfS )Nz7Unexpected error attempting to transmit file to client:)r re r8 r: r_ �CNX_CLOSED_TXFR_ABORTEDr7 r3 r3 r4 �ebSent� s
z FTP.ftp_RETR.<locals>.ebSentc s8 �j jr
��t� n��t� | ���}|�� �� |S r` )r� r� r$ r� � FILE_STATUS_OK_OPEN_DATA_CNX�sendrN ��filer� )r� r� r� rd r3 r4 �cbOpened� s
z FTP.ftp_RETR.<locals>.cbOpenedc sL | � ttt�st�d� t�| � | � t�r | jj d�
� �fS t d�
� �fS )Nz:Unexpected error attempting to open file for transmission:r5 ) r: rI rF rO r re r8 r_ r5 rg r� rk r7 ��newsegsr3 r4 �ebOpened� s �
z FTP.ftp_RETR.<locals>.ebOpened)r� r� rB rr r. r rE rF r �binaryr r2 �openForReadingrN r� �rd r? r� r� r� r� r3 )r� r� r� r� rd r4 �ftp_RETR� s(
�
z FTP.ftp_RETRc s� �j du r td��zt�j|��W n ty! t�t|�� Y S w ��d� �fdd�}� ��fdd�}�fdd�}�fd d
�� d d � �d
d� ��j �
��}|� ||� |� |� |S )a�
STORE (STOR)
This command causes the server-DTP to accept the data
transferred via the data connection and to store the data as
a file at the server site. If the file specified in the
pathname exists at the server site, then its contents shall
be replaced by the data being transferred. A new file is
created at the server site if the file specified in the
pathname does not already exist.
Nz!PORT or PASV required before STORc r� r` r� rB rh r3 r4 r� � r� z#FTP.ftp_STOR.<locals>.enableTimeoutc s4 � � � }|��� |�� fdd�� |���� |S )zx
File was open for reading. Launch the data transfer channel via
the file consumer.
c s � � � S r` )r rF �r� r3 r4 r� � � z0FTP.ftp_STOR.<locals>.cbOpened.<locals>.<lambda>)�receiver� rN r� )�
cbConsumerr� r� r� r4 r� � s
z FTP.ftp_STOR.<locals>.cbOpenedc s8 t | jt�r| jjd�� �fS t�| d� td�� �fS )z�
Called when failed to open the file for reading.
For known errors, return the FTP error code.
For all other, return a file not found error.
r5 z-Unexpected error received while opening file:)r% r5 r_ rg r� r r8 rk r7 r� r3 r4 r� s z FTP.ftp_STOR.<locals>.ebOpenedc s> � j st| �} � j�| �}� jjr� �t� |S � �t� |S )z�
Called after the file was opended for reading.
Prepare the data transfer channel and send the response
to the command channel.
)r� r r� r� r� r$ r� r� )r� r� rh r3 r4 r�
s
�z FTP.ftp_STOR.<locals>.cbConsumerc S r� )zK
Called from data transport when transfer is done.
r� rB r3 r3 r4 r� ! s z FTP.ftp_STOR.<locals>.cbSentc S s t �| d� | �t�r
| S tfS )zk
Called from data transport when there are errors during the
transfer.
z*Unexpected error received during transfer:)r r8 r: r_ r� r7 r3 r3 r4 r� ' s
z FTP.ftp_STOR.<locals>.ebSent)
r� r� rB rr r. r rE rF r r2 �openForWritingrN r� r� r3 )r� r� r� r� rd r4 �ftp_STOR� s$
�
z FTP.ftp_STORc C �N zt | j|�}W n ty t�t|�� Y S w dd� }| j�|d��|�S )ab
File SIZE
The FTP command, SIZE OF FILE (SIZE), is used to obtain the transfer
size of a file from the server-FTP process. This is the exact number
of octets (8 bit bytes) that would be transmitted over the data
connection should that file be transmitted. This value will change
depending on the current STRUcture, MODE, and TYPE of the data
connection or of a data connection that would be created were one
created now. Thus, the result of the SIZE command is dependent on
the currently established STRU, MODE, and TYPE parameters.
The SIZE command returns how many octets would be transferred if the
file were to be transferred using the current transfer structure,
mode, and type. This command is normally used in conjunction with
the RESTART (REST) command when STORing a file to a remote server in
STREAM mode, to determine the restart point. The server-PI might
need to read the partially transferred file, do any appropriate
conversion, and count the number of octets that would be generated
when sending the file in order to correctly respond to this command.
Estimates of the file transfer size MUST NOT be returned; only
precise information is acceptable.
http://tools.ietf.org/html/rfc3659
c S s | \}t t|�fS r` )� FILE_STATUSr� )rC r� r3 r3 r4 �cbStatW r z FTP.ftp_SIZE.<locals>.cbStat)r� � rB rr r. r rE rF r2 �statr� �rd r? r� r� r3 r3 r4 �ftp_SIZE8 s �z FTP.ftp_SIZEc C r� )a!
File Modification Time (MDTM)
The FTP command, MODIFICATION TIME (MDTM), can be used to determine
when a file in the server NVFS was last modified. This command has
existed in many FTP servers for many years, as an adjunct to the REST
command for STREAM mode, thus is widely available. However, where
supported, the "modify" fact that can be provided in the result from
the new MLST command is recommended as a superior alternative.
http://tools.ietf.org/html/rfc3659
c S s | \}t t�dt�|��fS )Nz %Y%m%d%H%M%S)r� r� �strftimer� )rC r� r3 r3 r4 r� o s z FTP.ftp_MDTM.<locals>.cbStat)r� r� r� r3 r3 r4 �ftp_MDTM] s
�z FTP.ftp_MDTMc C sH |� � }|r!t| d|d d�}|dur ||dd� �S | �|�S tfS )a
REPRESENTATION TYPE (TYPE)
The argument specifies the representation type as described
in the Section on Data Representation and Storage. Several
types take a second parameter. The first parameter is
denoted by a single Telnet character, as is the second
Format parameter for ASCII and EBCDIC; the second parameter
for local byte is a decimal integer to indicate Bytesize.
The parameters are separated by a <SP> (Space, ASCII code
32).
�type_r NrT )r\ rS � type_UNKNOWNru )rd �typer� �fr3 r3 r4 �ftp_TYPEu s
z FTP.ftp_TYPEc C s0 |dks|dkrd| _ td| fS t�t|��S )Nr7 �NF�A�r� � TYPE_SET_OKr rE rv �rd �coder3 r3 r4 �type_A� s z
FTP.type_Ac C s$ |dkr d| _ tdfS t�t|��S )Nr7 T�Ir� r� r3 r3 r4 �type_I� s z
FTP.type_Ic C s t �t|��S r` )r rE rz r� r3 r3 r4 r� � r� zFTP.type_UNKNOWNc C r� r` )�
NAME_SYS_TYPErh r3 r3 r4 �ftp_SYST� r� z FTP.ftp_SYSTc C �$ |� � }|dkr tfS t�t|��S )N�F�r\ �CMD_OKr rE rz )rd � structurer� r3 r3 r4 �ftp_STRU� � z FTP.ftp_STRUc C r� )N�Sr� )rd �moder� r3 r3 r4 �ftp_MODE� r� z FTP.ftp_MODEc sL zt | j� �}W n ty t�t� �� Y S w | j�|��� fdd��S )Nc s t � fS r` )� MKD_REPLYr� �r? r3 r4 r� � r� z FTP.ftp_MKD.<locals>.<lambda>) rB rr r. r rE rF r2 �
makeDirectoryr� �rd r? r� r3 r� r4 �ftp_MKD� s �
�z FTP.ftp_MKDc C �H zt | j|�}W n ty t�t|�� Y S w | j�|��dd� �S )Nc S r� r` �r� r� r3 r3 r4 r� � � z FTP.ftp_RMD.<locals>.<lambda>) rB rr r. r rE rF r2 �removeDirectoryr� r� r3 r3 r4 �ftp_RMD� � � �z FTP.ftp_RMDc C r� )Nc S r� r` r� r� r3 r3 r4 r� � r� z FTP.ftp_DELE.<locals>.<lambda>) rB rr r. r rE rF r2 �
removeFiler� r� r3 r3 r4 �ftp_DELE� r z FTP.ftp_DELEc C r� r` )r� rh r3 r3 r4 �ftp_NOOP� r� z FTP.ftp_NOOPc C s || _ | j| _tfS r` )� _fromNamerc r* �"REQ_FILE_ACTN_PENDING_FURTHER_INFO)rd �fromNamer3 r3 r4 �ftp_RNFR� s z FTP.ftp_RNFRc C sh | j }| ` | j| _zt| j|�}t| j|�}W n ty' t�t|�� Y S w | j �
||�� dd� �S )Nc S r� r` r� r� r3 r3 r4 r� � r� z FTP.ftp_RNTO.<locals>.<lambda>) r rb r* rB rr r. r rE rF r2 �renamer� )rd �toNamer �fromsegs�tosegsr3 r3 r4 rd � s ��z FTP.ftp_RNTOc C sB | � tt d � | jD ] }| � d| � q | � tt d � dS )zm
Advertise the features supported by the server.
http://tools.ietf.org/html/rfc2389
r rH rT N)r� rf �FEAT_OK�FEATURES)rd �featurer3 r3 r4 �ftp_FEAT� s
z FTP.ftp_FEATc C s | � t|�S )zl
Handle OPTS command.
http://tools.ietf.org/html/draft-ietf-ftpext-utf-8-option-00
)r$ �OPTS_NOT_IMPLEMENTED)rd �optionr3 r3 r4 �ftp_OPTS� s z FTP.ftp_OPTSc C s | � t� | j�� d| _d S r� )r$ � GOODBYE_MSGr� r� rE rh r3 r3 r4 �ftp_QUIT� s
z FTP.ftp_QUITc C s� t jddd� t �| j� | jd}| _tj�|�r |�� ntj�|�r*|�� nJ d|f ��| j �
� d| _ | j durCd| _ dS dS )z0
Call when DTP connection exits
r0 Tr� NFz@dtpPort should be an IListeningPort or IConnector, instead is %r) r re ri r
�IListeningPort�
providedBy�
stopListening�
IConnector�
disconnectr/ r� r� )rd ri r3 r3 r4 r0 � s"
��
�zFTP.cleanupDTP)r7 )@r/ r0 r1 r2 rE �ranger) r` rb rc r� r r2 r/ ri r� r� r] r re r � listenTCPrf r� r$ r� r� r� r4 rQ rM rj r^ ra r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r rd r r r r0 �
__classcell__r3 r3 r' r4 r � sn
/#!
-P
J`% r c @ sV e Zd ZdZeZeZdZdZ dZ
de j � d�Z
edd�Zdd
d �Zd d
� Zdd� Zd S )�
FTPFactorya
A factory for producing ftp protocol instances
@ivar timeOut: the protocol interpreter's idle timeout time in seconds,
default is 600 seconds.
@ivar passivePortRange: value forwarded to C{protocol.passivePortRange}.
@type passivePortRange: C{iterator}
T� anonymousiX zTwisted z FTP Serverr rT Nc C s || _ || _g | _d S r` )r rm � instances)rd r rm r3 r3 r4 rb ! s
zFTPFactory.__init__c C s8 t j�| |�}|d ur| j|j_| j|j_| j|j_|S r` )r � LimitTotalConnectionsFactoryr� r �wrappedProtocolr+ re r� r3 r3 r4 r� & s
zFTPFactory.buildProtocolc C s dd� | j D � tj�| � d S )Nc S s g | ] }|j d ur|�d ��qS r` )r+ r �r6 r� r3 r3 r4 �
<listcomp>1 s z*FTPFactory.stopFactory.<locals>.<listcomp>)r r r! r� rh r3 r3 r4 r� . s zFTPFactory.stopFactory)Nr )r/ r0 r1 r2 r r r �overflowProtocolrl rm r+ r �versionr- r re rb r� r� r3 r3 r3 r4 r s
r c @ s\ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zdd
d�Z ddd�Z
dd� Z dd� Z dS )rq z�
An abstraction of the shell commands used by the FTP protocol for
a given user account.
All path names must be absolute.
c C � dS )a
Create a directory.
@param path: The path, as a list of segments, to create
@type path: C{list} of C{unicode}
@return: A Deferred which fires when the directory has been
created, or which fails if the directory cannot be created.
Nr3 r� r3 r3 r4 r� @ r� zIFTPShell.makeDirectoryc C r' )a
Remove a directory.
@param path: The path, as a list of segments, to remove
@type path: C{list} of C{unicode}
@return: A Deferred which fires when the directory has been
removed, or which fails if the directory cannot be removed.
Nr3 r� r3 r3 r4 r� K r� zIFTPShell.removeDirectoryc C r' )a
Remove a file.
@param path: The path, as a list of segments, to remove
@type path: C{list} of C{unicode}
@return: A Deferred which fires when the file has been
removed, or which fails if the file cannot be removed.
Nr3 r� r3 r3 r4 r V r� zIFTPShell.removeFilec C r' )ax
Rename a file or directory.
@param fromPath: The current name of the path.
@type fromPath: C{list} of C{unicode}
@param toPath: The desired new name of the path.
@type toPath: C{list} of C{unicode}
@return: A Deferred which fires when the path has been
renamed, or which fails if the path cannot be renamed.
Nr3 )�fromPath�toPathr3 r3 r4 r a r� zIFTPShell.renamec C r' )a
Determine whether access to the given path is allowed.
@param path: The path, as a list of segments
@return: A Deferred which fires with None if access is allowed
or which fails with a specific exception type if access is
denied.
Nr3 r� r3 r3 r4 r� o r� zIFTPShell.accessr3 c C r' )z�
Retrieve information about the given path.
This is like list, except it will never return results about
child paths.
Nr3 �r? �keysr3 r3 r4 r� z r� zIFTPShell.statc C r' )ae
Retrieve information about the given path.
If the path represents a non-directory, the result list should
have only one entry with information about that non-directory.
Otherwise, the result list should have an element for each
child of the directory.
@param path: The path, as a list of segments, to list
@type path: C{list} of C{unicode} or C{bytes}
@param keys: A tuple of keys desired in the resulting
dictionaries.
@return: A Deferred which fires with a list of (name, list),
where the name is the name of the entry as a unicode string or
bytes and each list contains values corresponding to the requested
keys. The following are possible elements of keys, and the
values which should be returned for them:
- C{'size'}: size in bytes, as an integer (this is kinda required)
- C{'directory'}: boolean indicating the type of this entry
- C{'permissions'}: a bitvector (see os.stat(foo).st_mode)
- C{'hardlinks'}: Number of hard links to this entry
- C{'modified'}: number of seconds since the epoch since entry was
modified
- C{'owner'}: string indicating the user owner of this entry
- C{'group'}: string indicating the group owner of this entry
Nr3 r* r3 r3 r4 r� � r� zIFTPShell.listc C r' )z�
@param path: The path, as a list of segments, to open
@type path: C{list} of C{unicode}
@rtype: C{Deferred} which will fire with L{IReadFile}
Nr3 r� r3 r3 r4 r� � r� zIFTPShell.openForReadingc C r' )z�
@param path: The path, as a list of segments, to open
@type path: C{list} of C{unicode}
@rtype: C{Deferred} which will fire with L{IWriteFile}
Nr3 r� r3 r3 r4 r� � r� zIFTPShell.openForWritingN�r3 )
r/ r0 r1 r2 r� r� r r r� r� r� r� r� r3 r3 r3 r4 rq 8 s
% rq c @ � e Zd ZdZdd� ZdS )� IReadFilez0
A file out of which bytes may be read.
c C r' )a
Produce the contents of the given path to the given consumer. This
method may only be invoked once on each provider.
@type consumer: C{IConsumer}
@return: A Deferred which fires when the file has been
consumed completely.
Nr3 )�consumerr3 r3 r4 r� � r� zIReadFile.sendN)r/ r0 r1 r2 r� r3 r3 r3 r4 r. � s r. c @ r^ )�
IWriteFilez1
A file into which bytes may be written.
c C r' )z�
Create a consumer which will write to this file. This method may
only be invoked once on each provider.
@rtype: C{Deferred} of C{IConsumer}
Nr3 r3 r3 r3 r4 r� � r� zIWriteFile.receivec C r' )ae
Perform any post-write work that needs to be done. This method may
only be invoked once on each provider, and will always be invoked
after receive().
@rtype: C{Deferred} of anything: the value is ignored. The FTP client
will not see their upload request complete until this Deferred has
been fired.
Nr3 r3 r3 r3 r4 r � r� zIWriteFile.closeN)r/ r0 r1 r2 r� r r3 r3 r3 r4 r0 � s r0 c C sD g }t �| �}|�|j� t�� D ]}|j|jv r |�|j� q|S )z_
Return the primary and supplementary groups for the given UID.
@type uid: C{int}
) �pwd�getpwuidr= �pw_gid�grp�getgrall�pw_name�gr_mem�gr_gid)�uidrC �pwent�grentr3 r3 r4 �
_getgroups� s
�r< �rc
C s� |dkrt j}t j}t j}tj}n|dkr"t j}t j}t j}tj }nt
d|�d���d}tj � |�r`| dkr9d}n't� |�} || j
@ rK| | jkrKd}n|| j
@ rY|t| �v rYd}n|| j
@ r`d}|rut�||�sud}t�d| t�� f � |S ) a�
checks to see if uid has proper permissions to access path with mode
@type uid: C{int}
@param uid: numeric user id
@type gid: C{int}
@param gid: numeric group id
@type spath: C{str}
@param spath: the path on the server to test
@type mode: C{str}
@param mode: 'r' or 'w' (read or write)
@rtype: C{bool}
@return: True if the given credentials have the specified form of
access to the given path
r= �wz
Invalid mode z: must specify 'r' or 'w'Fr TzUFilesystem grants permission to UID %d but it is inaccessible to me running as UID %d)r� �S_IRUSR�S_IRGRP�S_IROTHr �R_OK�S_IWUSR�S_IWGRP�S_IWOTH�W_OK�
ValueErrorr? �exists�st_mode�st_uidr< r� r re �getuid)
r9 �gid�spathr� �usrr4 �oth�amoder� rA r3 r3 r4 �_testPermissions� s>
��rQ c @ s� e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
d,dd�Zd,dd�Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+S )-�FTPAnonymousShellz�
An anonymous implementation of IFTPShell
@type filesystemRoot: L{twisted.python.filepath.FilePath}
@ivar filesystemRoot: The path which is considered the root of
this shell.
c C r r` )�filesystemRoot)rd rS r3 r3 r4 rb 6 r zFTPAnonymousShell.__init__c C � | j �|�S r` )rS �
descendant�rd r? r3 r3 r4 �_path9 � zFTPAnonymousShell._pathc C � t �t� �S r` �r rE rm rV r3 r3 r4 r� < rX z FTPAnonymousShell.makeDirectoryc C rY r` rZ rV r3 r3 r4 r� ? rX z!FTPAnonymousShell.removeDirectoryc C rY r` rZ rV r3 r3 r4 r B rX z FTPAnonymousShell.removeFilec C rY r` rZ )rd r( r) r3 r3 r4 r E rX zFTPAnonymousShell.renamec C s | � |�}t�t� �S r` )rW r rE rm rV r3 r3 r4 r� H s
zFTPAnonymousShell.receivec
C � | � |�}|�� rt�t|��S z|�d�}W n$ ty/ } z t|j|�W Y d}~S d}~w t y; t�� Y S w t�
t |��S )a�
Open C{path} for reading.
@param path: The path, as a list of segments, to open.
@type path: C{list} of C{unicode}
@return: A L{Deferred} is returned that will fire with an object
implementing L{IReadFile} if the file is successfully opened. If
C{path} is a directory, or if an exception is raised while trying
to open the file, the L{Deferred} will fire with an error.
r= N) rW �isdirr rE rO �open�OSErrorrQ rC r� r� � _FileReader)rd r? r� r� rP r3 r3 r4 r� L s
� �z FTPAnonymousShell.openForReadingc C s t �td��S )za
Reject write attempts by anonymous users with
L{PermissionDeniedError}.
zSTOR not allowed)r rE rI rV r3 r3 r4 r� e s z FTPAnonymousShell.openForWritingc
C s� | � |�}|�� st�t|��S z|�� W n$ ty. } z t|j|�W Y d }~S d }~w t y: t�� Y S w t�
d �S r` ) rW rH r rE rF �listdirr^ rQ rC r� r� �rd r? r� rP r3 r3 r4 r� l s
� �
zFTPAnonymousShell.accessr3 c
C s� | � |�}|�� r;z| �||�}W n$ ty) } z t|j|�W Y d }~S d }~w ty5 t�� Y S w t� |�S | �
||�� dd� �S )Nc S s | d d S )Nr rT r3 )�resr3 r3 r4 r� � s z(FTPAnonymousShell.stat.<locals>.<lambda>) rW r\ � _statNoder^ rQ rC r� r rE r� r� r� )rd r? r+ r� �
statResultrP r3 r3 r4 r� | s
� �
zFTPAnonymousShell.statc s | � |�� � �� r� �� }� fdd�|D �}n� �� r*tjj� �| j�� g}� g}nt �
t |��S g }t ||�D ]C\}� g }|�
||f� |r{z |�| �� |�� W q8 tyl } zt|j|�W Y d}~ S d}~w tyz t �
� Y S w q8t �|�S )a
Return the list of files at given C{path}, adding C{keys} stat
informations if specified.
@param path: the directory or file to check.
@type path: C{str}
@param keys: the list of desired metadata
@type keys: C{list} of C{str}
c s g | ]}� � |��qS r3 )�childr# ��filePathr3 r4 r$ � s z*FTPAnonymousShell.list.<locals>.<listcomp>N)rW r\ r` �isfiler r? r� � segmentsFromrS r rE rF �zipr= �extendrc r^ rQ rC r� r� ) rd r? r+ �entries� fileEntriesr� �fileName�entrP r3 rf r4 r� � s.
� ��
zFTPAnonymousShell.listc s � � � � �fdd�|D �S )z�
Shortcut method to get stat info on a node.
@param filePath: the node to stat.
@type filePath: C{filepath.FilePath}
@param keys: the stat keys to get.
@type keys: C{iterable}
c s g | ] }t �d | �� ��qS )�_stat_)rS )r6 �k�rg rd r3 r4 r$ � s z/FTPAnonymousShell._statNode.<locals>.<listcomp>)�restat)rd rg r+ r3 rr r4 rc � s
zFTPAnonymousShell._statNodec C � |� � S )z�
Get the filepath's size as an int
@param fp: L{twisted.python.filepath.FilePath}
@return: C{int} representing the size
)�getsize�rd �fpr3 r3 r4 �
_stat_size� � z FTPAnonymousShell._stat_sizec C rt )z�
Get the filepath's permissions object
@param fp: L{twisted.python.filepath.FilePath}
@return: L{twisted.python.filepath.Permissions} of C{fp}
)�getPermissionsrv r3 r3 r4 �_stat_permissions� ry z#FTPAnonymousShell._stat_permissionsc C s z|� � W S ty Y dS w )a�
Get the number of hardlinks for the filepath - if the number of
hardlinks is not yet implemented (say in Windows), just return 0 since
stat-ing a file in Windows seems to return C{st_nlink=0}.
(Reference:
U{http://stackoverflow.com/questions/5275731/os-stat-on-windows})
@param fp: L{twisted.python.filepath.FilePath}
@return: C{int} representing the number of hardlinks
r )�getNumberOfHardLinks�NotImplementedErrorrv r3 r3 r4 �_stat_hardlinks� s
�z!FTPAnonymousShell._stat_hardlinksc C rt )z�
Get the filepath's last modified date
@param fp: L{twisted.python.filepath.FilePath}
@return: C{int} as seconds since the epoch
)�getModificationTimerv r3 r3 r4 �_stat_modified� ry z FTPAnonymousShell._stat_modifiedc C �\ z|� � }W n
ty Y dS w tdur*zt�|�d W S ty) Y t|�S w t|�S )a�
Get the filepath's owner's username. If this is not implemented
(say in Windows) return the string "0" since stat-ing a file in
Windows seems to return C{st_uid=0}.
(Reference:
U{http://stackoverflow.com/questions/5275731/os-stat-on-windows})
@param fp: L{twisted.python.filepath.FilePath}
@return: C{str} representing the owner's username
�0Nr )� getUserIDr} r1 r2 �KeyErrorr� )rd rw �userIDr3 r3 r4 � _stat_owner� � � �z FTPAnonymousShell._stat_ownerc C r� )a�
Get the filepath's owner's group. If this is not implemented
(say in Windows) return the string "0" since stat-ing a file in
Windows seems to return C{st_gid=0}.
(Reference:
U{http://stackoverflow.com/questions/5275731/os-stat-on-windows})
@param fp: L{twisted.python.filepath.FilePath}
@return: C{str} representing the owner's group
r� Nr )�
getGroupIDr} r4 �getgrgidr� r� )rd rw �groupIDr3 r3 r4 � _stat_group� r� z FTPAnonymousShell._stat_groupc C rt )z�
Get whether the filepath is a directory
@param fp: L{twisted.python.filepath.FilePath}
@return: C{bool}
)r\ rv r3 r3 r4 �_stat_directory ry z!FTPAnonymousShell._stat_directoryNr, )r/ r0 r1 r2 rb rW r� r� r r r� r� r� r� r� r� rc rx r{ r~ r� r� r� r� r3 r3 r3 r4 rR , s,
#
rR c @ �$ e Zd Zdd� Zdd� Zdd� ZdS )r_ c C � || _ d| _d S r� )r �_sendr r3 r3 r4 rb " �
z_FileReader.__init__c C s d| _ | j�� |S r� )r� r r )rd � passthroughr3 r3 r4 �_close& s
z_FileReader._closec C s6 | j rJ d��d| _ t�� �| j|�}|�| j� |S )Nz0Can only call IReadFile.send *once* per instanceT)r� r
�
FileSender�beginFileTransferr r� r� )rd r/ r� r3 r3 r4 r� + s
z_FileReader.sendN)r/ r0 r1 rb r� r� r3 r3 r3 r4 r_ s r_ c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
�FTPShellz:
An authenticated implementation of L{IFTPShell}.
c
C sj | � |�}z|�� W n$ ty# } z t|j|�W Y d }~S d }~w ty/ t�� Y S w t�d �S r` ) rW �makedirsr^ rQ rC r� r rE r� ra r3 r3 r4 r� 8 s
� �
zFTPShell.makeDirectoryc
C s� | � |�}|�� rt�t|��S zt�|j� W n$ ty0 } z t |j
|�W Y d }~S d }~w t y< t�� Y S w t� d �S r` )
rW rh r rE rK r �rmdirr? r^ rQ rC r� r� ra r3 r3 r4 r� C s
� �
zFTPShell.removeDirectoryc
C s� | � |�}|�� rt�t|��S z|�� W n$ ty. } z t|j|�W Y d }~S d }~w t y: t�� Y S w t�
d �S r` ) rW r\ r rE rO �remover^ rQ rC r� r� ra r3 r3 r4 r S s
� �
zFTPShell.removeFilec
C s| | � |�}| � |�}z
t�|j|j� W n$ ty, } z t|j|�W Y d }~S d }~w ty8 t� � Y S w t�
d �S r` ) rW r r r? r^ rQ rC r� r rE r� )rd r( r) rw �tprP r3 r3 r4 r c s
� �
zFTPShell.renamec
C r[ )a�
Open C{path} for writing.
@param path: The path, as a list of segments, to open.
@type path: C{list} of C{unicode}
@return: A L{Deferred} is returned that will fire with an object
implementing L{IWriteFile} if the file is successfully opened. If
C{path} is a directory, or if an exception is raised while trying
to open the file, the L{Deferred} will fire with an error.
r> N) rW r\ r rE rO r] r^ rQ rC r� r� � _FileWriter)rd r? r� r rP r3 r3 r4 r� o s
� �zFTPShell.openForWritingN) r/ r0 r1 r2 r� r� r r r� r3 r3 r3 r4 r� 3 s r� c @ r� )r� c C r� r� )r �_receiver r3 r3 r4 rb � r� z_FileWriter.__init__c C s$ | j rJ d��d| _ t�t| j��S )Nz4Can only call IWriteFile.receive *once* per instanceT)r� r r� r r rh r3 r3 r4 r� � s z_FileWriter.receivec C s
t �d �S r` )r r� rh r3 r3 r4 r � r z_FileWriter.closeN)r/ r0 r1 rb r� r r3 r3 r3 r4 r� � s r� c @ �( e Zd ZdZdd� Zdd� Zdd� ZdS ) � BaseFTPRealmz{
Base class for simple FTP realms which provides an easy hook for specifying
the home directory for each user.
c C s t �|�| _d S r` )r �FilePath�
anonymousRoot)rd r� r3 r3 r4 rb � r zBaseFTPRealm.__init__c C s t | j�d���)a
Return a L{FilePath} representing the home directory of the given
avatar. Override this in a subclass.
@param avatarId: A user identifier returned from a credentials checker.
@type avatarId: C{str}
@rtype: L{FilePath}
z" did not override getHomeDirectory)r} r( �rd �avatarIdr3 r3 r4 �getHomeDirectory� s
�z BaseFTPRealm.getHomeDirectoryc G sX |D ]%}|t u r'|tju rt| j�}nt| �|��}t |t|ddd� �f S qtd��)Nr. c S r� r` r3 r3 r3 r3 r4 r� � r� z,BaseFTPRealm.requestAvatar.<locals>.<lambda>z3Only IFTPShell interface is supported by this realm) rq r � ANONYMOUSrR r� r� r� rS r} )rd r� �mindr
�ifacert r3 r3 r4 �
requestAvatar� s
�zBaseFTPRealm.requestAvatarN)r/ r0 r1 r2 rb r� r� r3 r3 r3 r4 r� � s
r� c @ s" e Zd ZdZddd�Zdd� ZdS ) �FTPRealma"
@type anonymousRoot: L{twisted.python.filepath.FilePath}
@ivar anonymousRoot: Root of the filesystem to which anonymous
users will be granted access.
@type userHome: L{filepath.FilePath}
@ivar userHome: Root of the filesystem containing user home directories.
�/homec C s t �| |� t�|�| _d S r` )r� rb r r� �userHome)rd r� r� r3 r3 r4 rb � s zFTPRealm.__init__c C rT )z�
Use C{avatarId} as a single path segment to construct a child of
C{self.userHome} and return that child.
)r� re r� r3 r3 r4 r� � � zFTPRealm.getHomeDirectoryN)r� )r/ r0 r1 r2 rb r� r3 r3 r3 r4 r� � s
r� c @ r- )�SystemFTPRealmz�
L{SystemFTPRealm} uses system user account information to decide what the
home directory for a particular avatarId is.
This works on POSIX but probably is not reliable on Windows.
c C s, t j�d| �}|�d�rt�� �t�|�S )zx
Return the system-defined home directory of the system user account
with the name C{avatarId}.
�~)r r? �
expanduserr: rx ry r r� )rd r� r? r3 r3 r4 r� � s
z SystemFTPRealm.getHomeDirectoryN)r/ r0 r1 r2 r� r3 r3 r3 r4 r� � s r� c @ r| )�ConnectionLostNr~ r3 r3 r3 r4 r� � r r� c @ r| )�
CommandFailedNr~ r3 r3 r3 r4 r� � r r� c @ r| )� BadResponseNr~ r3 r3 r3 r4 r� � r r� c @ r| )�UnexpectedResponseNr~ r3 r3 r3 r4 r� r r� c @ r| )�UnexpectedDataNr~ r3 r3 r3 r4 r� r r� c @ s e Zd Zddd�Zdd� ZdS )�
FTPCommandNr c C s& || _ t�� | _d| _|| _d | _d S )NrT )�textr r� r� �ready�public�transferDeferred)rd r� r� r3 r3 r4 rb s
zFTPCommand.__init__c C s | j r | j�|� d S d S r` )r� r� r� )rd r r3 r3 r4 rE s �zFTPCommand.fail�Nr )r/ r0 r1 rb rE r3 r3 r3 r4 r�
s
r� c @ s, e Zd Zdd� Zdd� Zdd� Zdd� Zd S )
�ProtocolWrapperc C s || _ || _d S r` )�originalr� )rd r� r� r3 r3 r4 rb r� zProtocolWrapper.__init__c C r r` )r� �makeConnection�rd r� r3 r3 r4 r� r z ProtocolWrapper.makeConnectionc C r r` )r� r� r� r3 r3 r4 r� r z ProtocolWrapper.dataReceivedc C s | j �|� | j�d � d S r` )r� r� r� r� r� r3 r3 r4 r� " s z ProtocolWrapper.connectionLostN)r/ r0 r1 rb r� r� r� r3 r3 r3 r4 r� s
r� c @ r- )�IFinishableConsumerzA
A Consumer for producers that finish.
@since: 11.0
c C r' )z6
The producer has finished producing.
Nr3 r3 r3 r3 r4 �finish/ r� zIFinishableConsumer.finishN)r/ r0 r1 r2 r� r3 r3 r3 r4 r� ( s r� c @ sL e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dS )�SenderProtocolc C s t �� | _t �� | _d S r` )r r� �connectedDeferredr� rh r3 r3 r4 rb 7 s
zSenderProtocol.__init__c C s t d��)Nz<Received data from the server on a send-only data-connection)r� r� r3 r3 r4 r� ? s �zSenderProtocol.dataReceivedc C s t j�| |� | j�| � d S r` )r �Protocolr� r� r� r� r3 r3 r4 r� D s z SenderProtocol.makeConnectionc C s, |� tj�r| j�d� d S | j�|� d S )Nzconnection done)r: r �ConnectionDoner� r� r� r� r3 r3 r4 r� H s z SenderProtocol.connectionLostc C r r` r� r� r3 r3 r4 r� O r zSenderProtocol.writec C s | j �||� dS )zA
Register the given producer with our transport.
Nr� r� r3 r3 r4 r� R s z SenderProtocol.registerProducerc C s | j �� dS )z@
Unregister the previously registered producer.
N)r� r� rh r3 r3 r4 r� X � z!SenderProtocol.unregisterProducerc C r� r` r3 rh r3 r3 r4 r� ^ r� zSenderProtocol.finishN) r/ r0 r1 rb r� r� r� r� r� r� r� r3 r3 r3 r4 r� 5 s r� c C s� t �dd| �}dd� |�d�D �}|D ]}|dk s |dkr#td| |��q|\}}}}}} |� d |� d |� d |� �}
t|�d
> t| � } |
| fS ) ze
Decode an FTP response specifying a host and port.
@return: a 2-tuple of (host, port).
z[^0-9, ]r7 c S s g | ]}t |�� ��qS r3 )r� �stripr# r3 r3 r4 r$ i � z"decodeHostPort.<locals>.<listcomp>r� r � z Out of ranger6 r� )�re�subr; rG r� ) r� �abcdef�parsed�x�a�b�cr� rP r� r� r� r3 r3 r4 �decodeHostPortb s �r� c C s, | � d�t|d? �t|d �g }d�|�S )Nr6 r� � r� )r; r� r� )r� r� �numbersr3 r3 r4 r� s s "
r� c C s | � tj� | jjS r` )rw r �
FirstErrorr5 �
subFailurer{ r3 r3 r4 �_unwrapFirstErrorx s r� c @ r )�FTPDataPortFactoryz_
Factory for data connections that use the PORT command
(i.e. "active" transfers)
Fc C s | | j _| j�� | j S r` )r r� r� r� )rd r� r3 r3 r4 r� � s
z FTPDataPortFactory.buildProtocolN)r/ r0 r1 r2 �noisyr� r3 r3 r3 r4 r� } s r� c @ sz e Zd ZdZdZdZdd� Zdd� Zdd � Zd
d � Z d d
� Z
dd� Z dd� Z d dd�Z
dd� Zdd� Zdd� Zdd � Zd S ) �FTPClientBasicz'
Foundations of an FTP client.
Fr� c C s< g | _ d | _t�� �| j�| _| j�| j� g | _ d| _
d S r� ) � actionQueue�greetingr r� r� � _cb_greeting� nextDeferredrO rE ri �_failedrh r3 r3 r4 rb � s
zFTPClientBasic.__init__c C s | � |� dS )z8
Give an error to any queued deferreds.
N��_fail�rd r r3 r3 r4 rE � r� zFTPClientBasic.failc C sn | j r|S d| _ | jr$z| j�t�td|��� W n
tjy# Y nw | jD ]
}|� t�td|��� q'|S )z/
Errback all queued deferreds.
rT zFTP connection lost)
r� r� r� r �Failurer� r �AlreadyCalledErrorr� rE )rd r �
ftpCommandr3 r3 r4 r� � s ��
�zFTPClientBasic._failc C r r` )r� )rd r� r3 r3 r4 r� � r zFTPClientBasic._cb_greetingc C s4 |du rdS t |t�r|�| j�}tj�| |� dS )z�
Sends a line, unless line is None.
@param line: Line to send
@type line: L{bytes} or L{unicode}
N)r% r� r� r� r
� LineReceiverr� r� r3 r3 r4 r� � s
zFTPClientBasic.sendLinec C s� | � � }|du r
d| _dS |js#| j�d|� t�d| j� d| _dS |jdkr-| � |� | j
r8t � d|j � |j
| _| �|j� dS )zD
(Private) Processes the next command in the queue.
Nr g �?�PORTz<-- %s)�popCommandQueuer� r� r� �insertr r �sendNextCommandr� �generatePortCommandr� r re r� r� �rd r� r3 r3 r4 r� � s
z FTPClientBasic.sendNextCommandc C sF | j �|� t| j �dkr | jdur | jdu r!| �� dS dS dS dS )a
Add an FTPCommand object to the queue.
If it's the only thing in the queue, and we are connected and we aren't
waiting for a response of an earlier command, the command will be sent
immediately.
@param ftpCommand: an L{FTPCommand}
rT N)r� r= r
r� r� r� r� r3 r3 r4 � queueCommand� s
�zFTPClientBasic.queueCommandrT c C s t ||�}| �|� |jS )au
Queues a string to be issued as an FTP command
@param command: string of an FTP command to queue
@param public: a flag intended for internal use by FTPClient. Don't
change it unless you know what you're doing.
@return: a L{Deferred} that will be called when the response to the
command has been received.
)r� r� r� )rd rT r� r� r3 r3 r4 �queueStringCommand� s
z!FTPClientBasic.queueStringCommandc C s | j r | j �d�S dS )zR
Return the front element of the command queue, or None if empty.
r N)r� r< rh r3 r3 r4 r�
s z FTPClientBasic.popCommandQueuec s� g }�j d| dd�}|�|� |dur3td| dd�� ��� � |�� j� � �fdd�}|�|� |D ]}|��j� |�dd � � q5dS )
a
Login: send the username, send the password.
If the password is L{None}, the PASS command won't be sent. Also, if
the response to the USER command has a response code of 230 (User
logged in), then PASS won't be sent either.
zUSER r �r� NzPASS c s | d � d�r
�j�� � | S )Nr �230)r: r� r� )ri �� passwordCmdrd r3 r4 �cancelPasswordIfNotNeeded"
s z<FTPClientBasic.queueLogin.<locals>.cancelPasswordIfNotNeededc S r� r` r3 �r� r3 r3 r4 r� /
r� z+FTPClientBasic.queueLogin.<locals>.<lambda>)r� r= r� r� r� r� rO rE )rd rp r� � deferreds� userDeferredr� r� r3 r� r4 �
queueLogin
s
�zFTPClientBasic.queueLoginc C s� t tkr
|�| j�}| jrt�d| � | j�|� t �
d|�}|s$dS |dd� }|d dkr2dS | j du rA| � t
| j�� dS | j}g | _|d dv rT| j �|� n%|d dv rf| j �t�t|��� nt�d |� �� | j �t�t|��� | �� dS )
zM
(Private) Parses the response messages from the FTP server.
z--> %sz\d{3} Nr � �1)�2�3)�4�5z"Server sent invalid response code )r� r� rJ r� r� r re ri r= r� �matchr� rE r� r� r� r r� r� r� r� )rd r� � codeIsValidr� ri r3 r3 r4 rQ 1
s.
zFTPClientBasic.lineReceivedc C s | � |� d S r` r� r� r3 r3 r4 r� a
r� z FTPClientBasic.connectionLostN)rT )r/ r0 r1 r2 r� r� rb rE r� r� r� r� r� r� r� r� rQ r� r3 r3 r3 r4 r� � s
$ 0r� c @ r� ) �_PassiveConnectionFactoryFc C r r` )�
protoInstance)rd r� r3 r3 r4 rb h
r z"_PassiveConnectionFactory.__init__c C s | | j _| j S r` )r� r� r� r3 r3 r4 r� k
s z'_PassiveConnectionFactory.buildProtocolc C s t d|�}| jj�|� d S )NzConnection Failed)r} r� r� r� )rd r r� rP r3 r3 r4 r o
s
z0_PassiveConnectionFactory.clientConnectionFailedN)r/ r0 r1 r� rb r� r r3 r3 r3 r4 r� e
s
r� c @ s� e Zd ZdZejZ d1dd�Zdd� Zd d
� Z d d � Z
d
d� Z dd� Z dd� Z
dd� Zd2dd�ZeZd2dd�ZeZdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Z d.d/� Z d0S )3� FTPClientaI
L{FTPClient} is a client implementation of the FTP protocol which
exposes FTP commands as methods which return L{Deferred}s.
Each command method returns a L{Deferred} which is called back when a
successful response code (2xx or 3xx) is received from the server or
which is error backed if an error response code (4xx or 5xx) is received
from the server or if a protocol violation occurs. If an error response
code is received, the L{Deferred} fires with a L{Failure} wrapping a
L{CommandFailed} instance. The L{CommandFailed} instance is created
with a list of the response lines received from the server.
See U{RFC 959<http://www.ietf.org/rfc/rfc959.txt>} for error code
definitions.
Both active and passive transfers are supported.
@ivar passive: See description in __init__.
r �twisted@twistedmatrix.comrT c C s t �| � | �||� || _dS )ay
Constructor.
I will login as soon as I receive the welcome message from the server.
@param username: FTP username
@param password: FTP password
@param passive: flag that controls if I use active or passive data
connections. You can also change this after construction by
assigning to C{self.passive}.
N)r� rb r� �passive)rd rp r� r r3 r3 r4 rb �
s
zFTPClient.__init__c C s | j �� | �|� dS )zM
Disconnect, and also give an error to any queued deferreds.
N)r� r� r� r� r3 r3 r4 rE �
s
zFTPClient.failc C s$ t �|�}t|t�� �}| �||�S )a�
Retrieves a file or listing generated by the given command,
feeding it to the given protocol.
@param commands: list of strings of FTP commands to execute then
receive the results of (e.g. C{LIST}, C{RETR})
@param protocol: A L{Protocol} B{instance} e.g. an
L{FTPFileListProtocol}, or something that can be adapted to one.
Typically this will be an L{IConsumer} implementation.
@return: L{Deferred}.
)r
� IProtocolr� r r� �_openDataConnection)rd �commandsr �wrapperr3 r3 r4 �receiveFromConnection�
s
z FTPClient.receiveFromConnectionc C s: t �| ||� | jddd�}|�| j� |�dd� � dS )zg
Login: send the username, send the password, and
set retrieval mode to binary
zTYPE Ir r� c S r� r` r3 r� r3 r3 r4 r� �
r� z&FTPClient.queueLogin.<locals>.<lambda>N)r� r� r� rO rE )rd rp r� r� r3 r3 r4 r� �
s zFTPClient.queueLoginc C s t � }| �||�}|j|fS )aQ
XXX
@return: A tuple of two L{Deferred}s:
- L{Deferred} L{IFinishableConsumer}. You must call
the C{finish} method on the IFinishableConsumer when the
file is completely transferred.
- L{Deferred} list of control-connection responses.
)r� r r� )rd r rA r= r3 r3 r4 �sendToConnection�
s
zFTPClient.sendToConnectionc sJ dd� |D �}t jdd� |D �ddd�}|�t� �jrZdg� � ��fdd�}td �}��|� |j�|���j � ||j�jg}t j|ddd�}|�t� � fd
d �} |�
| � n?td �}
�j|
_ �|
_ |
j�|
j j
� ��|
� d
d� |
_dd� |
_ |�|
fdd�� ||
j|
j g}t j|ddd�}|�t� |D ]} ��| � q�|S )z5
This method returns a DeferredList.
c S s g | ]}t |d d��qS )rT r� )r� )r6 rT r3 r3 r4 r$ �
r� z1FTPClient._openDataConnection.<locals>.<listcomp>c S s g | ]}|j �qS r3 )r� )r6 r? r3 r3 r4 r$ �
s T)�fireOnOneErrback�
consumeErrorsNc s6 t | d dd� �\}}t��}��|||�� d< dS )z5Connect to the port specified in the response to PASVrS r Nr )r� r� �connectFactory)ri r� r� r� ��_mutabler rd r3 r4 � doPassive�
s z0FTPClient._openDataConnection.<locals>.doPassiver c S s |d o |d � � | S | S r� )r )r� �mr3 r3 r4 r �
s �z,FTPClient._openDataConnection.<locals>.closer� c S � | S r` r3 rB r3 r3 r4 r� r� z/FTPClient._openDataConnection.<locals>.<lambda>c S r r` r3 )r r3 r3 r4 r�
r� c S s |� | �p| S r` )rE )rP �pcr3 r3 r4 r�
s )r � DeferredListrO r� r r� r� r� r� rE r� r� r r� r� ) rd r r �cmds� cmdsDeferredr
�pasvCmdr� r� r �portCmdr? r3 r r4 r �
s< �
z FTPClient._openDataConnectionc C s\ t � }|j|_t�d|�}||_|fdd�}||_| j�� j}|�� j}dt ||� |_
dS )zG
(Private) Generates the text of a given PORT command.
r c S s |j r|�� | S r` )r� r� )r �listenerr3 r3 r4 � listenerFail. s z3FTPClient.generatePortCommand.<locals>.listenerFailzPORT N) r� r r r r� rE r� r� r� r� r� )rd r r� r r r� r� r3 r3 r4 r� s
z FTPClient.generatePortCommandc C s |� dd�S )zK
Returns a FTP escaped path (replace newlines with nulls).
�
r9 )rX rV r3 r3 r4 �
escapePath: r� zFTPClient.escapePathr c C s4 d| � |� g}|r|�ddt|� � | �||�S )a�
Retrieve a file from the given path
This method issues the 'RETR' FTP command.
The file is fed into the given Protocol instance. The data connection
will be passive if self.passive is set.
@param path: path to file that you wish to receive.
@param protocol: a L{Protocol} instance.
@param offset: offset to start downloading from
@return: L{Deferred}
zRETR r �REST )r r� r� r )rd r? r �offsetr r3 r3 r4 � retrieveFileA s zFTPClient.retrieveFilec C s2 d| � |� g}|r|�ddt|� � | �|�S )a�
Store a file at the given path.
This method issues the 'STOR' FTP command.
@return: A tuple of two L{Deferred}s:
- L{Deferred} L{IFinishableConsumer}. You must call
the C{finish} method on the IFinishableConsumer when the
file is completely transferred.
- L{Deferred} list of control-connection responses.
zSTOR r r )r r� r� r )rd r? r r r3 r3 r4 � storeFileW s
zFTPClient.storeFilec sp �� d��|� �}�� d��|� �}g � t�� ���� fdd�� ��fdd�}|�� j|� |��� �S )a]
Rename a file.
This method issues the I{RNFR}/I{RNTO} command sequence to rename
C{pathFrom} to C{pathTo}.
@param pathFrom: the absolute path to the file to be renamed
@type pathFrom: C{str}
@param pathTo: the absolute path to rename the file to.
@type pathTo: C{str}
@return: A L{Deferred} which fires when the rename operation has
succeeded or failed. If it succeeds, the L{Deferred} is called
back with a two-tuple of lists. The first list contains the
responses to the I{RNFR} command. The second list contains the
responses to the I{RNTO} command. If either I{RNFR} or I{RNTO}
fails, the L{Deferred} is errbacked with L{CommandFailed} or
L{BadResponse}.
@rtype: L{Deferred}
@since: 8.2
zRNFR zRNTO c s � | fS r` r3 )�
toResponse)� fromResponser3 r4 r� � r� z"FTPClient.rename.<locals>.<lambda>c s �� � � �| � d S r` )r� r� r{ )rC rd r3 r4 �ebFrom� s z FTPClient.rename.<locals>.ebFrom)r� r r r� r� rN rk �
chainDeferred)rd �pathFrom�pathTo�
renameFrom�renameTor r3 )r rC rd r4 r j s
zFTPClient.renamec C �$ |du rd}| � d| �|� g|�S )a|
Retrieve a file listing into the given protocol instance.
This method issues the 'LIST' FTP command.
@param path: path to get a file listing for.
@param protocol: a L{Protocol} instance, probably a
L{FTPFileListProtocol} instance. It can cope with most common file
listing formats.
@return: L{Deferred}
Nr7 zLIST �r r �rd r? r r3 r3 r4 r� � s
zFTPClient.listc C r& )a1
Retrieve a short file listing into the given protocol instance.
This method issues the 'NLST' FTP command.
NLST (should) return a list of filenames, one per line.
@param path: path to get short file listing for.
@param protocol: a L{Protocol} instance.
Nr7 zNLST r' r( r3 r3 r4 �nlst� s zFTPClient.nlstc C � | � d| �|� �S )z�
Issues the CWD (Change Working Directory) command.
@return: a L{Deferred} that will be called when done.
zCWD �r� r rV r3 r3 r4 r> � s z
FTPClient.cwdc C r* )a@
Make a directory
This method issues the MKD command.
@param path: The path to the directory to create.
@type path: C{str}
@return: A L{Deferred} which fires when the server responds. If the
directory is created, the L{Deferred} is called back with the
server response. If the server response indicates the directory
was not created, the L{Deferred} is errbacked with a L{Failure}
wrapping L{CommandFailed} or L{BadResponse}.
@rtype: L{Deferred}
@since: 8.2
zMKD r+ rV r3 r3 r4 r� � � zFTPClient.makeDirectoryc C r* )a^
Delete a file on the server.
L{removeFile} issues a I{DELE} command to the server to remove the
indicated file. Note that this command cannot remove a directory.
@param path: The path to the file to delete. May be relative to the
current dir.
@type path: C{str}
@return: A L{Deferred} which fires when the server responds. On error,
it is errbacked with either L{CommandFailed} or L{BadResponse}. On
success, it is called back with a list of response lines.
@rtype: L{Deferred}
@since: 8.2
zDELE r+ rV r3 r3 r4 r � r, zFTPClient.removeFilec C r* )a`
Delete a directory on the server.
L{removeDirectory} issues a I{RMD} command to the server to remove the
indicated directory. Described in RFC959.
@param path: The path to the directory to delete. May be relative to
the current working directory.
@type path: C{str}
@return: A L{Deferred} which fires when the server responds. On error,
it is errbacked with either L{CommandFailed} or L{BadResponse}. On
success, it is called back with a list of response lines.
@rtype: L{Deferred}
@since: 11.1
zRMD r+ rV r3 r3 r4 r� � r, zFTPClient.removeDirectoryc C r� )z
Issues the CDUP (Change Directory UP) command.
@return: a L{Deferred} that will be called when done.
�CDUP�r� rh r3 r3 r4 �cdup� s
zFTPClient.cdupc C r� )ah
Issues the PWD (Print Working Directory) command.
The L{getDirectory} does the same job but automatically parses the
result.
@return: a L{Deferred} that will be called when done. It is up to the
caller to interpret the response, but the L{parsePWDResponse}
method in this module should work.
�PWDr. rh r3 r3 r4 r1 s
z
FTPClient.pwdc C s dd� }| � � �|�S )a
Returns the current remote directory.
@return: a L{Deferred} that will be called back with a C{str} giving
the remote directory or which will errback with L{CommandFailed}
if an error response is returned.
c S sp zt | d �dd�d �dkrt�W n ttfy$ t�t| �� Y S w t| d �}|d u r6t�t| ��S |S )Nr rH rT i )r� r; rG �
IndexErrorr r� r� �parsePWDResponse)rC r? r3 r3 r4 �cbParse s �� z'FTPClient.getDirectory.<locals>.cbParse)r1 r� )rd r3 r3 r3 r4 � getDirectory s zFTPClient.getDirectoryc C r� )z�
Issues the I{QUIT} command.
@return: A L{Deferred} that fires when the server acknowledges the
I{QUIT} command. The transport should not be disconnected until
this L{Deferred} fires.
r r. rh r3 r3 r4 �quit* s
zFTPClient.quitN)r r rT )r ) r/ r0 r1 r2 r r� r
rb rE r r� r r r� r r �retrr �storr r� r) r> r� r r� r/ r1 r4 r5 r3 r3 r3 r4 r� t
s6
� G#
0
r� c @ sJ e Zd ZdZe�d�ZdZdZdd� Z dd� Z
d d
� Z d d � Z d
d� Z
dS )�FTPFileListProtocola�
Parser for standard FTP file listings
This is the evil required to match::
-rw-r--r-- 1 root other 531 Jan 29 03:26 README
If you need different evil for a wacky FTP server, you can
override either C{fileLinePattern} or C{parseDirectoryLine()}.
It populates the instance attribute self.files, which is a list containing
dicts with the following keys (examples from the above line):
- filetype: e.g. 'd' for directories, or '-' for an ordinary file
- perms: e.g. 'rw-r--r--'
- nlinks: e.g. 1
- owner: e.g. 'root'
- group: e.g. 'other'
- size: e.g. 531
- date: e.g. 'Jan 29 03:26'
- filename: e.g. 'README'
- linktarget: e.g. 'some/file'
Note that the 'date' value will be formatted differently depending on the
date. Check U{http://cr.yp.to/ftp.html} if you really want to try to parse
it.
It also matches the following::
-rw-r--r-- 1 root other 531 Jan 29 03:26 I HAVE\ SPACE
- filename: e.g. 'I HAVE SPACE'
-rw-r--r-- 1 root other 531 Jan 29 03:26 LINK -> TARGET
- filename: e.g. 'LINK'
- linktarget: e.g. 'TARGET'
-rw-r--r-- 1 root other 531 Jan 29 03:26 N S -> L S
- filename: e.g. 'N S'
- linktarget: e.g. 'L S'
@ivar files: list of dicts describing the files in this listing
z�^(?P<filetype>.)(?P<perms>.{9})\s+(?P<nlinks>\d*)\s*(?P<owner>\S+)\s+(?P<group>\S+)\s+(?P<size>\d+)\s+(?P<date>...\s+\d+\s+[\d:]+)\s+(?P<filename>.{1,}?)( -> (?P<linktarget>[^\r]*))?\r?$�
r� c C s
g | _ d S r` )�filesrh r3 r3 r4 rb h r z FTPFileListProtocol.__init__c C sB t tkr
|�| j�}| �|�}|d u r| �|� d S | �|� d S r` )r� r� rJ r� �parseDirectoryLine� unknownLine�addFile)rd r� r� r3 r3 r4 rQ k s
z FTPFileListProtocol.lineReceivedc C st | j �|�}|du r dS |�� }|d �dd�|d< t|d �|d< t|d �|d< |d r8|d �dd�|d< |S )z�
Return a dictionary of fields, or None if line cannot be parsed.
@param line: line of text expected to contain a directory entry
@type line: str
@return: dict
N�filenamez\ rH �nlinksr� �
linktarget)�fileLinePatternr� � groupdictrX r� )rd r� r� r� r3 r3 r4 r; t s z&FTPFileListProtocol.parseDirectoryLinec C s | j �|� dS )a�
Append file information dictionary to the list of known files.
Subclasses can override or extend this method to handle file
information differently without affecting the parsing of data
from the server.
@param info: dictionary containing the parsed representation
of the file information
@type info: dict
N)r: r= )rd r� r3 r3 r4 r= � s zFTPFileListProtocol.addFilec C r' )a
Deal with received lines which could not be parsed as file
information.
Subclasses can override this to perform any special processing
needed.
@param line: unparsable line as received
@type line: str
Nr3 r� r3 r3 r4 r< � s z FTPFileListProtocol.unknownLineN)r/ r0 r1 r2 r� �compilerA � delimiterr� rb rQ r; r= r< r3 r3 r3 r4 r8 5 s )� r8 c C s t �d| �}|r|�� d S dS )z�
Returns the path from a response to a PWD command.
Responses typically look like::
257 "/home/andrew" is current directory.
For this example, I will return C{'/home/andrew'}.
If I can't find the path, I return L{None}.
z"(.*)"r N)r� �search�groups)ri r� r3 r3 r4 r2 � s r2 r` )r= )�r2 rC rU r r� r� r� r4 r1 � ImportError�zope.interfacer r �twistedr � twisted.credr r r rx r r� r r
r r �twisted.protocolsr
r �twisted.pythonr r r �RESTART_MARKER_REPLY�SERVICE_READY_IN_N_MINUTESr� r� r� r� r� � CMD_NOT_IMPLMNTD_SUPERFLUOUS�SYS_STATUS_OR_HELP_REPLYr
�
DIR_STATUSr� �HELP_MSGr� �SVC_READY_FOR_NEW_USERr, �SVC_CLOSING_CTRL_CNXr � DATA_CNX_OPEN_NO_XFR_IN_PROGRESS�CLOSING_DATA_CNXr� r� �ENTERING_EPSV_MODEr� r~ r� r� r� ro rn �NEED_ACCT_FOR_LOGINr � SVC_NOT_AVAIL_CLOSING_CTRL_CNXr r� r� �REQ_ACTN_ABRTD_FILE_UNAVAIL�REQ_ACTN_ABRTD_LOCAL_ERR� REQ_ACTN_ABRTD_INSUFF_STORAGEru rw ry r r� r{ r_ r� �NEED_ACCT_FOR_STORrk rp rn rq r= rr rs �
PAGE_TYPE_UNK�EXCEEDED_STORAGE_ALLOC�FILENAME_NOT_ALLOWEDrf ra r. rB rQ rV rW r] r_ rF rm rI rK rM rO rt rv rx rz r} r� r� r� r� r� � IConsumerr� r� �
ClientFactoryr� r r r� r � TimeoutMixinr r! r rq r. r0 r< rQ rR r_ r� r� �IRealmr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� �
ServerFactoryr� r� r� r� r8 r2 r3 r3 r3 r4 �<module> s � ����
� � �
������������� � � � �!�#�$�%�'�(�*�+�.�0�2�3�4�5�7�:�;�<�=�>�?�@�A�B�C�D�E�F�Q
! c
O,
8 tU"%
, V D p