troggle/settings.py

import logging
import sys
from datetime import date
from pathlib import Path
from socket import gethostname

"""
Django settings for troggle project.

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

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

# print("*  importing troggle/settings.py")
HOSTNAME = gethostname() # "expo" on expo.survex.com
# print(f">>>>running on {HOSTNAME}<<<<")
if HOSTNAME == "expo":
    # print(">>>>running on expo.survex.com<<<<")
    DEVSERVER = False
else:
    print(f">>>>running on dev machine {HOSTNAME} <<<<")
    DEVSERVER = True

        
EPOCH = date.fromisoformat('1970-01-01')

# secrets are imported in localsettings.py from secret_credentials import *
# SECRET_KEY =...

# executables:
GIT = "git"  # command for running git
CAVERN = "cavern"  # for parsing .svx files and producing .3d files
SURVEXPORT = "survexport"  # for parsing .3d files and producing .pos files
MOGRIFY = "mogrify" # for rotating images

NOTABLECAVES1623 = ["290", "264", "258", "161", "204"]
#NOTABLECAVES1626 = []
NOTABLECAVES1626 = ["359"]

# Note that this builds upon the django system installed
# global settings in
# django/conf/global_settings.py which is automatically loaded first.
# read https://docs.djangoproject.com/en/dev/topics/settings/

# Django settings for troggle project.

ALLOWED_HOSTS = ["*", "expo.survex.com", ".survex.com", "localhost", "127.0.0.1", "192.168.0.5"]

ADMINS = (
    ('Wookey', 'wookey@wookware.org'),
    ('Philip', 'philip.sargent@klebos.eu'),
)
MANAGERS = ADMINS

# LOGIN_URL = '/accounts/login/' # this is the default value so does not need to be set

# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# If running in a Windows environment this must be set to the same as your
# system time zone.
USE_TZ = True
TIME_ZONE = "Europe/London"

# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = "en-uk"

SITE_ID = 1

# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True
USE_L10N = True

FIX_PERMISSIONS = []


### LOGGING set up here --------------------
class RequireDevServerTrue(logging.Filter):
    """Filter that only allows records through if DEVSERVER is True."""
    def filter(self, record):
        return DEVSERVER

PRIMARY_LOG_DIR = Path("/var/log/troggle")
FALLBACK_LOG_DIR = "/home/psargent/var-log-troggle"
log_filename = "troggle.log"
    
def get_valid_log_path():
    try:
        PRIMARY_LOG_DIR.mkdir(parents=True, exist_ok=True)
        test_file = PRIMARY_LOG_DIR / ".permissions_test"
        test_file.touch() # Create a tiny file
        test_file.unlink() # Delete it
        return PRIMARY_LOG_DIR / log_filename
    except (PermissionError, OSError):
        FALLBACK_LOG_DIR.mkdir(parents=True, exist_ok=True)
        return FALLBACK_LOG_DIR / log_filename

final_log_path = get_valid_log_path()
 
LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {
        "timestamped": {
            "format": "{asctime} {message}",
            # "format": "{levelname} {asctime} {module} {message}",
            # "format": "{levelname} [{module}:{lineno}] {message}" # for bug reporting
            "style": "{",
            "datefmt": "%Y-%m-%d %H:%M:%S", # No milliseconds
        },
        "simple": {
            "format": "{levelname} {asctime} [{module}:{lineno}] {message}",
            "style": "{",
            "datefmt": "%Y-%m-%d %H:%M:%S", # No milliseconds
        },
    },
    "filters": {
        "require_devserver_true": {
            # Use the full import path to your class
            # If this is in settings.py, you can use 'settings.RequireDevServerTrue'
            "()": "settings.RequireDevServerTrue", 
        },
    },
    "handlers": {
        "file": {
            "level": "WARNING",
            "class": "logging.handlers.RotatingFileHandler",
            "filename": final_log_path,
            "maxBytes": 1024 * 1024 * 5,
            "backupCount": 5,
            "formatter": "timestamped",
        },
        "console": {
            "level": "INFO",
            "filters": ["require_devserver_true"], # Applied here!
            "class": "logging.StreamHandler",
            "formatter": "simple",
        },
    },
    "loggers": {
        "troggle": {
            "handlers": ["file", "console"],
            "level": "INFO",
            "propagate": True,
        },
    },
}
### LOGGING set up end  --------------------


# top-level survex file basename (without .svx)
# SURVEX_TOPNAME = "1623-and-1626-no-schoenberg-hs"
SURVEX_TOPNAME = "troggle_import_root" # same, but without all the 'essentials' gubbins

ROOT_URLCONF = "troggle.urls"  # i.e. troggle/urls.py
LOGOUT_REDIRECT_URL = "/statistics"   # see troggle/core/views/auth.py
LOGIN_REDIRECT_URL = "/controlpanel"  # see troggle/core/views/auth.py

JSON_LOG_ENTRIES="log_entries"

PASSWORD_RESET_TIMEOUT = 3*60*60      # password reset sends an email. The response is valid for 3 hours
#ACCOUNT_ACTIVATION_DAYS = 3 # this is only if we are using django-registration package

SECURE_CONTENT_TYPE_NOSNIFF = True
SECURE_BROWSER_XSS_FILTER = True
# SESSION_COOKIE_SECURE = True # if enabled, cannot login to Django control panel, bug elsewhere?
# CSRF_COOKIE_SECURE = True # if enabled only sends cookies over SSL
X_FRAME_OPTIONS = "DENY"  # changed to "DENY" after I eliminated all the iframes e.g. /xmlvalid.html

DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"  # from Django 3.2

INSTALLED_APPS = (
    "django.contrib.admin",
    "django.contrib.auth",  # includes the url redirections for login, logout, password_reset etc.
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.admindocs",
    "django.forms",  # Required to customise widget templates
    #    'django.contrib.staticfiles', # We put our CSS etc explicitly in the right place so do not need this
    "troggle.core",
)

FORM_RENDERER = "django.forms.renderers.TemplatesSetting"  # Required to customise widget templates

# See the recommended order of these in https://docs.djangoproject.com/en/dev/ref/middleware/
# Note that this is a radically different onion architecture from earlier versions though it looks the same,
# see https://docs.djangoproject.com/en/dev/topics/http/middleware/#upgrading-pre-django-1-10-style-middleware
# Seriously, read this: https://www.webforefront.com/django/middlewaredjango.html which is MUCH BETTER than the docs

# We are NOT using the home-built TroggleAppendSlashMiddleware, NOR are we using the Django system append_slash
MIDDLEWARE = [
    #'django.middleware.security.SecurityMiddleware', # SECURE_SSL_REDIRECT and SECURE_SSL_HOST # we don't use this
    "django.middleware.gzip.GZipMiddleware",  # not needed when expofiles and photos served by apache
    "django.contrib.sessions.middleware.SessionMiddleware",  # Manages sessions, if CSRF_USE_SESSIONS then it needs to be early
    "django.middleware.common.CommonMiddleware",  # DISALLOWED_USER_AGENTS, APPEND_SLASH and PREPEND_WWW
    "django.middleware.csrf.CsrfViewMiddleware",  # Cross Site Request Forgeries by adding hidden form fields to POST
    "django.contrib.auth.middleware.AuthenticationMiddleware",  # Adds the user attribute, representing the currently-logged-in user
    "django.contrib.admindocs.middleware.XViewMiddleware",  # this and docutils needed by admindocs
    "django.contrib.messages.middleware.MessageMiddleware",  # Cookie-based and session-based message support. Needed by admin system
    "django.middleware.clickjacking.XFrameOptionsMiddleware",  # clickjacking protection via the X-Frame-Options header
    #'django.middleware.security.SecurityMiddleware', # SECURE_HSTS_SECONDS, SECURE_CONTENT_TYPE_NOSNIFF, SECURE_BROWSER_XSS_FILTER, SECURE_REFERRER_POLICY, and SECURE_SSL_REDIRECT
    #"troggle.core.middleware.TroggleAppendSlashMiddleware", # modified Feb.2025
]

WSGI_APPLICATION = "troggle.wsgi.application"  # change to asgi as soon as we upgrade to Django 5 ?
# Append slash can't work if we have a universal catchall URL rule, and we do because all the handbook files
# do not have simple prefix. This is why we used to have an /expoweb/ prefix for everything in the website.
# Also site-media etc. 
APPEND_SLASH = False # using django.middleware.common.CommonMiddleware which we need for other things (I think).

QM_PATTERN = r"\[\[\s*[Qq][Mm]:([ABC]?)(\d{4})-(\d*)-(\d*)\]\]"

# Re-enable TinyMCE when Dj upgraded to v3. Also templates/editexpopage.html
# TINYMCE_DEFAULT_CONFIG = {
# 'plugins': "table,spellchecker,paste,searchreplace",
# 'theme': "advanced",
# }
# TINYMCE_SPELLCHECKER = False
# TINYMCE_COMPRESSOR = True

TEST_RUNNER = "django.test.runner.DiscoverRunner"

# print("+  finished importing troggle/settings.py, re-importing localsettings again")
from localsettings import *
# localsettings needs to take precedence. Call it to override any existing vars.