Refactor ColdFront settings

.gitignore

@@ -18,3 +18,4 @@ coldfront.db
 *.code-workspace
 .vscode
 db.json
+.env

README.md

@@ -18,30 +18,18 @@ Python and released under the GPLv3 license.
 - Integration with 3rd party systems for automation and access control
 - Center director approval system and annual project reviews
 
-## Plug-in Documentation
- - [Slurm](coldfront/plugins/slurm)
- - [FreeIPA](coldfront/plugins/freeipa)
- - [LDAP](coldfront/plugins/ldap_user_search)
- - [Mokey/Hydra OpenID Connect](coldfront/plugins/mokey_oidc)
- - [iQuota](coldfront/plugins/iquota)
- - [Open OnDemand](coldfront/plugins/ondemand)
- - [Open XDMoD](coldfront/plugins/xdmod)
- - [System Monitor](coldfront/plugins/system_monitor) (example of ways to integrate your own plug-ins)
+## Documentation
 
-
-## Installation
-
-[Quick Start Instructions](docs/pages/quickstart.md)
-
-
-## ColdFront Demos
-
-[Animated gifs demonstrating ColdFront features](docs/pages/demos.md)
+For more information on installing and using ColdFront see our [documentation here](https://coldfront.readthedocs.io)
 
 ## Contact Information
-If you would like a live demo followed by QA, please contact us at ccr-coldfront-admin-list@listserv.buffalo.edu. You can also contact us for general inquiries and installation troubleshooting.
+If you would like a live demo followed by QA, please contact us at
+ccr-coldfront-admin-list@listserv.buffalo.edu. You can also contact us for
+general inquiries and installation troubleshooting.
 
-If you would like to join our mailing list to receive news and updates, please send an email to listserv@listserv.buffalo.edu with no subject, and the following command in the body of the message:
+If you would like to join our mailing list to receive news and updates, please
+send an email to listserv@listserv.buffalo.edu with no subject, and the
+following command in the body of the message:
 
 subscribe ccr-open-coldfront-list@listserv.buffalo.edu first_name last_name
 

coldfront/config/auth.py

@@ -0,0 +1,29 @@
+from coldfront.config.env import ENV
+from coldfront.config.base import INSTALLED_APPS, AUTHENTICATION_BACKENDS, TEMPLATES
+
+#------------------------------------------------------------------------------
+# ColdFront default authentication settings
+#------------------------------------------------------------------------------
+AUTHENTICATION_BACKENDS += [
+    'django.contrib.auth.backends.ModelBackend',
+]
+
+LOGIN_URL = '/user/login'
+LOGIN_REDIRECT_URL = '/'
+LOGOUT_REDIRECT_URL = '/'
+
+SU_LOGIN_CALLBACK = "coldfront.core.utils.common.su_login_callback"
+SU_LOGOUT_REDIRECT_URL = "/admin/auth/user/"
+
+SESSION_COOKIE_AGE = 60 * 15
+SESSION_SAVE_EVERY_REQUEST = True
+SESSION_COOKIE_SAMESITE  = 'Strict'
+SESSION_COOKIE_SECURE = True
+
+#------------------------------------------------------------------------------
+# Enable administrators to login as other users
+#------------------------------------------------------------------------------
+if ENV.bool('ENABLE_SU', default=True):
+    AUTHENTICATION_BACKENDS += ['django_su.backends.SuBackend',]
+    INSTALLED_APPS.insert(0, 'django_su')
+    TEMPLATES[0]['OPTIONS']['context_processors'].extend(['django_su.context_processors.is_su', ])

coldfront/config/base.py

@@ -0,0 +1,125 @@
+"""
+Base Django settings for ColdFront project.
+"""
+import os
+import coldfront
+from django.core.management.utils import get_random_secret_key
+from coldfront.config.env import ENV, PROJECT_ROOT
+
+#------------------------------------------------------------------------------
+# Base Django config for ColdFront
+#------------------------------------------------------------------------------
+VERSION = coldfront.VERSION
+BASE_DIR = PROJECT_ROOT()
+ALLOWED_HOSTS = ENV.list('ALLOWED_HOSTS', default=['*'])
+DEBUG = ENV.bool('DEBUG', default=False)
+WSGI_APPLICATION = 'coldfront.config.wsgi.application'
+ROOT_URLCONF = 'coldfront.config.urls'
+
+SECRET_KEY = ENV.str('SECRET_KEY', default='')
+if len(SECRET_KEY) == 0:
+    SECRET_KEY = get_random_secret_key()
+
+#------------------------------------------------------------------------------
+# Locale settings
+#------------------------------------------------------------------------------
+LANGUAGE_CODE = ENV.str('LANGUAGE_CODE', default='en-us')
+TIME_ZONE = ENV.str('TIME_ZONE', default='America/New_York')
+USE_I18N = True
+USE_L10N = True
+USE_TZ = True
+
+#------------------------------------------------------------------------------
+# Django Apps
+#------------------------------------------------------------------------------
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'django.contrib.humanize',
+]
+
+# Additional Apps
+INSTALLED_APPS += [
+    'crispy_forms',
+    'sslserver',
+    'django_q',
+    'simple_history',
+]
+
+# ColdFront Apps
+INSTALLED_APPS += [
+    'coldfront.core.user',
+    'coldfront.core.field_of_science',
+    'coldfront.core.utils',
+    'coldfront.core.portal',
+    'coldfront.core.project',
+    'coldfront.core.resource',
+    'coldfront.core.allocation',
+    'coldfront.core.grant',
+    'coldfront.core.publication',
+    'coldfront.core.research_output',
+]
+
+#------------------------------------------------------------------------------
+# Django Middleware
+#------------------------------------------------------------------------------
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    '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',
+    'simple_history.middleware.HistoryRequestMiddleware',
+]
+
+#------------------------------------------------------------------------------
+# Django authentication backend. See auth.py
+#------------------------------------------------------------------------------
+AUTHENTICATION_BACKENDS = []
+
+#------------------------------------------------------------------------------
+# Django template and site settings
+#------------------------------------------------------------------------------
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [
+            PROJECT_ROOT('site/templates'),
+            '/usr/share/coldfront/site/templates',
+            PROJECT_ROOT('coldfront/templates'),
+        ],
+        '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',
+                'django_settings_export.settings_export',
+            ],
+        },
+    },
+]
+
+CRISPY_TEMPLATE_PACK = 'bootstrap4'
+SETTINGS_EXPORT = []
+
+STATIC_URL = '/static/'
+STATIC_ROOT = PROJECT_ROOT('static_root')
+STATICFILES_DIRS = [
+    PROJECT_ROOT('coldfront/static'),
+]
+
+# Add local site static files
+if os.path.isdir(PROJECT_ROOT('site/static')):
+    STATICFILES_DIRS.insert(0, PROJECT_ROOT('site/static'))
+
+# Add system site static files
+if os.path.isdir('/usr/share/coldfront/site/static'):
+    STATICFILES_DIRS.insert(0, '/usr/share/coldfront/site/static')

coldfront/config/core.py

@@ -0,0 +1,76 @@
+from coldfront.config.base import SETTINGS_EXPORT
+from coldfront.config.env import ENV
+
+#------------------------------------------------------------------------------
+# Advanced ColdFront configurations
+#------------------------------------------------------------------------------
+
+#------------------------------------------------------------------------------
+# General Center Information
+#------------------------------------------------------------------------------
+CENTER_NAME = ENV.str('CENTER_NAME', default='HPC Resources')
+CENTER_HELP_URL = ENV.str('CENTER_HELP_URL', default='')
+CENTER_PROJECT_RENEWAL_HELP_URL = ENV.str('CENTER_PROJECT_RENEWAL_HELP_URL', default='')
+CENTER_BASE_URL = ENV.str('CENTER_BASE_URL', default='')
+
+#------------------------------------------------------------------------------
+# Enable Project Review
+#------------------------------------------------------------------------------
+PROJECT_ENABLE_PROJECT_REVIEW = ENV.bool('PROJECT_ENABLE_PROJECT_REVIEW', default=True)
+
+#------------------------------------------------------------------------------
+# Allocation related
+#------------------------------------------------------------------------------
+ALLOCATION_ENABLE_ALLOCATION_RENEWAL = ENV.bool('ALLOCATION_ENABLE_ALLOCATION_RENEWAL', default=True)
+ALLOCATION_FUNCS_ON_EXPIRE = ['coldfront.core.allocation.utils.test_allocation_function', ]
+
+# This is in days
+ALLOCATION_DEFAULT_ALLOCATION_LENGTH = ENV.int('ALLOCATION_DEFAULT_ALLOCATION_LENGTH', default=365)
+
+
+#------------------------------------------------------------------------------
+# Allow user to select account name for allocation
+#------------------------------------------------------------------------------
+ALLOCATION_ACCOUNT_ENABLED = ENV.bool('ALLOCATION_ACCOUNT_ENABLED', default=False)
+ALLOCATION_ACCOUNT_MAPPING = ENV.dict('ALLOCATION_ACCOUNT_MAPPING', default={})
+
+SETTINGS_EXPORT += [
+    'ALLOCATION_ACCOUNT_ENABLED'
+]
+
+ADMIN_COMMENTS_SHOW_EMPTY = ENV.bool('ADMIN_COMMENTS_SHOW_EMPTY', default=True)
+
+#------------------------------------------------------------------------------
+# Enable invoice functionality
+#------------------------------------------------------------------------------
+INVOICE_ENABLED = ENV.bool('INVOICE_ENABLED', default=True)
+# Override default 'Pending Payment' status
+INVOICE_DEFAULT_STATUS = ENV.str('INVOICE_DEFAULT_STATUS', default='New')
+
+#------------------------------------------------------------------------------
+# Enable Open OnDemand integration
+#------------------------------------------------------------------------------
+ONDEMAND_URL = ENV.str('ONDEMAND_URL', default=None)
+
+#------------------------------------------------------------------------------
+# Default Strings. Override these in local_settings.py
+#------------------------------------------------------------------------------
+LOGIN_FAIL_MESSAGE = ENV.str('LOGIN_FAIL_MESSAGE', '')
+
+EMAIL_DIRECTOR_PENDING_PROJECT_REVIEW_EMAIL = """
+You recently applied for renewal of your account, however, to date you have not entered any publication nor grant info in the ColdFront system. I am reluctant to approve your renewal without understanding why. If there are no relevant publications or grants yet, then please let me know. If there are, then I would appreciate it if you would take the time to enter the data (I have done it myself and it took about 15 minutes). We use this information to help make the case to the university for continued investment in our department and it is therefore important that faculty enter the data when appropriate. Please email xxx-helpexample.com if you need technical assistance.
+
+As always, I am available to discuss any of this.
+
+Best regards
+Director
+
+
+xxx@example.edu
+Phone: (xxx) xxx-xxx
+"""
+
+ACCOUNT_CREATION_TEXT = '''University faculty can submit a help ticket to request an account.
+Please see <a href="#">instructions on our website</a>. Staff, students, and external collaborators must 
+request an account through a university faculty member.
+'''

coldfront/config/database.py

@@ -0,0 +1,54 @@
+import os
+from coldfront.config.env import ENV
+
+#------------------------------------------------------------------------------
+# Database settings
+#------------------------------------------------------------------------------
+# Set this using the DB_URL env variable. Defaults to sqlite. 
+#
+# Examples:
+#
+# MariaDB:
+#  DB_URL=mysql://user:password@127.0.0.1:3306/database
+#
+# Postgresql:
+#  DB_URL=psql://user:password@127.0.0.1:8458/database
+#------------------------------------------------------------------------------
+DATABASES = {
+    'default': ENV.db_url(
+        var='DB_URL',
+        default='sqlite:///'+os.path.join(os.getcwd(), 'coldfront.db')
+    )
+}
+
+
+#------------------------------------------------------------------------------
+# Custom Database settings
+#------------------------------------------------------------------------------
+# You can also override this manually in local_settings.py, for example:
+#
+# NOTE: For mysql you need to: pip install mysqlclient
+#
+# DATABASES = {
+#     'default': {
+#         'ENGINE': 'django.db.backends.mysql',
+#         'NAME': 'coldfront',
+#         'USER': '',
+#         'PASSWORD': '',
+#         'HOST': 'localhost',
+#         'PORT': '',
+#     },
+# }
+#
+# NOTE: For postgresql you need to: pip install psycopg2
+#
+# DATABASES = {
+#     'default': {
+#         'ENGINE': 'django.db.backends.postgresql_psycopg2',
+#         'NAME': 'coldfront',
+#         'USER': '',
+#         'PASSWORD': '',
+#         'HOST': 'localhost',
+#         'PORT': '5432',
+#     },
+# }

coldfront/config/email.py

@@ -0,0 +1,23 @@
+from coldfront.config.env import ENV
+
+#------------------------------------------------------------------------------
+# Email/Notification settings
+#------------------------------------------------------------------------------
+EMAIL_ENABLED = ENV.bool('EMAIL_ENABLED', default=False)
+EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
+EMAIL_HOST = ENV.str('EMAIL_HOST', default='localhost')
+EMAIL_PORT = ENV.int('EMAIL_PORT', default=25)
+EMAIL_HOST_USER = ENV.str('EMAIL_HOST_USER', default='')
+EMAIL_HOST_PASSWORD = ENV.str('EMAIL_HOST_PASSWORD', default='')
+EMAIL_USE_TLS = ENV.bool('EMAIL_USE_TLS', default=False)
+EMAIL_TIMEOUT = ENV.int('EMAIL_TIMEOUT', default=3)
+EMAIL_SUBJECT_PREFIX = ENV.str('EMAIL_SUBJECT_PREFIX', default='[ColdFront]')
+EMAIL_ADMIN_LIST = ENV.list('EMAIL_ADMIN_LIST')
+EMAIL_SENDER = ENV.str('EMAIL_SENDER')
+EMAIL_TICKET_SYSTEM_ADDRESS = ENV.str('EMAIL_TICKET_SYSTEM_ADDRESS')
+EMAIL_DIRECTOR_EMAIL_ADDRESS = ENV.str('EMAIL_DIRECTOR_EMAIL_ADDRESS')
+EMAIL_PROJECT_REVIEW_CONTACT = ENV.str('EMAIL_PROJECT_REVIEW_CONTACT')
+EMAIL_DEVELOPMENT_EMAIL_LIST = ENV.list('EMAIL_DEVELOPMENT_EMAIL_LIST')
+EMAIL_OPT_OUT_INSTRUCTION_URL = ENV.str('EMAIL_OPT_OUT_INSTRUCTION_URL', default='')
+EMAIL_ALLOCATION_EXPIRING_NOTIFICATION_DAYS = ENV.list('EMAIL_ALLOCATION_EXPIRING_NOTIFICATION_DAYS', cast=int, default=[7, 14, 30])
+EMAIL_SIGNATURE = ENV.str('EMAIL_SIGNATURE', default='', multiline=True)

coldfront/config/env.py

@@ -0,0 +1,22 @@
+import environ
+
+ENV = environ.Env()
+PROJECT_ROOT = environ.Path(__file__) - 3
+
+# Default paths to environment files
+env_paths = [
+    PROJECT_ROOT.path('.env'),
+    environ.Path('/etc/coldfront/coldfront.env'),
+]
+
+if ENV.str('COLDFRONT_ENV', default='') != '':
+    env_paths.insert(0, environ.Path(ENV.str('COLDFRONT_ENV')))
+
+# Read in any environment files
+for e in env_paths:
+    try:
+        e.file('')
+        ENV.read_env(e())
+    except FileNotFoundError:
+        pass
+