69 lines
2.7 KiB
Python
69 lines
2.7 KiB
Python
import hashlib
|
|
import os
|
|
|
|
from django.conf import STATICFILES_STORAGE_ALIAS, settings
|
|
from django.contrib.staticfiles.storage import HashedFilesMixin
|
|
from django.core.files.storage import storages
|
|
from django.templatetags.static import static
|
|
|
|
from wagtail import __version__
|
|
|
|
# Check whether we should add cache-busting '?v=...' parameters to static file URLs
|
|
try:
|
|
# If a preference has been explicitly stated in the WAGTAILADMIN_STATIC_FILE_VERSION_STRINGS
|
|
# setting, use that
|
|
use_version_strings = settings.WAGTAILADMIN_STATIC_FILE_VERSION_STRINGS
|
|
except AttributeError:
|
|
# If WAGTAILADMIN_STATIC_FILE_VERSION_STRINGS not specified, default to version strings
|
|
# enabled, UNLESS we're using a storage backend with hashed filenames; in this case having
|
|
# a query parameter is redundant, and in some configurations (e.g. Cloudflare with the
|
|
# "No Query String" setting) it could break a previously-working cache setup
|
|
|
|
if settings.DEBUG:
|
|
# Hashed filenames are disabled in debug mode, so keep the querystring
|
|
use_version_strings = True
|
|
else:
|
|
# see if we're using a storage backend using hashed filenames
|
|
use_version_strings = not isinstance(
|
|
storages[STATICFILES_STORAGE_ALIAS], HashedFilesMixin
|
|
)
|
|
|
|
|
|
if use_version_strings:
|
|
# INSTALLED_APPS is used as a unique value to distinguish Wagtail apps
|
|
# and avoid exposing the Wagtail version directly
|
|
VERSION_HASH = hashlib.sha1(
|
|
"".join([__version__] + list(settings.INSTALLED_APPS)).encode(),
|
|
).hexdigest()[:8]
|
|
else:
|
|
VERSION_HASH = None
|
|
|
|
|
|
if os.environ.get("WAGTAIL_FAIL_ON_VERSIONED_STATIC", "0") == "1":
|
|
|
|
def versioned_static(path):
|
|
raise Exception(
|
|
"`versioned_static` was called during application startup. This is not valid "
|
|
"as it will cause failures if collectstatic has not yet completed (e.g. during "
|
|
"the collectstatic command itself). Ensure that any media definitions declared "
|
|
"via `class Media` are converted to a `media` property."
|
|
)
|
|
else:
|
|
|
|
def versioned_static(path):
|
|
"""
|
|
Wrapper for Django's static file finder to append a cache-busting query parameter
|
|
that updates on each Wagtail version
|
|
"""
|
|
# An absolute path is returned unchanged (either a full URL, or processed already)
|
|
if path.startswith(("http://", "https://", "/")):
|
|
return path
|
|
|
|
base_url = static(path)
|
|
|
|
# if URL already contains a querystring, don't add our own, to avoid interfering
|
|
# with existing mechanisms
|
|
if VERSION_HASH is None or "?" in base_url:
|
|
return base_url
|
|
else:
|
|
return base_url + "?v=" + VERSION_HASH
|