[3.14] gh-140691: urllib.request: Close FTP control socket if data socket can't connect (GH-140835) (GH-141555)

(cherry picked from commit f2bce51b98)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: codenamenam <bluetire27@gmail.com>
This commit is contained in:
Miss Islington (bot) 2025-11-14 17:27:33 +01:00 committed by GitHub
parent 2f23c88243
commit 959578e5d1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 70 additions and 19 deletions

View file

@ -589,6 +589,9 @@ class WarningMessage(object):
"line : %r}" % (self.message, self._category_name, "line : %r}" % (self.message, self._category_name,
self.filename, self.lineno, self.line)) self.filename, self.lineno, self.line))
def __repr__(self):
return f'<{type(self).__qualname__} {self}>'
class catch_warnings(object): class catch_warnings(object):

View file

@ -1,9 +1,13 @@
import contextlib
import errno import errno
import sysconfig
import unittest import unittest
from unittest import mock
from test import support from test import support
from test.support import os_helper from test.support import os_helper
from test.support import socket_helper from test.support import socket_helper
from test.support import ResourceDenied from test.support import ResourceDenied
from test.support.warnings_helper import check_no_resource_warning
import os import os
import socket import socket
@ -143,6 +147,43 @@ class OtherNetworkTests(unittest.TestCase):
] ]
self._test_urls(urls, self._extra_handlers()) self._test_urls(urls, self._extra_handlers())
@support.requires_resource('walltime')
@unittest.skipIf(sysconfig.get_platform() == 'linux-ppc64le',
'leaks on PPC64LE (gh-140691)')
def test_ftp_no_leak(self):
# gh-140691: When the data connection (but not control connection)
# cannot be made established, we shouldn't leave an open socket object.
class MockError(OSError):
pass
orig_create_connection = socket.create_connection
def patched_create_connection(address, *args, **kwargs):
"""Simulate REJECTing connections to ports other than 21"""
host, port = address
if port != 21:
raise MockError()
return orig_create_connection(address, *args, **kwargs)
url = 'ftp://www.pythontest.net/README'
entry = url, None, urllib.error.URLError
no_cache_handlers = [urllib.request.FTPHandler()]
cache_handlers = self._extra_handlers()
with mock.patch('socket.create_connection', patched_create_connection):
with check_no_resource_warning(self):
# Try without CacheFTPHandler
self._test_urls([entry], handlers=no_cache_handlers,
retry=False)
with check_no_resource_warning(self):
# Try with CacheFTPHandler (uncached)
self._test_urls([entry], cache_handlers, retry=False)
with check_no_resource_warning(self):
# Try with CacheFTPHandler (cached)
self._test_urls([entry], cache_handlers, retry=False)
# Try without the mock: the handler should not use a closed connection
with check_no_resource_warning(self):
self._test_urls([url], cache_handlers, retry=False)
def test_file(self): def test_file(self):
TESTFN = os_helper.TESTFN TESTFN = os_helper.TESTFN
f = open(TESTFN, 'w') f = open(TESTFN, 'w')
@ -255,18 +296,16 @@ class OtherNetworkTests(unittest.TestCase):
else: else:
req = expected_err = None req = expected_err = None
if expected_err:
context = self.assertRaises(expected_err)
else:
context = contextlib.nullcontext()
with socket_helper.transient_internet(url): with socket_helper.transient_internet(url):
try: f = None
with context:
f = urlopen(url, req, support.INTERNET_TIMEOUT) f = urlopen(url, req, support.INTERNET_TIMEOUT)
# urllib.error.URLError is a subclass of OSError if f is not None:
except OSError as err:
if expected_err:
msg = ("Didn't get expected error(s) %s for %s %s, got %s: %s" %
(expected_err, url, req, type(err), err))
self.assertIsInstance(err, expected_err, msg)
else:
raise
else:
try: try:
with time_out, \ with time_out, \
socket_peer_reset, \ socket_peer_reset, \

View file

@ -1535,6 +1535,7 @@ class FTPHandler(BaseHandler):
dirs, file = dirs[:-1], dirs[-1] dirs, file = dirs[:-1], dirs[-1]
if dirs and not dirs[0]: if dirs and not dirs[0]:
dirs = dirs[1:] dirs = dirs[1:]
fw = None
try: try:
fw = self.connect_ftp(user, passwd, host, port, dirs, req.timeout) fw = self.connect_ftp(user, passwd, host, port, dirs, req.timeout)
type = file and 'I' or 'D' type = file and 'I' or 'D'
@ -1552,8 +1553,12 @@ class FTPHandler(BaseHandler):
headers += "Content-length: %d\n" % retrlen headers += "Content-length: %d\n" % retrlen
headers = email.message_from_string(headers) headers = email.message_from_string(headers)
return addinfourl(fp, headers, req.full_url) return addinfourl(fp, headers, req.full_url)
except ftplib.all_errors as exp: except Exception as exp:
raise URLError(f"ftp error: {exp}") from exp if fw is not None and not fw.keepalive:
fw.close()
if isinstance(exp, ftplib.all_errors):
raise URLError(f"ftp error: {exp}") from exp
raise
def connect_ftp(self, user, passwd, host, port, dirs, timeout): def connect_ftp(self, user, passwd, host, port, dirs, timeout):
return ftpwrapper(user, passwd, host, port, dirs, timeout, return ftpwrapper(user, passwd, host, port, dirs, timeout,
@ -1577,14 +1582,15 @@ class CacheFTPHandler(FTPHandler):
def connect_ftp(self, user, passwd, host, port, dirs, timeout): def connect_ftp(self, user, passwd, host, port, dirs, timeout):
key = user, host, port, '/'.join(dirs), timeout key = user, host, port, '/'.join(dirs), timeout
if key in self.cache: conn = self.cache.get(key)
self.timeout[key] = time.time() + self.delay if conn is None or not conn.keepalive:
else: if conn is not None:
self.cache[key] = ftpwrapper(user, passwd, host, port, conn.close()
dirs, timeout) conn = self.cache[key] = ftpwrapper(user, passwd, host, port,
self.timeout[key] = time.time() + self.delay dirs, timeout)
self.timeout[key] = time.time() + self.delay
self.check_cache() self.check_cache()
return self.cache[key] return conn
def check_cache(self): def check_cache(self):
# first check for old ones # first check for old ones

View file

@ -0,0 +1,3 @@
In :mod:`urllib.request`, when opening a FTP URL fails because a data
connection cannot be made, the control connection's socket is now closed to
avoid a :exc:`ResourceWarning`.