Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ftp] support passwords with urlchars #1329

Merged
merged 1 commit into from
Oct 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 23 additions & 24 deletions storages/backends/ftp.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
import ftplib
import io
import os
from urllib.parse import urljoin
from urllib.parse import urlparse
import re
import urllib.parse

from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
Expand Down Expand Up @@ -55,29 +55,28 @@ def __init__(self, location=None, base_url=None, encoding=None):

def _decode_location(self, location):
"""Return splitted configuration data from location."""
splitted_url = urlparse(location)
config = {}

if splitted_url.scheme not in ("ftp", "aftp", "ftps"):
raise ImproperlyConfigured("FTPStorage works only with FTP protocol!")
if splitted_url.hostname == "":
raise ImproperlyConfigured("You must at least provide hostname!")
splitted_url = re.search(
r"^(?P<scheme>.+)://(?P<user>.+):(?P<passwd>.+)@"
r"(?P<host>.+):(?P<port>\d+)/(?P<path>.*)$",
location,
)

if splitted_url is None:
raise ImproperlyConfigured("Improperly formatted location URL")
if splitted_url["scheme"] not in ("ftp", "aftp", "ftps"):
raise ImproperlyConfigured("Only ftp, aftp, ftps schemes supported")
if splitted_url["host"] == "":
raise ImproperlyConfigured("You must at least provide host!")

if splitted_url.scheme == "aftp":
config["active"] = True
else:
config["active"] = False

if splitted_url.scheme == "ftps":
config["secure"] = True
else:
config["secure"] = False
config = {}
config["active"] = splitted_url["scheme"] == "aftp"
config["secure"] = splitted_url["scheme"] == "ftps"

config["path"] = splitted_url.path
config["host"] = splitted_url.hostname
config["user"] = splitted_url.username
config["passwd"] = splitted_url.password
config["port"] = int(splitted_url.port)
config["path"] = splitted_url["path"] or "/"
config["host"] = splitted_url["host"]
config["user"] = splitted_url["user"]
config["passwd"] = splitted_url["passwd"]
config["port"] = int(splitted_url["port"])

return config

Expand Down Expand Up @@ -235,7 +234,7 @@ def size(self, name):
def url(self, name):
if self._base_url is None:
raise ValueError("This file is not accessible via a URL.")
return urljoin(self._base_url, name).replace("\\", "/")
return urllib.parse.urljoin(self._base_url, name).replace("\\", "/")


class FTPStorageFile(File):
Expand Down
24 changes: 14 additions & 10 deletions tests/test_ftp.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
PASSWORD = "b@r"
HOST = "localhost"
PORT = 2121
URL = "ftp://{user}:{passwd}@{host}:{port}/".format(
user=USER, passwd=PASSWORD, host=HOST, port=PORT
)
URL_TLS = "ftps://{user}:{passwd}@{host}:{port}/".format(
user=USER, passwd=PASSWORD, host=HOST, port=PORT
)

LIST_FIXTURE = """drwxr-xr-x 2 ftp nogroup 4096 Jul 27 09:46 dir
-rw-r--r-- 1 ftp nogroup 1024 Jul 27 09:45 fi
-rw-r--r-- 1 ftp nogroup 2048 Jul 27 09:50 fi2"""


def geturl(scheme="ftp", pwd=PASSWORD):
return URL_TEMPLATE.format(
scheme=scheme, user=USER, passwd=pwd, host=HOST, port=PORT
)


URL_TEMPLATE = "{scheme}://{user}:{passwd}@{host}:{port}/"
URL = geturl()


def list_retrlines(cmd, func):
for line in LIST_FIXTURE.splitlines():
func(line)
Expand Down Expand Up @@ -72,9 +76,9 @@ def test_decode_location_error(self):
self.storage._decode_location("foo")
with self.assertRaises(ImproperlyConfigured):
self.storage._decode_location("http://foo.pt")
# TODO: Cannot not provide a port
# with self.assertRaises(ImproperlyConfigured):
# self.storage._decode_location('ftp://')

def test_decode_location_urlchars_password(self):
self.storage._decode_location(geturl(pwd="b#r"))

@patch("ftplib.FTP")
def test_start_connection(self, mock_ftp):
Expand Down Expand Up @@ -248,7 +252,7 @@ def test_close(self, mock_ftp, mock_storage):

class FTPTLSTest(TestCase):
def setUp(self):
self.storage = ftp.FTPStorage(location=URL_TLS)
self.storage = ftp.FTPStorage(location=geturl(scheme="ftps"))

def test_decode_location(self):
wanted_config = {
Expand Down