Files
Evection/apps/accounts/middleware.py
T
ksmithandClaude Sonnet 5 7577110238 Add the PWA layer: manifest, service worker, icons, offline page
Implements installable-PWA support per the plan: a manifest.webmanifest
view (name/short_name "Evection", standalone display, 192/512/maskable
icons), a service worker served at domain root (/sw.js, with
Service-Worker-Allowed: / so its scope covers the whole app, not just
/static/), and an offline fallback page.

The service worker ignores all non-GET requests outright (so mutations
like mark-read/star/OPML upload stay network-only without special-
casing every endpoint), does network-first-with-cache-fallback for
navigations (bounded to the 60 most recently viewed pages, trimmed
oldest-first), and cache-first for /static/ assets, with the cache
name keyed by EVECTION_PWA_CACHE_VERSION so a deploy can invalidate
old caches. Per the earlier decision, embedded remote images in
article content are not cached for offline reading — text/HTML only.

Generates a simple RSS-glyph icon set (192/512/maskable/apple-touch)
with a throwaway Pillow script (not a project dependency). Adds iOS
meta tags and service-worker registration to base.html. Fixed a real
bug found during this work: the first-run setup-wizard middleware was
redirecting /manifest.webmanifest, /sw.js, and /offline/ to /setup/
before an admin account existed, which would have broken a browser's
very first visit to a fresh install.

Verified: manifest JSON validity and required fields, sw.js delivery
(content-type, Service-Worker-Allowed header, correct body) via both
curl and automated tests (112 passing). Actual service-worker
registration could not be verified in this sandboxed browser pane —
confirmed via a control test (even a trivial unrelated static file
fails to register here with an opaque "unknown error fetching script")
that this is an environment limitation of locally-started dev servers
in this tool, not an application bug; registration, install-prompt,
and offline behavior need confirming in a real browser.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-30 16:46:06 -06:00

45 lines
1.6 KiB
Python

from django.conf import settings
from django.shortcuts import redirect
from django.urls import reverse
from .models import User
_SETUP_EXEMPT_PREFIXES = (settings.STATIC_URL,)
class SetupWizardMiddleware:
"""Force every request to the first-run setup wizard until an account exists.
Once any User row exists, /setup/ becomes unreachable again (see the
setup view), mirroring FreshRSS's one-time install wizard. The "a user
exists" check only ever flips false -> true for the lifetime of an
instance, so it's cached per-process after the first positive result to
avoid a query on every request.
"""
_a_user_exists = False
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
path = request.path
if not path.startswith(_SETUP_EXEMPT_PREFIXES) and path not in _pwa_exempt_paths():
if not SetupWizardMiddleware._a_user_exists:
SetupWizardMiddleware._a_user_exists = User.objects.exists()
setup_url = reverse("accounts:setup")
if path != setup_url and not SetupWizardMiddleware._a_user_exists:
return redirect(setup_url)
return self.get_response(request)
def _pwa_exempt_paths():
"""The manifest/service worker/offline page must work even before the
instance's first-run setup is complete — a browser can fetch these on
any visit, setup page included (it extends the same base template)."""
return {
reverse("pwa:manifest"),
reverse("pwa:service_worker"),
reverse("pwa:offline"),
}