settings.py

# This file is part of JuliaBase-Institute, see http://www.juliabase.org.
# Copyright © 2008–2022 Forschungszentrum Jülich GmbH, Jülich, Germany
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# In particular, you may modify this file freely and even remove this license,
# and offer it as part of a web service, as long as you do not distribute it.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program.  If not, see <http://www.gnu.org/licenses/>.


"""Django settings for a generic JuliaBase installation.
"""

import os, copy
from pathlib import Path
from tzlocal import get_localzone_name
import django, django.utils.log
from django.utils.translation import gettext_lazy as _
from jb_common.settings_defaults import *
from samples.settings_defaults import *


BASE_DIR = Path(os.path.abspath(os.path.dirname(__file__)))
if not os.path.exists(os.path.join(BASE_DIR, "jb_common")) and os.path.exists(os.path.join(BASE_DIR, "..", "juliabase")):
    BASE_DIR = os.path.join(os.path.dirname(BASE_DIR), "juliabase")


DEBUG = True


DEFAULT_AUTO_FIELD = "django.db.models.AutoField"

DEFAULT_FROM_EMAIL = ""
EMAIL_HOST = ""
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [
    ("JuliaBase-Admins", "bronger@physik.rwth-aachen.de"),
]

DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.postgresql",
        "NAME": "juliabase",
        "USER": "juliabase",
        "PASSWORD": "12345",
        "ATOMIC_REQUESTS": True
        }
    }

USE_TZ = True
TIME_ZONE = get_localzone_name()
EMAIL_USE_LOCALTIME = True

LANGUAGE_CODE = "en-us"

USE_I18N = True
USE_L10N = False
DATETIME_FORMAT = "D, j. N Y, H:i:s"
DATE_FORMAT = "D, j. N Y"


LOGGING = copy.deepcopy(django.utils.log.DEFAULT_LOGGING)
LOGGING["handlers"]["mail_admins"]["class"] = "log.AdminEmailHandler"


STATIC_ROOT = "/var/www/juliabase/static/"
MEDIA_ROOT = "/var/www/juliabase/uploads"


# Make sure to use a trailing slash if there is a path component (optional in
# other cases).  Examples: "http://media.lawrence.com",
# "http://example.com/static/"
STATIC_URL = "/static/"

ADMIN_MEDIA_PREFIX = STATIC_URL + "admin/"

SECRET_KEY = get_secret_key_from_file("~/.juliabase_secret_key")

# The reason why we use both ``django.template.loaders.filesystem.Loader`` and
# ``DIRS`` is that we want to be able to extend the overridden template.  This
# is used in institute's "sample claim" views, for example.
TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [BASE_DIR/"templates_root", django.__path__[0] + "/forms/templates"],
        "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",
                                   "jb_common.context_processors.default",
                                   "institute.context_processors.default"],
            "loaders": [("django.template.loaders.cached.Loader", ("django.template.loaders.app_directories.Loader",
                                                                   "django.template.loaders.filesystem.Loader"))]
            }
    }
]
if DEBUG:
    # Switch off caching, so that edits are active immediately
    TEMPLATES[0]["OPTIONS"]["loaders"] = ["django.template.loaders.app_directories.Loader",
                                          "django.template.loaders.filesystem.Loader"]

FORM_RENDERER = "django.forms.renderers.TemplatesSetting"

MIDDLEWARE = [
    "django.middleware.common.CommonMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "jb_common.middleware.MessageMiddleware",
    "django.middleware.locale.LocaleMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "jb_common.middleware.LoggingMiddleware",
    "jb_common.middleware.LocaleMiddleware",
    "samples.middleware.juliabase.ExceptionsMiddleware",
    "jb_common.middleware.JSONClientMiddleware",
    "jb_common.middleware.UserTracebackMiddleware",
]

APPEND_SLASH = False

ROOT_URLCONF = "urls"

INSTALLED_APPS = [
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.admin",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "django.contrib.sites",
    "oai_pmh",
    "institute",
    "samples",
    "jb_common"
]

SITE_ID = 1

JAVASCRIPT_I18N_APPS += ["institute"]

LOGIN_URL = "/login"
LOGIN_REDIRECT_URL = "/"

# This determines which flags are shown
LANGUAGES = [("en", _("English")), ("de", _("German"))]

CACHES = {
    "default": {
        "BACKEND": "django.core.cache.backends.redis.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "TIMEOUT": 3600 * 24 * 28
    }
}
if DEBUG:
    # Switch off caching, so that edits are active immediately
    CACHES = {"default": {"BACKEND": "django.core.cache.backends.dummy.DummyCache"}}

CACHE_MIDDLEWARE_SECONDS = 60 * 60 * 24
CACHE_MIDDLEWARE_KEY_PREFIX = ""

ADD_SAMPLES_VIEW = "institute:add_samples"

MEASUREMENT_DATA_ROOT_DIR = os.path.join(BASE_DIR, "remote_client", "examples")
PDS_ROOT_DIR = os.path.join(MEASUREMENT_DATA_ROOT_DIR, "pds_raw_data")
SOLARSIMULATOR_1_ROOT_DIR = os.path.join(MEASUREMENT_DATA_ROOT_DIR, "solarsimulator_raw_data")

MERGE_CLEANUP_FUNCTION = "institute.utils.base.clean_up_after_merging"

SAMPLE_NAME_FORMATS = {
    "provisional": {"possible_renames": {"new"}},
    "old":         {"pattern": r"{short_year}[A-Z]-\d{{3,4}}([-A-Za-z_/][-A-Za-z_/0-9#()]*)?",
                    "possible_renames": {"new"},
                    "verbose_name": _("old-style")},
    "new":         {"pattern": r"({short_year}-{user_initials}|{external_contact_initials})-[-A-Za-z_/0-9#()]+",
                    "verbose_name": _("new-style")}
}

NAME_PREFIX_TEMPLATES = ["{short_year}-{user_initials}-", "{external_contact_initials}-"]