10838275505

Committed 12 Sep 2024 08:29PM UTC coverage: 87.44%. Remained the same

Build # 10838275505

Build Type

Pull #1357

github

Committed by

web-flow

Commit Message

Merge a50f46409 into 1d7cc8ea0

Pull Request Pull Request #1357: remove importlib-metadata

Run Details

2912 of 3298 branches covered (88.3%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

18 existing lines in 1 file now uncovered.

11416 of 13088 relevant lines covered (87.22%)

0.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.19

/ephios/settings.py

import copy
import datetime
import os
from datetime import timedelta
from email.utils import getaddresses
from pathlib import Path

import environ
from cryptography.hazmat.primitives import serialization
from django.contrib.messages import constants
from django.utils.translation import gettext_lazy
from py_vapid import Vapid, b64urlencode

from ephios.extra.secrets import django_secret_from_file

try:
    import importlib_metadata  # importlib is broken on python3.8, using backport
except ImportError:
    import importlib.metadata as importlib_metadata

# BASE_DIR is the directory containing the ephios package
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))


env = environ.Env()
# for syntax see https://django-environ.readthedocs.io/en/latest/
# read env file from ENV_PATH or fall back to a .env file in the project root
env_path = env.str("ENV_PATH", default=os.path.join(BASE_DIR, ".env"))
print(f"Loading ephios environment from {Path(env_path).absolute()}")
environ.Env.read_env(env_file=env_path)

DEBUG = env.bool("DEBUG")

DATA_DIR = env.str("DATA_DIR", os.path.join(BASE_DIR, "data"))
PUBLIC_DIR = env.str("PUBLIC_DIR", os.path.join(DATA_DIR, "public"))
STATIC_ROOT = env.str("STATIC_ROOT", os.path.join(PUBLIC_DIR, "static"))

PRIVATE_DIR = env.str("PRIVATE_DIR", os.path.join(DATA_DIR, "private"))
LOG_DIR = env.str("LOG_DIR", os.path.join(PRIVATE_DIR, "logs"))
MEDIA_ROOT = env.str("MEDIA_ROOT", os.path.join(PRIVATE_DIR, "media"))

DIRECTORIES = {
    "DATA_DIR": DATA_DIR,
    "PUBLIC_DIR": PUBLIC_DIR,
    "STATIC_ROOT": STATIC_ROOT,
    "PRIVATE_DIR": PRIVATE_DIR,
    "LOG_DIR": LOG_DIR,
    "MEDIA_ROOT": MEDIA_ROOT,
}
for directory in DIRECTORIES.values():
    os.makedirs(directory, exist_ok=True)

if "SECRET_KEY" in env:
    SECRET_KEY = env.str("SECRET_KEY")
else:
    SECRET_FILE = os.path.join(PRIVATE_DIR, ".secret")
    SECRET_KEY = django_secret_from_file(SECRET_FILE)


ALLOWED_HOSTS = env.list("ALLOWED_HOSTS")

try:
    EPHIOS_VERSION = importlib_metadata.version("ephios")
except importlib_metadata.PackageNotFoundError:
    # ephios is not installed as a package (e.g. development setup)
    EPHIOS_VERSION = "dev"

INSTALLED_APPS = [
    # we need to import our own modules before everything else to allow template
    # customizing e.g. for django-oauth-toolkit
    "ephios.core",
    "ephios.extra",
    "ephios.api",
    "django.contrib.admin",
    "django.contrib.auth",
    "polymorphic",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "django.contrib.humanize",
    "django_filters",
    "guardian",
    "oauth2_provider",
    "rest_framework",
    "django_select2",
    "djangoformsetjs",
    "compressor",
    "recurrence",
    "statici18n",
    "dynamic_preferences.users.apps.UserPreferencesConfig",
    "crispy_forms",
    "crispy_bootstrap5",
    "webpush",
    "ephios.modellogging",
]

EPHIOS_APP_MODULES = [
    # core modules always receive plugin signals
    "ephios.core",
    "ephios.extra",
    "ephios.api",
]
CORE_PLUGINS = [
    "ephios.plugins.baseshiftstructures.apps.PluginApp",
    "ephios.plugins.basesignupflows.apps.PluginApp",
    "ephios.plugins.complexsignup.apps.PluginApp",
    "ephios.plugins.pages.apps.PluginApp",
    "ephios.plugins.qualification_management.apps.PluginApp",
    "ephios.plugins.guests.apps.PluginApp",
    "ephios.plugins.eventautoqualification.apps.PluginApp",
    "ephios.plugins.simpleresource.apps.PluginApp",
    "ephios.plugins.federation.apps.PluginApp",
]
PLUGINS = copy.copy(CORE_PLUGINS)
for ep in importlib_metadata.entry_points(group="ephios.plugins"):
    PLUGINS.append(ep.value)

INSTALLED_APPS += PLUGINS

INSTALLED_APPS += ["dynamic_preferences"]  # must come after our apps to collect preferences

DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

MIDDLEWARE = [
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.locale.LocaleMiddleware",
    "ephios.extra.middleware.EphiosLocaleMiddleware",
    "ephios.extra.middleware.EphiosNotificationMiddleware",
    "django.middleware.common.CommonMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
    "csp.middleware.CSPMiddleware",
    "ephios.modellogging.middleware.LoggingRequestMiddleware",
]

ROOT_URLCONF = "ephios.urls"

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [os.path.join(BASE_DIR, "ephios/templates")],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
                "django.template.context_processors.debug",
                "django.template.context_processors.request",
                "django.contrib.auth.context_processors.auth",
                "django.contrib.messages.context_processors.messages",
                "django.template.context_processors.i18n",
                "dynamic_preferences.processors.global_preferences",
                "ephios.core.context.ephios_base_context",
            ],
            "debug": DEBUG,
        },
    },
]

LOCALE_PATHS = [
    os.path.join(BASE_DIR, "ephios/locale"),
]

WSGI_APPLICATION = "ephios.wsgi.application"

# Database
# https://docs.djangoproject.com/en/3.0/ref/settings/#databases

DATABASES = {"default": env.db_url()}

# Caches
CACHES = {
    "default": {
        "TIMEOUT": 60 * 60 * 12,  # 12 hours
        **env.cache_url(default="locmemcache://"),
    }
}
SESSION_ENGINE = "django.contrib.sessions.backends.cached_db"
DJANGO_REDIS_IGNORE_EXCEPTIONS = True
DJANGO_REDIS_LOG_IGNORED_EXCEPTIONS = True

# Password validation
# https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
    },
    {
        "NAME": "ephios.core.services.password_reset.CustomMinimumLengthValidator",
    },
    {
        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
    },
    {
        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
    },
]

AUTHENTICATION_BACKENDS = [
    "django.contrib.auth.backends.ModelBackend",
    "guardian.backends.ObjectPermissionBackend",
    "ephios.extra.auth.EphiosOIDCAB",
]

AUTH_USER_MODEL = "core.UserProfile"
LOGIN_REDIRECT_URL = "/"
PASSWORD_RESET_TIMEOUT = 28 * 24 * 60 * 60  # seconds

# Internationalization
# https://docs.djangoproject.com/en/3.0/topics/i18n/

LANGUAGE_CODE = "de"
LANGUAGES = [
    ("de", gettext_lazy("German")),
    ("en", gettext_lazy("English")),
]

TIME_ZONE = "Europe/Berlin"

USE_I18N = True

USE_TZ = True

# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/3.0/howto/static-files/

STATIC_URL = env.str("STATIC_URL", default="/static/")

STATICFILES_DIRS = (os.path.join(BASE_DIR, "ephios/static"),)
STATICFILES_FINDERS = (
    "django.contrib.staticfiles.finders.FileSystemFinder",
    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
    "compressor.finders.CompressorFinder",
)
COMPRESS_ENABLED = not DEBUG
# https://www.accordbox.com/blog/how-use-scss-sass-your-django-project-python-way/
COMPRESS_PRECOMPILERS = (("text/x-scss", "django_libsass.SassCompiler"),)

# mail configuration
EMAIL_CONFIG = env.email_url("EMAIL_URL")
vars().update(EMAIL_CONFIG)
DEFAULT_FROM_EMAIL = env.str("DEFAULT_FROM_EMAIL")
SERVER_EMAIL = env.str("SERVER_EMAIL")
ADMINS = getaddresses([env("ADMINS")])

# logging
LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {
        "default": {"format": "[%(levelname)s] %(asctime)s %(name)s :: %(message)s"},
    },
    "filters": {
        "require_debug_false": {
            "()": "django.utils.log.RequireDebugFalse",
        },
        "require_debug_true": {
            "()": "django.utils.log.RequireDebugTrue",
        },
    },
    "handlers": {
        "console": {
            "level": "DEBUG",
            "class": "logging.StreamHandler",
            "formatter": "default",
            "filters": ["require_debug_true"],
        },
        "mail_admins": {
            "level": "ERROR",
            "filters": ["require_debug_false"],
            "class": "django.utils.log.AdminEmailHandler",
        },
        "file": {
            "level": "DEBUG",
            "formatter": "default",
            "filters": [],
            **(
                {
                    "class": "logging.handlers.TimedRotatingFileHandler",
                    "filename": os.path.join(LOG_DIR, "ephios.log"),
                    "when": "midnight",
                    "backupCount": env.int("LOGGING_BACKUP_DAYS", default=14),
                    "atTime": datetime.time(4),
                    "encoding": "utf-8",
                }
            ),
        },
    },
    "loggers": {
        "ephios": {
            "handlers": ["mail_admins", "console", "file"],
            "level": "DEBUG" if DEBUG else "INFO",
            "propagate": False,
        },
        "django": {
            "handlers": [],
            "level": "INFO",
            "propagate": True,
        },
        "django.server": {
            "handlers": [],
            "level": "INFO",
            "propagate": True,
        },
    },
    "root": {
        "handlers": ["mail_admins", "console", "file"],
        "level": "INFO",
    },
}


def GET_SITE_URL():
    site_url = env.str("SITE_URL")
    if site_url.endswith("/"):
        site_url = site_url[:-1]
    return site_url


# Guardian configuration
ANONYMOUS_USER_NAME = None
GUARDIAN_MONKEY_PATCH = False

# django-select2
# Prevent django-select from loading the select2 resources as we want to serve them locally
SELECT2_JS = ""
SELECT2_CSS = ""
SELECT2_I18N_PATH = ""
SELECT2_CACHE_BACKEND = "default"
SELECT2_THEME = "bootstrap-5"

# django-debug-toolbar
ENABLE_DEBUG_TOOLBAR = env.bool("DEBUG_TOOLBAR", False)
if ENABLE_DEBUG_TOOLBAR:
    INSTALLED_APPS.append("django_extensions")
    INSTALLED_APPS.append("debug_toolbar")
    MIDDLEWARE.insert(0, "debug_toolbar.middleware.DebugToolbarMiddleware")
    INTERNAL_IPS = env.list("INTERNAL_IPS", default=["127.0.0.1"])

# django-csp
# Bootstrap requires embedded SVG files loaded via a data URI. This is not ideal, but will only be fixed in
# bootstrap v5 or v6. See https://github.com/twbs/bootstrap/issues/25394 for details on the problem and
# https://security.stackexchange.com/a/167244 on why allowing data: is considered okay
CSP_IMG_SRC = ("'self'", "data:")
CSP_STYLE_SRC = "'self'"
CSP_INCLUDE_NONCE_IN = ["style-src"]

# django-crispy-forms
CRISPY_ALLOWED_TEMPLATE_PACKS = ("bootstrap5",)
CRISPY_TEMPLATE_PACK = "bootstrap5"
CRISPY_FAIL_SILENTLY = not DEBUG

# django.contrib.messages
MESSAGE_TAGS = {
    constants.DEBUG: "alert-info",
    constants.INFO: "alert-info",
    constants.SUCCESS: "alert-success",
    constants.WARNING: "alert-warning",
    constants.ERROR: "alert-danger",
}

# PWA
PWA_APP_ICONS = [
    {
        "src": "/static/ephios/img/ephios-192x.png",
        "sizes": "192x192",
        "type": "image/png",
        "purpose": "maskable",
    },
    {
        "src": "/static/ephios/img/ephios-512x.png",
        "sizes": "512x512",
        "type": "image/png",
        "purpose": "maskable",
    },
    {
        "src": "/static/ephios/img/ephios-1024x.png",
        "sizes": "1024x1024",
        "type": "image/png",
        "purpose": "maskable",
    },
    {
        "src": "/static/ephios/img/ephios-symbol-red.svg",
        "sizes": "any",
        "type": "image/svg+xml",
        "purpose": "any",
    },
]

# django-webpush
VAPID_PRIVATE_KEY_PATH = env.str(
    "VAPID_PRIVATE_KEY_PATH", os.path.join(PRIVATE_DIR, "vapid_key.pem")
)
WEBPUSH_SETTINGS = {}
if os.path.exists(VAPID_PRIVATE_KEY_PATH):
    vp = Vapid().from_file(VAPID_PRIVATE_KEY_PATH)
    WEBPUSH_SETTINGS = {
        "VAPID_PUBLIC_KEY": b64urlencode(
            vp.public_key.public_bytes(
                serialization.Encoding.X962, serialization.PublicFormat.UncompressedPoint
            )
        ),
        "VAPID_PRIVATE_KEY": vp,
        "VAPID_ADMIN_EMAIL": ADMINS[0][1],
    }


# Health check
# interval for calls to the run_periodic_tasks management command over which the cronjob is considered to be broken
RUN_PERIODIC_MAX_INTERVAL = 60 * 5 + 30  # 5 minutes + 30 seconds


# django-rest-framework
DEFAULT_LISTVIEW_PAGINATION = 100
REST_FRAMEWORK = {
    "DEFAULT_PERMISSION_CLASSES": ["rest_framework.permissions.DjangoObjectPermissions"],
    "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.NamespaceVersioning",
    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
    "PAGE_SIZE": 100,
    "DEFAULT_AUTHENTICATION_CLASSES": [
        "rest_framework.authentication.SessionAuthentication",
        "ephios.api.access.auth.CustomOAuth2Authentication",
    ],
}

# Like UserProfile, these models are implemented using djangos private swappable API
# due to a shaky implementation in django-oauth-toolkit, we need to customize all models,
# although we only want to customize the AccessToken model
OAUTH2_PROVIDER_ACCESS_TOKEN_MODEL = "api.AccessToken"
OAUTH2_PROVIDER_APPLICATION_MODEL = "api.Application"
OAUTH2_PROVIDER_ID_TOKEN_MODEL = "api.IDToken"
OAUTH2_PROVIDER_GRANT_MODEL = "api.Grant"
OAUTH2_PROVIDER_REFRESH_TOKEN_MODEL = "api.RefreshToken"
OAUTH2_PROVIDER = {
    "SCOPES": {
        "PUBLIC_READ": gettext_lazy("Read public data like available events and shifts"),
        "PUBLIC_WRITE": gettext_lazy("Write public data like available events and shifts"),
        "ME_READ": gettext_lazy("Read own personal data and participations"),
        "ME_WRITE": gettext_lazy("Write own personal data and participations"),
        "CONFIDENTIAL_READ": gettext_lazy(
            "Read confidential data like all users profile and participations"
        ),
        "CONFIDENTIAL_WRITE": gettext_lazy(
            "Write confidential data like all users profile and participations"
        ),
    },
    "REFRESH_TOKEN_EXPIRE_SECONDS": timedelta(days=90),
}

# SECURITY SETTINGS
if not DEBUG:
    SESSION_COOKIE_SECURE = True
    CSRF_COOKIE_SECURE = True
    X_FRAME_OPTIONS = "DENY"
    SECURE_CONTENT_TYPE_NOSNIFF = True
    SECURE_SSL_REDIRECT = True
    SECURE_REFERRER_POLICY = "same-origin"
    # 1 day by default, change to 1 year in production (see deployment docs)
    SECURE_HSTS_SECONDS = env.int("SECURE_HSTS_SECONDS", default=3600 * 24)
    SECURE_HSTS_INCLUDE_SUBDOMAINS = env.bool("SECURE_HSTS_INCLUDE_SUBDOMAINS", default=False)
    SECURE_HSTS_PRELOAD = env.bool("SECURE_HSTS_PRELOAD", default=False)
    CONN_MAX_AGE = env.int("CONN_MAX_AGE", default=0)

if env.bool("TRUST_X_FORWARDED_PROTO", default=False):
    SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")

1	import copy	1✔
2	import datetime	1✔
3	import os	1✔
4	from datetime import timedelta	1✔
5	from email.utils import getaddresses	1✔
6	from pathlib import Path	1✔
7
8	import environ	1✔
9	from cryptography.hazmat.primitives import serialization	1✔
10	from django.contrib.messages import constants	1✔
11	from django.utils.translation import gettext_lazy	1✔
12	from py_vapid import Vapid, b64urlencode	1✔
13
14	from ephios.extra.secrets import django_secret_from_file	1✔
15
16	try:	1✔
17	import importlib_metadata # importlib is broken on python3.8, using backport	1✔
UNCOV 18	except ImportError:	×
UNCOV 19	import importlib.metadata as importlib_metadata	×
20
21	# BASE_DIR is the directory containing the ephios package
22	BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))	1✔
23
24
25	env = environ.Env()	1✔
26	# for syntax see https://django-environ.readthedocs.io/en/latest/
27	# read env file from ENV_PATH or fall back to a .env file in the project root
28	env_path = env.str("ENV_PATH", default=os.path.join(BASE_DIR, ".env"))	1✔
29	print(f"Loading ephios environment from {Path(env_path).absolute()}")	1✔
30	environ.Env.read_env(env_file=env_path)	1✔
31
32	DEBUG = env.bool("DEBUG")	1✔
33
34	DATA_DIR = env.str("DATA_DIR", os.path.join(BASE_DIR, "data"))	1✔
35	PUBLIC_DIR = env.str("PUBLIC_DIR", os.path.join(DATA_DIR, "public"))	1✔
36	STATIC_ROOT = env.str("STATIC_ROOT", os.path.join(PUBLIC_DIR, "static"))	1✔
37
38	PRIVATE_DIR = env.str("PRIVATE_DIR", os.path.join(DATA_DIR, "private"))	1✔
39	LOG_DIR = env.str("LOG_DIR", os.path.join(PRIVATE_DIR, "logs"))	1✔
40	MEDIA_ROOT = env.str("MEDIA_ROOT", os.path.join(PRIVATE_DIR, "media"))	1✔
41
42	DIRECTORIES = {	1✔
43	"DATA_DIR": DATA_DIR,
44	"PUBLIC_DIR": PUBLIC_DIR,
45	"STATIC_ROOT": STATIC_ROOT,
46	"PRIVATE_DIR": PRIVATE_DIR,
47	"LOG_DIR": LOG_DIR,
48	"MEDIA_ROOT": MEDIA_ROOT,
49	}
50	for directory in DIRECTORIES.values():	1✔
51	os.makedirs(directory, exist_ok=True)	1✔
52
53	if "SECRET_KEY" in env:	1!
UNCOV 54	SECRET_KEY = env.str("SECRET_KEY")	×
55	else:
56	SECRET_FILE = os.path.join(PRIVATE_DIR, ".secret")	1✔
57	SECRET_KEY = django_secret_from_file(SECRET_FILE)	1✔
58
59
60	ALLOWED_HOSTS = env.list("ALLOWED_HOSTS")	1✔
61
62	try:	1✔
63	EPHIOS_VERSION = importlib_metadata.version("ephios")	1✔
UNCOV 64	except importlib_metadata.PackageNotFoundError:	×
65	# ephios is not installed as a package (e.g. development setup)
UNCOV 66	EPHIOS_VERSION = "dev"	×
67
68	INSTALLED_APPS = [	1✔
69	# we need to import our own modules before everything else to allow template
70	# customizing e.g. for django-oauth-toolkit
71	"ephios.core",
72	"ephios.extra",
73	"ephios.api",
74	"django.contrib.admin",
75	"django.contrib.auth",
76	"polymorphic",
77	"django.contrib.contenttypes",
78	"django.contrib.sessions",
79	"django.contrib.messages",
80	"django.contrib.staticfiles",
81	"django.contrib.humanize",
82	"django_filters",
83	"guardian",
84	"oauth2_provider",
85	"rest_framework",
86	"django_select2",
87	"djangoformsetjs",
88	"compressor",
89	"recurrence",
90	"statici18n",
91	"dynamic_preferences.users.apps.UserPreferencesConfig",
92	"crispy_forms",
93	"crispy_bootstrap5",
94	"webpush",
95	"ephios.modellogging",
96	]
97
98	EPHIOS_APP_MODULES = [	1✔
99	# core modules always receive plugin signals
100	"ephios.core",
101	"ephios.extra",
102	"ephios.api",
103	]
104	CORE_PLUGINS = [	1✔
105	"ephios.plugins.baseshiftstructures.apps.PluginApp",
106	"ephios.plugins.basesignupflows.apps.PluginApp",
107	"ephios.plugins.complexsignup.apps.PluginApp",
108	"ephios.plugins.pages.apps.PluginApp",
109	"ephios.plugins.qualification_management.apps.PluginApp",
110	"ephios.plugins.guests.apps.PluginApp",
111	"ephios.plugins.eventautoqualification.apps.PluginApp",
112	"ephios.plugins.simpleresource.apps.PluginApp",
113	"ephios.plugins.federation.apps.PluginApp",
114	]
115	PLUGINS = copy.copy(CORE_PLUGINS)	1✔
116	for ep in importlib_metadata.entry_points(group="ephios.plugins"):	1✔
117	PLUGINS.append(ep.value)	1✔
118
119	INSTALLED_APPS += PLUGINS	1✔
120
121	INSTALLED_APPS += ["dynamic_preferences"] # must come after our apps to collect preferences	1✔
122
123	DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"	1✔
124
125	MIDDLEWARE = [	1✔
126	"django.middleware.security.SecurityMiddleware",
127	"django.contrib.sessions.middleware.SessionMiddleware",
128	"django.middleware.locale.LocaleMiddleware",
129	"ephios.extra.middleware.EphiosLocaleMiddleware",
130	"ephios.extra.middleware.EphiosNotificationMiddleware",
131	"django.middleware.common.CommonMiddleware",
132	"django.middleware.csrf.CsrfViewMiddleware",
133	"django.contrib.auth.middleware.AuthenticationMiddleware",
134	"django.contrib.messages.middleware.MessageMiddleware",
135	"django.middleware.clickjacking.XFrameOptionsMiddleware",
136	"csp.middleware.CSPMiddleware",
137	"ephios.modellogging.middleware.LoggingRequestMiddleware",
138	]
139
140	ROOT_URLCONF = "ephios.urls"	1✔
141
142	TEMPLATES = [	1✔
143	{
144	"BACKEND": "django.template.backends.django.DjangoTemplates",
145	"DIRS": [os.path.join(BASE_DIR, "ephios/templates")],
146	"APP_DIRS": True,
147	"OPTIONS": {
148	"context_processors": [
149	"django.template.context_processors.debug",
150	"django.template.context_processors.request",
151	"django.contrib.auth.context_processors.auth",
152	"django.contrib.messages.context_processors.messages",
153	"django.template.context_processors.i18n",
154	"dynamic_preferences.processors.global_preferences",
155	"ephios.core.context.ephios_base_context",
156	],
157	"debug": DEBUG,
158	},
159	},
160	]
161
162	LOCALE_PATHS = [	1✔
163	os.path.join(BASE_DIR, "ephios/locale"),
164	]
165
166	WSGI_APPLICATION = "ephios.wsgi.application"	1✔
167
168	# Database
169	# https://docs.djangoproject.com/en/3.0/ref/settings/#databases
170
171	DATABASES = {"default": env.db_url()}	1✔
172
173	# Caches
174	CACHES = {	1✔
175	"default": {
176	"TIMEOUT": 60 * 60 * 12, # 12 hours
177	**env.cache_url(default="locmemcache://"),
178	}
179	}
180	SESSION_ENGINE = "django.contrib.sessions.backends.cached_db"	1✔
181	DJANGO_REDIS_IGNORE_EXCEPTIONS = True	1✔
182	DJANGO_REDIS_LOG_IGNORED_EXCEPTIONS = True	1✔
183
184	# Password validation
185	# https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
186
187	AUTH_PASSWORD_VALIDATORS = [	1✔
188	{
189	"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
190	},
191	{
192	"NAME": "ephios.core.services.password_reset.CustomMinimumLengthValidator",
193	},
194	{
195	"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
196	},
197	{
198	"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
199	},
200	]
201
202	AUTHENTICATION_BACKENDS = [	1✔
203	"django.contrib.auth.backends.ModelBackend",
204	"guardian.backends.ObjectPermissionBackend",
205	"ephios.extra.auth.EphiosOIDCAB",
206	]
207
208	AUTH_USER_MODEL = "core.UserProfile"	1✔
209	LOGIN_REDIRECT_URL = "/"	1✔
210	PASSWORD_RESET_TIMEOUT = 28 * 24 * 60 * 60 # seconds	1✔
211
212	# Internationalization
213	# https://docs.djangoproject.com/en/3.0/topics/i18n/
214
215	LANGUAGE_CODE = "de"	1✔
216	LANGUAGES = [	1✔
217	("de", gettext_lazy("German")),
218	("en", gettext_lazy("English")),
219	]
220
221	TIME_ZONE = "Europe/Berlin"	1✔
222
223	USE_I18N = True	1✔
224
225	USE_TZ = True	1✔
226
227	# Static files (CSS, JavaScript, Images)
228	# https://docs.djangoproject.com/en/3.0/howto/static-files/
229
230	STATIC_URL = env.str("STATIC_URL", default="/static/")	1✔
231
232	STATICFILES_DIRS = (os.path.join(BASE_DIR, "ephios/static"),)	1✔
233	STATICFILES_FINDERS = (	1✔
234	"django.contrib.staticfiles.finders.FileSystemFinder",
235	"django.contrib.staticfiles.finders.AppDirectoriesFinder",
236	"compressor.finders.CompressorFinder",
237	)
238	COMPRESS_ENABLED = not DEBUG	1✔
239	# https://www.accordbox.com/blog/how-use-scss-sass-your-django-project-python-way/
240	COMPRESS_PRECOMPILERS = (("text/x-scss", "django_libsass.SassCompiler"),)	1✔
241
242	# mail configuration
243	EMAIL_CONFIG = env.email_url("EMAIL_URL")	1✔
244	vars().update(EMAIL_CONFIG)	1✔
245	DEFAULT_FROM_EMAIL = env.str("DEFAULT_FROM_EMAIL")	1✔
246	SERVER_EMAIL = env.str("SERVER_EMAIL")	1✔
247	ADMINS = getaddresses([env("ADMINS")])	1✔
248
249	# logging
250	LOGGING = {	1✔
251	"version": 1,
252	"disable_existing_loggers": False,
253	"formatters": {
254	"default": {"format": "[%(levelname)s] %(asctime)s %(name)s :: %(message)s"},
255	},
256	"filters": {
257	"require_debug_false": {
258	"()": "django.utils.log.RequireDebugFalse",
259	},
260	"require_debug_true": {
261	"()": "django.utils.log.RequireDebugTrue",
262	},
263	},
264	"handlers": {
265	"console": {
266	"level": "DEBUG",
267	"class": "logging.StreamHandler",
268	"formatter": "default",
269	"filters": ["require_debug_true"],
270	},
271	"mail_admins": {
272	"level": "ERROR",
273	"filters": ["require_debug_false"],
274	"class": "django.utils.log.AdminEmailHandler",
275	},
276	"file": {
277	"level": "DEBUG",
278	"formatter": "default",
279	"filters": [],
280	**(
281	{
282	"class": "logging.handlers.TimedRotatingFileHandler",
283	"filename": os.path.join(LOG_DIR, "ephios.log"),
284	"when": "midnight",
285	"backupCount": env.int("LOGGING_BACKUP_DAYS", default=14),
286	"atTime": datetime.time(4),
287	"encoding": "utf-8",
288	}
289	),
290	},
291	},
292	"loggers": {
293	"ephios": {
294	"handlers": ["mail_admins", "console", "file"],
295	"level": "DEBUG" if DEBUG else "INFO",
296	"propagate": False,
297	},
298	"django": {
299	"handlers": [],
300	"level": "INFO",
301	"propagate": True,
302	},
303	"django.server": {
304	"handlers": [],
305	"level": "INFO",
306	"propagate": True,
307	},
308	},
309	"root": {
310	"handlers": ["mail_admins", "console", "file"],
311	"level": "INFO",
312	},
313	}
314
315
316	def GET_SITE_URL():	1✔
UNCOV 317	site_url = env.str("SITE_URL")	×
UNCOV 318	if site_url.endswith("/"):	×
UNCOV 319	site_url = site_url[:-1]	×
UNCOV 320	return site_url	×
321
322
323	# Guardian configuration
324	ANONYMOUS_USER_NAME = None	1✔
325	GUARDIAN_MONKEY_PATCH = False	1✔
326
327	# django-select2
328	# Prevent django-select from loading the select2 resources as we want to serve them locally
329	SELECT2_JS = ""	1✔
330	SELECT2_CSS = ""	1✔
331	SELECT2_I18N_PATH = ""	1✔
332	SELECT2_CACHE_BACKEND = "default"	1✔
333	SELECT2_THEME = "bootstrap-5"	1✔
334
335	# django-debug-toolbar
336	ENABLE_DEBUG_TOOLBAR = env.bool("DEBUG_TOOLBAR", False)	1✔
337	if ENABLE_DEBUG_TOOLBAR:	1!
UNCOV 338	INSTALLED_APPS.append("django_extensions")	×
UNCOV 339	INSTALLED_APPS.append("debug_toolbar")	×
UNCOV 340	MIDDLEWARE.insert(0, "debug_toolbar.middleware.DebugToolbarMiddleware")	×
UNCOV 341	INTERNAL_IPS = env.list("INTERNAL_IPS", default=["127.0.0.1"])	×
342
343	# django-csp
344	# Bootstrap requires embedded SVG files loaded via a data URI. This is not ideal, but will only be fixed in
345	# bootstrap v5 or v6. See https://github.com/twbs/bootstrap/issues/25394 for details on the problem and
346	# https://security.stackexchange.com/a/167244 on why allowing data: is considered okay
347	CSP_IMG_SRC = ("'self'", "data:")	1✔
348	CSP_STYLE_SRC = "'self'"	1✔
349	CSP_INCLUDE_NONCE_IN = ["style-src"]	1✔
350
351	# django-crispy-forms
352	CRISPY_ALLOWED_TEMPLATE_PACKS = ("bootstrap5",)	1✔
353	CRISPY_TEMPLATE_PACK = "bootstrap5"	1✔
354	CRISPY_FAIL_SILENTLY = not DEBUG	1✔
355
356	# django.contrib.messages
357	MESSAGE_TAGS = {	1✔
358	constants.DEBUG: "alert-info",
359	constants.INFO: "alert-info",
360	constants.SUCCESS: "alert-success",
361	constants.WARNING: "alert-warning",
362	constants.ERROR: "alert-danger",
363	}
364
365	# PWA
366	PWA_APP_ICONS = [	1✔
367	{
368	"src": "/static/ephios/img/ephios-192x.png",
369	"sizes": "192x192",
370	"type": "image/png",
371	"purpose": "maskable",
372	},
373	{
374	"src": "/static/ephios/img/ephios-512x.png",
375	"sizes": "512x512",
376	"type": "image/png",
377	"purpose": "maskable",
378	},
379	{
380	"src": "/static/ephios/img/ephios-1024x.png",
381	"sizes": "1024x1024",
382	"type": "image/png",
383	"purpose": "maskable",
384	},
385	{
386	"src": "/static/ephios/img/ephios-symbol-red.svg",
387	"sizes": "any",
388	"type": "image/svg+xml",
389	"purpose": "any",
390	},
391	]
392
393	# django-webpush
394	VAPID_PRIVATE_KEY_PATH = env.str(	1✔
395	"VAPID_PRIVATE_KEY_PATH", os.path.join(PRIVATE_DIR, "vapid_key.pem")
396	)
397	WEBPUSH_SETTINGS = {}	1✔
398	if os.path.exists(VAPID_PRIVATE_KEY_PATH):	1!
399	vp = Vapid().from_file(VAPID_PRIVATE_KEY_PATH)	1✔
400	WEBPUSH_SETTINGS = {	1✔
401	"VAPID_PUBLIC_KEY": b64urlencode(
402	vp.public_key.public_bytes(
403	serialization.Encoding.X962, serialization.PublicFormat.UncompressedPoint
404	)
405	),
406	"VAPID_PRIVATE_KEY": vp,
407	"VAPID_ADMIN_EMAIL": ADMINS[0][1],
408	}
409
410
411	# Health check
412	# interval for calls to the run_periodic_tasks management command over which the cronjob is considered to be broken
413	RUN_PERIODIC_MAX_INTERVAL = 60 * 5 + 30 # 5 minutes + 30 seconds	1✔
414
415
416	# django-rest-framework
417	DEFAULT_LISTVIEW_PAGINATION = 100	1✔
418	REST_FRAMEWORK = {	1✔
419	"DEFAULT_PERMISSION_CLASSES": ["rest_framework.permissions.DjangoObjectPermissions"],
420	"DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.NamespaceVersioning",
421	"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
422	"PAGE_SIZE": 100,
423	"DEFAULT_AUTHENTICATION_CLASSES": [
424	"rest_framework.authentication.SessionAuthentication",
425	"ephios.api.access.auth.CustomOAuth2Authentication",
426	],
427	}
428
429	# Like UserProfile, these models are implemented using djangos private swappable API
430	# due to a shaky implementation in django-oauth-toolkit, we need to customize all models,
431	# although we only want to customize the AccessToken model
432	OAUTH2_PROVIDER_ACCESS_TOKEN_MODEL = "api.AccessToken"	1✔
433	OAUTH2_PROVIDER_APPLICATION_MODEL = "api.Application"	1✔
434	OAUTH2_PROVIDER_ID_TOKEN_MODEL = "api.IDToken"	1✔
435	OAUTH2_PROVIDER_GRANT_MODEL = "api.Grant"	1✔
436	OAUTH2_PROVIDER_REFRESH_TOKEN_MODEL = "api.RefreshToken"	1✔
437	OAUTH2_PROVIDER = {	1✔
438	"SCOPES": {
439	"PUBLIC_READ": gettext_lazy("Read public data like available events and shifts"),
440	"PUBLIC_WRITE": gettext_lazy("Write public data like available events and shifts"),
441	"ME_READ": gettext_lazy("Read own personal data and participations"),
442	"ME_WRITE": gettext_lazy("Write own personal data and participations"),
443	"CONFIDENTIAL_READ": gettext_lazy(
444	"Read confidential data like all users profile and participations"
445	),
446	"CONFIDENTIAL_WRITE": gettext_lazy(
447	"Write confidential data like all users profile and participations"
448	),
449	},
450	"REFRESH_TOKEN_EXPIRE_SECONDS": timedelta(days=90),
451	}
452
453	# SECURITY SETTINGS
454	if not DEBUG:	1!
455	SESSION_COOKIE_SECURE = True	×
456	CSRF_COOKIE_SECURE = True	×
UNCOV 457	X_FRAME_OPTIONS = "DENY"	×
458	SECURE_CONTENT_TYPE_NOSNIFF = True	×
459	SECURE_SSL_REDIRECT = True	×
460	SECURE_REFERRER_POLICY = "same-origin"	×
461	# 1 day by default, change to 1 year in production (see deployment docs)
UNCOV 462	SECURE_HSTS_SECONDS = env.int("SECURE_HSTS_SECONDS", default=3600 * 24)	×
UNCOV 463	SECURE_HSTS_INCLUDE_SUBDOMAINS = env.bool("SECURE_HSTS_INCLUDE_SUBDOMAINS", default=False)	×
464	SECURE_HSTS_PRELOAD = env.bool("SECURE_HSTS_PRELOAD", default=False)	×
UNCOV 465	CONN_MAX_AGE = env.int("CONN_MAX_AGE", default=0)	×
466
467	if env.bool("TRUST_X_FORWARDED_PROTO", default=False):	1!
UNCOV 468	SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")	×

ephios-dev / ephios / 10838275505

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous