settings.py

"""
Django settings for caselaw project.

For more information on this file, see
https://docs.djangoproject.com/en/4.2/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.2/ref/settings/
"""

# Standard library
import os
import sys
from distutils.util import strtobool

# Third-party
import django_heroku
from django.utils.translation import gettext_lazy as _

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = os.environ.get("DJANGO_SECRET_KEY")

# SECURITY WARNING: don't run with debug turned on in production!
# 1) "dumpdata": avoid the Django Debug Toolbar when dumping data
# 2) "loaddata": avoid the Django Debug Toolbar when loading data
# 3) "publish": avoid debug output in published files
# 4) "test": the Django Debug Toolbar can't be used with tests:
#      HINT: Django changes the DEBUG setting to False when running tests.  By
#      default the Django Debug Toolbar is installed because DEBUG is set to
#      True. For most cases, you need to avoid installing the toolbar when
#      running tests. If you feel this check is in error, you can set
#      DEBUG_TOOLBAR_CONFIG['IS_RUNNING_TESTS'] = False to bypass this check.
DEBUG = False
if (
    "dumpdata" not in sys.argv
    and "loaddata" not in sys.argv
    and "publish" not in sys.argv
    and "test" not in sys.argv
):
    DEBUG = bool(
        strtobool(str(os.environ.get("DJANGO_DEBUG_ENABLED", default=False)))
    )

ALLOWED_HOSTS = ["localhost", "127.0.0.1"]


# Application definition

INSTALLED_APPS = [
    "compressor",
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "django_countries",
    "legal_db.apps.LegalDBConfig",
    "markdownx",
    "ordered_model",
    "taggit",
    "widget_tweaks",
]
if DEBUG:  # Debug toolbar
    INSTALLED_APPS.append("debug_toolbar")

if DEBUG:
    # https://django-debug-toolbar.readthedocs.io/en/latest/installation.html
    #   The order of MIDDLEWARE is important. You should include the Debug
    #   Toolbar middleware as early as possible in the list. However, it must
    #   come after any other middleware that encodes the response’s content,
    #   such as GZipMiddleware.
    MIDDLEWARE = [
        # SecurityMiddleware must be listed before other middleware
        "django.middleware.security.SecurityMiddleware",
        "debug_toolbar.middleware.DebugToolbarMiddleware",
        "django.contrib.sessions.middleware.SessionMiddleware",
        "django.middleware.locale.LocaleMiddleware",
        "django.middleware.common.CommonMiddleware",
        "django.middleware.csrf.CsrfViewMiddleware",
        "django.contrib.auth.middleware.AuthenticationMiddleware",
        "django.contrib.messages.middleware.MessageMiddleware",
        "django.middleware.clickjacking.XFrameOptionsMiddleware",
        "whitenoise.middleware.WhiteNoiseMiddleware",
    ]
else:
    MIDDLEWARE = [
        # SecurityMiddleware must be listed before other middleware
        "django.middleware.security.SecurityMiddleware",
        "django.contrib.sessions.middleware.SessionMiddleware",
        "django.middleware.locale.LocaleMiddleware",
        "django.middleware.common.CommonMiddleware",
        "django.middleware.csrf.CsrfViewMiddleware",
        "django.contrib.auth.middleware.AuthenticationMiddleware",
        "django.contrib.messages.middleware.MessageMiddleware",
        "django.middleware.clickjacking.XFrameOptionsMiddleware",
        "whitenoise.middleware.WhiteNoiseMiddleware",
    ]

ROOT_URLCONF = "caselaw.urls"

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
                "django.template.context_processors.request",
                "django.contrib.auth.context_processors.auth",
                "django.contrib.messages.context_processors.messages",
            ],
        },
    },
]
if DEBUG:  # Debug toolbar
    TEMPLATES[0]["OPTIONS"]["context_processors"].append(
        "django.template.context_processors.debug",
    )

WSGI_APPLICATION = "caselaw.wsgi.application"


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

DEFAULT_AUTO_FIELD = "django.db.models.AutoField"

DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.postgresql",
        "NAME": os.environ.get("DJANGO_DATABASE_NAME", "postgres"),
        "USER": os.environ.get("DJANGO_DATABASE_USER", "postgres"),
        "PASSWORD": os.environ.get("DJANGO_DATABASE_PASSWORD"),
        "HOST": os.environ.get("DJANGO_DATABASE_HOST", "127.0.0.1"),
        "PORT": os.environ.get("DJANGO_DATABASE_PORT", "5432"),
    }
}

# See https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables  # noqa: E501

if "GITHUB_WORKFLOW" in os.environ:
    SECRET_KEY = "cbo9e7%1c^ijxoit37^!kbfyikaet%z&*pm&4k(3#h*k%irylt"

    DATABASES = {
        "default": {
            "ENGINE": "django.db.backends.postgresql",
            "NAME": "github_action_testing",
            "USER": "postgres",
            "PASSWORD": "postgres",
            "HOST": "127.0.0.1",
            "PORT": "5432",
        }
    }


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

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


# See https://docs.djangoproject.com/en/4.2/topics/logging
LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {
        "verbose": {
            "format": (
                "%(asctime)s [%(process)d] [%(levelname)s] "
                "pathname=%(pathname)s lineno=%(lineno)s "
                "funcname=%(funcName)s %(message)s"
            ),
            "datefmt": "%Y-%m-%d %H:%M:%S",
        },
        "simple": {"format": "%(levelname)s %(message)s"},
    },
    "handlers": {
        "null": {"level": "DEBUG", "class": "logging.NullHandler"},
        "console": {
            "level": "INFO",
            "class": "logging.StreamHandler",
            "formatter": "verbose",
        },
    },
    "loggers": {
        "django": {
            "handlers": ["console"],
            "level": "DEBUG",
            "propagate": True,
        },
        "django.request": {
            "handlers": ["console"],
            "level": "DEBUG",
            "propagate": False,
        },
    },
}


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

# This matches the language code on Transifex ("en")
LANGUAGE_CODE = "en"

TIME_ZONE = os.environ.get("DJANGO_TIME_ZONE", "UTC")

USE_I18N = True

USE_L10N = True

USE_TZ = True

LOCALE_PATHS = (os.path.join(BASE_DIR, "locale"),)

LANGUAGES = [
    ("en", _("English")),
    ("es", _("Spanish")),
    # Add other languages here
]

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

STATIC_URL = "/static/"

STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")

STATICFILES_FINDERS = [
    "django.contrib.staticfiles.finders.FileSystemFinder",
    "django.contrib.staticfiles.finders.AppDirectoriesFinder",
    "compressor.finders.CompressorFinder",
]

STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"

COMPRESS_PRECOMPILERS = (("text/x-scss", "django_libsass.SassCompiler"),)

COMPRESS_ENABLED = bool(
    strtobool(str(os.environ.get("DJANGO_COMPRESS_ENABLED", True)))
)

COMPRESS_OFFLINE = bool(
    strtobool(str(os.environ.get("DJANGO_COMPRESS_OFFLINE", True)))
)

LIBSASS_OUTPUT_STYLE = os.environ.get("DJANGO_LIBSASS_STYLE", "compressed")


# TLS/SSL (HTTPS)
SECURE_SSL_REDIRECT = bool(
    strtobool(str(os.environ.get("DJANGO_SECURE_SSL_REDIRECT", True)))
)
if SECURE_SSL_REDIRECT:
    SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")

# Debug toolbar
if DEBUG:
    DEBUG_TOOLBAR_CONFIG = {"SHOW_TOOLBAR_CALLBACK": lambda request: DEBUG}

# See https://devcenter.heroku.com/articles/deploying-python
django_heroku.settings(locals(), logging=False)