Port FTP protocol to Python 3

koncybernet · Jan 18, 2017 · 135d387 · 135d387
1 parent ffb0d00
commit 135d387
Show file tree

Hide file tree

Showing 4 changed files with 261 additions and 243 deletions.
diff --git a/src/twisted/protocols/ftp.py b/src/twisted/protocols/ftp.py
@@ -27,7 +27,7 @@
 from twisted.protocols import basic, policies
 
 from twisted.python import log, failure, filepath
-
+from twisted.python.compat import xrange, unicode
 from twisted.cred import error as cred_error, portal, credentials, checkers
 
 # constants
@@ -401,6 +401,7 @@ class DTP(protocol.Protocol, object):
     _cons = None
     _onConnLost = None
     _buffer = None
+    _encoding = 'latin-1'
 
     def connectionMade(self):
         self.isConnected = True
@@ -419,15 +420,15 @@ def sendLine(self, line):
         @param line: The line to be sent.
         @type line: L{bytes}
         """
-        self.transport.write(line + '\r\n')
+        self.transport.write(line + b'\r\n')
 
 
     def _formatOneListResponse(self, name, size, directory, permissions, hardlinks, modified, owner, group):
         """
         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{str} name of the entry (file or directory or link)
+        @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
@@ -456,23 +457,23 @@ def formatDate(mtime):
 
         format = ('%(directory)s%(permissions)s%(hardlinks)4d '
                   '%(owner)-9s %(group)-9s %(size)15d %(date)12s '
-                  '%(name)s')
+                  )
 
-        return format % {
+        msg = (format % {
             'directory': directory and 'd' or '-',
             'permissions': permissions.shorthand(),
             'hardlinks': hardlinks,
             'owner': owner[:8],
             'group': group[:8],
             'size': size,
             'date': formatDate(time.gmtime(modified)),
-            'name': name}
+        }).encode(self._encoding)
+        return msg + name
 
 
     def sendListResponse(self, name, response):
         self.sendLine(self._formatOneListResponse(name, *response))
 
-
     # Proxy IConsumer to our transport
     def registerProducer(self, producer, streaming):
         return self.transport.registerProducer(producer, streaming)
@@ -680,8 +681,10 @@ def write(self, bytes):
 
 class FTPOverflowProtocol(basic.LineReceiver):
     """FTP mini-protocol for when there are too many connections."""
+    _encoding = 'latin-1'
+
     def connectionMade(self):
-        self.sendLine(RESPONSE[TOO_MANY_CONNECTIONS])
+        self.sendLine(RESPONSE[TOO_MANY_CONNECTIONS].encode(self._encoding))
         self.transport.loseConnection()
 
 
@@ -736,11 +739,14 @@ class FTP(basic.LineReceiver, policies.TimeoutMixin, object):
     passivePortRange = xrange(0, 1)
 
     listenFactory = reactor.listenTCP
+    _encoding = 'latin-1'
 
     def reply(self, key, *args):
         msg = RESPONSE[key] % args
-        self.sendLine(msg)
+        self.sendEncodedLine(msg)
 
+    def sendEncodedLine(self, line):
+        self.sendLine(line.encode(self._encoding))
 
     def connectionMade(self):
         self.state = self.UNAUTH
@@ -765,12 +771,15 @@ def timeoutConnection(self):
     def lineReceived(self, line):
         self.resetTimeout()
         self.pauseProducing()
+        line = line.decode(self._encoding)
 
         def processFailed(err):
             if err.check(FTPCmdError):
-                self.sendLine(err.value.response())
+                self.sendLine(err.value.response().encode(self._encoding))
             elif (err.check(TypeError) and
-                  err.value.args[0].find('takes exactly') != -1):
+                    (err.value.args[0].find('takes exactly') != -1) or
+                    (err.value.args[0].find('required positional argument') !=
+                     -1)):
                 self.reply(SYNTAX_ERR, "%s requires an argument." % (cmd,))
             else:
                 log.msg("Unexpected FTP error")
@@ -939,8 +948,8 @@ def ftp_PASV(self):
 
 
     def ftp_PORT(self, address):
-        addr = map(int, address.split(','))
-        ip = '%d.%d.%d.%d' % tuple(addr[:4])
+        addr = tuple(map(int, address.split(',')))
+        ip = '%d.%d.%d.%d' % addr[:4]
         port = addr[4] << 8 | addr[5]
 
         # if we have a DTP port set up, lose it.
@@ -1477,10 +1486,10 @@ def ftp_FEAT(self):
 
         http://tools.ietf.org/html/rfc2389
         """
-        self.sendLine(RESPONSE[FEAT_OK][0])
+        self.sendEncodedLine(RESPONSE[FEAT_OK][0])
         for feature in self.FEATURES:
-            self.sendLine(' ' + feature)
-        self.sendLine(RESPONSE[FEAT_OK][1])
+            self.sendEncodedLine(' ' + feature)
+        self.sendEncodedLine(RESPONSE[FEAT_OK][1])
 
     def ftp_OPTS(self, option):
         """
@@ -2447,6 +2456,7 @@ class FTPClientBasic(basic.LineReceiver):
     Foundations of an FTP client.
     """
     debug = False
+    _encoding = 'latin-1'
 
     def __init__(self):
         self.actionQueue = []
@@ -2490,6 +2500,11 @@ def sendLine(self, line):
             return
         basic.LineReceiver.sendLine(self, line)
 
+    def sendEncodedLine(self, line):
+        if line is None:
+            return
+        self.sendLine(line.encode(self._encoding))
+
     def sendNextCommand(self):
         """
         (Private) Processes the next command in the queue.
@@ -2512,7 +2527,7 @@ def sendNextCommand(self):
         if self.debug:
             log.msg('<-- %s' % ftpCommand.text)
         self.nextDeferred = ftpCommand.deferred
-        self.sendLine(ftpCommand.text)
+        self.sendEncodedLine(ftpCommand.text)
 
     def queueCommand(self, ftpCommand):
         """
@@ -2593,6 +2608,7 @@ def lineReceived(self, line):
         (Private) Parses the response messages from the FTP server.
         """
         # Add this line to the current response
+        line = line.decode(self._encoding)
         if self.debug:
             log.msg('--> %s' % line)
         self.response.append(line)
@@ -3155,12 +3171,14 @@ class FTPFileListProtocol(basic.LineReceiver):
         r'(?P<date>...\s+\d+\s+[\d:]+)\s+(?P<filename>.{1,}?)'
         r'( -> (?P<linktarget>[^\r]*))?\r?$'
     )
-    delimiter = '\n'
+    delimiter = b'\n'
+    _encoding = 'latin-1'
 
     def __init__(self):
         self.files = []
 
     def lineReceived(self, line):
+        line = line.decode(self._encoding)
         d = self.parseDirectoryLine(line)
         if d is None:
             self.unknownLine(line)

diff --git a/src/twisted/python/_setup.py b/src/twisted/python/_setup.py
@@ -420,7 +420,6 @@ def _checkCPython(sys=sys, platform=platform):
     "twisted.plugins.twisted_socks",
     "twisted.plugins.twisted_words",
     "twisted.protocols.finger",
-    "twisted.protocols.ftp",
     "twisted.protocols.ident",
     "twisted.protocols.mice.__init__",
     "twisted.protocols.mice.mouseman",
@@ -447,8 +446,6 @@ def _checkCPython(sys=sys, platform=platform):
     "twisted.test.myrebuilder2",
     "twisted.test.test_finger",
     "twisted.test.test_formmethod",
-    "twisted.test.test_ftp",
-    "twisted.test.test_ftp_options",
     "twisted.test.test_hook",
     "twisted.test.test_ident",
     "twisted.test.test_rebuild",