troggle/_deploy/debian/localsettings2023-04-05-cleansed.py

import os
import sys
import urllib.parse
from pathlib import Path

"""Settings for a troggle installation which may vary among different
installations: for development or deployment, in a docker image or
python virtual environment (venv), on ubuntu, debian or in Windows
System for Linux (WSL), on the main server or in the potato hut,
using SQLite or mariaDB.

It sets the directory locations for the major parts of the system so
that e.g. expofiles can be on a different filesystem.

This file is included at the end of the main troggle/settings.py file so that
it overwrites defaults in that file.

NOTE this file is vastly out of sync with troggle/_deploy/wsl/localsettings.py
which is the most recent version used in active maintenance. There should be
essential differences, but there and many, many non-essential differences which 
should be eliminated for clarity and to use modern idioms. 8 March 2023.
"""

print(" * importing troggle/localsettings.py")

# DO NOT check this file into the git repo - it contains real passwords.

EXPOFILESREMOTE = False # if True, then re-routes urls in expofiles to remote sever
#SECURE_SSL_REDIRECT = True # breaks 7 tests in test suite 301 not 200 (or 302) and runserver fails completely

DATABASES = {
    'default': { 
        'ENGINE': 'django.db.backends.mysql', # 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
        'NAME' : 'troggle',                   # Or path to database file if using sqlite3.
        'USER' : 'expo',                      # Not used with sqlite3.
        'PASSWORD' : '123456789012345',       # Not used with sqlite3. Not a real password.
        'HOST' : '',                          # Set to empty string for localhost. Not used with sqlite3.
        'PORT' : '',                          # Set to empty string for default. Not used with sqlite3.
    }
}


EXPOUSER = 'expo'
EXPOUSERPASS = 'Not a real password'
EXPOADMINUSER = 'expoadmin'
EXPOADMINUSERPASS = 'Not a real password'
EXPOUSER_EMAIL = 'wookey@wookware.org'
EXPOADMINUSER_EMAIL = 'wookey@wookware.org'

REPOS_ROOT_PATH = '/home/expo/'
sys.path.append(REPOS_ROOT_PATH)
sys.path.append(REPOS_ROOT_PATH + 'troggle')
# Define the path to the django app (troggle in this case)
PYTHON_PATH = REPOS_ROOT_PATH + 'troggle/'


PHOTOS_YEAR = "2023"
# add in 358 when they don't make it crash horribly
NOTABLECAVESHREFS = [ "290", "291", "359", "264", "258", "204", "76", "107"]

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            PYTHON_PATH + "templates"
        ],
        'OPTIONS': {
            'debug': 'DEBUG',
            'context_processors': [ 
                # django.template.context_processors.csrf, # is always enabled and cannot be removed, sets csrf_token
                'django.contrib.auth.context_processors.auth', # knowledge of logged-on user & permissions
                'core.context.troggle_context',    # in core/troggle.py
                'django.template.context_processors.debug',
                #'django.template.context_processors.request', # copy of current request, added in trying to make csrf work
                'django.template.context_processors.i18n',
                'django.template.context_processors.media',  # includes a variable MEDIA_URL
                'django.template.context_processors.static', # includes a variable STATIC_URL
                'django.template.context_processors.tz',
                'django.contrib.messages.context_processors.messages',
            ],
            'loaders': [
                'django.template.loaders.filesystem.Loader',
                'django.template.loaders.app_directories.Loader', #For each app, inc admin,  in INSTALLED_APPS, loader looks for /templates 
               # insert your own TEMPLATE_LOADERS here
           ]
       },
    },
]

PUBLIC_SITE = True

# This should be False for normal running
DEBUG = False
CACHEDPAGES = True  # experimental page cache for a handful of page types


# executables:
CAVERN = 'cavern' # for parsing .svx files and producing .3d files
SURVEXPORT = 'survexport' # for parsing .3d files and producing .pos files

PV = "python" + str(sys.version_info.major) + "." + str(sys.version_info.minor)
LIBDIR  =  Path(REPOS_ROOT_PATH) / 'lib' / PV 

EXPOWEB = Path(REPOS_ROOT_PATH + 'expoweb/')
SURVEYS = REPOS_ROOT_PATH
SURVEY_SCANS = REPOS_ROOT_PATH + 'expofiles/surveyscans/'
FILES = REPOS_ROOT_PATH + 'expofiles'
PHOTOS_ROOT = REPOS_ROOT_PATH + 'expofiles/photos/'

TROGGLE_PATH = Path(__file__).parent
TEMPLATE_PATH     = TROGGLE_PATH / 'templates'
MEDIA_ROOT        = TROGGLE_PATH / 'media'
JSLIB_ROOT        = TROGGLE_PATH / 'media' / 'jslib' # used for CaveViewer JS utility


CAVEDESCRIPTIONS = EXPOWEB / "cave_data"
ENTRANCEDESCRIPTIONS = EXPOWEB / "entrance_data"


PYTHON_PATH = REPOS_ROOT_PATH + 'troggle/'


#URL_ROOT = 'http://expo.survex.com/'
URL_ROOT = '/'
DIR_ROOT = Path("") #this should end in / if a value is given
EXPOWEB_URL = '/'
SURVEYS_URL = '/survey_scans/'

REPOS_ROOT_PATH = Path(REPOS_ROOT_PATH)

SURVEX_DATA = REPOS_ROOT_PATH / "loser"
DRAWINGS_DATA = REPOS_ROOT_PATH / "drawings"


EXPOFILES = REPOS_ROOT_PATH / "expofiles"
SCANS_ROOT = EXPOFILES / "surveyscans"
PHOTOS_ROOT = EXPOFILES / "photos"

#EXPOFILES   = urllib.parse.urljoin(REPOS_ROOT_PATH, 'expofiles/')
PHOTOS_URL  = urllib.parse.urljoin(URL_ROOT, '/photos/')

# MEDIA_URL is used by urls.py in a regex. See urls.py & core/views_surveys.py
MEDIA_URL = '/site_media/'


STATIC_URL = urllib.parse.urljoin(URL_ROOT , '/static/') # used by Django admin pages. Do not delete.
JSLIB_URL  = urllib.parse.urljoin(URL_ROOT , '/javascript/') # always fails, try to revive it ?
# STATIC_ROOT removed after merging content into MEDIA_ROOT. See urls.py & core/views/surveys.py

#TINY_MCE_MEDIA_ROOT = STATIC_ROOT + '/tiny_mce/' # not needed while TinyMCE not installed
#TINY_MCE_MEDIA_URL = STATIC_URL + '/tiny_mce/' # not needed while TinyMCE not installed

LOGFILE = '/var/log/troggle/troggle.log'
IMPORTLOGFILE = '/var/log/troggle/import.log'

# Sanitise these to be strings as Django seems to be particularly sensitive to crashing if they aren't
STATIC_URL = str(STATIC_URL) + "/"
MEDIA_URL = str(MEDIA_URL) + "/"

print(" + finished importing troggle/localsettings.py")