settings.py

import random
import hashlib

from django.utils import timezone
import django_jinja_knockout
# from django.utils.version import get_version
# from distutils.version import LooseVersion

"""
Django settings for djk_sample project.
"""

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
import os

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/dev/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
# Use string generated by Django get_random_secret_key() in production.
SECRET_KEY = 'sample_secret_key_for_ci!do_not_use_in_production!'

# SECURITY WARNING: don't run with debug turned on in production!
TRUE_STR = ('true', '1', 'on', 'yes', 't')
DEBUG = os.environ.get('DJANGO_DEBUG', 'true').lower() in TRUE_STR
CHERRYPY_STATIC = os.environ.get('CHERRYPY_STATIC', 'false').lower() in TRUE_STR

JS_ERRORS_ALERT = DEBUG
# Requires proper setup of Django email error logging.
JS_ERRORS_LOGGING = not DEBUG

if DEBUG:
    import mimetypes
    mimetypes.add_type("application/javascript", ".ts", True)
    mimetypes.add_type("application/javascript", ".tsx", True)

ALLOWED_HOSTS = ['127.0.0.1']

# Application definition

DJK_APPS = [
    'djk_sample',
    'club_app',
    'event_app',
]

OPTIONAL_APPS = []

try:
    import django_deno
    # django_deno is an optional Javascript module bundler, not required to run in modern browsers
    OPTIONAL_APPS.append('django_deno')
except ImportError:
    pass

try:
    import django_jinja
    OPTIONAL_APPS += [
        'django_jinja',
        'django_jinja.contrib._humanize',
    ]
except ImportError:
    pass

# Order of installed apps is important for Django Template loader to find 'djk_sample/templates/base.html'
# before original allauth 'base.html' is found, when allauth DTL templates are used instead of built-in
# 'django_jinja_knockout._allauth' Jinja2 templates, thus DJK_APPS are included before 'allauth'.
#
# For the same reason, djk_ui app is included before django_jinja_knockout, to make it possible to override
# any of django_jinja_knockout template / macro.
    INSTALLED_APPS = [
        'django.contrib.admin',
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        # 'sites' is required by allauth
        'django.contrib.sites',
    ] + OPTIONAL_APPS + [
        'djk_ui',
        'django_jinja_knockout',
        'django_jinja_knockout._allauth',
    ] + DJK_APPS + [
        'allauth',
        'allauth.account',
        # Required for socialaccount template tag library despite we do not use social login
        'allauth.socialaccount',
    ]

# Since v0.9.0 most of the functionality except resolver_match and view permissions in urls.py
# works without middleware. In such case comment out DJK_MIDDLEWARE and it's references.
DJK_MIDDLEWARE = 'djk_sample.middleware.ContextMiddleware'
# For simple cases it is enough to include original middleware (commented out).
# DJK_MIDDLEWARE = 'django_jinja_knockout.middleware.ContextMiddleware'

MIDDLEWARE = [
    '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',
    'django.middleware.security.SecurityMiddleware',
    'allauth.account.middleware.AccountMiddleware',
    DJK_MIDDLEWARE
]

AUTHENTICATION_BACKENDS = (
    # Needed to login by username in Django admin, regardless of `allauth`
    'django.contrib.auth.backends.ModelBackend',
    # `allauth` specific authentication methods, such as login by e-mail
    'allauth.account.auth_backends.AuthenticationBackend',
)

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse',
        }
    },
    'handlers': {
        'file': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': os.path.join(BASE_DIR, 'logs', 'django_log.sql'),
        },
        'mail_admins': {
            'level': 'ERROR',
            'filters': ['require_debug_false'],
            'class': 'django.utils.log.AdminEmailHandler',
            'include_html': True,
        }
    },
    'loggers': {
        'django': {
            'handlers': ['file', 'mail_admins'],
            'level': 'DEBUG',
            'propagate': True,
        },
    },
}

ROOT_URLCONF = 'djk_sample.urls'

TEMPLATES = []

if 'django_jinja' in OPTIONAL_APPS:
    # Optional support for django_jinja package, may be removed in the future in case there is no updates for it.
    TEMPLATES.append(
        {
            "BACKEND": "django_jinja.backend.Jinja2",
            "APP_DIRS": True,
            "OPTIONS": {
                "environment": "django_jinja_knockout.jinja2.CompatibleEnvironment",
                "match_extension": ".htm",
                "app_dirname": "jinja2",
                'context_processors': [
                    'django.template.context_processors.i18n',
                    # For simple cases it is enough to include original template context processor (commented out).
                    'djk_sample.context_processors.template_context_processor'
                    # 'django_jinja_knockout.context_processors.template_context_processor'
                ]
            },
        },
    )
else:
    # Default, use Django Jinja2 backend with custom environment.
    # One may inherit from EnvironmentPackage class to tweak the environment.
    TEMPLATES.append(
        {
            "BACKEND": "django.template.backends.jinja2.Jinja2",
            "APP_DIRS": True,
            "OPTIONS": {
                'environment': 'django_jinja_knockout.jinja2.environment',
                'context_processors': [
                    'django.template.context_processors.i18n',
                    # For simple cases it is enough to include original template context processor (commented out).
                    'djk_sample.context_processors.template_context_processor'
                    # 'django_jinja_knockout.context_processors.template_context_processor'
                ]
            },
        },
    )


TEMPLATES.append(
    {
        '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',
                # Next line is required only if project uses Django templates (DTL).
                'djk_sample.context_processors.template_context_processor'
            ],
        },
    },
)

WSGI_APPLICATION = 'djk_sample.wsgi.application'


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

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'TEST': {},
    }
}
TEST_DB_NAME = os.environ.get('DJK_TEST_DB_NAME')
if TEST_DB_NAME is None:
    DATABASES['default']['NAME'] = os.path.join(BASE_DIR, 'db.sqlite3')
    DATABASES['default']['TEST']['NAME'] = ':memory:'
else:
    TEST_DB_NAME = os.path.join(BASE_DIR, TEST_DB_NAME)
    DATABASES['default']['NAME'] = TEST_DB_NAME
    DATABASES['default']['TEST']['NAME'] = TEST_DB_NAME

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

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

# Internationalization
# https://docs.djangoproject.com/en/dev/topics/i18n/
# See also DatetimeWidget.formatFixes in /static/djk/js/document.js
LANGUAGE_CODE = 'en-us'

# For manage.py compilemessages to work correctly:
LOCALE_PATHS = [os.path.join(django_jinja_knockout.__path__[0], 'locale')]

TIME_ZONE = 'UTC'

# Use django_jinja_knockout document.js / middleware.py to detect timezone from browser.
USE_JS_TIMEZONE = True

USE_I18N = True

USE_TZ = True


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

VUE_INTERPOLATION = False

STATIC_URL = '/static/'

STATIC_ROOT = os.path.join(BASE_DIR, 'static')

# List of finder classes that know how to find static files in
# various locations.
STATICFILES_FINDERS = (
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    # 'django.contrib.staticfiles.finders.DefaultStorageFinder',
)

DJK_DEFAULT_SCRIPTS = ['sample/js/app.js']

# django_deno dependence is optional and is required only to run with old browsers (e.g. IE11)
# or to create minimized production mode bundle.
if 'django_deno' in OPTIONAL_APPS:

    DENO_ENABLE = True
    DENO_DEBUG = False
    # https://github.com/Dmitri-Sintsov/django-deno/blob/main/django_deno/deno/.vscode/launch.json
    DENO_DEBUG_EXTERNAL = False
    DENO_NO_REMOTE = True
    DENO_RELOAD = False
    DENO_CHECK_LOCK_FILE = True
    DENO_USE_COMPILED_BINARY = True

    DENO_ROLLUP_ENTRY_POINTS = [
        'sample/js/app.js',
        'sample/js/club-grid.js',
        'sample/js/icon-test.js',
        'sample/js/member-grid.js',
        'sample/js/tooltips-grid.js',
    ]

    DENO_ROLLUP_BUNDLES = {
        'djk': {
            # 'useGlobStar': False,
            'writeEntryPoint': 'sample/js/app.js',
            'matches': [
                'djk/js/**',
                # 'djk/js/*',
                # 'djk/js/lib/*',
                # 'djk/js/grid/*',
            ],
            'excludes': [],
            'virtualEntryPoints': 'matches',
            'virtualEntryPointsExcludes': 'excludes',
        },
    }

    # Run $VIRTUAL_ENV/djk-sample/cherry_django.py to check the validity of collectrollup command output bundle.
    DENO_ROLLUP_COLLECT_OPTIONS = {
        'sucrase': True,
        'swc': False,
        'terser': True,
    }

    DENO_SYNTHETIC_NAMED_EXPORTS = {
        # 'document.js': 'ActionTemplateDialog, Actions, Dialog, Grid, GridActions, GridRow, globalIoc, inherit, ui, TabPane',
    }

    # Do not forget to re-run collectrollup management command after changing rollup.js bundles module type:
    DENO_OUTPUT_MODULE_TYPE = 'module' if DEBUG else 'systemjs-module'
    DJK_JS_MODULE_TYPE = DENO_OUTPUT_MODULE_TYPE
else:
    DJK_JS_MODULE_TYPE = 'module'


# List of global client routes that will be injected into every view (globally).
# This is a good idea if some client-side route is frequently used by most views.
# Alternatively one can specify client route url names per view (see the documentation).
# Second element of each tuple defines whether the client-side route should be available to anonymous users.
DJK_CLIENT_ROUTES = {
    ('user_change', True),
    ('equipment_grid', True),
}

# Next setting is required so multiple Django instances running at the same host/IP with different ports
# do not interfere each other (apollo13).
hash_obj = hashlib.md5(BASE_DIR.encode('utf-8'))
SESSION_COOKIE_NAME = f'djk_sessionid_{hash_obj.hexdigest()}'

# As this is the test application, registration with SMTP confirmation is not supported.
# Use:
""" python manage.py createsuperuser """
# or:
"""
python manage.py shell
from django.contrib.auth.models import User
user = User.objects.create_user('user', email='user@gmail.com', password='djk12345')
user.save()
exit()
"""

# For 'allauth'.
SITE_ID = 1
# Prevents infinite redirect when user has no permission to access current view.
ACCOUNT_AUTHENTICATED_LOGIN_REDIRECTS = False
ALLAUTH_DJK_URLS = True

# Login / logout for allauth.
LOGIN_URL = '/accounts/login/'
LOGIN_REDIRECT_URL = "/"
LOGOUT_URL = '/accounts/logout/'

# Pagination settings.
OBJECTS_PER_PAGE = 3 if DEBUG else 10

# unit testing settings
FIXTURE_DIRS = (
    os.path.join(BASE_DIR, 'fixtures'),
)

random.seed(timezone.now().timestamp())