Compare commits

..

No commits in common. "master" and "2.3.0" have entirely different histories.

77 changed files with 198 additions and 476 deletions

View file

@ -1,8 +0,0 @@
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"

View file

@ -11,12 +11,12 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v2
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v6 uses: actions/setup-python@v2
with: with:
python-version: 3.8 python-version: 3.8

View file

@ -9,24 +9,29 @@ jobs:
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14'] python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
django-version: ['4.2', '5.0', '5.1', '5.2', 'main'] django-version: ['2.2', '3.1', '3.2', '4.0', 'main']
exclude: exclude:
# Django 5.0 dropped support for Python <3.10 # Django prior to 3.2 does not support Python 3.10
- django-version: '5.0' - django-version: '2.2'
python-version: '3.8' python-version: '3.10'
- django-version: '5.0' - django-version: '3.1'
python-version: '3.9' python-version: '3.10'
# Django after 3.2 dropped support for Python prior to 3.8
- django-version: '4.0'
python-version: '3.6'
- django-version: 'main' - django-version: 'main'
python-version: '3.8' python-version: '3.6'
- django-version: '4.0'
python-version: '3.7'
- django-version: 'main' - django-version: 'main'
python-version: '3.9' python-version: '3.7'
steps: steps:
- uses: actions/checkout@v6 - uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }} - name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6 uses: actions/setup-python@v2
with: with:
python-version: ${{ matrix.python-version }} python-version: ${{ matrix.python-version }}
@ -36,7 +41,7 @@ jobs:
echo "::set-output name=dir::$(pip cache dir)" echo "::set-output name=dir::$(pip cache dir)"
- name: Cache - name: Cache
uses: actions/cache@v5 uses: actions/cache@v2
with: with:
path: ${{ steps.pip-cache.outputs.dir }} path: ${{ steps.pip-cache.outputs.dir }}
key: key:
@ -56,6 +61,6 @@ jobs:
DJANGO: ${{ matrix.django-version }} DJANGO: ${{ matrix.django-version }}
- name: Upload coverage - name: Upload coverage
uses: codecov/codecov-action@v6 uses: codecov/codecov-action@v1
with: with:
name: Python ${{ matrix.python-version }} name: Python ${{ matrix.python-version }}

View file

@ -1,59 +0,0 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: check-toml
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- id: mixed-line-ending
- id: file-contents-sorter
files: docs/spelling_wordlist.txt
- repo: https://github.com/pycqa/doc8
rev: v2.0.0
hooks:
- id: doc8
- repo: https://github.com/adamchainz/django-upgrade
rev: 1.30.0
hooks:
- id: django-upgrade
args: [--target-version, "4.2"]
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
- id: rst-backticks
- id: rst-directive-colons
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v4.0.0-alpha.8
hooks:
- id: prettier
entry: env PRETTIER_LEGACY_CLI=1 prettier
types_or: [javascript, css]
args:
- --trailing-comma=es5
- repo: https://github.com/pre-commit/mirrors-eslint
rev: v10.3.0
hooks:
- id: eslint
additional_dependencies:
- "eslint@v9.0.0-beta.1"
- "@eslint/js@v9.0.0-beta.1"
- "globals"
files: \.js?$
types: [file]
args:
- --fix
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: 'v0.15.12'
hooks:
- id: ruff
args: [--fix, --exit-non-zero-on-fix]
- id: ruff-format
- repo: https://github.com/tox-dev/pyproject-fmt
rev: v2.21.1
hooks:
- id: pyproject-fmt
- repo: https://github.com/abravalheri/validate-pyproject
rev: v0.25
hooks:
- id: validate-pyproject

View file

@ -1,18 +0,0 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
sphinx:
configuration: docs/conf.py
python:
install:
- method: pip
path: .

21
AUTHORS
View file

@ -6,23 +6,22 @@ Maintainer: Benoît Bryon <benoit@marmelune.net>
Original code by `PeopleDoc <https://www.people-doc.com/>`_ team: Original code by `PeopleDoc <https://www.people-doc.com/>`_ team:
* Adam Chainz <adam@adamj.eu> * Nicolas Tobo <https://github.com/nicolastobo>
* Aleksi Häkli <aleksi.hakli@iki.fi> * Lauréline Guérin <https://github.com/zebuline>
* Gregory Tappero <https://github.com/gregtap>
* Rémy Hubscher <https://github.com/natim>
* Benoît Bryon <benoit@marmelune.net> * Benoît Bryon <benoit@marmelune.net>
* CJ <cjdreiss@users.noreply.github.com> * Aleksi Häkli <https://github.com/aleksihakli>
* David Wolf <68775926+devidw@users.noreply.github.com> * Johnt Hagen <johnthagen@gmail.com>
* Davide Setti <setti.davide89@gmail.com>
* Erik Dykema <dykema@gmail.com>
* Fabre Florian <ffabre@hybird.org> * Fabre Florian <ffabre@hybird.org>
* Peter Marheine <peter@taricorp.net>
* Hasan Ramezani <hasan.r67@gmail.com> * Hasan Ramezani <hasan.r67@gmail.com>
* Jannis Leidel <jannis@leidel.info> * Jannis Leidel <jannis@leidel.info>
* John Hagen <johnthagen@gmail.com> * Erik Dykema <dykema@gmail.com>
* Mariusz Felisiak <felisiak.mariusz@gmail.com>
* Martin Bächtold <martin@baechtold.me>
* Nikhil Benesch <nikhil.benesch@gmail.com> * Nikhil Benesch <nikhil.benesch@gmail.com>
* Omer Katz <omer.drow@gmail.com> * Omer Katz <omer.drow@gmail.com>
* Peter Marheine <peter@taricorp.net>
* René Leonhardt <rene.leonhardt@gmail.com> * René Leonhardt <rene.leonhardt@gmail.com>
* Rémy HUBSCHER <hubscher.remy@gmail.com> * Adam Chainz <adam@adamj.eu>
* Martin Bächtold <martin@baechtold.me>
* Tim Gates <tim.gates@iress.com> * Tim Gates <tim.gates@iress.com>
* zero13cool <zero13cool@yandex.ru> * zero13cool <zero13cool@yandex.ru>

View file

@ -4,33 +4,18 @@ Changelog
This document describes changes between past releases. For information about This document describes changes between past releases. For information about
future releases, check `milestones`_ and :doc:`/about/vision`. future releases, check `milestones`_ and :doc:`/about/vision`.
2.6.0 (unreleased)
2.3 (unreleased)
---------------- ----------------
- No changes yet
2.5.0 (2025-10-28)
----------------
- Upgrade to Django 5.2 and Python 3.14
2.4.0 (2024-08-05)
------------------
- Drop support for Python 3.6
- Escape malicious filenames
- Handle headers in XAccel responses
2.3.0 (2022-01-11)
------------------
- Drop Django 3.0 support - Drop Django 3.0 support
- Add Django 3.2 support - Add Django 3.2 support
- Add support for Python 3.10 - Add support for Python 3.10
- Add support for Django 4.0 - Add support for Django 4.0
2.2 (unreleased)
----------------
- Remove support for Python 3.5 and Django 1.11 - Remove support for Python 3.5 and Django 1.11
- Add support for Python 3.9 and Django 3.1 - Add support for Python 3.9 and Django 3.1
- Remove old urls syntax and adopt the new one - Remove old urls syntax and adopt the new one

View file

@ -1,46 +0,0 @@
# Code of Conduct
As contributors and maintainers of the Jazzband projects, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.
We are committed to making participation in the Jazzband a harassment-free experience
for everyone, regardless of the level of experience, gender, gender identity and
expression, sexual orientation, disability, personal appearance, body size, race,
ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery
- Personal attacks
- Trolling or insulting/derogatory comments
- Public or private harassment
- Publishing other's private information, such as physical or electronic addresses,
without explicit permission
- Other unethical or unprofessional conduct
The Jazzband roadies have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are not
aligned to this Code of Conduct, or to ban temporarily or permanently any contributor
for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
By adopting this Code of Conduct, the roadies commit themselves to fairly and
consistently applying these principles to every aspect of managing the jazzband
projects. Roadies who do not follow or enforce the Code of Conduct may be permanently
removed from the Jazzband roadies.
This code of conduct applies both within project spaces and in public spaces when an
individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
contacting the roadies at `roadies@jazzband.co`. All complaints will be reviewed and
investigated and will result in a response that is deemed necessary and appropriate to
the circumstances. Roadies are obligated to maintain confidentiality with regard to the
reporter of an incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version
1.3.0, available at [https://contributor-covenant.org/version/1/3/0/][version]
[homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/3/0/

View file

@ -11,7 +11,7 @@ This is a `Jazzband <https://jazzband.co>`_ project. By contributing you agree t
This document provides guidelines for people who want to contribute to This document provides guidelines for people who want to contribute to
``django-downloadview``. `django-downloadview`.
************** **************
@ -50,7 +50,7 @@ Use topic branches
Fork, clone Fork, clone
*********** ***********
Clone ``django-downloadview`` repository (adapt to use your own fork): Clone `django-downloadview` repository (adapt to use your own fork):
.. code:: sh .. code:: sh
@ -62,7 +62,7 @@ Clone ``django-downloadview`` repository (adapt to use your own fork):
Usual actions Usual actions
************* *************
The ``Makefile`` is the reference card for usual actions in development The `Makefile` is the reference card for usual actions in development
environment: environment:
* Install development toolkit with `pip`_: ``make develop``. * Install development toolkit with `pip`_: ``make develop``.
@ -70,7 +70,7 @@ environment:
* Run tests with `tox`_: ``make test``. * Run tests with `tox`_: ``make test``.
* Build documentation: ``make documentation``. It builds `Sphinx`_ * Build documentation: ``make documentation``. It builds `Sphinx`_
documentation in ``var/docs/html/index.html``. documentation in `var/docs/html/index.html`.
* Release project with `zest.releaser`_: ``make release``. * Release project with `zest.releaser`_: ``make release``.
@ -84,7 +84,7 @@ See also ``make help``.
Demo project included Demo project included
********************* *********************
The ``demo`` included in project's repository is part of the tests and The `demo` included in project's repository is part of the tests and
documentation. Maintain it along with code and documentation. documentation. Maintain it along with code and documentation.

View file

@ -12,8 +12,8 @@ Install
Requirements Requirements
************ ************
`django-downloadview` has been tested with `Python`_ 3.7, 3.8, 3.9 and 3.10. `django-downloadview` has been tested with `Python`_ 3.6, 3.7 and 3.8. Other
Other versions may work, but they are not part of the test suite at the moment. versions may work, but they are not part of the test suite at the moment.
Installing `django-downloadview` will automatically trigger the installation of Installing `django-downloadview` will automatically trigger the installation of
the following requirements: the following requirements:

View file

@ -26,16 +26,16 @@ django-downloadview
:target: https://codecov.io/gh/jazzband/django-downloadview :target: https://codecov.io/gh/jazzband/django-downloadview
:alt: Coverage :alt: Coverage
``django-downloadview`` makes it easy to serve files with `Django`_: `django-downloadview` makes it easy to serve files with `Django`_:
* you manage files with Django (permissions, filters, generation, ...); * you manage files with Django (permissions, filters, generation, ...);
* files are stored somewhere or generated somehow (local filesystem, remote * files are stored somewhere or generated somehow (local filesystem, remote
storage, memory...); storage, memory...);
* ``django-downloadview`` helps you stream the files with very little code; * `django-downloadview` helps you stream the files with very little code;
* ``django-downloadview`` helps you improve performances with reverse proxies, * `django-downloadview` helps you improve performances with reverse proxies,
via mechanisms such as Nginx's X-Accel or Apache's X-Sendfile. via mechanisms such as Nginx's X-Accel or Apache's X-Sendfile.

View file

@ -3,7 +3,7 @@ Demo project
############ ############
`Demo folder in project's repository`_ contains a Django project to illustrate `Demo folder in project's repository`_ contains a Django project to illustrate
``django-downloadview`` usage. `django-downloadview` usage.
***************************************** *****************************************
@ -31,7 +31,7 @@ Deploy the demo
System requirements: System requirements:
* `Python`_ version 3.7+, available as ``python`` command. * `Python`_ version 3.6+, available as ``python`` command.
.. note:: .. note::

View file

@ -43,19 +43,3 @@ class OptimizedByDecoratorTestCase(django.test.TestCase):
basename="hello-world.txt", basename="hello-world.txt",
file_path="/apache-optimized-by-decorator/hello-world.txt", file_path="/apache-optimized-by-decorator/hello-world.txt",
) )
class ModifiedHeadersTestCase(django.test.TestCase):
def test_response(self):
"""'apache:modified_headers' returns X-Sendfile response."""
setup_file()
url = reverse("apache:modified_headers")
response = self.client.get(url)
assert_x_sendfile(
self,
response,
content_type="text/plain; charset=utf-8",
basename="hello-world.txt",
file_path="/apache-modified-headers/hello-world.txt",
)
self.assertEqual(response["X-Test"], "header")

View file

@ -1,5 +1,4 @@
"""URL mapping.""" """URL mapping."""
from django.urls import path from django.urls import path
from demoproject.apache import views from demoproject.apache import views
@ -16,9 +15,4 @@ urlpatterns = [
views.optimized_by_decorator, views.optimized_by_decorator,
name="optimized_by_decorator", name="optimized_by_decorator",
), ),
path(
"modified_headers/",
views.modified_headers,
name="modified_headers",
),
] ]

View file

@ -22,17 +22,3 @@ optimized_by_decorator = x_sendfile(
source_url=storage.base_url, source_url=storage.base_url,
destination_dir="/apache-optimized-by-decorator/", destination_dir="/apache-optimized-by-decorator/",
) )
def _modified_headers(request):
view = StorageDownloadView.as_view(storage=storage, path="hello-world.txt")
response = view(request)
response["X-Test"] = "header"
return response
modified_headers = x_sendfile(
_modified_headers,
source_url=storage.base_url,
destination_dir="/apache-modified-headers/",
)

View file

@ -43,19 +43,3 @@ class OptimizedByDecoratorTestCase(django.test.TestCase):
basename="hello-world.txt", basename="hello-world.txt",
file_path="/lighttpd-optimized-by-decorator/hello-world.txt", file_path="/lighttpd-optimized-by-decorator/hello-world.txt",
) )
class ModifiedHeadersTestCase(django.test.TestCase):
def test_response(self):
"""'lighttpd:modified_headers' returns X-Sendfile response."""
setup_file()
url = reverse("lighttpd:modified_headers")
response = self.client.get(url)
assert_x_sendfile(
self,
response,
content_type="text/plain; charset=utf-8",
basename="hello-world.txt",
file_path="/lighttpd-modified-headers/hello-world.txt",
)
self.assertEqual(response["X-Test"], "header")

View file

@ -1,5 +1,4 @@
"""URL mapping.""" """URL mapping."""
from django.urls import path from django.urls import path
from demoproject.lighttpd import views from demoproject.lighttpd import views
@ -16,9 +15,4 @@ urlpatterns = [
views.optimized_by_decorator, views.optimized_by_decorator,
name="optimized_by_decorator", name="optimized_by_decorator",
), ),
path(
"modified_headers/",
views.modified_headers,
name="modified_headers",
),
] ]

View file

@ -22,17 +22,3 @@ optimized_by_decorator = x_sendfile(
source_url=storage.base_url, source_url=storage.base_url,
destination_dir="/lighttpd-optimized-by-decorator/", destination_dir="/lighttpd-optimized-by-decorator/",
) )
def _modified_headers(request):
view = StorageDownloadView.as_view(storage=storage, path="hello-world.txt")
response = view(request)
response["X-Test"] = "header"
return response
modified_headers = x_sendfile(
_modified_headers,
source_url=storage.base_url,
destination_dir="/lighttpd-modified-headers/",
)

View file

@ -51,23 +51,3 @@ class OptimizedByDecoratorTestCase(django.test.TestCase):
with_buffering=None, with_buffering=None,
limit_rate=None, limit_rate=None,
) )
class ModifiedHeadersTestCase(django.test.TestCase):
def test_response(self):
"""'nginx:modified_headers' returns X-Sendfile response."""
setup_file()
url = reverse("nginx:modified_headers")
response = self.client.get(url)
assert_x_accel_redirect(
self,
response,
content_type="text/plain; charset=utf-8",
charset="utf-8",
basename="hello-world.txt",
redirect_url="/nginx-modified-headers/hello-world.txt",
expires=None,
with_buffering=None,
limit_rate=None,
)
self.assertEqual(response["X-Test"], "header")

View file

@ -16,9 +16,4 @@ urlpatterns = [
views.optimized_by_decorator, views.optimized_by_decorator,
name="optimized_by_decorator", name="optimized_by_decorator",
), ),
path(
"modified_headers/",
views.modified_headers,
name="modified_headers",
),
] ]

View file

@ -22,17 +22,3 @@ optimized_by_decorator = x_accel_redirect(
source_url=storage.base_url, source_url=storage.base_url,
destination_url="/nginx-optimized-by-decorator/", destination_url="/nginx-optimized-by-decorator/",
) )
def _modified_headers(request):
view = StorageDownloadView.as_view(storage=storage, path="hello-world.txt")
response = view(request)
response["X-Test"] = "header"
return response
modified_headers = x_accel_redirect(
_modified_headers,
source_url=storage.base_url,
destination_url="/nginx-modified-headers/",
)

View file

@ -30,7 +30,7 @@ class DynamicPathDownloadView(PathDownloadView):
def get_path(self): def get_path(self):
"""Return path inside fixtures directory.""" """Return path inside fixtures directory."""
# Get path from URL resolvers or as_view kwarg. # Get path from URL resolvers or as_view kwarg.
relative_path = super().get_path() relative_path = super(DynamicPathDownloadView, self).get_path()
# Make it absolute. # Make it absolute.
absolute_path = os.path.join(fixtures_dir, relative_path) absolute_path = os.path.join(fixtures_dir, relative_path)
return absolute_path return absolute_path

View file

@ -1,5 +1,4 @@
"""Django settings for django-downloadview demo project.""" """Django settings for django-downloadview demo project."""
import os import os

View file

@ -44,7 +44,8 @@ class StaticPathTestCase(django.test.TestCase):
url = reverse("storage:static_path", kwargs={"path": "1.txt"}) url = reverse("storage:static_path", kwargs={"path": "1.txt"})
year = datetime.date.today().year + 4 year = datetime.date.today().year + 4
response = self.client.get( response = self.client.get(
url, headers={"if-modified-since": f"Sat, 29 Oct {year} 19:43:31 GMT"} url,
HTTP_IF_MODIFIED_SINCE=f"Sat, 29 Oct {year} 19:43:31 GMT",
) )
self.assertTrue(isinstance(response, HttpResponseNotModified)) self.assertTrue(isinstance(response, HttpResponseNotModified))
@ -54,7 +55,7 @@ class StaticPathTestCase(django.test.TestCase):
setup_file("1.txt") setup_file("1.txt")
url = reverse("storage:static_path", kwargs={"path": "1.txt"}) url = reverse("storage:static_path", kwargs={"path": "1.txt"})
response = self.client.get( response = self.client.get(
url, headers={"if-modified-since": "Sat, 29 Oct 1980 19:43:31 GMT"} url, HTTP_IF_MODIFIED_SINCE="Sat, 29 Oct 1980 19:43:31 GMT"
) )
assert_download_response( assert_download_response(
self, self,

View file

@ -14,7 +14,7 @@ class DynamicStorageDownloadView(StorageDownloadView):
def get_path(self): def get_path(self):
"""Return uppercase path.""" """Return uppercase path."""
return super().get_path().upper() return super(DynamicStorageDownloadView, self).get_path().upper()
dynamic_path = DynamicStorageDownloadView.as_view(storage=storage) dynamic_path = DynamicStorageDownloadView.as_view(storage=storage)

View file

@ -1,5 +1,4 @@
"""Test suite for demoproject.download.""" """Test suite for demoproject.download."""
from django.test import TestCase from django.test import TestCase
from django.urls import reverse from django.urls import reverse

View file

@ -12,7 +12,6 @@ middleware here, or combine a Django application with an application of another
framework. framework.
""" """
import os import os
from django.core.wsgi import get_wsgi_application from django.core.wsgi import get_wsgi_application

View file

@ -1,8 +1,7 @@
"""Serve files with Django and reverse proxies.""" """Serve files with Django and reverse proxies."""
from django_downloadview.api import * # NoQA from django_downloadview.api import * # NoQA
import importlib.metadata import pkg_resources
#: Module version, as defined in PEP-0396. #: Module version, as defined in PEP-0396.
__version__ = importlib.metadata.version(__package__.replace("-", "_")) __version__ = pkg_resources.get_distribution(__package__.replace("-", "_")).version

View file

@ -5,7 +5,6 @@ See also `documentation of mod_xsendfile for Apache
Apache optimizations </optimizations/apache>`. Apache optimizations </optimizations/apache>`.
""" """
# API shortcuts. # API shortcuts.
from django_downloadview.apache.decorators import x_sendfile # NoQA from django_downloadview.apache.decorators import x_sendfile # NoQA
from django_downloadview.apache.middlewares import XSendfileMiddleware # NoQA from django_downloadview.apache.middlewares import XSendfileMiddleware # NoQA

View file

@ -1,5 +1,4 @@
"""Decorators to apply Apache X-Sendfile on a specific view.""" """Decorators to apply Apache X-Sendfile on a specific view."""
from django_downloadview.apache.middlewares import XSendfileMiddleware from django_downloadview.apache.middlewares import XSendfileMiddleware
from django_downloadview.decorators import DownloadDecorator from django_downloadview.decorators import DownloadDecorator

View file

@ -19,7 +19,9 @@ class XSendfileMiddleware(ProxiedDownloadMiddleware):
self, get_response=None, source_dir=None, source_url=None, destination_dir=None self, get_response=None, source_dir=None, source_url=None, destination_dir=None
): ):
"""Constructor.""" """Constructor."""
super().__init__(get_response, source_dir, source_url, destination_dir) super(XSendfileMiddleware, self).__init__(
get_response, source_dir, source_url, destination_dir
)
def process_download_response(self, request, response): def process_download_response(self, request, response):
"""Replace DownloadResponse instances by XSendfileResponse ones.""" """Replace DownloadResponse instances by XSendfileResponse ones."""
@ -32,5 +34,4 @@ class XSendfileMiddleware(ProxiedDownloadMiddleware):
content_type=response["Content-Type"], content_type=response["Content-Type"],
basename=response.basename, basename=response.basename,
attachment=response.attachment, attachment=response.attachment,
headers=response.headers,
) )

View file

@ -1,5 +1,4 @@
"""Apache's specific responses.""" """Apache's specific responses."""
import os.path import os.path
from django_downloadview.response import ProxiedDownloadResponse, content_disposition from django_downloadview.response import ProxiedDownloadResponse, content_disposition
@ -8,14 +7,9 @@ from django_downloadview.response import ProxiedDownloadResponse, content_dispos
class XSendfileResponse(ProxiedDownloadResponse): class XSendfileResponse(ProxiedDownloadResponse):
"Delegates serving file to Apache via X-Sendfile header." "Delegates serving file to Apache via X-Sendfile header."
def __init__( def __init__(self, file_path, content_type, basename=None, attachment=True):
self, file_path, content_type, basename=None, attachment=True, headers=None
):
"""Return a HttpResponse with headers for Apache X-Sendfile.""" """Return a HttpResponse with headers for Apache X-Sendfile."""
# content-type must be provided only as keyword argument to response super(XSendfileResponse, self).__init__(content_type=content_type)
if headers and content_type:
headers.pop("Content-Type", None)
super().__init__(content_type=content_type, headers=headers)
if attachment: if attachment:
self.basename = basename or os.path.basename(file_path) self.basename = basename or os.path.basename(file_path)
self["Content-Disposition"] = content_disposition(self.basename) self["Content-Disposition"] = content_disposition(self.basename)

View file

@ -1,7 +1,7 @@
from django_downloadview.apache.response import XSendfileResponse from django_downloadview.apache.response import XSendfileResponse
class XSendfileValidator: class XSendfileValidator(object):
"""Utility class to validate XSendfileResponse instances. """Utility class to validate XSendfileResponse instances.
See also :py:func:`assert_x_sendfile` shortcut function. See also :py:func:`assert_x_sendfile` shortcut function.

View file

@ -1,6 +1,5 @@
# flake8: noqa # flake8: noqa
"""Declaration of API shortcuts.""" """Declaration of API shortcuts."""
from django_downloadview.files import HTTPFile, StorageFile, VirtualFile from django_downloadview.files import HTTPFile, StorageFile, VirtualFile
from django_downloadview.io import BytesIteratorIO, TextIteratorIO from django_downloadview.io import BytesIteratorIO, TextIteratorIO
from django_downloadview.middlewares import ( from django_downloadview.middlewares import (

View file

@ -1,5 +1,4 @@
"""File wrappers for use as exchange data between views and responses.""" """File wrappers for use as exchange data between views and responses."""
from io import BytesIO from io import BytesIO
from urllib.parse import urlparse from urllib.parse import urlparse
@ -168,7 +167,7 @@ class VirtualFile(File):
File URL. File URL.
""" """
super().__init__(file, name) super(VirtualFile, self).__init__(file, name)
self.url = url self.url = url
if size is not None: if size is not None:
self._size = size self._size = size
@ -184,7 +183,7 @@ class VirtualFile(File):
return self._size return self._size
def _set_size(self, value): def _set_size(self, value):
return super()._set_size(value) return super(VirtualFile, self)._set_size(value)
size = property(_get_size, _set_size) size = property(_get_size, _set_size)

View file

@ -1,5 +1,4 @@
"""Low-level IO operations, for use with file wrappers.""" """Low-level IO operations, for use with file wrappers."""
import io import io
from django.utils.encoding import force_bytes, force_str from django.utils.encoding import force_bytes, force_str

View file

@ -6,7 +6,6 @@ See also `documentation of X-Sendfile for Lighttpd
</optimizations/lighttpd>`. </optimizations/lighttpd>`.
""" """
# API shortcuts. # API shortcuts.
from django_downloadview.lighttpd.decorators import x_sendfile # NoQA from django_downloadview.lighttpd.decorators import x_sendfile # NoQA
from django_downloadview.lighttpd.middlewares import XSendfileMiddleware # NoQA from django_downloadview.lighttpd.middlewares import XSendfileMiddleware # NoQA

View file

@ -1,5 +1,4 @@
"""Decorators to apply Lighttpd X-Sendfile on a specific view.""" """Decorators to apply Lighttpd X-Sendfile on a specific view."""
from django_downloadview.decorators import DownloadDecorator from django_downloadview.decorators import DownloadDecorator
from django_downloadview.lighttpd.middlewares import XSendfileMiddleware from django_downloadview.lighttpd.middlewares import XSendfileMiddleware

View file

@ -19,7 +19,9 @@ class XSendfileMiddleware(ProxiedDownloadMiddleware):
self, get_response=None, source_dir=None, source_url=None, destination_dir=None self, get_response=None, source_dir=None, source_url=None, destination_dir=None
): ):
"""Constructor.""" """Constructor."""
super().__init__(get_response, source_dir, source_url, destination_dir) super(XSendfileMiddleware, self).__init__(
get_response, source_dir, source_url, destination_dir
)
def process_download_response(self, request, response): def process_download_response(self, request, response):
"""Replace DownloadResponse instances by XSendfileResponse ones.""" """Replace DownloadResponse instances by XSendfileResponse ones."""
@ -32,5 +34,4 @@ class XSendfileMiddleware(ProxiedDownloadMiddleware):
content_type=response["Content-Type"], content_type=response["Content-Type"],
basename=response.basename, basename=response.basename,
attachment=response.attachment, attachment=response.attachment,
headers=response.headers,
) )

View file

@ -1,5 +1,4 @@
"""Lighttpd's specific responses.""" """Lighttpd's specific responses."""
import os.path import os.path
from django_downloadview.response import ProxiedDownloadResponse, content_disposition from django_downloadview.response import ProxiedDownloadResponse, content_disposition
@ -8,14 +7,9 @@ from django_downloadview.response import ProxiedDownloadResponse, content_dispos
class XSendfileResponse(ProxiedDownloadResponse): class XSendfileResponse(ProxiedDownloadResponse):
"Delegates serving file to Lighttpd via X-Sendfile header." "Delegates serving file to Lighttpd via X-Sendfile header."
def __init__( def __init__(self, file_path, content_type, basename=None, attachment=True):
self, file_path, content_type, basename=None, attachment=True, headers=None
):
"""Return a HttpResponse with headers for Lighttpd X-Sendfile.""" """Return a HttpResponse with headers for Lighttpd X-Sendfile."""
# content-type must be porvided only as keyword argument to response super(XSendfileResponse, self).__init__(content_type=content_type)
if headers and content_type:
headers.pop("Content-Type", None)
super().__init__(content_type=content_type, headers=headers)
if attachment: if attachment:
self.basename = basename or os.path.basename(file_path) self.basename = basename or os.path.basename(file_path)
self["Content-Disposition"] = content_disposition(self.basename) self["Content-Disposition"] = content_disposition(self.basename)

View file

@ -4,7 +4,6 @@ Download middlewares capture :py:class:`django_downloadview.DownloadResponse`
responses and may replace them with optimized download responses. responses and may replace them with optimized download responses.
""" """
import collections.abc import collections.abc
import copy import copy
import os import os
@ -37,7 +36,6 @@ class BaseDownloadMiddleware:
Subclasses **must** implement :py:meth:`process_download_response` method. Subclasses **must** implement :py:meth:`process_download_response` method.
""" """
def __init__(self, get_response): def __init__(self, get_response):
self.get_response = get_response self.get_response = get_response
@ -77,9 +75,14 @@ class RealDownloadMiddleware(BaseDownloadMiddleware):
whose file attribute have either an URL or a file name. whose file attribute have either an URL or a file name.
""" """
return super().is_download_response(response) and bool( if super(RealDownloadMiddleware, self).is_download_response(response):
getattr(response.file, "url", None) or getattr(response.file, "name", None) try:
) return response.file.url or response.file.name
except AttributeError:
return False
else:
return True
return False
class DownloadDispatcher: class DownloadDispatcher:
@ -92,7 +95,7 @@ class DownloadDispatcher:
def auto_configure_middlewares(self): def auto_configure_middlewares(self):
"""Populate :attr:`middlewares` from """Populate :attr:`middlewares` from
``settings.DOWNLOADVIEW_MIDDLEWARES``.""" ``settings.DOWNLOADVIEW_MIDDLEWARES``."""
for key, import_string, kwargs in getattr( for (key, import_string, kwargs) in getattr(
settings, "DOWNLOADVIEW_MIDDLEWARES", [] settings, "DOWNLOADVIEW_MIDDLEWARES", []
): ):
factory = import_member(import_string) factory = import_member(import_string)
@ -101,7 +104,7 @@ class DownloadDispatcher:
def dispatch(self, request, response): def dispatch(self, request, response):
"""Dispatches job to children middlewares.""" """Dispatches job to children middlewares."""
for key, middleware in self.middlewares: for (key, middleware) in self.middlewares:
response = middleware.process_response(request, response) response = middleware.process_response(request, response)
return response return response
@ -110,7 +113,7 @@ class DownloadDispatcherMiddleware(BaseDownloadMiddleware):
"Download middleware that dispatches job to several middleware instances." "Download middleware that dispatches job to several middleware instances."
def __init__(self, get_response, middlewares=AUTO_CONFIGURE): def __init__(self, get_response, middlewares=AUTO_CONFIGURE):
super().__init__(get_response) super(DownloadDispatcherMiddleware, self).__init__(get_response)
self.dispatcher = DownloadDispatcher(middlewares) self.dispatcher = DownloadDispatcher(middlewares)
def process_download_response(self, request, response): def process_download_response(self, request, response):
@ -127,7 +130,7 @@ class SmartDownloadMiddleware(DownloadDispatcherMiddleware):
backend_options=AUTO_CONFIGURE, backend_options=AUTO_CONFIGURE,
): ):
"""Constructor.""" """Constructor."""
super().__init__(get_response, middlewares=[]) super(SmartDownloadMiddleware, self).__init__(get_response, middlewares=[])
#: Callable (typically a class) to instantiate backend (typically a #: Callable (typically a class) to instantiate backend (typically a
#: :class:`DownloadMiddleware` subclass). #: :class:`DownloadMiddleware` subclass).
self.backend_factory = backend_factory self.backend_factory = backend_factory
@ -145,7 +148,7 @@ class SmartDownloadMiddleware(DownloadDispatcherMiddleware):
self.backend_factory = import_member(settings.DOWNLOADVIEW_BACKEND) self.backend_factory = import_member(settings.DOWNLOADVIEW_BACKEND)
except AttributeError: except AttributeError:
raise ImproperlyConfigured( raise ImproperlyConfigured(
"SmartDownloadMiddleware requires settings.DOWNLOADVIEW_BACKEND" "SmartDownloadMiddleware requires " "settings.DOWNLOADVIEW_BACKEND"
) )
def auto_configure_backend_options(self): def auto_configure_backend_options(self):
@ -155,7 +158,7 @@ class SmartDownloadMiddleware(DownloadDispatcherMiddleware):
options_list = copy.deepcopy(settings.DOWNLOADVIEW_RULES) options_list = copy.deepcopy(settings.DOWNLOADVIEW_RULES)
except AttributeError: except AttributeError:
raise ImproperlyConfigured( raise ImproperlyConfigured(
"SmartDownloadMiddleware requires settings.DOWNLOADVIEW_RULES" "SmartDownloadMiddleware requires " "settings.DOWNLOADVIEW_RULES"
) )
for key, options in enumerate(options_list): for key, options in enumerate(options_list):
args = [] args = []
@ -184,7 +187,7 @@ class ProxiedDownloadMiddleware(RealDownloadMiddleware):
self, get_response, source_dir=None, source_url=None, destination_url=None self, get_response, source_dir=None, source_url=None, destination_url=None
): ):
"""Constructor.""" """Constructor."""
super().__init__(get_response) super(ProxiedDownloadMiddleware, self).__init__(get_response)
self.source_dir = source_dir self.source_dir = source_dir
self.source_url = source_url self.source_url = source_url

View file

@ -5,7 +5,6 @@ See also `Nginx X-accel documentation <http://wiki.nginx.org/X-accel>`_ and
</optimizations/nginx>`. </optimizations/nginx>`.
""" """
# API shortcuts. # API shortcuts.
from django_downloadview.nginx.decorators import x_accel_redirect # NoQA from django_downloadview.nginx.decorators import x_accel_redirect # NoQA
from django_downloadview.nginx.middlewares import XAccelRedirectMiddleware # NoQA from django_downloadview.nginx.middlewares import XAccelRedirectMiddleware # NoQA

View file

@ -1,5 +1,4 @@
"""Decorators to apply Nginx X-Accel on a specific view.""" """Decorators to apply Nginx X-Accel on a specific view."""
from django_downloadview.decorators import DownloadDecorator from django_downloadview.decorators import DownloadDecorator
from django_downloadview.nginx.middlewares import XAccelRedirectMiddleware from django_downloadview.nginx.middlewares import XAccelRedirectMiddleware

View file

@ -58,7 +58,9 @@ class XAccelRedirectMiddleware(ProxiedDownloadMiddleware):
else: else:
source_dir = source_dir source_dir = source_dir
super().__init__(get_response, source_dir, source_url, destination_url) super(XAccelRedirectMiddleware, self).__init__(
get_response, source_dir, source_url, destination_url
)
self.expires = expires self.expires = expires
self.with_buffering = with_buffering self.with_buffering = with_buffering
@ -85,7 +87,6 @@ class XAccelRedirectMiddleware(ProxiedDownloadMiddleware):
with_buffering=self.with_buffering, with_buffering=self.with_buffering,
limit_rate=self.limit_rate, limit_rate=self.limit_rate,
attachment=response.attachment, attachment=response.attachment,
headers=response.headers,
) )
@ -131,7 +132,7 @@ class SingleXAccelRedirectMiddleware(XAccelRedirectMiddleware):
"settings.NGINX_DOWNLOAD_MIDDLEWARE_DESTINATION_URL is " "settings.NGINX_DOWNLOAD_MIDDLEWARE_DESTINATION_URL is "
"required by %s middleware" % self.__class__.__name__ "required by %s middleware" % self.__class__.__name__
) )
super().__init__( super(SingleXAccelRedirectMiddleware, self).__init__(
get_response=get_response, get_response=get_response,
source_dir=settings.NGINX_DOWNLOAD_MIDDLEWARE_SOURCE_DIR, source_dir=settings.NGINX_DOWNLOAD_MIDDLEWARE_SOURCE_DIR,
source_url=settings.NGINX_DOWNLOAD_MIDDLEWARE_SOURCE_URL, source_url=settings.NGINX_DOWNLOAD_MIDDLEWARE_SOURCE_URL,

View file

@ -1,5 +1,4 @@
"""Nginx's specific responses.""" """Nginx's specific responses."""
from datetime import timedelta from datetime import timedelta
from django.utils.timezone import now from django.utils.timezone import now
@ -20,13 +19,9 @@ class XAccelRedirectResponse(ProxiedDownloadResponse):
with_buffering=None, with_buffering=None,
limit_rate=None, limit_rate=None,
attachment=True, attachment=True,
headers=None,
): ):
"""Return a HttpResponse with headers for Nginx X-Accel-Redirect.""" """Return a HttpResponse with headers for Nginx X-Accel-Redirect."""
# content-type must be porvided only as keyword argument to response super(XAccelRedirectResponse, self).__init__(content_type=content_type)
if headers and content_type:
headers.pop("Content-Type", None)
super().__init__(content_type=content_type, headers=headers)
if attachment: if attachment:
self.basename = basename or url_basename(redirect_url, content_type) self.basename = basename or url_basename(redirect_url, content_type)
self["Content-Disposition"] = content_disposition(self.basename) self["Content-Disposition"] = content_disposition(self.basename)

View file

@ -7,7 +7,6 @@
for details. for details.
""" """
import warnings import warnings
from django.conf import settings from django.conf import settings
@ -18,7 +17,14 @@ from django.core.exceptions import ImproperlyConfigured
deprecated_middleware = "django_downloadview.nginx.XAccelRedirectMiddleware" deprecated_middleware = "django_downloadview.nginx.XAccelRedirectMiddleware"
if deprecated_middleware in settings.MIDDLEWARE: def get_middlewares():
try:
return settings.MIDDLEWARE
except AttributeError:
return settings.MIDDLEWARE_CLASSES
if deprecated_middleware in get_middlewares():
raise ImproperlyConfigured( raise ImproperlyConfigured(
"{deprecated_middleware} middleware has been renamed as of " "{deprecated_middleware} middleware has been renamed as of "
"django-downloadview version 1.3. You may use " "django-downloadview version 1.3. You may use "

View file

@ -1,7 +1,7 @@
from django_downloadview.nginx.response import XAccelRedirectResponse from django_downloadview.nginx.response import XAccelRedirectResponse
class XAccelRedirectValidator: class XAccelRedirectValidator(object):
"""Utility class to validate XAccelRedirectResponse instances. """Utility class to validate XAccelRedirectResponse instances.
See also :py:func:`assert_x_accel_redirect` shortcut function. See also :py:func:`assert_x_accel_redirect` shortcut function.

View file

@ -1,5 +1,4 @@
""":py:class:`django.http.HttpResponse` subclasses.""" """:py:class:`django.http.HttpResponse` subclasses."""
import mimetypes import mimetypes
import os import os
import re import re
@ -73,13 +72,7 @@ def content_disposition(filename):
""" """
if not filename: if not filename:
return "attachment" return "attachment"
# ASCII filenames are quoted and must ensure escape sequences ascii_filename = encode_basename_ascii(filename)
# in the filename won't break out of the quoted header value
# which can permit a reflected file download attack. The UTF-8
# version is immune because it's not quoted.
ascii_filename = (
encode_basename_ascii(filename).replace("\\", "\\\\").replace('"', r"\"")
)
utf8_filename = encode_basename_utf8(filename) utf8_filename = encode_basename_utf8(filename)
if ascii_filename == utf8_filename: # ASCII only. if ascii_filename == utf8_filename: # ASCII only.
return f'attachment; filename="{ascii_filename}"' return f'attachment; filename="{ascii_filename}"'
@ -145,7 +138,7 @@ class DownloadResponse(StreamingHttpResponse):
#: A :doc:`file wrapper instance </files>`, such as #: A :doc:`file wrapper instance </files>`, such as
#: :class:`~django.core.files.base.File`. #: :class:`~django.core.files.base.File`.
self.file = file_instance self.file = file_instance
super().__init__( super(DownloadResponse, self).__init__(
streaming_content=self.file, status=status, content_type=content_type streaming_content=self.file, status=status, content_type=content_type
) )
@ -202,6 +195,16 @@ class DownloadResponse(StreamingHttpResponse):
self._default_headers = headers self._default_headers = headers
return self._default_headers return self._default_headers
def items(self):
"""Return iterable of (header, value).
This method is called by http handlers just before WSGI's
start_response() is called... but it is not called by
django.test.ClientHandler! :'(
"""
return super(DownloadResponse, self).items()
def get_basename(self): def get_basename(self):
"""Return basename.""" """Return basename."""
if self.basename: if self.basename:

View file

@ -1,5 +1,4 @@
"""Port of django-sendfile in django-downloadview.""" """Port of django-sendfile in django-downloadview."""
from django_downloadview.views.path import PathDownloadView from django_downloadview.views.path import PathDownloadView

View file

@ -10,7 +10,7 @@ class SignedURLMixin:
""" """
def url(self, name): def url(self, name):
path = super().url(name) path = super(SignedURLMixin, self).url(name)
signer = TimestampSigner() signer = TimestampSigner()
signature = signer.sign(path) signature = signer.sign(path)
return "{}?X-Signature={}".format(path, signature) return "{}?X-Signature={}".format(path, signature)

View file

@ -71,13 +71,13 @@ class temporary_media_root(override_settings):
settings.MEDIA_ROOT.""" settings.MEDIA_ROOT."""
tmp_dir = tempfile.mkdtemp() tmp_dir = tempfile.mkdtemp()
self.options["MEDIA_ROOT"] = tmp_dir self.options["MEDIA_ROOT"] = tmp_dir
super().enable() super(temporary_media_root, self).enable()
def disable(self): def disable(self):
"""Remove directory settings.MEDIA_ROOT then restore original """Remove directory settings.MEDIA_ROOT then restore original
setting.""" setting."""
shutil.rmtree(settings.MEDIA_ROOT) shutil.rmtree(settings.MEDIA_ROOT)
super().disable() super(temporary_media_root, self).disable()
class DownloadResponseValidator(object): class DownloadResponseValidator(object):

View file

@ -1,5 +1,4 @@
"""Utility functions that may be implemented in external packages.""" """Utility functions that may be implemented in external packages."""
import re import re
charset_pattern = re.compile(r"charset=(?P<charset>.+)$", re.I | re.U) charset_pattern = re.compile(r"charset=(?P<charset>.+)$", re.I | re.U)

View file

@ -1,5 +1,4 @@
"""Views to stream files.""" """Views to stream files."""
# API shortcuts. # API shortcuts.
from django_downloadview.views.base import BaseDownloadView, DownloadMixin # NoQA from django_downloadview.views.base import BaseDownloadView, DownloadMixin # NoQA
from django_downloadview.views.http import HTTPDownloadView # NoQA from django_downloadview.views.http import HTTPDownloadView # NoQA

View file

@ -1,6 +1,5 @@
"""Base material for download views: :class:`DownloadMixin` and """Base material for download views: :class:`DownloadMixin` and
:class:`BaseDownloadView`""" :class:`BaseDownloadView`"""
import calendar import calendar
from django.http import Http404, HttpResponseNotModified from django.http import Http404, HttpResponseNotModified
@ -103,9 +102,9 @@ class DownloadMixin(object):
Else, fallbacks to default implementation, which uses Else, fallbacks to default implementation, which uses
:py:func:`django.views.static.was_modified_since`. :py:func:`django.views.static.was_modified_since`.
Django's ``was_modified_since`` function needs a datetime. Django's ``was_modified_since`` function needs a datetime and a size.
It is passed the ``modified_time`` attribute from file It is passed ``modified_time`` and ``size`` attributes from file
wrapper. If file wrapper does not support this attribute wrapper. If file wrapper does not support these attributes
(``AttributeError`` or ``NotImplementedError`` is raised), then (``AttributeError`` or ``NotImplementedError`` is raised), then
the file is considered as modified and ``True`` is returned. the file is considered as modified and ``True`` is returned.
@ -117,11 +116,12 @@ class DownloadMixin(object):
modification_time = calendar.timegm( modification_time = calendar.timegm(
file_instance.modified_time.utctimetuple() file_instance.modified_time.utctimetuple()
) )
size = file_instance.size
except (AttributeError, NotImplementedError) as e: except (AttributeError, NotImplementedError) as e:
print("!=======!", e) print("!=======!", e)
return True return True
else: else:
return was_modified_since(since, modification_time) return was_modified_since(since, modification_time, size)
def not_modified_response(self, *response_args, **response_kwargs): def not_modified_response(self, *response_args, **response_kwargs):
"""Return :class:`django.http.HttpResponseNotModified` instance.""" """Return :class:`django.http.HttpResponseNotModified` instance."""
@ -157,7 +157,7 @@ class DownloadMixin(object):
except exceptions.FileNotFound: except exceptions.FileNotFound:
return self.file_not_found_response() return self.file_not_found_response()
# Respect the If-Modified-Since header. # Respect the If-Modified-Since header.
since = self.request.headers.get("if-modified-since", None) since = self.request.META.get("HTTP_IF_MODIFIED_SINCE", None)
if since is not None: if since is not None:
if not self.was_modified_since(self.file_instance, since): if not self.was_modified_since(self.file_instance, since):
return self.not_modified_response(**response_kwargs) return self.not_modified_response(**response_kwargs)

View file

@ -1,5 +1,4 @@
"""Stream files given an URL, i.e. files you want to proxy.""" """Stream files given an URL, i.e. files you want to proxy."""
from django_downloadview.files import HTTPFile from django_downloadview.files import HTTPFile
from django_downloadview.views.base import BaseDownloadView from django_downloadview.views.base import BaseDownloadView
@ -45,5 +44,5 @@ class HTTPDownloadView(BaseDownloadView):
request_factory=self.get_request_factory(), request_factory=self.get_request_factory(),
name=self.get_basename(), name=self.get_basename(),
url=self.get_url(), url=self.get_url(),
**self.get_request_kwargs(), **self.get_request_kwargs()
) )

View file

@ -1,5 +1,4 @@
"""Stream files that live in models.""" """Stream files that live in models."""
from django.views.generic.detail import SingleObjectMixin from django.views.generic.detail import SingleObjectMixin
from django_downloadview.exceptions import FileNotFound from django_downloadview.exceptions import FileNotFound
@ -84,7 +83,7 @@ class ObjectDownloadView(SingleObjectMixin, BaseDownloadView):
def get_basename(self): def get_basename(self):
"""Return client-side filename.""" """Return client-side filename."""
basename = super().get_basename() basename = super(ObjectDownloadView, self).get_basename()
if basename is None: if basename is None:
field = "basename" field = "basename"
model_field = getattr(self, "%s_field" % field, False) model_field = getattr(self, "%s_field" % field, False)
@ -94,4 +93,4 @@ class ObjectDownloadView(SingleObjectMixin, BaseDownloadView):
def get(self, request, *args, **kwargs): def get(self, request, *args, **kwargs):
self.object = self.get_object() self.object = self.get_object()
return super().get(request, *args, **kwargs) return super(ObjectDownloadView, self).get(request, *args, **kwargs)

View file

@ -1,5 +1,4 @@
""":class:`PathDownloadView`.""" """:class:`PathDownloadView`."""
import os import os
from django.core.files import File from django.core.files import File

View file

@ -1,5 +1,4 @@
"""Stream files from storage.""" """Stream files from storage."""
from django.core.files.storage import DefaultStorage from django.core.files.storage import DefaultStorage
from django_downloadview.files import StorageFile from django_downloadview.files import StorageFile
@ -15,6 +14,16 @@ class StorageDownloadView(PathDownloadView):
#: Path to the file to serve relative to storage. #: Path to the file to serve relative to storage.
path = None # Override docstring. path = None # Override docstring.
def get_path(self):
"""Return path of the file to serve, relative to storage.
Default implementation simply returns view's :py:attr:`path` attribute.
Override this method if you want custom implementation.
"""
return super(StorageDownloadView, self).get_path()
def get_file(self): def get_file(self):
"""Return :class:`~django_downloadview.files.StorageFile` instance.""" """Return :class:`~django_downloadview.files.StorageFile` instance."""
return StorageFile(self.storage, self.get_path()) return StorageFile(self.storage, self.get_path())

View file

@ -1,5 +1,4 @@
"""Stream files that you generate or that live in memory.""" """Stream files that you generate or that live in memory."""
from django_downloadview.views.base import BaseDownloadView from django_downloadview.views.base import BaseDownloadView

View file

@ -1,9 +1,8 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
"""django-downloadview documentation build configuration file.""" """django-downloadview documentation build configuration file."""
import os
import re import re
from pkg_resources import get_distribution
import importlib.metadata
# Minimal Django settings. Required to use sphinx.ext.autodoc, because # Minimal Django settings. Required to use sphinx.ext.autodoc, because
# django-downloadview depends on Django... # django-downloadview depends on Django...
@ -49,9 +48,9 @@ author_slug = re.sub(r"([\w_.-]+)", "-", author)
# built documents. # built documents.
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = importlib.metadata.version("django-downloadview") release = get_distribution("django-downloadview").version
# The short X.Y version. # The short X.Y version.
version = ".".join(release.split(".")[:2]) version = '.'.join(release.split('.')[:2])
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

View file

@ -31,7 +31,7 @@ Here are tips to migrate from `django-sendfile` to `django-downloadview`...
* setup ``DOWNLOADVIEW_RULES``. It replaces ``SENDFILE_ROOT`` and can do * setup ``DOWNLOADVIEW_RULES``. It replaces ``SENDFILE_ROOT`` and can do
more. more.
* register ``django_downloadview.SmartDownloadMiddleware`` in * register ``django_downloadview.SmartDownloadMiddleware`` in
``MIDDLEWARE``. ``MIDDLEWARE_CLASSES``.
4. Change your tests if any. You can no longer use `django-senfile`'s 4. Change your tests if any. You can no longer use `django-senfile`'s
``development`` backend. See :doc:`/testing` for `django-downloadview`'s ``development`` backend. See :doc:`/testing` for `django-downloadview`'s

View file

@ -45,7 +45,7 @@ Setup XSendfile middlewares
*************************** ***************************
Make sure ``django_downloadview.SmartDownloadMiddleware`` is in Make sure ``django_downloadview.SmartDownloadMiddleware`` is in
``MIDDLEWARE`` of your `Django` settings. ``MIDDLEWARE_CLASSES`` of your `Django` settings.
Example: Example:

View file

@ -51,7 +51,7 @@ Setup XSendfile middlewares
*************************** ***************************
Make sure ``django_downloadview.SmartDownloadMiddleware`` is in Make sure ``django_downloadview.SmartDownloadMiddleware`` is in
``MIDDLEWARE`` of your `Django` settings. ``MIDDLEWARE_CLASSES`` of your `Django` settings.
Example: Example:

View file

@ -13,11 +13,11 @@ There is no need to register this application in ``INSTALLED_APPS``.
****************** ******************
MIDDLEWARE MIDDLEWARE_CLASSES
****************** ******************
If you plan to setup :doc:`reverse-proxy optimizations </optimizations/index>`, If you plan to setup :doc:`reverse-proxy optimizations </optimizations/index>`,
add ``django_downloadview.SmartDownloadMiddleware`` to ``MIDDLEWARE``. add ``django_downloadview.SmartDownloadMiddleware`` to ``MIDDLEWARE_CLASSES``.
It is a response middleware. Move it after middlewares that compute the It is a response middleware. Move it after middlewares that compute the
response content such as gzip middleware. response content such as gzip middleware.
@ -58,7 +58,7 @@ URLs, and they can then be verified with the supplied ``signature_required`` wra
download = ObjectDownloadView.as_view(model=Document, file_field='file') download = ObjectDownloadView.as_view(model=Document, file_field='file')
urlpatterns = [ urlpatterns = [
path('download/<str:slug>/', signature_required(download)), path('download/<str:slug>/', signature_required(download),
] ]
Make sure to test the desired functionality after configuration. Make sure to test the desired functionality after configuration.
@ -91,7 +91,7 @@ Example:
See :doc:`/optimizations/index` for a list of available backends (middlewares). See :doc:`/optimizations/index` for a list of available backends (middlewares).
When ``django_downloadview.SmartDownloadMiddleware`` is in your When ``django_downloadview.SmartDownloadMiddleware`` is in your
``MIDDLEWARE``, this setting must be explicitely configured (no default ``MIDDLEWARE_CLASSES``, this setting must be explicitely configured (no default
value). Else, you can ignore this setting. value). Else, you can ignore this setting.
@ -119,5 +119,5 @@ See :doc:`/optimizations/index` for details about builtin backends
(middlewares) and their options. (middlewares) and their options.
When ``django_downloadview.SmartDownloadMiddleware`` is in your When ``django_downloadview.SmartDownloadMiddleware`` is in your
``MIDDLEWARE``, this setting must be explicitely configured (no default ``MIDDLEWARE_CLASSES``, this setting must be explicitely configured (no default
value). Else, you can ignore this setting. value). Else, you can ignore this setting.

View file

@ -41,3 +41,4 @@ Example, related to :doc:`StorageDownloadView demo </views/storage>`:
.. literalinclude:: /../demo/demoproject/storage/tests.py .. literalinclude:: /../demo/demoproject/storage/tests.py
:language: python :language: python
:lines: 1-2, 8-12, 59- :lines: 1-2, 8-12, 59-

View file

@ -10,21 +10,21 @@ setup(
setup_requires=["setuptools_scm"], setup_requires=["setuptools_scm"],
description="Serve files with Django and reverse-proxies.", description="Serve files with Django and reverse-proxies.",
long_description=open(os.path.join(here, "README.rst")).read(), long_description=open(os.path.join(here, "README.rst")).read(),
long_description_content_type="text/x-rst", long_description_content_type='text/x-rst',
classifiers=[ classifiers=[
"Development Status :: 5 - Production/Stable", "Development Status :: 5 - Production/Stable",
"License :: OSI Approved :: BSD License", "License :: OSI Approved :: BSD License",
"Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11", 'Framework :: Django',
"Programming Language :: Python :: 3.12", 'Framework :: Django :: 2.2',
"Programming Language :: Python :: 3.13", 'Framework :: Django :: 3.1',
"Programming Language :: Python :: 3.14", 'Framework :: Django :: 3.2',
"Framework :: Django", 'Framework :: Django :: 4.0',
"Framework :: Django :: 4.2",
"Framework :: Django :: 5.0",
], ],
keywords=" ".join( keywords=" ".join(
[ [
@ -54,10 +54,9 @@ setup(
], ],
include_package_data=True, include_package_data=True,
zip_safe=False, zip_safe=False,
python_requires=">=3.8",
install_requires=[ install_requires=[
# BEGIN requirements # BEGIN requirements
"Django>=4.2", "Django>=2.2",
"requests", "requests",
# END requirements # END requirements
], ],

View file

@ -1,5 +1,4 @@
"""Test suite around :mod:`django_downloadview.api` and deprecation plan.""" """Test suite around :mod:`django_downloadview.api` and deprecation plan."""
from importlib import import_module, reload from importlib import import_module, reload
import unittest import unittest
import warnings import warnings
@ -101,6 +100,7 @@ class DeprecatedAPITestCase(django.test.SimpleTestCase):
def test_nginx_x_accel_redirect_middleware(self): def test_nginx_x_accel_redirect_middleware(self):
"XAccelRedirectMiddleware in settings triggers ImproperlyConfigured." "XAccelRedirectMiddleware in settings triggers ImproperlyConfigured."
with override_settings( with override_settings(
MIDDLEWARE_CLASSES=["django_downloadview.nginx.XAccelRedirectMiddleware"],
MIDDLEWARE=["django_downloadview.nginx.XAccelRedirectMiddleware"], MIDDLEWARE=["django_downloadview.nginx.XAccelRedirectMiddleware"],
): ):
with self.assertRaises(ImproperlyConfigured): with self.assertRaises(ImproperlyConfigured):
@ -131,7 +131,7 @@ class DeprecatedAPITestCase(django.test.SimpleTestCase):
reload(django_downloadview.nginx.settings) reload(django_downloadview.nginx.settings)
caught = False caught = False
for warning_item in warning_list: for warning_item in warning_list:
if warning_item.category is DeprecationWarning: if warning_item.category == DeprecationWarning:
if "deprecated" in str(warning_item.message): if "deprecated" in str(warning_item.message):
if setting_name in str(warning_item.message): if setting_name in str(warning_item.message):
caught = True caught = True
@ -141,5 +141,5 @@ class DeprecatedAPITestCase(django.test.SimpleTestCase):
if missed_warnings: if missed_warnings:
self.fail( self.fail(
f"No DeprecationWarning raised about following settings: " f"No DeprecationWarning raised about following settings: "
f"{', '.join(missed_warnings)}." f'{", ".join(missed_warnings)}.'
) )

View file

@ -1,5 +1,4 @@
"""Tests around :mod:`django_downloadview.io`.""" """Tests around :mod:`django_downloadview.io`."""
import unittest import unittest
from django_downloadview import BytesIteratorIO, TextIteratorIO from django_downloadview import BytesIteratorIO, TextIteratorIO

View file

@ -1,6 +1,4 @@
"""Tests around project's distribution and packaging.""" """Tests around project's distribution and packaging."""
import importlib.metadata
import os import os
import unittest import unittest
@ -26,14 +24,22 @@ class VersionTestCase(unittest.TestCase):
self.fail("django_downloadview package has no __version__.") self.fail("django_downloadview package has no __version__.")
def test_version_match(self): def test_version_match(self):
"""django_downloadview.__version__ matches importlib metadata.""" """django_downloadview.__version__ matches pkg_resources info."""
distribution = importlib.metadata.distribution("django-downloadview") try:
import pkg_resources
except ImportError:
self.fail(
"Cannot import pkg_resources module. It is part of "
"setuptools, which is a dependency of "
"django_downloadview."
)
distribution = pkg_resources.get_distribution("django-downloadview")
installed_version = distribution.version installed_version = distribution.version
self.assertEqual( self.assertEqual(
installed_version, installed_version,
self.get_version(), self.get_version(),
"Version mismatch: django_downloadview.__version__ " "Version mismatch: django_downloadview.__version__ "
'is "%s" whereas importlib.metadata tells "%s". ' 'is "%s" whereas pkg_resources tells "%s". '
"You may need to run ``make develop`` to update the " "You may need to run ``make develop`` to update the "
"installed version in development environment." "installed version in development environment."
% (self.get_version(), installed_version), % (self.get_version(), installed_version),

View file

@ -1,5 +1,4 @@
"""Unit tests around responses.""" """Unit tests around responses."""
import unittest import unittest
from django_downloadview.response import DownloadResponse from django_downloadview.response import DownloadResponse
@ -20,13 +19,3 @@ class DownloadResponseTestCase(unittest.TestCase):
self.assertIn( self.assertIn(
"filename*=UTF-8''espac%C3%A9%20.txt", headers["Content-Disposition"] "filename*=UTF-8''espac%C3%A9%20.txt", headers["Content-Disposition"]
) )
def test_content_disposition_escaping(self):
"""Content-Disposition headers escape special characters."""
response = DownloadResponse(
"fake file", attachment=True, basename=r'"malicious\file.exe'
)
headers = response.default_headers
self.assertIn(
r'filename="\"malicious\\file.exe"', headers["Content-Disposition"]
)

View file

@ -1,5 +1,4 @@
"""Tests around :py:mod:`django_downloadview.sendfile`.""" """Tests around :py:mod:`django_downloadview.sendfile`."""
from django.http import Http404 from django.http import Http404
import django.test import django.test

View file

@ -1,5 +1,4 @@
"""Tests around :mod:`django_downloadview.views`.""" """Tests around :mod:`django_downloadview.views`."""
import calendar import calendar
from datetime import datetime from datetime import datetime
import os import os
@ -86,12 +85,13 @@ class DownloadMixinTestCase(unittest.TestCase):
When calling file wrapper's ``was_modified_since()`` raises When calling file wrapper's ``was_modified_since()`` raises
``NotImplementedError`` or ``AttributeError``, ``NotImplementedError`` or ``AttributeError``,
:meth:`django_downloadview.views.base.DownloadMixin.was_modified_since` :meth:`django_downloadview.views.base.DownloadMixin.was_modified_since`
tries to pass file wrapper's ``modified_time`` to tries to pass file wrapper's ``size`` and ``modified_time`` to
:func:`django.views.static import was_modified_since`. :func:`django.views.static import was_modified_since`.
""" """
file_wrapper = mock.Mock() file_wrapper = mock.Mock()
file_wrapper.was_modified_since = mock.Mock(side_effect=AttributeError) file_wrapper.was_modified_since = mock.Mock(side_effect=AttributeError)
file_wrapper.size = mock.sentinel.size
file_wrapper.modified_time = datetime.now() file_wrapper.modified_time = datetime.now()
was_modified_since_mock = mock.Mock(return_value=mock.sentinel.was_modified) was_modified_since_mock = mock.Mock(return_value=mock.sentinel.was_modified)
mixin = views.DownloadMixin() mixin = views.DownloadMixin()
@ -106,6 +106,7 @@ class DownloadMixinTestCase(unittest.TestCase):
was_modified_since_mock.assert_called_once_with( was_modified_since_mock.assert_called_once_with(
mock.sentinel.since, mock.sentinel.since,
calendar.timegm(file_wrapper.modified_time.utctimetuple()), calendar.timegm(file_wrapper.modified_time.utctimetuple()),
mock.sentinel.size,
) )
def test_was_modified_since_fallback(self): def test_was_modified_since_fallback(self):
@ -116,7 +117,7 @@ class DownloadMixinTestCase(unittest.TestCase):
* calling file wrapper's ``was_modified_since()`` raises * calling file wrapper's ``was_modified_since()`` raises
``NotImplementedError`` or ``AttributeError``; ``NotImplementedError`` or ``AttributeError``;
* and accessing ``modified_time`` from file wrapper raises * and accessing ``size`` and ``modified_time`` from file wrapper raises
``NotImplementedError`` or ``AttributeError``... ``NotImplementedError`` or ``AttributeError``...
... then ... then

36
tox.ini
View file

@ -1,49 +1,44 @@
[tox] [tox]
envlist = envlist =
py{38,39,310,311,312}-dj{42}-{unittest,pytest,checkmigrations} py{36,37,38,39,310}-dj{22,31,32}
py{310,311,312,313}-dj{50}-{unittest,pytest,checkmigrations} py{38,39,310}-dj{40,main}
py{310,311,312,313}-dj{51}-{unittest,pytest,checkmigrations}
py{310,311,312,313,314}-dj{52}-{unittest,pytest,checkmigrations}
py{312,313,314}-dj{main}-{unittest,pytest,checkmigrations}
lint lint
sphinx sphinx
readme readme
[gh-actions] [gh-actions]
python = python =
3.6: py36
3.7: py37
3.8: py38, lint, sphinx, readme 3.8: py38, lint, sphinx, readme
3.9: py39 3.9: py39
3.10: py310 3.10: py310
3.11: py311
3.12: py312
3.13: py313
3.14: py314
[gh-actions:env] [gh-actions:env]
DJANGO = DJANGO =
4.2: dj42 2.2: dj22
5.0: dj50 3.1: dj31
5.1: dj51 3.2: dj32
5.2: dj52 4.0: dj40
main: djmain main: djmain
[testenv] [testenv]
deps = deps =
coverage coverage
dj42: Django>=4.2,<5.0 dj22: Django>=2.2,<3.0
dj50: Django>=5.0,<5.1 dj31: Django>=3.1,<3.2
dj51: django>=5.1,<5.2 dj32: Django>=3.2,<3.3
dj52: django>=5.2,<5.3 dj40: Django>=4.0,<4.1
djmain: https://github.com/django/django/archive/main.tar.gz djmain: https://github.com/django/django/archive/main.tar.gz
pytest pytest
pytest-cov pytest-cov
commands = commands =
pip install -e . pip install -e .
pip install -e demo pip install -e demo
# doctests and unit tests # doctests
pytest --cov=django_downloadview --cov=demoproject {posargs} pytest --cov=django_downloadview --cov=demoproject {posargs}
# demo project integration tests # all other test cases
coverage run --append {envbindir}/demo test {posargs: demoproject} coverage run --append {envbindir}/demo test {posargs: tests demoproject}
coverage xml coverage xml
pip freeze pip freeze
ignore_outcome = ignore_outcome =
@ -85,4 +80,3 @@ source = django_downloadview,demo
[pytest] [pytest]
DJANGO_SETTINGS_MODULE = demoproject.settings DJANGO_SETTINGS_MODULE = demoproject.settings
addopts = --doctest-modules --ignore=docs/ addopts = --doctest-modules --ignore=docs/
python_files = tests/*.py