fix issue #6822: ftplib's storline method doesn't work with text files

giampaolo · giampaolo · commit b939235c6aa8 · 2010-08-04T10:12:00.000Z
diff --git a/Lib/ftplib.py b/Lib/ftplib.py
@@ -493,9 +493,15 @@ def storlines(self, cmd, fp, callback=None):
         while 1:
             buf = fp.readline()
             if not buf: break
-            if buf[-2:] != B_CRLF:
-                if buf[-1] in B_CRLF: buf = buf[:-1]
-                buf = buf + B_CRLF
+            if isinstance(buf, str):
+                if not buf.endswith(CRLF):
+                    if buf[-1] in CRLF: buf = buf[:-1]
+                    buf = buf + CRLF
+                buf = bytes(buf, self.encoding)
+            else:
+                if not buf.endswith(B_CRLF):
+                    if buf[-1:] in B_CRLF: buf = buf[:-1]
+                    buf = buf + B_CRLF
             conn.sendall(buf)
             if callback: callback(buf)
         conn.close()
@@ -771,9 +777,15 @@ def storlines(self, cmd, fp, callback=None):
                 while 1:
                     buf = fp.readline()
                     if not buf: break
-                    if buf[-2:] != B_CRLF:
-                        if buf[-1] in B_CRLF: buf = buf[:-1]
-                        buf = buf + B_CRLF
+                    if isinstance(buf, str):
+                        if not buf.endswith(CRLF):
+                            if buf[-1] in CRLF: buf = buf[:-1]
+                            buf = buf + CRLF
+                        buf = bytes(buf, self.encoding)
+                    else:
+                        if not buf.endswith(B_CRLF):
+                            if buf[-1:] in B_CRLF: buf = buf[:-1]
+                            buf = buf + B_CRLF
                     conn.sendall(buf)
                     if callback: callback(buf)
                 # shutdown ssl layer
@@ -783,6 +795,7 @@ def storlines(self, cmd, fp, callback=None):
                 conn.close()
             return self.voidresp()
 
+
     __all__.append('FTP_TLS')
     all_errors = (Error, IOError, EOFError, ssl.SSLError)
 
diff --git a/Lib/test/test_ftplib.py b/Lib/test/test_ftplib.py
@@ -24,6 +24,7 @@
 # the dummy data returned by server over the data channel when
 # RETR, LIST and NLST commands are issued
 RETR_DATA = 'abcde12345\r\n' * 1000
+RETR_TEXT = 'abcd\xe912345\r\n' * 1000
 LIST_DATA = 'foo\r\nbar\r\n'
 NLST_DATA = 'foo\r\nbar\r\n'
 
@@ -37,7 +38,7 @@ def __init__(self, conn, baseclass):
         self.baseclass.last_received_data = ''
 
     def handle_read(self):
-        self.baseclass.last_received_data += self.recv(1024).decode('ascii')
+        self.baseclass.last_received_data += self.recv(1024).decode('latin-1')
 
     def handle_close(self):
         # XXX: this method can be called many times in a row for a single
@@ -49,7 +50,7 @@ def handle_close(self):
             self.dtp_conn_closed = True
 
     def push(self, what):
-        super(DummyDTPHandler, self).push(what.encode('ascii'))
+        super(DummyDTPHandler, self).push(what.encode('latin-1'))
 
     def handle_error(self):
         raise
@@ -68,6 +69,7 @@ def __init__(self, conn):
         self.last_received_data = ''
         self.next_response = ''
         self.rest = None
+        self.current_type = 'a'
         self.push('220 welcome')
 
     def collect_incoming_data(self, data):
@@ -175,7 +177,16 @@ def cmd_pwd(self, arg):
         self.push('257 "pwd ok"')
 
     def cmd_type(self, arg):
-        self.push('200 type ok')
+        # ASCII type
+        if arg.lower() == 'a':
+            self.current_type = 'a'
+            self.push('200 type ok')
+        # Binary type
+        elif arg.lower() == 'i':
+            self.current_type = 'i'
+            self.push('200 type ok')
+        else:
+            self.push('504 unsupported type')
 
     def cmd_quit(self, arg):
         self.push('221 quit ok')
@@ -194,7 +205,10 @@ def cmd_retr(self, arg):
             offset = int(self.rest)
         else:
             offset = 0
-        self.dtp.push(RETR_DATA[offset:])
+        if self.current_type == 'i':
+            self.dtp.push(RETR_DATA[offset:])
+        else:
+            self.dtp.push(RETR_TEXT[offset:])
         self.dtp.close_when_done()
         self.rest = None
 
@@ -511,7 +525,7 @@ def callback(data):
     def test_retrlines(self):
         received = []
         self.client.retrlines('retr', received.append)
-        self.assertEqual(''.join(received), RETR_DATA.replace('\r\n', ''))
+        self.assertEqual(''.join(received), RETR_TEXT.replace('\r\n', ''))
 
     def test_storbinary(self):
         f = io.BytesIO(RETR_DATA.encode('ascii'))
@@ -530,7 +544,7 @@ def test_storbinary_rest(self):
             self.client.storbinary('stor', f, rest=r)
             self.assertEqual(self.server.handler_instance.rest, str(r))
 
-    def test_storlines(self):
+    def test_storlines_bytes(self):
         f = io.BytesIO(RETR_DATA.replace('\r\n', '\n').encode('ascii'))
         self.client.storlines('stor', f)
         self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA)
@@ -540,6 +554,16 @@ def test_storlines(self):
         self.client.storlines('stor foo', f, callback=lambda x: flag.append(None))
         self.assertTrue(flag)
 
+    def test_storlines_str(self):
+        f = io.StringIO(RETR_TEXT.replace('\r\n', '\n'))
+        self.client.storlines('stor', f)
+        self.assertEqual(self.server.handler_instance.last_received_data, RETR_TEXT)
+        # test new callback arg
+        flag = []
+        f.seek(0)
+        self.client.storlines('stor foo', f, callback=lambda x: flag.append(None))
+        self.assertTrue(flag)
+
     def test_nlst(self):
         self.client.nlst()
         self.assertEqual(self.client.nlst(), NLST_DATA.split('\r\n')[:-1])
diff --git a/Misc/ACKS b/Misc/ACKS
@@ -896,3 +896,4 @@ Uwe Zessin
 Tarek Ziadé
 Peter Åstrand
 Alexander Shigin
+Robert DeVaughn
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -37,6 +37,8 @@ Extensions
 Library
 -------
 
+- Issue #6822: ftplib's storlines method doesn't work with text files.
+
 - Issue #2944: asyncore doesn't handle connection refused correctly.
 
 - Issue #4184: Private attributes on smtpd.SMTPChannel made public and
