""" Django settings for config project. Generated by 'django-admin startproject' using Django 3.2.5. For more information on this file, see https://docs.djangoproject.com/en/3.2/topics/settings/ For the full list of settings and their values, see https://docs.djangoproject.com/en/3.2/ref/settings/ """ import hashlib from os import environ, path from pathlib import Path from common.src.env_settings import EnvironmentSettings from common.src.helper import ta_host_parser from common.src.ta_redis import RedisArchivist from corsheaders.defaults import default_headers try: from dotenv import load_dotenv load_dotenv(".env") except ModuleNotFoundError: pass # Build paths inside the project like this: BASE_DIR / 'subdir'. BASE_DIR = Path(__file__).resolve().parent.parent # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/ PW_HASH = hashlib.sha256(EnvironmentSettings.TA_PASSWORD.encode()) SECRET_KEY = PW_HASH.hexdigest() # SECURITY WARNING: don't run with debug turned on in production! DEBUG = bool(environ.get("DJANGO_DEBUG")) ALLOWED_HOSTS, CSRF_TRUSTED_ORIGINS = ta_host_parser( environ.get("TA_HOST", "localhost") ) CORS_ALLOWED_ORIGINS = CSRF_TRUSTED_ORIGINS # Application definition INSTALLED_APPS = [ "django_celery_beat", "django.contrib.admin", "django.contrib.auth", "django.contrib.contenttypes", "django.contrib.sessions", "django.contrib.messages", "corsheaders", "django.contrib.staticfiles", "django.contrib.humanize", "rest_framework", "rest_framework.authtoken", "drf_spectacular", "common", "video", "channel", "playlist", "download", "task", "appsettings", "stats", "user", "config", ] MIDDLEWARE = [ "django.middleware.security.SecurityMiddleware", "django.contrib.sessions.middleware.SessionMiddleware", "corsheaders.middleware.CorsMiddleware", "config.middleware.StartTimeMiddleware", "django.middleware.common.CommonMiddleware", "django.middleware.csrf.CsrfViewMiddleware", "django.contrib.auth.middleware.AuthenticationMiddleware", "django.contrib.messages.middleware.MessageMiddleware", "django.middleware.clickjacking.XFrameOptionsMiddleware", ] ROOT_URLCONF = "config.urls" TEMPLATES = [ { "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", ], }, }, ] WSGI_APPLICATION = "config.wsgi.application" # Database # https://docs.djangoproject.com/en/3.2/ref/settings/#databases CACHE_DIR = EnvironmentSettings.CACHE_DIR DB_PATH = path.join(CACHE_DIR, "db.sqlite3") DATABASES = { "default": { "ENGINE": "django.db.backends.sqlite3", "NAME": DB_PATH, } } # Password validation # https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators AUTH_PASSWORD_VALIDATORS = [ { "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator", # noqa: E501 }, { "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator", # noqa: E501 }, { "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator", # noqa: E501 }, { "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator", # noqa: E501 }, ] AUTH_USER_MODEL = "user.Account" # Configure Authentication Backend Combinations _login_auth_mode = (environ.get("TA_LOGIN_AUTH_MODE") or "single").casefold() if _login_auth_mode == "local": AUTHENTICATION_BACKENDS: tuple = ( "django.contrib.auth.backends.ModelBackend", ) elif _login_auth_mode == "ldap": AUTHENTICATION_BACKENDS = ("django_auth_ldap.backend.LDAPBackend",) from .ldap_settings import * # noqa: F403 F401 elif _login_auth_mode == "forwardauth": from .fwd_auth_settings import * # noqa: F403 F401 AUTHENTICATION_BACKENDS = ( "django.contrib.auth.backends.RemoteUserBackend", ) MIDDLEWARE.append("user.src.remote_user_auth.HttpRemoteUserMiddleware") elif _login_auth_mode == "ldap_local": AUTHENTICATION_BACKENDS = ( "django_auth_ldap.backend.LDAPBackend", "django.contrib.auth.backends.ModelBackend", ) from .ldap_settings import * # noqa: F403 F401 else: # If none of these cases match, AUTHENTICATION_BACKENDS is unset, which # means the ModelBackend should be used by default if bool(environ.get("TA_LDAP")): AUTHENTICATION_BACKENDS = ("django_auth_ldap.backend.LDAPBackend",) from .ldap_settings import * # noqa: F403 F401 if bool(environ.get("TA_ENABLE_AUTH_PROXY")): from .fwd_auth_settings import * # noqa: F403 F401 AUTHENTICATION_BACKENDS = ( "django.contrib.auth.backends.RemoteUserBackend", ) MIDDLEWARE.append("user.src.remote_user_auth.HttpRemoteUserMiddleware") # Internationalization # https://docs.djangoproject.com/en/3.2/topics/i18n/ LANGUAGE_CODE = "en-us" TIME_ZONE = EnvironmentSettings.TZ USE_I18N = True USE_L10N = True USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/3.2/howto/static-files/ STATIC_URL = "/static/" STATICFILES_DIRS = (str(BASE_DIR.joinpath("static")),) STATIC_ROOT = str(BASE_DIR.joinpath("staticfiles")) # Default primary key field type # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" LOGIN_URL = "/login/" LOGOUT_REDIRECT_URL = "/login/" # Cors needed for browser extension # background.js makes the request so HTTP_ORIGIN will be from extension if environ.get("DISABLE_CORS"): # disable cors CORS_ALLOW_ALL_ORIGINS = True else: CORS_ALLOWED_ORIGIN_REGEXES = [ r"moz-extension://*", r"chrome-extension://*", ] CORS_ALLOW_CREDENTIALS = True CORS_ALLOW_HEADERS = list(default_headers) + [ "mode", ] CORS_EXPOSE_HEADERS = ["X-Start-Timestamp"] # TA application settings TA_UPSTREAM = "https://github.com/tubearchivist/tubearchivist" TA_VERSION = "v0.5.10-unstable" try: TA_START = RedisArchivist().get_message_str("STARTTIMESTAMP") except ValueError: # fails in unittests bootstrap pass # API REST_FRAMEWORK = { "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema", } SPECTACULAR_SETTINGS = { "TITLE": "Tube Archivist API", "DESCRIPTION": "API documentation for Tube Archivist backend.", "VERSION": TA_VERSION, "SERVE_INCLUDE_SCHEMA": False, "SERVE_PERMISSIONS": ["rest_framework.permissions.IsAuthenticated"], } # Logging configuration LOGGING = { "version": 1, "disable_existing_loggers": False, "handlers": { "console": { "class": "logging.StreamHandler", }, }, "loggers": { "apprise": { "handlers": ["console"], "level": "DEBUG", "propagate": True, }, }, }