Make media URLs stable and cacheable, add real image thumbnails
Signed media URLs embedded the current second (TimestampSigner), so every API response re-minted every raw/thumbnail/staged URL and the browser re-downloaded each file on every poll or navigation. Responses also carried no cache headers at all. - sign with a plain Signer plus a bucket-quantized exp (7d TTL, 24h bucket), so a URL is byte-identical across responses and rotates once a day; legacy TimestampSigner URLs stay accepted for one release - add a v=<md5> version parameter to library media URLs so replacing a file under the same J-ID (the optimize flow) busts caches exactly when needed - serve_file now sends ETag/Last-Modified and a private Cache-Control and answers conditional requests with 304; library media gets max-age 6d + immutable, staged/similarity files 1h - build cached 480px JPEG thumbnails for images (Pillow, keyed by MD5 under MEDIA_ROOT/thumbs) instead of serving full-size originals through the thumbnail endpoint; the library grid uses thumbnail_url for images too
This commit is contained in:
@@ -6,16 +6,20 @@ import os
|
||||
import re
|
||||
import shutil
|
||||
import subprocess
|
||||
from datetime import datetime, timezone
|
||||
from pathlib import Path
|
||||
from urllib.parse import urlencode
|
||||
|
||||
import imagehash
|
||||
from django.conf import settings
|
||||
from django.core import signing
|
||||
from django.http import FileResponse, Http404, HttpResponse
|
||||
from django.utils.cache import get_conditional_response
|
||||
from django.utils.http import http_date
|
||||
from django.utils.text import get_valid_filename
|
||||
from PIL import Image
|
||||
from PIL import Image, ImageOps
|
||||
|
||||
from .models import MediaItem, MediaLocation
|
||||
from .signing_urls import sign_payload
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
@@ -37,6 +41,11 @@ UPLOAD_FILE_SALT = "j621.upload-file"
|
||||
MEDIA_FILE_SALT = "j621.media-file"
|
||||
CHUNK_SIZE = 1024 * 1024
|
||||
RANGE_RE = re.compile(r"bytes=(\d*)-(\d*)$")
|
||||
# Versioned media URLs are immutable, so they may sit in the browser cache for
|
||||
# as long as the signature is guaranteed to stay valid (7 days).
|
||||
MEDIA_CACHE_SECONDS = 6 * 86400
|
||||
# Staged uploads and similarity files can be deleted at any moment.
|
||||
TEMP_CACHE_SECONDS = 3600
|
||||
|
||||
|
||||
def compute_md5(path):
|
||||
@@ -78,14 +87,24 @@ def signed_media_url(item, user, action="raw", request=None):
|
||||
|
||||
With a ``request`` the URL is absolute, so the SPA also works when it is
|
||||
served from a different origin; without one it stays relative.
|
||||
|
||||
The ``v`` parameter is the item's MD5: it busts the browser cache exactly
|
||||
when the file is replaced (the optimize flow rewrites files under the same
|
||||
J-ID), which is what lets the URL be cached for days instead of re-minted
|
||||
on every response.
|
||||
"""
|
||||
path = f"/api/files/J-{item.id}/{action}/"
|
||||
params = {}
|
||||
if user is not None and getattr(user, "is_authenticated", False):
|
||||
signature = signing.dumps(
|
||||
{"item": item.id, "user": user.id, "action": action},
|
||||
salt=MEDIA_FILE_SALT,
|
||||
)
|
||||
path = f"{path}?sig={signature}"
|
||||
params = {
|
||||
"v": item.md5,
|
||||
"sig": sign_payload(
|
||||
{"item": item.id, "user": user.id, "action": action},
|
||||
MEDIA_FILE_SALT,
|
||||
),
|
||||
}
|
||||
if params:
|
||||
path = f"{path}?{urlencode(params)}"
|
||||
if request is None:
|
||||
return path
|
||||
return request.build_absolute_uri(path)
|
||||
@@ -207,12 +226,36 @@ class RangeFileWrapper:
|
||||
self.file.close()
|
||||
|
||||
|
||||
def serve_file(request, path, download=False):
|
||||
"""Serve a file with HTTP range support (needed for video seeking)."""
|
||||
def _apply_cache_headers(response, cache_control, etag, mtime):
|
||||
response["Cache-Control"] = cache_control
|
||||
response["ETag"] = etag
|
||||
response["Last-Modified"] = http_date(mtime)
|
||||
return response
|
||||
|
||||
|
||||
def serve_file(request, path, download=False, *, max_age=TEMP_CACHE_SECONDS, immutable=False):
|
||||
"""Serve a file with HTTP range support (needed for video seeking).
|
||||
|
||||
Responses carry validators (ETag/Last-Modified) and a private
|
||||
``Cache-Control`` so browsers reuse media instead of re-downloading it on
|
||||
every SPA poll. ``max_age``/``immutable`` are chosen by the caller: versioned
|
||||
library media can be cached hard, staged files only briefly.
|
||||
"""
|
||||
path = Path(path)
|
||||
if not path.is_file():
|
||||
raise Http404
|
||||
size = path.stat().st_size
|
||||
stat = path.stat()
|
||||
size = stat.st_size
|
||||
etag = f'W/"{size:x}-{stat.st_mtime_ns:x}"'
|
||||
last_modified = datetime.fromtimestamp(stat.st_mtime, tz=timezone.utc)
|
||||
conditional = get_conditional_response(
|
||||
request, etag=etag, last_modified=last_modified
|
||||
)
|
||||
if conditional is not None:
|
||||
return conditional
|
||||
cache_control = f"private, max-age={int(max_age)}"
|
||||
if immutable:
|
||||
cache_control += ", immutable"
|
||||
content_type = mimetypes.guess_type(str(path))[0] or "application/octet-stream"
|
||||
range_header = request.headers.get("Range", "").strip()
|
||||
if range_header:
|
||||
@@ -240,7 +283,9 @@ def serve_file(request, path, download=False):
|
||||
response["Content-Length"] = str(length)
|
||||
response["Content-Range"] = f"bytes {start}-{end}/{size}"
|
||||
response["Accept-Ranges"] = "bytes"
|
||||
return response
|
||||
return _apply_cache_headers(
|
||||
response, cache_control, etag, stat.st_mtime
|
||||
)
|
||||
response = FileResponse(
|
||||
open(path, "rb"),
|
||||
content_type=content_type,
|
||||
@@ -248,7 +293,7 @@ def serve_file(request, path, download=False):
|
||||
filename=path.name,
|
||||
)
|
||||
response["Accept-Ranges"] = "bytes"
|
||||
return response
|
||||
return _apply_cache_headers(response, cache_control, etag, stat.st_mtime)
|
||||
|
||||
|
||||
class DownloadCancelled(Exception):
|
||||
@@ -465,3 +510,31 @@ def generate_video_thumbnail(md5, path):
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return None
|
||||
return target if target.exists() else None
|
||||
|
||||
|
||||
def generate_image_thumbnail(md5, path):
|
||||
"""Downscale an image, cached under MEDIA_ROOT/thumbs like video thumbs.
|
||||
|
||||
The thumbnail action used to serve full-size originals for images; a
|
||||
cached 480px JPEG keeps the library grid light without touching the
|
||||
original file. Returns ``None`` when Pillow cannot decode the format, so
|
||||
callers can fall back to the original.
|
||||
"""
|
||||
thumbs_dir = Path(settings.MEDIA_ROOT) / "thumbs"
|
||||
thumbs_dir.mkdir(parents=True, exist_ok=True)
|
||||
target = thumbs_dir / f"{md5}.jpg"
|
||||
if target.exists() and target.stat().st_mtime >= os.path.getmtime(path):
|
||||
return target
|
||||
try:
|
||||
with Image.open(path) as image:
|
||||
# Animated formats: the first frame is the preview.
|
||||
image.seek(0)
|
||||
frame = ImageOps.exif_transpose(image) or image
|
||||
frame = frame.convert("RGB")
|
||||
frame.thumbnail((480, 480))
|
||||
frame.save(target, "JPEG", quality=82, optimize=True)
|
||||
except Exception: # noqa: BLE001 - previews must never break serving
|
||||
logger.exception("Could not build an image thumbnail for %s", path)
|
||||
target.unlink(missing_ok=True)
|
||||
return None
|
||||
return target if target.exists() else None
|
||||
|
||||
Reference in New Issue
Block a user