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

Fixed #513 -- Properly truncate available names when file_overwrite = True #554

Merged
merged 2 commits into from
Aug 30, 2018
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
10 changes: 6 additions & 4 deletions storages/backends/azure_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
from django.utils.deconstruct import deconstructible
from django.utils.encoding import force_bytes, force_text

from storages.utils import clean_name, safe_join, setting
from storages.utils import (
clean_name, get_available_overwrite_name, safe_join, setting,
)


@deconstructible
Expand Down Expand Up @@ -190,10 +192,10 @@ def get_available_name(self, name, max_length=_AZURE_NAME_MAX_LEN):
Returns a filename that's free on the target storage system, and
available for new content to be written to.
"""
name = self.get_valid_name(name)
if self.overwrite_files:
return self.get_valid_name(name)
return super(AzureStorage, self).get_available_name(
self.get_valid_name(name), max_length)
return get_available_overwrite_name(name, max_length)
return super(AzureStorage, self).get_available_name(name, max_length)

def exists(self, name):
return self.service.exists(
Expand Down
9 changes: 6 additions & 3 deletions storages/backends/gcloud.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
from django.utils.deconstruct import deconstructible
from django.utils.encoding import force_bytes, smart_str

from storages.utils import check_location, clean_name, safe_join, setting
from storages.utils import (
check_location, clean_name, get_available_overwrite_name, safe_join,
setting,
)

try:
from google.cloud.storage.client import Client
Expand Down Expand Up @@ -255,7 +258,7 @@ def url(self, name):
return blob.public_url

def get_available_name(self, name, max_length=None):
name = clean_name(name)
if self.file_overwrite:
name = clean_name(name)
return name
return get_available_overwrite_name(name, max_length)
return super(GoogleCloudStorage, self).get_available_name(name, max_length)
7 changes: 4 additions & 3 deletions storages/backends/s3boto.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
from django.utils.six import BytesIO

from storages.utils import (
check_location, clean_name, lookup_env, safe_join, setting,
check_location, clean_name, get_available_overwrite_name, lookup_env,
safe_join, setting,
)

try:
Expand Down Expand Up @@ -489,7 +490,7 @@ def url(self, name, headers=None, response_headers=None, expire=None):

def get_available_name(self, name, max_length=None):
""" Overwrite existing file with the same name. """
name = self._clean_name(name)
if self.file_overwrite:
name = self._clean_name(name)
return name
return get_available_overwrite_name(name, max_length)
return super(S3BotoStorage, self).get_available_name(name, max_length)
9 changes: 6 additions & 3 deletions storages/backends/s3boto3.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@
from django.utils.six.moves.urllib import parse as urlparse
from django.utils.timezone import is_naive, localtime

from storages.utils import check_location, lookup_env, safe_join, setting
from storages.utils import (
check_location, get_available_overwrite_name, lookup_env, safe_join,
setting,
)

try:
import boto3.session
Expand Down Expand Up @@ -615,7 +618,7 @@ def url(self, name, parameters=None, expire=None):

def get_available_name(self, name, max_length=None):
"""Overwrite existing file with the same name."""
name = self._clean_name(name)
if self.file_overwrite:
name = self._clean_name(name)
return name
return get_available_overwrite_name(name, max_length)
return super(S3Boto3Storage, self).get_available_name(name, max_length)
23 changes: 22 additions & 1 deletion storages/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
import posixpath

from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
from django.core.exceptions import (
ImproperlyConfigured, SuspiciousFileOperation,
)
from django.utils.encoding import force_text


Expand Down Expand Up @@ -97,3 +99,22 @@ def lookup_env(names):
value = os.environ.get(name)
if value:
return value


def get_available_overwrite_name(name, max_length):
if max_length is None or len(name) < max_length:
return name

# Adapted from Django
dir_name, file_name = os.path.split(name)
file_root, file_ext = os.path.splitext(file_name)
truncation = len(name) - max_length

file_root = file_root[:-truncation]
if not file_root:
raise SuspiciousFileOperation(
'Storage tried to truncate away entire filename "%s". '
'Please make sure that the corresponding file field '
'allows sufficient "max_length".' % name
)
return os.path.join(dir_name, "%s%s" % (file_root, file_ext))
12 changes: 11 additions & 1 deletion tests/test_gcloud.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
import datetime
import mimetypes

from django.core.exceptions import ImproperlyConfigured
from django.core.exceptions import (
ImproperlyConfigured, SuspiciousFileOperation,
)
from django.core.files.base import ContentFile
from django.test import TestCase
from django.utils import timezone
Expand Down Expand Up @@ -348,6 +350,14 @@ def test_get_available_name_unicode(self):
filename = 'ủⓝï℅ⅆℇ.txt'
self.assertEqual(self.storage.get_available_name(filename), filename)

def test_get_available_name_overwrite_maxlength(self):
self.storage.file_overwrite = True

self.assertEqual(self.storage.get_available_name('test/foo.txt', 11), 'test/fo.txt')
self.assertEqual(self.storage.get_available_name('test_a/foobar.txt', None), 'test_a/foobar.txt')
with self.assertRaises(SuspiciousFileOperation):
self.storage.get_available_name('test_a/foobar.txt', 10)

def test_cache_control(self):
data = 'This is some test content.'
filename = 'cache_control_file.txt'
Expand Down