2023-02-26 23:24:29 +01:00
|
|
|
from os import environ, getenv
|
2022-03-01 13:22:24 +01:00
|
|
|
from typing import Optional
|
2020-01-30 14:47:36 +01:00
|
|
|
|
2023-02-26 23:24:29 +01:00
|
|
|
from .. import PACKAGE, VERSION
|
|
|
|
|
2022-04-04 14:38:50 +02:00
|
|
|
API_VERSION = "2.0.0"
|
|
|
|
|
2020-01-30 14:47:36 +01:00
|
|
|
# SECURITY WARNING: don't run with debug turned on in production!
|
2022-04-04 14:38:50 +02:00
|
|
|
DEBUG = getenv("LIBRETIME_DEBUG", "false").lower() == "true"
|
2020-01-30 14:47:36 +01:00
|
|
|
|
|
|
|
# Application definition
|
|
|
|
|
|
|
|
INSTALLED_APPS = [
|
2022-05-28 16:27:57 +02:00
|
|
|
"libretime_api.legacy",
|
2022-04-04 14:38:50 +02:00
|
|
|
"libretime_api.core",
|
|
|
|
"libretime_api.history",
|
|
|
|
"libretime_api.storage",
|
2022-06-21 14:40:21 +02:00
|
|
|
"libretime_api.podcasts",
|
2022-04-04 14:38:50 +02:00
|
|
|
"libretime_api.schedule",
|
2021-05-27 16:23:02 +02:00
|
|
|
"django.contrib.auth",
|
|
|
|
"django.contrib.contenttypes",
|
|
|
|
"django.contrib.sessions",
|
|
|
|
"django.contrib.messages",
|
|
|
|
"django.contrib.staticfiles",
|
|
|
|
"rest_framework",
|
2021-10-16 20:34:03 +02:00
|
|
|
"django_filters",
|
|
|
|
"drf_spectacular",
|
2023-03-23 15:40:30 +01:00
|
|
|
"corsheaders",
|
2020-01-30 14:47:36 +01:00
|
|
|
]
|
|
|
|
|
|
|
|
MIDDLEWARE = [
|
2023-03-23 15:40:30 +01:00
|
|
|
"corsheaders.middleware.CorsMiddleware",
|
2021-05-27 16:23:02 +02:00
|
|
|
"django.middleware.security.SecurityMiddleware",
|
|
|
|
"django.contrib.sessions.middleware.SessionMiddleware",
|
|
|
|
"django.middleware.common.CommonMiddleware",
|
|
|
|
"django.middleware.csrf.CsrfViewMiddleware",
|
|
|
|
"django.contrib.auth.middleware.AuthenticationMiddleware",
|
|
|
|
"django.contrib.messages.middleware.MessageMiddleware",
|
|
|
|
"django.middleware.clickjacking.XFrameOptionsMiddleware",
|
2020-01-30 14:47:36 +01:00
|
|
|
]
|
|
|
|
|
2021-12-24 00:04:30 +01:00
|
|
|
ROOT_URLCONF = "libretime_api.urls"
|
2020-01-30 14:47:36 +01:00
|
|
|
|
|
|
|
TEMPLATES = [
|
|
|
|
{
|
2021-05-27 16:23:02 +02:00
|
|
|
"BACKEND": "django.template.backends.django.DjangoTemplates",
|
|
|
|
"DIRS": [],
|
|
|
|
"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",
|
2020-01-30 14:47:36 +01:00
|
|
|
],
|
|
|
|
},
|
|
|
|
},
|
|
|
|
]
|
|
|
|
|
2021-12-24 00:04:30 +01:00
|
|
|
WSGI_APPLICATION = "libretime_api.wsgi.application"
|
2020-01-30 14:47:36 +01:00
|
|
|
|
2022-04-04 14:38:50 +02:00
|
|
|
# Static files (CSS, JavaScript, Images)
|
|
|
|
# https://docs.djangoproject.com/en/3.2/howto/static-files/
|
|
|
|
|
|
|
|
STATIC_URL = "/api/v2/static/"
|
|
|
|
|
|
|
|
# Default primary key field type
|
|
|
|
# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
|
|
|
|
|
|
|
|
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
|
|
|
|
|
|
|
|
|
2020-01-30 14:47:36 +01:00
|
|
|
# Password validation
|
2022-04-04 14:38:50 +02:00
|
|
|
# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
|
2020-01-30 14:47:36 +01:00
|
|
|
|
|
|
|
AUTH_PASSWORD_VALIDATORS = [
|
|
|
|
{
|
2021-05-27 16:23:02 +02:00
|
|
|
"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
|
2020-01-30 14:47:36 +01:00
|
|
|
},
|
|
|
|
{
|
2021-05-27 16:23:02 +02:00
|
|
|
"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
|
2020-01-30 14:47:36 +01:00
|
|
|
},
|
|
|
|
{
|
2021-05-27 16:23:02 +02:00
|
|
|
"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
|
2020-01-30 14:47:36 +01:00
|
|
|
},
|
|
|
|
{
|
2021-05-27 16:23:02 +02:00
|
|
|
"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
|
2020-01-30 14:47:36 +01:00
|
|
|
},
|
|
|
|
]
|
|
|
|
|
2022-03-04 14:50:05 +01:00
|
|
|
|
2022-04-04 14:38:50 +02:00
|
|
|
# Logging
|
|
|
|
# https://docs.djangoproject.com/en/3.2/topics/logging/#configuring-logging
|
2020-01-30 14:47:36 +01:00
|
|
|
|
|
|
|
|
2022-03-01 13:22:24 +01:00
|
|
|
def setup_logger(log_filepath: Optional[str]):
|
|
|
|
logging_handlers = {
|
|
|
|
"console": {
|
|
|
|
"level": "INFO",
|
|
|
|
"class": "logging.StreamHandler",
|
|
|
|
"formatter": "simple",
|
|
|
|
},
|
2022-01-15 18:22:24 +01:00
|
|
|
}
|
|
|
|
|
2022-03-01 13:22:24 +01:00
|
|
|
if log_filepath is not None:
|
|
|
|
logging_handlers["file"] = {
|
|
|
|
"level": "DEBUG",
|
|
|
|
"class": "logging.FileHandler",
|
|
|
|
"filename": log_filepath,
|
|
|
|
"formatter": "verbose",
|
|
|
|
}
|
|
|
|
|
|
|
|
return {
|
|
|
|
"version": 1,
|
|
|
|
"disable_existing_loggers": False,
|
|
|
|
"formatters": {
|
|
|
|
"simple": {
|
|
|
|
"format": "{levelname} {message}",
|
|
|
|
"style": "{",
|
|
|
|
},
|
|
|
|
"verbose": {
|
|
|
|
"format": "{asctime} {module} {levelname} {message}",
|
|
|
|
"style": "{",
|
|
|
|
},
|
2021-05-27 16:23:02 +02:00
|
|
|
},
|
2022-03-01 13:22:24 +01:00
|
|
|
"handlers": logging_handlers,
|
|
|
|
"loggers": {
|
|
|
|
"django": {
|
|
|
|
"handlers": logging_handlers.keys(),
|
|
|
|
"level": "INFO",
|
|
|
|
"propagate": True,
|
|
|
|
},
|
|
|
|
"libretime_api": {
|
|
|
|
"handlers": logging_handlers.keys(),
|
|
|
|
"level": "INFO",
|
|
|
|
"propagate": True,
|
|
|
|
},
|
2020-01-30 14:47:36 +01:00
|
|
|
},
|
2022-03-01 13:22:24 +01:00
|
|
|
}
|
2022-04-04 14:38:50 +02:00
|
|
|
|
|
|
|
|
|
|
|
# Rest Framework
|
|
|
|
# https://www.django-rest-framework.org/api-guide/settings/
|
|
|
|
|
|
|
|
renderer_classes = ["rest_framework.renderers.JSONRenderer"]
|
|
|
|
if DEBUG:
|
|
|
|
renderer_classes += ["rest_framework.renderers.BrowsableAPIRenderer"]
|
|
|
|
|
|
|
|
REST_FRAMEWORK = {
|
|
|
|
"DEFAULT_RENDERER_CLASSES": renderer_classes,
|
|
|
|
"DEFAULT_AUTHENTICATION_CLASSES": (
|
|
|
|
"rest_framework.authentication.SessionAuthentication",
|
|
|
|
"rest_framework.authentication.BasicAuthentication",
|
|
|
|
),
|
|
|
|
"DEFAULT_PERMISSION_CLASSES": [
|
|
|
|
"libretime_api.permissions.IsSystemTokenOrUser",
|
|
|
|
],
|
|
|
|
"DEFAULT_FILTER_BACKENDS": [
|
|
|
|
"django_filters.rest_framework.DjangoFilterBackend",
|
|
|
|
],
|
|
|
|
"DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
|
|
|
|
"URL_FIELD_NAME": "item_url",
|
|
|
|
}
|
|
|
|
|
|
|
|
# Auth
|
|
|
|
# https://docs.djangoproject.com/en/3.2/topics/auth/customizing/#substituting-a-custom-user-model
|
|
|
|
|
|
|
|
AUTH_USER_MODEL = "core.User"
|
|
|
|
|
|
|
|
# Spectacular
|
|
|
|
# https://drf-spectacular.readthedocs.io/en/latest/settings.html
|
|
|
|
|
2022-07-19 19:21:58 +02:00
|
|
|
SPECTACULAR_ENUM_NAME_OVERRIDES = {
|
2023-03-14 11:26:46 +01:00
|
|
|
"FileImportStatusEnum": "libretime_api.storage.models.File.ImportStatus",
|
2022-07-19 19:21:58 +02:00
|
|
|
"PlaylistContentKindEnum": "libretime_api.schedule.models.PlaylistContent.Kind",
|
2023-03-14 11:26:46 +01:00
|
|
|
"SmartBlockKindEnum": "libretime_api.schedule.models.SmartBlock.Kind",
|
2022-07-19 19:21:58 +02:00
|
|
|
}
|
|
|
|
|
2022-04-04 14:38:50 +02:00
|
|
|
SPECTACULAR_SETTINGS = {
|
|
|
|
"TITLE": "LibreTime API",
|
|
|
|
"DESCRIPTION": "Radio Broadcast & Automation Platform",
|
|
|
|
"VERSION": API_VERSION,
|
2022-07-19 19:21:58 +02:00
|
|
|
"ENUM_NAME_OVERRIDES": SPECTACULAR_ENUM_NAME_OVERRIDES,
|
2022-04-04 14:38:50 +02:00
|
|
|
}
|
2023-02-26 23:24:29 +01:00
|
|
|
|
|
|
|
# Sentry
|
|
|
|
# https://docs.sentry.io/platforms/python/guides/django/
|
|
|
|
if "SENTRY_DSN" in environ:
|
|
|
|
# pylint: disable=import-outside-toplevel
|
|
|
|
import sentry_sdk
|
|
|
|
from sentry_sdk.integrations.django import DjangoIntegration
|
|
|
|
|
|
|
|
sentry_sdk.init(
|
|
|
|
traces_sample_rate=1.0,
|
|
|
|
release=f"{PACKAGE}@{VERSION}",
|
|
|
|
integrations=[
|
|
|
|
DjangoIntegration(),
|
|
|
|
],
|
|
|
|
)
|