wiki-eleves/app/settings.py

"""
Django settings for the wiki_ens project
"""

from pathlib import Path

from django.contrib.messages import constants as messages
from django.urls import reverse_lazy
from django.utils.translation import gettext_lazy as _
from loadcredential import Credentials

credentials = Credentials(env_prefix="WIKIENS_")

# 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", [])


###
# 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.sites",
    "django.contrib.humanize",
    "django_nyt",
    "mptt",
    "sekizai",
    "sorl.thumbnail",
    "widget_tweaks",
    "shared",  # Keep `shared` above `wiki` to override the default templates
    "wiki_groups",
    "wiki",
    "wiki.plugins.attachments",
    "wiki.plugins.notifications",
    "wiki.plugins.images",
    "wiki.plugins.macros",
    "allauth_ens",
    "allauth",
    "allauth.account",
    "allauth.socialaccount",
    "allauth_ens.providers.clipper",
]


###
# 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.template.context_processors.debug",
                "django.template.context_processors.request",
                "django.contrib.auth.context_processors.auth",
                "django.contrib.messages.context_processors.messages",
                "sekizai.context_processors.sekizai",
            ],
        },
    },
]


###
# 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.db.backends.sqlite3",
            "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 = [
    "allauth.account.auth_backends.AuthenticationBackend",
]

ACCOUNT_ADAPTER = "shared.allauth_adapter.AccountAdapter"
SOCIALACCOUNT_ADAPTER = "shared.allauth_adapter.SocialAccountAdapter"

HOME_URL = reverse_lazy("wiki:root")

LOGIN_URL = "/_profil/login/"
LOGOUT_URL = reverse_lazy("account_logout")
LOGIN_REDIRECT_URL = HOME_URL
ACCOUNT_LOGOUT_REDIRECT_URL = HOME_URL


def _user_display(user):
    return user.get_full_name() or user.username


ACCOUNT_AUTHENTICATED_LOGIN_REDIRECTS = False
ACCOUNT_HOME_URL = HOME_URL
ACCOUNT_USER_DISPLAY = _user_display

SOCIALACCOUNT_PROVIDERS = {
    "clipper": {
        "MESSAGE_SUGGEST_LOGOUT_ON_LOGOUT": True,
        "MESSAGE_SUGGEST_LOGOUT_ON_LOGOUT_LEVEL": messages.INFO,
    },
}

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

###
# Wiki configuration

WIKI_ATTACHMENTS_EXTENSIONS = [
    "pdf",
    "doc",
    "odt",
    "docx",
    "txt",
    "md",
    "c2p",
    "msc",
    "png",
    "jpg",
    "svg",
    "ai",
    "esf",
    "tex",
]

WIKI_REVISIONS_PER_HOUR = 180
WIKI_REVISIONS_PER_MINUTES = 180

# Use sign up, login, logout, profile settings views of allauth.
WIKI_ACCOUNT_HANDLING = False

# Signup allowed? If it’s not allowed, logged in superusers
# can still access the signup page to create new users.
WIKI_ACCOUNT_SIGNUP_ALLOWED = True

# Globally enable write access for anonymous users, if true anonymous users
# will be treated as the others_write boolean field on models.Article.
WIKI_ANONYMOUS_WRITE = False
WIKI_ANONYMOUS = False


# FIXME: Add correct email settings

# Development settings
if DEBUG:
    EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"