experiENS/app/settings.py

"""
Django settings for the experiENS project
"""

from pathlib import Path

from loadcredential import Credentials

from django.urls import reverse_lazy
from django.utils.translation import gettext_lazy as _

credentials = Credentials(env_prefix="EXPERIENS_")

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent

# WARNING: keep the secret key used in production secret!
SECRET_KEY = credentials["SECRET_KEY"]

# WARNING: don't run with debug turned on in production!
DEBUG = credentials.get_json("DEBUG", False)

ALLOWED_HOSTS = credentials.get_json("ALLOWED_HOSTS", [])

ADMINS = credentials.get_json("ADMINS", [])

SITE_ID = 1


###
# ElasticSearch configuration

USE_ELASTICSEARCH = credentials.get_json("USE_ELASTICSEARCH", False)
ELASTICSEARCH_DSL = credentials.get_json(
    "ELASTICSEARCH_DSL", {"default": {"hosts": "127.0.0.1:9200"}}
)


###
# Libraries configuration

GDAL_LIBRARY_PATH = credentials.get("GDAL_LIBRARY_PATH")
GEOS_LIBRARY_PATH = credentials.get("GEOS_LIBRARY_PATH")


###
# List the installed applications

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "django.contrib.gis",
    "django.contrib.sites",
    *(["django_elasticsearch_dsl"] if USE_ELASTICSEARCH else []),
    "simple_email_confirmation",
    "authens",
    "tastypie",
    "braces",
    "tinymce",
    "taggit",
    "taggit_autosuggest",
    "avisstage",
]


###
# List the installed middlewares

MIDDLEWARE = [
    "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",
]


###
# The main url configuration

ROOT_URLCONF = "app.urls"


###
# Template configuration:
#   - Django Templating Language is used
#   - Application directories can be used


TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
                "django.contrib.auth.context_processors.auth",
                "django.template.context_processors.debug",
                "django.template.context_processors.i18n",
                "django.template.context_processors.media",
                "django.template.context_processors.static",
                "django.template.context_processors.tz",
                "django.template.context_processors.request",
                "django.contrib.messages.context_processors.messages",
            ],
        },
    },
]


###
# Database configuration
#   -> https://docs.djangoproject.com/en/4.2/ref/settings/#databases

DEFAULT_AUTO_FIELD = "django.db.models.AutoField"

DATABASES = credentials.get_json(
    "DATABASES",
    {
        "default": {
            "ENGINE": "django.contrib.gis.db.backends.spatialite",
            "NAME": BASE_DIR / "db.sqlite3",
        }
    },
)

CACHES = credentials.get_json(
    "CACHES",
    default={
        "default": {
            "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
        },
    },
)


###
# WSGI application configuration

WSGI_APPLICATION = "app.wsgi.application"


###
# Staticfiles configuration

STATIC_ROOT = credentials["STATIC_ROOT"]
STATIC_URL = "/static/"

MEDIA_ROOT = credentials.get("MEDIA_ROOT", BASE_DIR / "media")
MEDIA_URL = "/media/"


###
# Internationalization configuration
#   -> https://docs.djangoproject.com/en/4.2/topics/i18n/

LANGUAGE_CODE = "fr-fr"
TIME_ZONE = "Europe/Paris"

USE_I18N = True
USE_L10N = True
USE_TZ = True

LANGUAGES = [
    ("fr", _("Français")),
]


###
# Authentication configuration

AUTHENTICATION_BACKENDS = [
    "django.contrib.auth.backends.ModelBackend",
    "experiENS.auth.ENSCASBackend",
]

CAS_SERVER_URL = "https://cas.eleves.ens.fr/"  # SPI CAS

AUTHENS_USE_OLDCAS = False

LOGIN_URL = reverse_lazy("authens:login")
LOGOUT_URL = reverse_lazy("authens:logout")
LOGIN_REDIRECT_URL = reverse_lazy("avisstage:perso")
LOGOUT_REDIRECT_URL = reverse_lazy("avisstage:index")


AUTH_PASSWORD_VALIDATORS = [
    {"NAME": f"django.contrib.auth.password_validation.{v}"}
    for v in [
        "UserAttributeSimilarityValidator",
        "MinimumLengthValidator",
        "CommonPasswordValidator",
        "NumericPasswordValidator",
    ]
]


###
# Logging configuration

LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "handlers": {
        "file": {
            "level": "INFO",
            "class": "logging.FileHandler",
            "filename": credentials.get(
                "RECHERCHE_LOG_FILE", BASE_DIR / "recherche.log"
            ),
        },
    },
    "loggers": {
        "recherche": {
            "handlers": ["file"],
            "level": "INFO",
            "propagate": True,
        },
    },
}


###
# LDAP configuration

CLIPPER_LDAP_SERVER = credentials.get("CLIPPER_LDAP_SERVER", "ldaps://localhost:636")


# Development settings
if DEBUG:
    EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
    INSTALLED_APPS += [
        "debug_toolbar",
    ]

    MIDDLEWARE = ["debug_toolbar.middleware.DebugToolbarMiddleware", *MIDDLEWARE]