Compare commits

..

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

103 changed files with 649 additions and 972 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

@ -1,40 +0,0 @@
name: Release
on:
push:
tags:
- '*'
jobs:
build:
if: github.repository == 'jazzband/django-downloadview'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install -U pip
python -m pip install -U setuptools twine wheel
- name: Build package
run: |
python setup.py --version
python setup.py sdist --format=gztar bdist_wheel
twine check dist/*
- name: Upload packages to Jazzband
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@master
with:
user: jazzband
password: ${{ secrets.JAZZBAND_RELEASE_KEY }}
repository_url: https://jazzband.co/projects/django-downloadview/upload

View file

@ -1,61 +0,0 @@
name: Test
on: [push, pull_request]
jobs:
build:
name: build (Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
django-version: ['4.2', '5.0', '5.1', '5.2', 'main']
exclude:
# Django 5.0 dropped support for Python <3.10
- django-version: '5.0'
python-version: '3.8'
- django-version: '5.0'
python-version: '3.9'
- django-version: 'main'
python-version: '3.8'
- django-version: 'main'
python-version: '3.9'
steps:
- uses: actions/checkout@v6
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Get pip cache dir
id: pip-cache
run: |
echo "::set-output name=dir::$(pip cache dir)"
- name: Cache
uses: actions/cache@v5
with:
path: ${{ steps.pip-cache.outputs.dir }}
key:
${{ matrix.python-version }}-v1-${{ hashFiles('**/setup.py') }}
restore-keys: |
${{ matrix.python-version }}-v1-
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install --upgrade tox tox-gh-actions
- name: Tox tests
run: |
tox -v
env:
DJANGO: ${{ matrix.django-version }}
- name: Upload coverage
uses: codecov/codecov-action@v6
with:
name: Python ${{ matrix.python-version }}

8
.gitignore vendored
View file

@ -6,8 +6,6 @@
# Data files. # Data files.
/var/ /var/
coverage.xml
.coverage/
# Python files. # Python files.
*.pyc *.pyc
@ -16,17 +14,11 @@ coverage.xml
# Tox files. # Tox files.
/.tox/ /.tox/
.eggs
*.egg-info
# Virtualenv files (created by tox). # Virtualenv files (created by tox).
/build/ /build/
/dist/ /dist/
# Virtual environments (created by user).
/venv/
# Editors' temporary buffers. # Editors' temporary buffers.
.*.swp .*.swp
*~ *~
.idea

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: .

11
.travis.yml Normal file
View file

@ -0,0 +1,11 @@
language: python
dist: bionic
python:
- 3.6
- 3.7
- 3.8
install:
- pip install tox
- pip install -q tox-travis
script:
- tox

28
AUTHORS
View file

@ -4,25 +4,13 @@ Authors & contributors
Maintainer: Benoît Bryon <benoit@marmelune.net> Maintainer: Benoît Bryon <benoit@marmelune.net>
Original code by `PeopleDoc <https://www.people-doc.com/>`_ team: Original code by `Novapost <http://www.novapost.fr>`_ 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/coulix>
* Rémy Hubscher <remy.hubscher@novapost.fr>
* 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>
* Davide Setti <setti.davide89@gmail.com> Developers: https://github.com/benoitbryon/django-downloadview/graphs/contributors
* Erik Dykema <dykema@gmail.com>
* Fabre Florian <ffabre@hybird.org>
* Hasan Ramezani <hasan.r67@gmail.com>
* Jannis Leidel <jannis@leidel.info>
* John Hagen <johnthagen@gmail.com>
* Mariusz Felisiak <felisiak.mariusz@gmail.com>
* Martin Bächtold <martin@baechtold.me>
* Nikhil Benesch <nikhil.benesch@gmail.com>
* Omer Katz <omer.drow@gmail.com>
* Peter Marheine <peter@taricorp.net>
* René Leonhardt <rene.leonhardt@gmail.com>
* Rémy HUBSCHER <hubscher.remy@gmail.com>
* Tim Gates <tim.gates@iress.com>
* zero13cool <zero13cool@yandex.ru>

View file

@ -4,45 +4,6 @@ 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)
----------------
- 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
- Add Django 3.2 support
- Add support for Python 3.10
- Add support for Django 4.0
- Remove support for Python 3.5 and Django 1.11
- Add support for Python 3.9 and Django 3.1
- Remove old urls syntax and adopt the new one
- Move the project to the jazzband organization
- Adopt black automatic formatting rules
2.1.1 (2020-01-14)
------------------
- Fix missing function parameter. (#152)
2.1 (2020-01-13) 2.1 (2020-01-13)
---------------- ----------------
@ -266,4 +227,4 @@ Contains **backward incompatible changes.**
.. target-notes:: .. target-notes::
.. _`milestones`: https://github.com/jazzband/django-downloadview/milestones .. _`milestones`: https://github.com/benoitbryon/django-downloadview/milestones

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

@ -2,16 +2,8 @@
Contributing Contributing
############ ############
.. image:: https://jazzband.co/static/img/jazzband.svg
:target: https://jazzband.co/
:alt: Jazzband
This is a `Jazzband <https://jazzband.co>`_ project. By contributing you agree to abide by the `Contributor Code of Conduct <https://jazzband.co/about/conduct>`_ and follow the `guidelines <https://jazzband.co/about/guidelines>`_.
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,11 +42,11 @@ 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
git clone git@github.com:jazzband/django-downloadview.git git clone git@github.com:benoitbryon/django-downloadview.git
cd django-downloadview/ cd django-downloadview/
@ -62,7 +54,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 +62,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 +76,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.
@ -93,7 +85,7 @@ documentation. Maintain it along with code and documentation.
.. target-notes:: .. target-notes::
.. _`bugtracker`: .. _`bugtracker`:
https://github.com/jazzband/django-downloadview/issues https://github.com/benoitbryon/django-downloadview/issues
.. _`rebase`: http://git-scm.com/book/en/Git-Branching-Rebasing .. _`rebase`: http://git-scm.com/book/en/Git-Branching-Rebasing
.. _`merge-based rebase`: https://tech.people-doc.com/psycho-rebasing.html .. _`merge-based rebase`: https://tech.people-doc.com/psycho-rebasing.html
.. _`pip`: https://pypi.python.org/pypi/pip/ .. _`pip`: https://pypi.python.org/pypi/pip/

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

@ -6,3 +6,4 @@ include CONTRIBUTING.rst
include INSTALL include INSTALL
include LICENSE include LICENSE
include README.rst include README.rst
include VERSION

View file

@ -92,6 +92,12 @@ demo:
runserver: demo runserver: demo
demo runserver demo runserver
#: release - Tag and push to PyPI.
.PHONY: release
release:
$(TOX) -e release
.PHONY: black .PHONY: black
black: black:
$(BLACK) demo tests django_downloadview $(BLACK) demo tests django_downloadview

View file

@ -2,40 +2,16 @@
django-downloadview django-downloadview
################### ###################
.. image:: https://jazzband.co/static/img/badge.svg `django-downloadview` makes it easy to serve files with `Django`_:
:target: https://jazzband.co/
:alt: Jazzband
.. image:: https://img.shields.io/pypi/v/django-downloadview.svg
:target: https://pypi.python.org/pypi/django-downloadview
.. image:: https://img.shields.io/pypi/pyversions/django-downloadview.svg
:target: https://pypi.python.org/pypi/django-downloadview
.. image:: https://img.shields.io/pypi/djversions/django-downloadview.svg
:target: https://pypi.python.org/pypi/django-downloadview
.. image:: https://img.shields.io/pypi/dm/django-downloadview.svg
:target: https://pypi.python.org/pypi/django-downloadview
.. image:: https://github.com/jazzband/django-downloadview/workflows/Test/badge.svg
:target: https://github.com/jazzband/django-downloadview/actions
:alt: GitHub Actions
.. image:: https://codecov.io/gh/jazzband/django-downloadview/branch/master/graph/badge.svg
:target: https://codecov.io/gh/jazzband/django-downloadview
:alt: Coverage
``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.
@ -65,9 +41,10 @@ Resources
* Documentation: https://django-downloadview.readthedocs.io * Documentation: https://django-downloadview.readthedocs.io
* PyPI page: http://pypi.python.org/pypi/django-downloadview * PyPI page: http://pypi.python.org/pypi/django-downloadview
* Code repository: https://github.com/jazzband/django-downloadview * Code repository: https://github.com/benoitbryon/django-downloadview
* Bugtracker: https://github.com/jazzband/django-downloadview/issues * Bugtracker: https://github.com/benoitbryon/django-downloadview/issues
* Continuous integration: https://github.com/jazzband/django-downloadview/actions * Continuous integration: https://travis-ci.org/benoitbryon/django-downloadview
* Roadmap: https://github.com/jazzband/django-downloadview/milestones * Roadmap: https://github.com/benoitbryon/django-downloadview/milestones
.. _`Django`: https://djangoproject.com .. _`Django`: https://djangoproject.com

1
VERSION Normal file
View file

@ -0,0 +1 @@
2.1

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 2.7, available as ``python`` command.
.. note:: .. note::
@ -44,7 +44,7 @@ Execute:
.. code-block:: sh .. code-block:: sh
git clone git@github.com:jazzband/django-downloadview.git git clone git@github.com:benoitbryon/django-downloadview.git
cd django-downloadview/ cd django-downloadview/
make runserver make runserver
@ -66,7 +66,7 @@ References
.. target-notes:: .. target-notes::
.. _`demo folder in project's repository`: .. _`demo folder in project's repository`:
https://github.com/jazzband/django-downloadview/tree/master/demo/demoproject/ https://github.com/benoitbryon/django-downloadview/tree/master/demo/demoproject/
.. _`Python`: http://python.org .. _`Python`: http://python.org
.. _`Virtualenv`: http://virtualenv.org .. _`Virtualenv`: http://virtualenv.org

View file

@ -2,11 +2,11 @@ import os
from django.core.files.base import ContentFile from django.core.files.base import ContentFile
import django.test import django.test
from django.urls import reverse
from django_downloadview.apache import assert_x_sendfile from django_downloadview.apache import assert_x_sendfile
from demoproject.apache.views import storage, storage_dir from demoproject.apache.views import storage, storage_dir
from demoproject.compat import reverse
def setup_file(): def setup_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,24 +1,19 @@
"""URL mapping.""" """URL mapping."""
from django.conf.urls import url
from django.urls import path
from demoproject.apache import views from demoproject.apache import views
from demoproject.compat import patterns
app_name = "apache" urlpatterns = patterns(
urlpatterns = [ "demoproject.apache.views",
path( url(
"optimized-by-middleware/", r"^optimized-by-middleware/$",
views.optimized_by_middleware, views.optimized_by_middleware,
name="optimized_by_middleware", name="optimized_by_middleware",
), ),
path( url(
"optimized-by-decorator/", r"^optimized-by-decorator/$",
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

@ -0,0 +1,26 @@
from distutils.version import StrictVersion
from django.utils.version import get_version
try:
from django.conf.urls import patterns # noqa
except ImportError:
def patterns(prefix, *args):
return list(args)
try:
from django.urls import reverse # noqa
except ImportError:
from django.core.urlresolvers import reverse # noqa
if StrictVersion(get_version()) >= StrictVersion("2.0"):
from django.conf.urls import include as urlinclude # noqa
def include(arg, namespace=None, app_name=None):
return urlinclude((arg, app_name), namespace=namespace)
else:
from django.conf.urls import include # noqa

View file

@ -1,8 +1,9 @@
import django.test import django.test
from django.urls import reverse
from django_downloadview import assert_download_response from django_downloadview import assert_download_response
from demoproject.compat import reverse
class SimpleURLTestCase(django.test.TestCase): class SimpleURLTestCase(django.test.TestCase):
def test_download_response(self): def test_download_response(self):

View file

@ -1,9 +1,10 @@
from django.urls import path from django.conf.urls import url
from demoproject.compat import patterns
from demoproject.http import views from demoproject.http import views
app_name = "http" urlpatterns = patterns(
urlpatterns = [ "",
path("simple_url/", views.simple_url, name="simple_url"), url(r"^simple_url/$", views.simple_url, name="simple_url"),
path("avatar_url/", views.avatar_url, name="avatar_url"), url(r"^avatar_url/$", views.avatar_url, name="avatar_url"),
] )

View file

@ -6,7 +6,7 @@ class SimpleURLDownloadView(HTTPDownloadView):
"""Return URL of hello-world.txt file on GitHub.""" """Return URL of hello-world.txt file on GitHub."""
return ( return (
"https://raw.githubusercontent.com" "https://raw.githubusercontent.com"
"/jazzband/django-downloadview" "/benoitbryon/django-downloadview"
"/b7f660c5e3f37d918b106b02c5af7a887acc0111" "/b7f660c5e3f37d918b106b02c5af7a887acc0111"
"/demo/demoproject/download/fixtures/hello-world.txt" "/demo/demoproject/download/fixtures/hello-world.txt"
) )

View file

@ -2,10 +2,10 @@ import os
from django.core.files.base import ContentFile from django.core.files.base import ContentFile
import django.test import django.test
from django.urls import reverse
from django_downloadview.lighttpd import assert_x_sendfile from django_downloadview.lighttpd import assert_x_sendfile
from demoproject.compat import reverse
from demoproject.lighttpd.views import storage, storage_dir from demoproject.lighttpd.views import storage, storage_dir
@ -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,24 +1,19 @@
"""URL mapping.""" """URL mapping."""
from django.conf.urls import url
from django.urls import path from demoproject.compat import patterns
from demoproject.lighttpd import views from demoproject.lighttpd import views
app_name = "lighttpd" urlpatterns = patterns(
urlpatterns = [ "demoproject.lighttpd.views",
path( url(
"optimized-by-middleware/", r"^optimized-by-middleware/$",
views.optimized_by_middleware, views.optimized_by_middleware,
name="optimized_by_middleware", name="optimized_by_middleware",
), ),
path( url(
"optimized-by-decorator/", r"^optimized-by-decorator/$",
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

@ -2,10 +2,10 @@ import os
from django.core.files.base import ContentFile from django.core.files.base import ContentFile
import django.test import django.test
from django.urls import reverse
from django_downloadview.nginx import assert_x_accel_redirect from django_downloadview.nginx import assert_x_accel_redirect
from demoproject.compat import reverse
from demoproject.nginx.views import storage, storage_dir from demoproject.nginx.views import storage, storage_dir
@ -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

@ -1,24 +1,20 @@
"""URL mapping.""" """URL mapping."""
from django.urls import path from django.conf.urls import url
from demoproject.compat import patterns
from demoproject.nginx import views from demoproject.nginx import views
app_name = "nginx" urlpatterns = patterns(
urlpatterns = [ "demoproject.nginx.views",
path( url(
"optimized-by-middleware/", r"^optimized-by-middleware/$",
views.optimized_by_middleware, views.optimized_by_middleware,
name="optimized_by_middleware", name="optimized_by_middleware",
), ),
path( url(
"optimized-by-decorator/", r"^optimized-by-decorator/$",
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

@ -1,9 +1,9 @@
from django.core.files.base import ContentFile from django.core.files.base import ContentFile
import django.test import django.test
from django.urls import reverse
from django_downloadview import assert_download_response, temporary_media_root from django_downloadview import assert_download_response, temporary_media_root
from demoproject.compat import reverse
from demoproject.object.models import Document from demoproject.object.models import Document
# Fixtures. # Fixtures.

View file

@ -1,27 +1,28 @@
from django.urls import re_path from django.conf.urls import url
from demoproject.compat import patterns
from demoproject.object import views from demoproject.object import views
app_name = "object" urlpatterns = patterns(
urlpatterns = [ "",
re_path( url(
r"^default-file/(?P<slug>[a-zA-Z0-9_-]+)/$", r"^default-file/(?P<slug>[a-zA-Z0-9_-]+)/$",
views.default_file_view, views.default_file_view,
name="default_file", name="default_file",
), ),
re_path( url(
r"^another-file/(?P<slug>[a-zA-Z0-9_-]+)/$", r"^another-file/(?P<slug>[a-zA-Z0-9_-]+)/$",
views.another_file_view, views.another_file_view,
name="another_file", name="another_file",
), ),
re_path( url(
r"^deserialized_basename/(?P<slug>[a-zA-Z0-9_-]+)/$", r"^deserialized_basename/(?P<slug>[a-zA-Z0-9_-]+)/$",
views.deserialized_basename_view, views.deserialized_basename_view,
name="deserialized_basename", name="deserialized_basename",
), ),
re_path( url(
r"^inline-file/(?P<slug>[a-zA-Z0-9_-]+)/$", r"^inline-file/(?P<slug>[a-zA-Z0-9_-]+)/$",
views.inline_file_view, views.inline_file_view,
name="inline_file", name="inline_file",
), ),
] )

View file

@ -1,8 +1,9 @@
import django.test import django.test
from django.urls import reverse
from django_downloadview import assert_download_response from django_downloadview import assert_download_response
from demoproject.compat import reverse
class StaticPathTestCase(django.test.TestCase): class StaticPathTestCase(django.test.TestCase):
def test_download_response(self): def test_download_response(self):

View file

@ -1,13 +1,14 @@
from django.urls import path, re_path from django.conf.urls import url
from demoproject.compat import patterns
from demoproject.path import views from demoproject.path import views
app_name = "path" urlpatterns = patterns(
urlpatterns = [ "",
path("static-path/", views.static_path, name="static_path"), url(r"^static-path/$", views.static_path, name="static_path"),
re_path( url(
r"^dynamic-path/(?P<path>[a-zA-Z0-9_-]+\.[a-zA-Z0-9]{1,4})$", r"^dynamic-path/(?P<path>[a-zA-Z0-9_-]+\.[a-zA-Z0-9]{1,4})$",
views.dynamic_path, views.dynamic_path,
name="dynamic_path", name="dynamic_path",
), ),
] )

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

85
demo/demoproject/settings.py Normal file → Executable file
View file

@ -1,7 +1,8 @@
"""Django settings for django-downloadview demo project.""" """Django settings for django-downloadview demo project."""
from distutils.version import StrictVersion
import os import os
from django.utils.version import get_version
# Configure some relative directories. # Configure some relative directories.
demoproject_dir = os.path.dirname(os.path.abspath(__file__)) demoproject_dir = os.path.dirname(os.path.abspath(__file__))
@ -54,18 +55,30 @@ INSTALLED_APPS = (
"django.contrib.sites", "django.contrib.sites",
"django.contrib.messages", "django.contrib.messages",
"django.contrib.staticfiles", "django.contrib.staticfiles",
# Stuff that must be at the end.
"django_nose",
) )
# BEGIN middlewares # BEGIN middlewares
MIDDLEWARE = [ if StrictVersion(get_version()) >= StrictVersion("1.10"):
"django.middleware.common.CommonMiddleware", MIDDLEWARE = [
"django.contrib.sessions.middleware.SessionMiddleware", "django.middleware.common.CommonMiddleware",
"django.middleware.csrf.CsrfViewMiddleware", "django.contrib.sessions.middleware.SessionMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware", "django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.messages.middleware.MessageMiddleware", "django.contrib.auth.middleware.AuthenticationMiddleware",
"django_downloadview.SmartDownloadMiddleware", "django.contrib.messages.middleware.MessageMiddleware",
] "django_downloadview.SmartDownloadMiddleware",
]
else:
MIDDLEWARE_CLASSES = [
"django.middleware.common.CommonMiddleware",
"django.contrib.sessions.middleware.SessionMiddleware",
"django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
"django_downloadview.SmartDownloadMiddleware",
]
# END middlewares # END middlewares
@ -110,25 +123,37 @@ DOWNLOADVIEW_RULES += [
# Test/development settings. # Test/development settings.
DEBUG = True DEBUG = True
TEST_RUNNER = "django_nose.NoseTestSuiteRunner"
NOSE_ARGS = [
TEMPLATES = [ "--verbosity=2",
{ "--no-path-adjustment",
"BACKEND": "django.template.backends.django.DjangoTemplates", "--nocapture",
"DIRS": [os.path.join(os.path.dirname(__file__), "templates")], "--all-modules",
"OPTIONS": { "--with-coverage",
"debug": DEBUG, "--with-doctest",
"context_processors": [
# Insert your TEMPLATE_CONTEXT_PROCESSORS here or use this
# list if you haven't customized them:
"django.contrib.auth.context_processors.auth",
"django.template.context_processors.debug",
"django.template.context_processors.i18n",
"django.template.context_processors.media",
"django.template.context_processors.static",
"django.template.context_processors.tz",
"django.contrib.messages.context_processors.messages",
],
},
},
] ]
if StrictVersion(get_version()) >= StrictVersion("1.8"):
TEMPLATES = [
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"DIRS": [os.path.join(os.path.dirname(__file__), "templates")],
"OPTIONS": {
"debug": DEBUG,
"context_processors": [
# Insert your TEMPLATE_CONTEXT_PROCESSORS here or use this
# list if you haven't customized them:
"django.contrib.auth.context_processors.auth",
"django.template.context_processors.debug",
"django.template.context_processors.i18n",
"django.template.context_processors.media",
"django.template.context_processors.static",
"django.template.context_processors.tz",
"django.contrib.messages.context_processors.messages",
],
},
},
]
else:
TEMPLATE_DEBUG = DEBUG
TEMPLATE_DIRS = (os.path.join(os.path.dirname(__file__), "templates"),)

View file

@ -4,7 +4,6 @@ import unittest
from django.core.files.base import ContentFile from django.core.files.base import ContentFile
from django.http.response import HttpResponseNotModified from django.http.response import HttpResponseNotModified
import django.test import django.test
from django.urls import reverse
from django_downloadview import ( from django_downloadview import (
assert_download_response, assert_download_response,
@ -12,6 +11,7 @@ from django_downloadview import (
temporary_media_root, temporary_media_root,
) )
from demoproject.compat import reverse
from demoproject.storage import views from demoproject.storage import views
# Fixtures. # Fixtures.
@ -44,7 +44,7 @@ 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 +54,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

@ -1,17 +1,18 @@
from django.urls import re_path from django.conf.urls import url
from demoproject.compat import patterns
from demoproject.storage import views from demoproject.storage import views
app_name = "storage" urlpatterns = patterns(
urlpatterns = [ "",
re_path( url(
r"^static-path/(?P<path>[a-zA-Z0-9_-]+\.[a-zA-Z0-9]{1,4})$", r"^static-path/(?P<path>[a-zA-Z0-9_-]+\.[a-zA-Z0-9]{1,4})$",
views.static_path, views.static_path,
name="static_path", name="static_path",
), ),
re_path( url(
r"^dynamic-path/(?P<path>[a-zA-Z0-9_-]+\.[a-zA-Z0-9]{1,4})$", r"^dynamic-path/(?P<path>[a-zA-Z0-9_-]+\.[a-zA-Z0-9]{1,4})$",
views.dynamic_path, views.dynamic_path,
name="dynamic_path", name="dynamic_path",
), ),
] )

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,7 +1,8 @@
# coding=utf8
"""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 demoproject.compat import reverse
class HomeViewTestCase(TestCase): class HomeViewTestCase(TestCase):

51
demo/demoproject/urls.py Normal file → Executable file
View file

@ -1,44 +1,47 @@
from django.urls import include, path from django.conf.urls import url
from django.views.generic import TemplateView from django.views.generic import TemplateView
from demoproject.compat import include, patterns
home = TemplateView.as_view(template_name="home.html") home = TemplateView.as_view(template_name="home.html")
urlpatterns = [ urlpatterns = patterns(
"",
# ObjectDownloadView. # ObjectDownloadView.
path( url(
"object/", r"^object/",
include("demoproject.object.urls", namespace="object"), include("demoproject.object.urls", app_name="object", namespace="object"),
), ),
# StorageDownloadView. # StorageDownloadView.
path( url(
"storage/", r"^storage/",
include("demoproject.storage.urls", namespace="storage"), include("demoproject.storage.urls", app_name="storage", namespace="storage"),
), ),
# PathDownloadView. # PathDownloadView.
path("path/", include("demoproject.path.urls", namespace="path")), url(r"^path/", include("demoproject.path.urls", app_name="path", namespace="path")),
# HTTPDownloadView. # HTTPDownloadView.
path("http/", include("demoproject.http.urls", namespace="http")), url(r"^http/", include("demoproject.http.urls", app_name="http", namespace="http")),
# VirtualDownloadView. # VirtualDownloadView.
path( url(
"virtual/", r"^virtual/",
include("demoproject.virtual.urls", namespace="virtual"), include("demoproject.virtual.urls", app_name="virtual", namespace="virtual"),
), ),
# Nginx optimizations. # Nginx optimizations.
path( url(
"nginx/", r"^nginx/",
include("demoproject.nginx.urls", namespace="nginx"), include("demoproject.nginx.urls", app_name="nginx", namespace="nginx"),
), ),
# Apache optimizations. # Apache optimizations.
path( url(
"apache/", r"^apache/",
include("demoproject.apache.urls", namespace="apache"), include("demoproject.apache.urls", app_name="apache", namespace="apache"),
), ),
# Lighttpd optimizations. # Lighttpd optimizations.
path( url(
"lighttpd/", r"^lighttpd/",
include("demoproject.lighttpd.urls", namespace="lighttpd"), include("demoproject.lighttpd.urls", app_name="lighttpd", namespace="lighttpd"),
), ),
# An informative homepage. # An informative homepage.
path("", home, name="home"), url(r"$", home, name="home"),
] )

View file

@ -1,8 +1,9 @@
import django.test import django.test
from django.urls import reverse
from django_downloadview import assert_download_response from django_downloadview import assert_download_response
from demoproject.compat import reverse
class TextTestCase(django.test.TestCase): class TextTestCase(django.test.TestCase):
def test_download_response(self): def test_download_response(self):

View file

@ -1,10 +1,11 @@
from django.urls import path from django.conf.urls import url
from demoproject.compat import patterns
from demoproject.virtual import views from demoproject.virtual import views
app_name = "virtual" urlpatterns = patterns(
urlpatterns = [ "",
path("text/", views.TextDownloadView.as_view(), name="text"), url(r"^text/$", views.TextDownloadView.as_view(), name="text"),
path("stringio/", views.StringIODownloadView.as_view(), name="stringio"), url(r"^stringio/$", views.StringIODownloadView.as_view(), name="stringio"),
path("gerenated/", views.GeneratedDownloadView.as_view(), name="generated"), url(r"^gerenated/$", views.GeneratedDownloadView.as_view(), name="generated"),
] )

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,26 +1,46 @@
"""Python packaging."""
import os import os
from setuptools import setup from setuptools import setup
here = os.path.abspath(os.path.dirname(__file__)) here = os.path.abspath(os.path.dirname(__file__))
project_root = os.path.dirname(here)
setup(
name="django-downloadview-demo", NAME = "django-downloadview-demo"
version="1.0", DESCRIPTION = "Serve files with Django and reverse-proxies."
description="Serve files with Django and reverse-proxies.", README = open(os.path.join(here, "README.rst")).read()
long_description=open(os.path.join(here, "README.rst")).read(), VERSION = open(os.path.join(project_root, "VERSION")).read().strip()
classifiers=[ AUTHOR = "Benoît Bryon"
"Development Status :: 5 - Production/Stable", EMAIL = "benoit@marmelune.net"
"License :: OSI Approved :: BSD License", URL = "https://django-downloadview.readthedocs.io/"
"Programming Language :: Python :: 3", CLASSIFIERS = [
"Framework :: Django", "Development Status :: 5 - Production/Stable",
], "License :: OSI Approved :: BSD License",
author="Benoît Bryon", "Programming Language :: Python :: 2.7",
author_email="benoit@marmelune.net", "Framework :: Django",
url="https://django-downloadview.readthedocs.io/", ]
license="BSD", KEYWORDS = []
packages=["demoproject"], PACKAGES = ["demoproject"]
include_package_data=True, REQUIREMENTS = ["django-downloadview", "django-nose"]
zip_safe=False, ENTRY_POINTS = {"console_scripts": ["demo = demoproject.manage:main"]}
install_requires=["django-downloadview", "pytest-django"],
entry_points={"console_scripts": ["demo = demoproject.manage:main"]},
) if __name__ == "__main__": # Don't run setup() when we import this module.
setup(
name=NAME,
version=VERSION,
description=DESCRIPTION,
long_description=README,
classifiers=CLASSIFIERS,
keywords=" ".join(KEYWORDS),
author=AUTHOR,
author_email=EMAIL,
url=URL,
license="BSD",
packages=PACKAGES,
include_package_data=True,
zip_safe=False,
install_requires=REQUIREMENTS,
entry_points=ENTRY_POINTS,
)

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

@ -70,7 +70,7 @@ def signature_required(function):
@wraps(function) @wraps(function)
def decorator(request, *args, **kwargs): def decorator(request, *args, **kwargs):
_signature_is_valid(request) _signature_is_valid()
return function(request, *args, **kwargs) return function(request, *args, **kwargs)
return decorator return decorator

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,8 +1,7 @@
"""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_text
class TextIteratorIO(io.TextIOBase): class TextIteratorIO(io.TextIOBase):
@ -33,7 +32,7 @@ class TextIteratorIO(io.TextIOBase):
break break
else: else:
# Make sure we handle text. # Make sure we handle text.
self._left = force_str(self._left) self._left = force_text(self._left)
ret = self._left[:n] ret = self._left[:n]
self._left = self._left[len(ret) :] self._left = self._left[len(ret) :]
return ret return ret

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,8 +4,7 @@ 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
import collections.abc
import copy import copy
import os import os
@ -15,6 +14,14 @@ from django.core.exceptions import ImproperlyConfigured
from django_downloadview.response import DownloadResponse from django_downloadview.response import DownloadResponse
from django_downloadview.utils import import_member from django_downloadview.utils import import_member
try:
from django.utils.deprecation import MiddlewareMixin
except ImportError:
class MiddlewareMixin(object):
def __init__(self, get_response=None):
super(MiddlewareMixin, self).__init__()
#: Sentinel value to detect whether configuration is to be loaded from Django #: Sentinel value to detect whether configuration is to be loaded from Django
#: settings or not. #: settings or not.
@ -31,20 +38,13 @@ def is_download_response(response):
return isinstance(response, DownloadResponse) return isinstance(response, DownloadResponse)
class BaseDownloadMiddleware: class BaseDownloadMiddleware(MiddlewareMixin):
"""Base (abstract) Django middleware that handles download responses. """Base (abstract) Django middleware that handles download responses.
Subclasses **must** implement :py:meth:`process_download_response` method. Subclasses **must** implement :py:meth:`process_download_response` method.
""" """
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
response = self.get_response(request)
return self.process_response(request, response)
def is_download_response(self, response): def is_download_response(self, response):
"""Return True if ``response`` can be considered as a file download. """Return True if ``response`` can be considered as a file download.
@ -77,13 +77,21 @@ 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 DownloadDispatcherMiddleware(BaseDownloadMiddleware):
def __init__(self, middlewares=AUTO_CONFIGURE): "Download middleware that dispatches job to several middleware instances."
def __init__(self, get_response=None, middlewares=AUTO_CONFIGURE):
super(DownloadDispatcherMiddleware, self).__init__(get_response)
#: List of children middlewares. #: List of children middlewares.
self.middlewares = middlewares self.middlewares = middlewares
if self.middlewares is AUTO_CONFIGURE: if self.middlewares is AUTO_CONFIGURE:
@ -92,48 +100,40 @@ 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)
middleware = factory(**kwargs) middleware = factory(**kwargs)
self.middlewares.append((key, middleware)) self.middlewares.append((key, middleware))
def dispatch(self, request, response): def process_download_response(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
class DownloadDispatcherMiddleware(BaseDownloadMiddleware): class SmartDownloadMiddleware(BaseDownloadMiddleware):
"Download middleware that dispatches job to several middleware instances."
def __init__(self, get_response, middlewares=AUTO_CONFIGURE):
super().__init__(get_response)
self.dispatcher = DownloadDispatcher(middlewares)
def process_download_response(self, request, response):
return self.dispatcher.dispatch(request, response)
class SmartDownloadMiddleware(DownloadDispatcherMiddleware):
"""Easy to configure download middleware.""" """Easy to configure download middleware."""
def __init__( def __init__(
self, self,
get_response, get_response=None,
backend_factory=AUTO_CONFIGURE, backend_factory=AUTO_CONFIGURE,
backend_options=AUTO_CONFIGURE, backend_options=AUTO_CONFIGURE,
): ):
"""Constructor.""" """Constructor."""
super().__init__(get_response, middlewares=[]) super(SmartDownloadMiddleware, self).__init__(get_response)
#: Callable (typically a class) to instantiate backend (typically a #: :class:`DownloadDispatcher` instance that can hold multiple
#: backend instances.
self.dispatcher = DownloadDispatcherMiddleware(middlewares=[])
#: Callable (typically a class) to instanciate backend (typically a
#: :class:`DownloadMiddleware` subclass). #: :class:`DownloadMiddleware` subclass).
self.backend_factory = backend_factory self.backend_factory = backend_factory
if self.backend_factory is AUTO_CONFIGURE: if self.backend_factory is AUTO_CONFIGURE:
self.auto_configure_backend_factory() self.auto_configure_backend_factory()
#: List of positional or keyword arguments to instantiate backend #: List of positional or keyword arguments to instanciate backend
#: instances. #: instances.
self.backend_options = backend_options self.backend_options = backend_options
if self.backend_options is AUTO_CONFIGURE: if self.backend_options is AUTO_CONFIGURE:
@ -145,7 +145,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,12 +155,12 @@ 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 = []
kwargs = {} kwargs = {}
if isinstance(options, collections.abc.Mapping): # Using kwargs. if isinstance(options, collections.Mapping): # Using kwargs.
kwargs = options kwargs = options
else: else:
args = options args = options
@ -172,6 +172,10 @@ class SmartDownloadMiddleware(DownloadDispatcherMiddleware):
middleware_instance = factory(*args, **kwargs) middleware_instance = factory(*args, **kwargs)
self.dispatcher.middlewares.append((key, middleware_instance)) self.dispatcher.middlewares.append((key, middleware_instance))
def process_download_response(self, request, response):
"""Use :attr:`dispatcher` to process download response."""
return self.dispatcher.process_download_response(request, response)
class NoRedirectionMatch(Exception): class NoRedirectionMatch(Exception):
"""Response object does not match redirection rules.""" """Response object does not match redirection rules."""
@ -181,10 +185,10 @@ class ProxiedDownloadMiddleware(RealDownloadMiddleware):
"""Base class for middlewares that use optimizations of reverse proxies.""" """Base class for middlewares that use optimizations of reverse proxies."""
def __init__( def __init__(
self, get_response, source_dir=None, source_url=None, destination_url=None self, get_response=None, 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):
@ -125,13 +125,11 @@ class DownloadResponseValidator(object):
check_ascii = True check_ascii = True
if check_ascii: if check_ascii:
test_case.assertIn( test_case.assertIn(
f'filename="{ascii_name}"', f'filename="{ascii_name}"', response["Content-Disposition"],
response["Content-Disposition"],
) )
if check_utf8: if check_utf8:
test_case.assertIn( test_case.assertIn(
f"filename*=UTF-8''{utf8_name}", f"filename*=UTF-8''{utf8_name}", response["Content-Disposition"],
response["Content-Disposition"],
) )
def assert_content_type(self, test_case, response, value): def assert_content_type(self, test_case, response, value):

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

@ -19,8 +19,8 @@ optimizations.
* :doc:`/about/alternatives` * :doc:`/about/alternatives`
* `roadmap * `roadmap
<https://github.com/jazzband/django-downloadview/milestones>`_ <https://github.com/benoitbryon/django-downloadview/milestones>`_
.. target-notes:: .. target-notes::
.. _`Django`: https://www.djangoproject.com .. _`Django`: https://djangoproject.com

View file

@ -1,14 +1,14 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
"""django-downloadview documentation build configuration file.""" """django-downloadview documentation build configuration file."""
import os
import re import re
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...
from django.conf import settings from django.conf import settings
settings.configure( settings.configure(
DATABASES={}, # Required to load ``django.views.generic``. DATABASES={}, # Required to load ``django.views.generic``.
) )
@ -18,58 +18,63 @@ settings.configure(
# Extensions. # Extensions.
extensions = [ extensions = [
"sphinx.ext.autodoc", 'sphinx.ext.autodoc',
"sphinx.ext.autosummary", 'sphinx.ext.autosummary',
"sphinx.ext.doctest", 'sphinx.ext.doctest',
"sphinx.ext.coverage", 'sphinx.ext.coverage',
"sphinx.ext.intersphinx", 'sphinx.ext.intersphinx',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"] templates_path = ['_templates']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = ".txt" source_suffix = '.txt'
# The encoding of source files. # The encoding of source files.
source_encoding = "utf-8" source_encoding = 'utf-8'
# The master toctree document. # The master toctree document.
master_doc = "index" master_doc = 'index'
# General information about the project. # General information about the project.
project = "django-downloadview" project = u'django-downloadview'
project_slug = re.sub(r"([\w_.-]+)", "-", project) project_slug = re.sub(r'([\w_.-]+)', u'-', project)
copyright = "2012-2015, Benoît Bryon" copyright = u'2012-2015, Benoît Bryon'
author = "Benoît Bryon" author = u'Benoît Bryon'
author_slug = re.sub(r"([\w_.-]+)", "-", author) author_slug = re.sub(r'([\w_.-]+)', u'-', author)
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
configuration_dir = os.path.dirname(__file__)
documentation_dir = configuration_dir
version_file = os.path.normpath(os.path.join(
documentation_dir,
'../VERSION'))
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = importlib.metadata.version("django-downloadview") release = open(version_file).read().strip()
# The short X.Y version. # The short X.Y version.
version = ".".join(release.split(".")[:2]) version = '.'.join(release.split('.')[0:1])
# 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.
language = "en" language = 'en'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
exclude_patterns = ["_build"] exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx" pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = "alabaster" html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
@ -78,22 +83,23 @@ html_static_path = []
# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names.
html_sidebars = { html_sidebars = {
"**": ["globaltoc.html", "relations.html", "sourcelink.html", "searchbox.html"], '**': ['globaltoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html'],
} }
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = "{project}doc".format(project=project_slug) htmlhelp_basename = u'{project}doc'.format(project=project_slug)
# -- Options for sphinx.ext.intersphinx --------------------------------------- # -- Options for sphinx.ext.intersphinx ---------------------------------------
intersphinx_mapping = { intersphinx_mapping = {
"python": ("https://docs.python.org/3", None), 'python': ('http://docs.python.org/2.7', None),
"django": ( 'django': ('http://docs.djangoproject.com/en/1.8/',
"https://docs.djangoproject.com/en/3.1/", 'http://docs.djangoproject.com/en/1.8/_objects/'),
"https://docs.djangoproject.com/en/3.1/_objects/", 'requests': ('http://docs.python-requests.org/en/latest/', None),
),
"requests": ("https://requests.readthedocs.io/en/master/", None),
} }
@ -105,13 +111,11 @@ latex_elements = {}
# (source start file, target name, title, author, documentclass # (source start file, target name, title, author, documentclass
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
( ('index',
"index", u'{project}.tex'.format(project=project_slug),
"{project}.tex".format(project=project_slug), u'{project} Documentation'.format(project=project),
"{project} Documentation".format(project=project), author,
author, 'manual'),
"manual",
),
] ]
@ -120,7 +124,11 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
("index", project, "{project} Documentation".format(project=project), [author], 1) ('index',
project,
u'{project} Documentation'.format(project=project),
[author],
1)
] ]
@ -130,13 +138,11 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
( ('index',
"index", project_slug,
project_slug, u'{project} Documentation'.format(project=project),
"{project} Documentation".format(project=project), author,
author, project,
project, 'One line description of project.',
"One line description of project.", 'Miscellaneous'),
"Miscellaneous",
),
] ]

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
@ -54,4 +54,4 @@ API reference
.. _`django-sendfile`: http://pypi.python.org/pypi/django-sendfile .. _`django-sendfile`: http://pypi.python.org/pypi/django-sendfile
.. _`django-downloadview's bugtracker`: .. _`django-downloadview's bugtracker`:
https://github.com/jazzband/django-downloadview/issues https://github.com/benoitbryon/django-downloadview/issues

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

@ -87,6 +87,6 @@ Here are optimizations builtin `django_downloadview`:
.. target-notes:: .. target-notes::
.. _`tell us`: .. _`tell us`:
https://github.com/jazzband/django-downloadview/issues?labels=optimizations https://github.com/benoitbryon/django-downloadview/issues?labels=optimizations
.. _`a feature request about "local cache" for streamed files`: .. _`a feature request about "local cache" for streamed files`:
https://github.com/jazzband/django-downloadview/issues/70 https://github.com/benoitbryon/django-downloadview/issues/70

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:
@ -137,4 +137,4 @@ setup.
.. _`Lighttpd X-Sendfile documentation`: .. _`Lighttpd X-Sendfile documentation`:
http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file
.. _`X-Sendfile2 feature request on django_downloadview's bugtracker`: .. _`X-Sendfile2 feature request on django_downloadview's bugtracker`:
https://github.com/jazzband/django-downloadview/issues/67 https://github.com/benoitbryon/django-downloadview/issues/67

View file

@ -28,7 +28,7 @@ Let's consider the following view:
.. literalinclude:: /../demo/demoproject/nginx/views.py .. literalinclude:: /../demo/demoproject/nginx/views.py
:language: python :language: python
:lines: 1-6, 8-17 :lines: 1-6, 8-16
What is important here is that the files will have an ``url`` property What is important here is that the files will have an ``url`` property
implemented by storage. Let's setup an optimization rule based on that URL. implemented by storage. Let's setup an optimization rule based on that URL.
@ -46,26 +46,26 @@ Setup XAccelRedirect 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:
.. literalinclude:: /../demo/demoproject/settings.py .. literalinclude:: /../demo/demoproject/settings.py
:language: python :language: python
:lines: 62-69 :lines: 63-70
Then set ``django_downloadview.nginx.XAccelRedirectMiddleware`` as Then set ``django_downloadview.nginx.XAccelRedirectMiddleware`` as
``DOWNLOADVIEW_BACKEND``: ``DOWNLOADVIEW_BACKEND``:
.. literalinclude:: /../demo/demoproject/settings.py .. literalinclude:: /../demo/demoproject/settings.py
:language: python :language: python
:lines: 75 :lines: 76
Then register as many ``DOWNLOADVIEW_RULES`` as you wish: Then register as many ``DOWNLOADVIEW_RULES`` as you wish:
.. literalinclude:: /../demo/demoproject/settings.py .. literalinclude:: /../demo/demoproject/settings.py
:language: python :language: python
:lines: 83-88 :lines: 84-89
Each item in ``DOWNLOADVIEW_RULES`` is a dictionary of keyword arguments passed Each item in ``DOWNLOADVIEW_RULES`` is a dictionary of keyword arguments passed
to the middleware factory. In the example above, we capture responses by to the middleware factory. In the example above, we capture responses by
@ -183,7 +183,7 @@ Add ``charset utf-8;`` in your nginx configuration file.
``open() "path/to/something" failed (2: No such file or directory)`` ``open() "path/to/something" failed (2: No such file or directory)``
==================================================================== ====================================================================
Check your ``settings.NGINX_DOWNLOAD_MIDDLEWARE_SOURCE_DIR`` in Django Check your ``settings.NGINX_DOWNLOAD_MIDDLEWARE_MEDIA_ROOT`` in Django
configuration VS ``alias`` in nginx configuration: in a standard configuration, configuration VS ``alias`` in nginx configuration: in a standard configuration,
they should be equal. they should be equal.

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

@ -87,7 +87,7 @@ Modified" response:
class TextDownloadView(VirtualDownloadView): class TextDownloadView(VirtualDownloadView):
def get_file(self): def get_file(self):
"""Return :class:`django.core.files.base.ContentFile` object.""" """Return :class:`django.core.files.base.ContentFile` object."""
return ContentFile("Hello world!", name='hello-world.txt') return ContentFile(u"Hello world!", name='hello-world.txt')
def was_modified_since(self, file_instance, since): def was_modified_since(self, file_instance, since):
return False # Never modified, always "Hello world!". return False # Never modified, always u"Hello world!".

View file

@ -30,7 +30,7 @@ Setup a view to stream the ``file`` attribute:
.. literalinclude:: /../demo/demoproject/object/views.py .. literalinclude:: /../demo/demoproject/object/views.py
:language: python :language: python
:lines: 1-6 :lines: 1-5, 7
:class:`~django_downloadview.views.object.ObjectDownloadView` inherits from :class:`~django_downloadview.views.object.ObjectDownloadView` inherits from
:class:`~django.views.generic.detail.BaseDetailView`, i.e. it expects either :class:`~django.views.generic.detail.BaseDetailView`, i.e. it expects either
@ -38,7 +38,7 @@ Setup a view to stream the ``file`` attribute:
.. literalinclude:: /../demo/demoproject/object/urls.py .. literalinclude:: /../demo/demoproject/object/urls.py
:language: python :language: python
:lines: 1-7, 8-11, 27 :lines: 1-7, 8-10, 20
************ ************
@ -69,7 +69,7 @@ Then here is the code to serve "another_file" instead of the default "file":
.. literalinclude:: /../demo/demoproject/object/views.py .. literalinclude:: /../demo/demoproject/object/views.py
:language: python :language: python
:lines: 1-4, 8-11 :lines: 1-5, 10-12
********************************** **********************************
@ -90,7 +90,7 @@ Then you can configure the :attr:`ObjectDownloadView.basename_field` option:
.. literalinclude:: /../demo/demoproject/object/views.py .. literalinclude:: /../demo/demoproject/object/views.py
:language: python :language: python
:lines: 1-4, 13-17 :lines: 1-5, 16-18
.. note:: .. note::

View file

@ -24,8 +24,8 @@ Setup a view to stream files given path:
.. literalinclude:: /../demo/demoproject/path/views.py .. literalinclude:: /../demo/demoproject/path/views.py
:language: python :language: python
:lines: 1-13 :lines: 1-14
:emphasize-lines: 13 :emphasize-lines: 14
************ ************
@ -54,7 +54,7 @@ via URLconfs:
.. literalinclude:: /../demo/demoproject/path/urls.py .. literalinclude:: /../demo/demoproject/path/urls.py
:language: python :language: python
:lines: 1-13 :lines: 1-7, 11-13, 14
************* *************

View file

@ -18,20 +18,20 @@ Given a storage:
.. literalinclude:: /../demo/demoproject/storage/views.py .. literalinclude:: /../demo/demoproject/storage/views.py
:language: python :language: python
:lines: 1, 4-5 :lines: 1, 4-6
Setup a view to stream files in storage: Setup a view to stream files in storage:
.. literalinclude:: /../demo/demoproject/storage/views.py .. literalinclude:: /../demo/demoproject/storage/views.py
:language: python :language: python
:lines: 3-6, 8-9 :lines: 3-5, 10
The view accepts a ``path`` argument you can setup either in ``as_view`` or The view accepts a ``path`` argument you can setup either in ``as_view`` or
via URLconfs: via URLconfs:
.. literalinclude:: /../demo/demoproject/storage/urls.py .. literalinclude:: /../demo/demoproject/storage/urls.py
:language: python :language: python
:lines: 1-6, 7-11, 17 :lines: 1-7, 8-10, 14
************ ************
@ -56,7 +56,7 @@ uppercase:
.. literalinclude:: /../demo/demoproject/storage/views.py .. literalinclude:: /../demo/demoproject/storage/views.py
:language: python :language: python
:lines: 3-5, 11-20 :lines: 3-5, 13-20
************* *************

149
setup.py
View file

@ -1,67 +1,94 @@
#!/usr/bin/env python
"""Python packaging."""
import os import os
import sys
from setuptools import setup from setuptools import setup
from setuptools.command.test import test as TestCommand
class Tox(TestCommand):
"""Test command that runs tox."""
def finalize_options(self):
TestCommand.finalize_options(self)
self.test_args = []
self.test_suite = True
def run_tests(self):
import tox # import here, cause outside the eggs aren't loaded.
errno = tox.cmdline(self.test_args)
sys.exit(errno)
#: Absolute path to directory containing setup.py file. #: Absolute path to directory containing setup.py file.
here = os.path.abspath(os.path.dirname(__file__)) here = os.path.abspath(os.path.dirname(__file__))
setup(
name="django-downloadview", NAME = 'django-downloadview'
use_scm_version={"version_scheme": "post-release"}, DESCRIPTION = 'Serve files with Django and reverse-proxies.'
setup_requires=["setuptools_scm"], README = open(os.path.join(here, 'README.rst')).read()
description="Serve files with Django and reverse-proxies.", VERSION = open(os.path.join(here, 'VERSION')).read().strip()
long_description=open(os.path.join(here, "README.rst")).read(), AUTHOR = u'Benoît Bryon'
long_description_content_type="text/x-rst", EMAIL = 'benoit@marmelune.net'
classifiers=[ LICENSE = 'BSD'
"Development Status :: 5 - Production/Stable", URL = 'https://{name}.readthedocs.io/'.format(name=NAME)
"License :: OSI Approved :: BSD License", CLASSIFIERS = [
"Programming Language :: Python :: 3 :: Only", 'Development Status :: 5 - Production/Stable',
"Programming Language :: Python :: 3.8", 'Framework :: Django',
"Programming Language :: Python :: 3.9", 'License :: OSI Approved :: BSD License',
"Programming Language :: Python :: 3.10", 'Programming Language :: Python :: 3 :: Only',
"Programming Language :: Python :: 3.11", 'Programming Language :: Python :: 3.6',
"Programming Language :: Python :: 3.12", 'Programming Language :: Python :: 3.7',
"Programming Language :: Python :: 3.13", 'Programming Language :: Python :: 3.8',
"Programming Language :: Python :: 3.14", ]
"Framework :: Django", KEYWORDS = ['file',
"Framework :: Django :: 4.2", 'stream',
"Framework :: Django :: 5.0", 'download',
], 'FileField',
keywords=" ".join( 'ImageField',
[ 'x-accel',
"file", 'x-accel-redirect',
"stream", 'x-sendfile',
"download", 'sendfile',
"FileField", 'mod_xsendfile',
"ImageField", 'offload']
"x-accel", PACKAGES = [NAME.replace('-', '_')]
"x-accel-redirect", REQUIREMENTS = [
"x-sendfile", # BEGIN requirements
"sendfile", 'Django>=1.11',
"mod_xsendfile", 'requests',
"offload", 'setuptools',
] # END requirements
), ]
author="Benoît Bryon", ENTRY_POINTS = {}
author_email="benoit@marmelune.net", SETUP_REQUIREMENTS = ['setuptools']
url="https://django-downloadview.readthedocs.io/", TEST_REQUIREMENTS = ['tox']
license="BSD", CMDCLASS = {'test': Tox}
packages=[ EXTRA_REQUIREMENTS = {
"django_downloadview", 'test': TEST_REQUIREMENTS,
"django_downloadview.apache", }
"django_downloadview.lighttpd",
"django_downloadview.nginx",
"django_downloadview.views", if __name__ == '__main__': # Don't run setup() when we import this module.
], setup(
include_package_data=True, name=NAME,
zip_safe=False, version=VERSION,
python_requires=">=3.8", description=DESCRIPTION,
install_requires=[ long_description=README,
# BEGIN requirements classifiers=CLASSIFIERS,
"Django>=4.2", keywords=' '.join(KEYWORDS),
"requests", author=AUTHOR,
# END requirements author_email=EMAIL,
], url=URL,
extras_require={ license=LICENSE,
"test": ["tox"], packages=PACKAGES,
}, include_package_data=True,
) zip_safe=False,
install_requires=REQUIREMENTS,
entry_points=ENTRY_POINTS,
tests_require=TEST_REQUIREMENTS,
cmdclass=CMDCLASS,
setup_requires=SETUP_REQUIREMENTS,
extras_require=EXTRA_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,15 +24,37 @@ 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),
) )
def test_version_file(self):
"""django_downloadview.__version__ matches VERSION file info."""
version_file = os.path.join(project_dir, "VERSION")
file_version = open(version_file).read().strip()
self.assertEqual(
file_version,
self.get_version(),
"Version mismatch: django_downloadview.__version__ "
'is "%s" whereas VERSION file tells "%s". '
"You may need to run ``make develop`` to update the "
"installed version in development environment."
% (self.get_version(), file_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
@ -11,22 +10,10 @@ class DownloadResponseTestCase(unittest.TestCase):
def test_content_disposition_encoding(self): def test_content_disposition_encoding(self):
"""Content-Disposition header is encoded.""" """Content-Disposition header is encoded."""
response = DownloadResponse( response = DownloadResponse(
"fake file", "fake file", attachment=True, basename="espacé .txt",
attachment=True,
basename="espacé .txt",
) )
headers = response.default_headers headers = response.default_headers
self.assertIn('filename="espace_.txt"', headers["Content-Disposition"]) self.assertIn('filename="espace_.txt"', headers["Content-Disposition"])
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
@ -302,7 +303,9 @@ class VirtualDownloadViewTestCase(unittest.TestCase):
:py:class:`django_downloadview.views.VirtualDownloadView`.""" :py:class:`django_downloadview.views.VirtualDownloadView`."""
def test_was_modified_since_specific(self): def test_was_modified_since_specific(self):
"""VirtualDownloadView.was_modified_since() delegates to file wrapper.""" """VirtualDownloadView.was_modified_since() delegates to file wrapper.
"""
file_wrapper = mock.Mock() file_wrapper = mock.Mock()
file_wrapper.was_modified_since = mock.Mock( file_wrapper.was_modified_since = mock.Mock(
return_value=mock.sentinel.from_file_wrapper return_value=mock.sentinel.from_file_wrapper

89
tox.ini
View file

@ -1,63 +1,35 @@
[tox] [tox]
envlist = envlist = py{35,36,36,37,38}-django{111,22,30},
py{38,39,310,311,312}-dj{42}-{unittest,pytest,checkmigrations} flake8, sphinx, readme
py{310,311,312,313}-dj{50}-{unittest,pytest,checkmigrations}
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
sphinx
readme
[gh-actions] [travis]
python = python=
3.8: py38, lint, sphinx, readme 3.8: py38, flake8, sphinx, readme
3.9: py39
3.10: py310
3.11: py311
3.12: py312
3.13: py313
3.14: py314
[gh-actions:env]
DJANGO =
4.2: dj42
5.0: dj50
5.1: dj51
5.2: dj52
main: djmain
[testenv] [testenv]
deps = deps =
coverage coverage
dj42: Django>=4.2,<5.0 django111: Django>=1.11,<2.0
dj50: Django>=5.0,<5.1 django22: Django>=2.2,<3.0
dj51: django>=5.1,<5.2 django30: Django>=3.0,<3.1
dj52: django>=5.2,<5.3 nose
djmain: https://github.com/django/django/archive/main.tar.gz py27: mock
pytest
pytest-cov
commands = commands =
pip install -e . pip install -e .
pip install -e demo pip install -e demo
# doctests and unit tests python -Wd {envbindir}/demo test --cover-package=django_downloadview --cover-package=demoproject {posargs: tests demoproject}
pytest --cov=django_downloadview --cov=demoproject {posargs} coverage erase
# demo project integration tests
coverage run --append {envbindir}/demo test {posargs: demoproject}
coverage xml
pip freeze pip freeze
ignore_outcome =
djmain: True
[testenv:lint] [testenv:flake8]
deps = deps =
flake8 flake8
black black
isort isort
commands = commands =
flake8 demo django_downloadview tests flake8 demo django_downloadview tests
black --check demo django_downloadview tests black --check demo django_downloadview tests
isort --check-only --recursive demo django_downloadview tests isort --check-only --recursive demo django_downloadview tests
[testenv:sphinx] [testenv:sphinx]
deps = deps =
@ -69,20 +41,23 @@ whitelist_externals =
make make
[testenv:readme] [testenv:readme]
description = Ensure README renders on PyPI deps =
deps = twine docutils
pygments
commands = commands =
{envpython} setup.py -q sdist bdist_wheel mkdir -p var/docs
twine check dist/* rst2html.py --exit-status=2 README.rst var/docs/README.html
rst2html.py --exit-status=2 CONTRIBUTING.rst var/docs/CONTRIBUTING.html
whitelist_externals =
mkdir
[testenv:release]
deps =
wheel
zest.releaser
commands =
fullrelease
[flake8] [flake8]
max-line-length = 88 max-line-length = 88
ignore = E203, W503 ignore = E203, W503
[coverage:run]
source = django_downloadview,demo
[pytest]
DJANGO_SETTINGS_MODULE = demoproject.settings
addopts = --doctest-modules --ignore=docs/
python_files = tests/*.py