diff --git a/CHANGELOG b/CHANGELOG
index dbe23372c4f65f254a3bf043cb4e1328d2818257..5de78527ff78208648d5195df7235c19f91ad0ba 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -5,6 +5,8 @@ smasch (1.0.0~alpha.1-0) unstable; urgency=low
* small improvement: possibility to unfinish visit (#351)
* small improvement: all requests to export data to csv/xls are tracked
(#285)
+ * small improvement: all configuration options that are not obligatory are
+ moved to configuration panel (#343)
-- Piotr Gawron <piotr.gawron@uni.lu> Tue, 10 Nov 2020 14:00:00 +0200
diff --git a/debian-files/smasch.py b/debian-files/smasch.py
index 5a860c1a694174471b8516fc7b2177c903ade16b..357f4639499f4143ff9a72365c523bb38a4159ec 100644
--- a/debian-files/smasch.py
+++ b/debian-files/smasch.py
@@ -7,8 +7,6 @@ DEBUG = False
# Should the static/media files be served by Django
SERVE_STATIC = True
-WSGI_APPLICATION = 'smash.wsgi.application'
-
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
@@ -19,15 +17,8 @@ DATABASES = {
STATIC_ROOT = '/usr/lib/smasch/data/static'
MEDIA_ROOT = '/usr/lib/smasch/data/media'
-LOGIN_PAGE_BACKGROUND_IMAGE = 'background.jpg' # Path to a static file containing background image, used in login.html
-
ALLOWED_HOSTS = ["127.0.0.1", "localhost"]
-STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
-NEXMO_API_KEY = 'API_KEY'
-NEXMO_API_SECRET = 'API_SECRET'
-NEXMO_DEFAULT_FROM = 'Scheduling' # the sender of the message (phone number or text)
-
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
@@ -64,3 +55,4 @@ LOGGING = {
},
}
+TWO_FACTOR_SMS_GATEWAY = "web.nexmo_gateway.Nexmo"
diff --git a/local_settings_ci.py b/local_settings_ci.py
index 498971bd66253cec0e393dde57c6ba2a0828734e..0d3635ecf21577f55f30d9c1512d70c22603bd42 100644
--- a/local_settings_ci.py
+++ b/local_settings_ci.py
@@ -4,8 +4,6 @@ SECRET_KEY = 'Paste long random string here' # Insert long random string
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
-WSGI_APPLICATION = 'smash.wsgi.application'
-
# Database
# https://docs.djangoproject.com/en/1.10/ref/settings/#databases
@@ -29,12 +27,8 @@ DATABASES = {
STATIC_ROOT = '/tmp/static' # Warning! `/tmp` directory can be flushed in any moment; use a persistent one; e.g. ~/tmp/static
MEDIA_ROOT = '/tmp/media' # Warning! `/tmp` directory can be flushed in any moment; use a persistent one, e.g. ~/tmp/media
+UPLOAD_ROOT = '/tmp/upload'
-LOGIN_PAGE_BACKGROUND_IMAGE = 'background.jpg' # Path to a static file containing background image, used in login.html
+STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
ALLOWED_HOSTS = ["127.0.0.1", "localhost"]
-
-STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
-NEXMO_API_KEY = 'API_KEY'
-NEXMO_API_SECRET = 'API_SECRET'
-NEXMO_DEFAULT_FROM = 'Scheduling' # the sender of the message (phone number or text)
diff --git a/local_settings_ci_sqlite.py b/local_settings_ci_sqlite.py
index 2e98aec13d400b12228ab10b4a8c6079527ee217..b56d164043bdf58d8f3194a012f68f960eaf2ed3 100644
--- a/local_settings_ci_sqlite.py
+++ b/local_settings_ci_sqlite.py
@@ -4,8 +4,6 @@ SECRET_KEY = 'Paste long random string here' # Insert long random string
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
-WSGI_APPLICATION = 'smash.wsgi.application'
-
# Database
# https://docs.djangoproject.com/en/1.10/ref/settings/#databases
@@ -18,12 +16,8 @@ DATABASES = {
STATIC_ROOT = '/tmp/static' # Warning! `/tmp` directory can be flushed in any moment; use a persistent one; e.g. ~/tmp/static
MEDIA_ROOT = '/tmp/media' # Warning! `/tmp` directory can be flushed in any moment; use a persistent one, e.g. ~/tmp/media
+UPLOAD_ROOT = '/tmp/upload'
-LOGIN_PAGE_BACKGROUND_IMAGE = 'background.jpg' # Path to a static file containing background image, used in login.html
+STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
ALLOWED_HOSTS = ["127.0.0.1", "localhost"]
-
-STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
-NEXMO_API_KEY = 'API_KEY'
-NEXMO_API_SECRET = 'API_SECRET'
-NEXMO_DEFAULT_FROM = 'Scheduling' # the sender of the message (phone number or text)
diff --git a/smash/db_scripts/import_file.py b/smash/db_scripts/import_file.py
index 71c8486f8c19e26e4a89516bb217d2366c29bb2c..d8d8d18406cdf77f3120eef893e44fb2cf266907 100644
--- a/smash/db_scripts/import_file.py
+++ b/smash/db_scripts/import_file.py
@@ -1,9 +1,10 @@
# coding=utf-8
-import os, sys
+import os
+import sys
+
sys.path.append(sys.path.append(os.path.join(os.path.dirname(__file__), '..'))) #run script as it was on parent folder
import getpass
import django
-from django.conf import settings
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "smash.settings")
django.setup()
from smash.local_settings import MEDIA_ROOT
@@ -15,17 +16,16 @@ import datetime
from dateutil.relativedelta import relativedelta
import re
from operator import itemgetter
-from collections import OrderedDict, defaultdict
-import string
+from collections import OrderedDict
from django.contrib.auth.models import User
-from web.models.constants import VOUCHER_STATUS_IN_USE, SUBJECT_TYPE_CHOICES_PATIENT, GLOBAL_STUDY_ID, SEX_CHOICES, SEX_CHOICES_MALE, SEX_CHOICES_FEMALE
+from web.models.constants import VOUCHER_STATUS_IN_USE, SUBJECT_TYPE_CHOICES_PATIENT, GLOBAL_STUDY_ID, SEX_CHOICES_MALE, SEX_CHOICES_FEMALE
from web.algorithm import VerhoeffAlgorithm, LuhnAlgorithm
from web.utils import is_valid_social_security_number
-from web.models import VoucherType, Voucher, Country, AppointmentTypeLink, AppointmentType, Study, Worker, Language, Subject, WorkerStudyRole, StudySubject, Location, FlyingTeam, Visit, Appointment, AppointmentType
+from web.models import VoucherType, Voucher, Country, AppointmentTypeLink, Study, Worker, Language, Subject, WorkerStudyRole, StudySubject, Location, FlyingTeam, Visit, Appointment, AppointmentType
-from web.models.worker_study_role import ROLE_CHOICES_TECHNICIAN, WORKER_STAFF, ROLE_CHOICES_SECRETARY, ROLE_CHOICES_HEALTH_PARTNER, \
- WORKER_HEALTH_PARTNER, ROLE_CHOICES_DOCTOR, ROLE_CHOICES_VOUCHER_PARTNER, ROLE_CHOICES, ROLE_CHOICES_NURSE, ROLE_CHOICES_PSYCHOLOGIST, ROLE_CHOICES_PROJECT_MANAGER
+from web.models.worker_study_role import ROLE_CHOICES_TECHNICIAN, ROLE_CHOICES_SECRETARY, ROLE_CHOICES_HEALTH_PARTNER, \
+ ROLE_CHOICES_DOCTOR, ROLE_CHOICES_VOUCHER_PARTNER, ROLE_CHOICES_NURSE, ROLE_CHOICES_PSYCHOLOGIST, ROLE_CHOICES_PROJECT_MANAGER
DEFAULT_LOCATION = 'CHL'
DEFAULT_LOCATION_PREFIX = 'P'
diff --git a/smash/smash/context_processors.py b/smash/smash/context_processors.py
index fec3d587a5d3859a9775aa33d56221a21fc66f43..f60066ac7aa617647182e6569a8833219eec31be 100644
--- a/smash/smash/context_processors.py
+++ b/smash/smash/context_processors.py
@@ -1,12 +1,12 @@
-from django.conf import settings
+from web.models import ConfigurationItem
+from web.models.constants import LOGIN_PAGE_BACKGROUND_IMAGE
-BACKGROUND_IMAGE = getattr(settings, "LOGIN_PAGE_BACKGROUND_IMAGE", "background.jpg")
-
+# noinspection PyUnusedLocal
def login_background(request):
"""
Context processor - these values will be available to templates once registered in settings.py
"""
return {
- 'login_page_background': BACKGROUND_IMAGE
+ 'login_page_background': ConfigurationItem.objects.get(type=LOGIN_PAGE_BACKGROUND_IMAGE).value
}
diff --git a/smash/smash/local_settings.py.template b/smash/smash/local_settings.py.template
index dbbf01a34f1d159b043df629b989615a57674971..79c90e5220130d1e6ea9467b312d3edf30beee9b 100644
--- a/smash/smash/local_settings.py.template
+++ b/smash/smash/local_settings.py.template
@@ -4,10 +4,6 @@ SECRET_KEY = 'Paste long random string here' # Insert long random string
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
-WSGI_APPLICATION = 'smash.wsgi.application'
-
-IMPORTER_USER = 'admin' #username
-
EMAIL_USE_TLS = False
EMAIL_USE_SSL = False
EMAIL_HOST = 'smtp.uni.lu'
@@ -15,12 +11,8 @@ EMAIL_HOST_USER = ''
EMAIL_HOST_PASSWORD = ''
EMAIL_PORT = 25
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
-DEFAULT_FROM_EMAIL = 'prc-scheduling-admin@uni.lu'
-ALLOWED_HOSTS = ['prc.parkinson.lu', 'localhost']
-
-# Database
-# https://docs.djangoproject.com/en/1.10/ref/settings/#databases
+ALLOWED_HOSTS = ['your.domain.com', 'localhost']
DATABASES = {
'default': {
@@ -37,16 +29,15 @@ DATABASES = {
}
}
-STATIC_ROOT = '/tmp/static' # Warning! `/tmp` directory can be flushed in any moment; use a persistent one; e.g. ~/tmp/static
-MEDIA_ROOT = '/tmp/media' # Warning! `/tmp` directory can be flushed in any moment; use a persistent one, e.g. ~/tmp/media
-
-LOGIN_PAGE_BACKGROUND_IMAGE = 'background.jpg' # Path to a static file containing background image, used in login.html
-
-STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
-
-NEXMO_API_KEY = 'API_KEY'
-NEXMO_API_SECRET = 'API_SECRET'
-NEXMO_DEFAULT_FROM = 'Scheduling' # the sender of the message (phone number or text)
+# Warning! `/tmp` directory can be flushed in any moment;
+# use a persistent one; e.g. ~/tmp/static
+STATIC_ROOT = '~/tmp/static'
+# Warning! `/tmp` directory can be flushed in any moment;
+# use a persistent one, e.g. ~/tmp/media
+MEDIA_ROOT = '~/tmp/media'
+# Warning! `/tmp` directory can be flushed in any moment;
+# use a persistent one, e.g. ~/tmp/upload
+UPLOAD_ROOT = '~/tmp/upload'
LOGGING = {
'version': 1,
@@ -83,3 +74,5 @@ LOGGING = {
},
},
}
+
+TWO_FACTOR_SMS_GATEWAY = "web.nexmo_gateway.Nexmo"
diff --git a/smash/smash/settings.py b/smash/smash/settings.py
index edaaa38ada3e74eb94a52f64e755b527497e5f30..15be4ea9c4cd68270d4226892658989016d80985 100644
--- a/smash/smash/settings.py
+++ b/smash/smash/settings.py
@@ -20,6 +20,8 @@ PROJECT_PATH = os.path.abspath(os.path.dirname(__file__))
DEBUG = True
+WSGI_APPLICATION = 'smash.wsgi.application'
+
SERVE_STATIC = False
# Application definition
diff --git a/smash/web/importer/csv_tns_visit_import_reader.py b/smash/web/importer/csv_tns_visit_import_reader.py
index 54a111e48701e84413b09810e05db5a7f22e94ae..2669ad51342b94fbffc5e311248b2f61a4b00314 100644
--- a/smash/web/importer/csv_tns_visit_import_reader.py
+++ b/smash/web/importer/csv_tns_visit_import_reader.py
@@ -7,11 +7,11 @@ import sys
import traceback
import pytz
-from django.conf import settings
+from web.models import StudySubject, Study, Visit, Appointment, AppointmentType, Location, AppointmentTypeLink, Subject, \
+ User, Worker, Provenance, ConfigurationItem
+from web.models.constants import GLOBAL_STUDY_ID, IMPORTER_USER, IMPORT_APPOINTMENT_TYPE
from .warning_counter import MsgCounterHandler
-from web.models import StudySubject, Study, Visit, Appointment, AppointmentType, Location, AppointmentTypeLink, Subject, User, Worker, Provenance
-from web.models.constants import GLOBAL_STUDY_ID
CSV_DATE_FORMAT = "%d/%m/%Y"
@@ -21,13 +21,13 @@ logger = logging.getLogger(__name__)
class TnsCsvVisitImportReader:
def __init__(self):
self.study = Study.objects.filter(id=GLOBAL_STUDY_ID)[0]
- appointment_code = getattr(settings, "IMPORT_APPOINTMENT_TYPE", "SAMPLES")
+ appointment_code = ConfigurationItem.objects.get(type=IMPORT_APPOINTMENT_TYPE).value
appointment_types = AppointmentType.objects.filter(code=appointment_code)
if len(appointment_types) > 0:
self.appointment_type = appointment_types[0]
else:
- logger.warn("Appointment type does not exist: " + appointment_code)
+ logger.warning("Appointment type does not exist: " + appointment_code)
self.appointment_type = None
self.problematic_count = 0
self.processed_count = 0
@@ -35,11 +35,11 @@ class TnsCsvVisitImportReader:
self.importer_user = None
- importer_user_name = getattr(settings, "IMPORTER_USER", None)
- if importer_user_name is not None:
+ importer_user_name = ConfigurationItem.objects.get(type=IMPORTER_USER).value
+ if importer_user_name is not None and importer_user_name != '':
user = User.objects.filter(username=importer_user_name)
if user is None:
- logger.warn("User does not exist: " + importer_user_name)
+ logger.warning("User does not exist: " + importer_user_name)
else:
self.importer_user = Worker.objects.filter(user=user)
@@ -100,13 +100,13 @@ class TnsCsvVisitImportReader:
continue
description = '{} changed from "{}" to "{}"'.format(field, old_value, new_value)
p = Provenance(modified_table=Visit._meta.db_table,
- modified_table_id=visit.id,
- modification_author=self.importer_user,
- previous_value=old_value,
- new_value=new_value,
- modification_description=description,
- modified_field=field,
- )
+ modified_table_id=visit.id,
+ modification_author=self.importer_user,
+ previous_value=old_value,
+ new_value=new_value,
+ modification_description=description,
+ modified_field=field,
+ )
setattr(visit, field, new_value)
p.save()
visit.save()
@@ -115,30 +115,30 @@ class TnsCsvVisitImportReader:
datetime_begin=date,
datetime_end=date + datetime.timedelta(days=14))
visit.save()
- #visit does not have id until .save() is done
+ # visit does not have id until .save() is done
for field in Visit._meta.get_fields():
if field.get_internal_type() == "CharField" or field.get_internal_type() == "DateField" or field.get_internal_type() is "BooleanField":
new_value = getattr(visit, field.name)
if new_value is not None and new_value != "":
description = '{} changed from "{}" to "{}"'.format(field, '', new_value)
p = Provenance(modified_table=Visit._meta.db_table,
- modified_table_id=visit.id,
- modification_author=self.importer_user,
- previous_value='',
- new_value=new_value,
- modification_description=description,
- modified_field=field,
- )
+ modified_table_id=visit.id,
+ modification_author=self.importer_user,
+ previous_value='',
+ new_value=new_value,
+ modification_description=description,
+ modified_field=field,
+ )
p.save()
-
+
result.append(visit)
appointments = Appointment.objects.filter(visit=visit, appointment_types=self.appointment_type)
if len(appointments) > 0:
logger.debug("Appointment for subject " + nd_number + " already set. Updating")
appointment = appointments[0]
-
- #(field, new_value)
+
+ # (field, new_value)
changes = [('length', 60),
('datetime_when', date),
('location', location)]
@@ -149,13 +149,13 @@ class TnsCsvVisitImportReader:
continue
description = '{} changed from "{}" to "{}"'.format(field, old_value, new_value)
p = Provenance(modified_table=Appointment._meta.db_table,
- modified_table_id=appointment.id,
- modification_author=self.importer_user,
- previous_value=old_value,
- new_value=new_value,
- modification_description=description,
- modified_field=field,
- )
+ modified_table_id=appointment.id,
+ modification_author=self.importer_user,
+ previous_value=old_value,
+ new_value=new_value,
+ modification_description=description,
+ modified_field=field,
+ )
setattr(appointment, field, new_value)
p.save()
appointment.save()
@@ -165,22 +165,22 @@ class TnsCsvVisitImportReader:
if self.appointment_type is not None:
AppointmentTypeLink.objects.create(appointment_id=appointment.id,
appointment_type=self.appointment_type)
-
+
appointment.save()
- #appointment does not have id until .save() is done
+ # appointment does not have id until .save() is done
for field in Appointment._meta.get_fields():
if field.get_internal_type() == "CharField" or field.get_internal_type() == "DateField" or field.get_internal_type() is "BooleanField":
new_value = getattr(appointment, field.name)
if new_value is not None and new_value != "":
description = '{} changed from "{}" to "{}"'.format(field, '', new_value)
p = Provenance(modified_table=Appointment._meta.db_table,
- modified_table_id=appointment.id,
- modification_author=self.importer_user,
- previous_value='',
- new_value=new_value,
- modification_description=description,
- modified_field=field,
- )
+ modified_table_id=appointment.id,
+ modification_author=self.importer_user,
+ previous_value='',
+ new_value=new_value,
+ modification_description=description,
+ modified_field=field,
+ )
p.save()
self.processed_count += 1
except:
diff --git a/smash/web/importer/exporter_cron_job.py b/smash/web/importer/exporter_cron_job.py
index 4af44d80a508c1b5678d0f578020f2e67fcf85d0..8e4849457d8a9ea72e48ad5ae77de26c01e3dc2c 100644
--- a/smash/web/importer/exporter_cron_job.py
+++ b/smash/web/importer/exporter_cron_job.py
@@ -3,29 +3,33 @@ import logging
import traceback
import timeout_decorator
-from django.conf import settings
from django_cron import CronJobBase, Schedule
+from web.models import ConfigurationItem
+from web.models.constants import CRON_JOB_TIMEOUT, DEFAULT_FROM_EMAIL, DAILY_SUBJECT_EXPORT_FILE, \
+ DAILY_VISIT_EXPORT_FILE, SUBJECT_EXPORT_RUN_AT, VISIT_EXPORT_RUN_AT
+from web.smash_email import EmailSender
from .exporter import SubjectExporter, VisitExporter
-from web.models.constants import CRON_JOB_TIMEOUT
-from ..smash_email import EmailSender
logger = logging.getLogger(__name__)
class SubjectExporterCronJob(CronJobBase):
- RUN_AT_TIMES = getattr(settings, "EXPORT_RUN_AT", ['23:55'])
+ item = ConfigurationItem.objects.filter(type=SUBJECT_EXPORT_RUN_AT).first()
+ RUN_AT_TIMES = []
+ if item is not None:
+ RUN_AT_TIMES = item.value.split(';')
schedule = Schedule(run_at_times=RUN_AT_TIMES)
code = 'web.export_subject_daily_job' # a unique code
@timeout_decorator.timeout(CRON_JOB_TIMEOUT)
def do(self):
email_title = "Daily subject export"
- email_recipients = getattr(settings, "DEFAULT_FROM_EMAIL", None)
+ email_recipients = ConfigurationItem.objects.get(type=DEFAULT_FROM_EMAIL).value
- filename = getattr(settings, "DAILY_SUBJECT_EXPORT_FILE", None)
+ filename = ConfigurationItem.objects.get(type=DAILY_SUBJECT_EXPORT_FILE).value
- if filename is None:
+ if filename is None or filename == '':
logger.info("Exporting subjects skipped. File not defined ")
return "export file not defined"
logger.info("Exporting subjects to file: " + filename)
@@ -47,18 +51,21 @@ class SubjectExporterCronJob(CronJobBase):
class VisitExporterCronJob(CronJobBase):
- RUN_AT_TIMES = getattr(settings, "EXPORT_RUN_AT", ['23:55'])
+ item = ConfigurationItem.objects.filter(type=VISIT_EXPORT_RUN_AT).first()
+ RUN_AT_TIMES = []
+ if item is not None:
+ RUN_AT_TIMES = item.value.split(';')
schedule = Schedule(run_at_times=RUN_AT_TIMES)
code = 'web.export_visit_daily_job' # a unique code
@timeout_decorator.timeout(CRON_JOB_TIMEOUT)
def do(self):
email_title = "Daily visit export"
- email_recipients = getattr(settings, "DEFAULT_FROM_EMAIL", None)
+ email_recipients = ConfigurationItem.objects.get(type=DEFAULT_FROM_EMAIL).value
- filename = getattr(settings, "DAILY_VISIT_EXPORT_FILE", None)
+ filename = ConfigurationItem.objects.get(type=DAILY_VISIT_EXPORT_FILE).value
- if filename is None:
+ if filename is None or filename == '':
logger.info("Exporting visit skipped. File not defined ")
return "export file not defined"
logger.info("Exporting visits to file: " + filename)
diff --git a/smash/web/importer/importer.py b/smash/web/importer/importer.py
index 84eece4d198d39747c32fdedddd829abd17abfcc..00d2bf1d7c2c633ee9c36e6a35b37abd794e32ee 100644
--- a/smash/web/importer/importer.py
+++ b/smash/web/importer/importer.py
@@ -3,13 +3,12 @@ import logging
import sys
import traceback
-from django.conf import settings
from django.contrib.auth.models import User
+from web.models import StudySubject, Subject, Provenance, Worker, ConfigurationItem
+from web.models.constants import GLOBAL_STUDY_ID, IMPORTER_USER
from .subject_import_reader import SubjectImportReader
from .warning_counter import MsgCounterHandler
-from web.models import StudySubject, Subject, Provenance, Worker
-from web.models.constants import GLOBAL_STUDY_ID
logger = logging.getLogger(__name__)
@@ -27,11 +26,11 @@ class Importer(object):
self.importer_user = None
- importer_user_name = getattr(settings, "IMPORTER_USER", None)
- if importer_user_name is not None:
+ importer_user_name = ConfigurationItem.objects.get(type=IMPORTER_USER).value
+ if importer_user_name is not None and importer_user_name != '':
user = User.objects.filter(username=importer_user_name)
if user is None:
- logger.warn("User does not exist: " + importer_user_name)
+ logger.warning("User does not exist: " + importer_user_name)
else:
self.importer_user = Worker.objects.filter(user=user)
diff --git a/smash/web/importer/importer_cron_job.py b/smash/web/importer/importer_cron_job.py
index db4a2da3788785258bcd2b70c372af309c1d4988..1fe761e1fe19a46e95af643a52aa21d86e5f55d7 100644
--- a/smash/web/importer/importer_cron_job.py
+++ b/smash/web/importer/importer_cron_job.py
@@ -6,31 +6,35 @@ import os.path
import traceback
import timeout_decorator
-from django.conf import settings
from django_cron import CronJobBase, Schedule
+from web.models import ConfigurationItem
+from web.models.constants import CRON_JOB_TIMEOUT, DEFAULT_FROM_EMAIL, DAILY_SUBJECT_IMPORT_FILE, \
+ DAILY_VISIT_IMPORT_FILE, SUBJECT_IMPORT_RUN_AT, VISIT_IMPORT_RUN_AT
+from web.smash_email import EmailSender
from .csv_tns_subject_import_reader import TnsCsvSubjectImportReader
from .csv_tns_visit_import_reader import TnsCsvVisitImportReader
from .importer import Importer
-from web.models.constants import CRON_JOB_TIMEOUT
-from ..smash_email import EmailSender
logger = logging.getLogger(__name__)
class SubjectImporterCronJob(CronJobBase):
- RUN_AT_TIMES = getattr(settings, "SUBJECT_IMPORT_RUN_AT", ['23:45'])
+ item = ConfigurationItem.objects.filter(type=SUBJECT_IMPORT_RUN_AT).first()
+ RUN_AT_TIMES = []
+ if item is not None:
+ RUN_AT_TIMES = item.value.split(';')
schedule = Schedule(run_at_times=RUN_AT_TIMES)
code = 'web.import_subjects_daily_job' # a unique code
@timeout_decorator.timeout(CRON_JOB_TIMEOUT)
def do(self):
email_title = "Subjects daily import"
- email_recipients = getattr(settings, "DEFAULT_FROM_EMAIL", None)
+ email_recipients = ConfigurationItem.objects.get(type=DEFAULT_FROM_EMAIL).value
- filename = getattr(settings, "DAILY_SUBJECT_IMPORT_FILE", None)
+ filename = ConfigurationItem.objects.get(type=DAILY_SUBJECT_IMPORT_FILE).value
- if filename is None:
+ if filename is None or filename == '':
logger.info("Importing subjects skipped. File not defined ")
return "import file not defined"
logger.info("Importing subjects from file: " + filename)
@@ -40,7 +44,7 @@ class SubjectImporterCronJob(CronJobBase):
email_recipients)
return "import file not found"
try:
- importer = Importer(settings.DAILY_SUBJECT_IMPORT_FILE, TnsCsvSubjectImportReader())
+ importer = Importer(filename, TnsCsvSubjectImportReader())
importer.execute()
email_body = importer.get_summary()
EmailSender().send_email(email_title,
@@ -63,18 +67,21 @@ class SubjectImporterCronJob(CronJobBase):
class VisitImporterCronJob(CronJobBase):
- RUN_AT_TIMES = getattr(settings, "VISIT_IMPORT_RUN_AT", ['23:55'])
+ item = ConfigurationItem.objects.filter(type=VISIT_IMPORT_RUN_AT).first()
+ RUN_AT_TIMES = []
+ if item is not None:
+ RUN_AT_TIMES = item.value.split(';')
schedule = Schedule(run_at_times=RUN_AT_TIMES)
code = 'web.import_visits_daily_job' # a unique code
@timeout_decorator.timeout(CRON_JOB_TIMEOUT)
def do(self):
email_title = "Visits daily import"
- email_recipients = getattr(settings, "DEFAULT_FROM_EMAIL", None)
+ email_recipients = ConfigurationItem.objects.get(type=DEFAULT_FROM_EMAIL).value
- filename = getattr(settings, "DAILY_VISIT_IMPORT_FILE", None)
+ filename = ConfigurationItem.objects.get(type=DAILY_VISIT_IMPORT_FILE).value
- if filename is None:
+ if filename is None or filename == '':
logger.info("Importing visits skipped. File not defined ")
return "import file not defined"
logger.info("Importing visits from file: " + filename)
diff --git a/smash/web/migrations/0176_configurationitem_local_setting_clean.py b/smash/web/migrations/0176_configurationitem_local_setting_clean.py
new file mode 100644
index 0000000000000000000000000000000000000000..3723e5377c976ee1736dba7245b31f0baf8372a4
--- /dev/null
+++ b/smash/web/migrations/0176_configurationitem_local_setting_clean.py
@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+from django.conf import settings
+from django.db import migrations
+
+from web.models.constants import DEFAULT_FROM_EMAIL, DAILY_SUBJECT_IMPORT_FILE, DAILY_SUBJECT_EXPORT_FILE, \
+ DAILY_VISIT_IMPORT_FILE, DAILY_VISIT_EXPORT_FILE, SUBJECT_IMPORT_RUN_AT, SUBJECT_EXPORT_RUN_AT, \
+ VISIT_EXPORT_RUN_AT, VISIT_IMPORT_RUN_AT, IMPORTER_USER, IMPORT_APPOINTMENT_TYPE, NEXMO_API_KEY, NEXMO_API_SECRET, \
+ NEXMO_DEFAULT_FROM, LOGIN_PAGE_BACKGROUND_IMAGE
+
+
+def create_item(apps, item_type, value, name):
+ # We can't import the ConfigurationItem model directly as it may be a newer
+ # version than this migration expects. We use the historical version.
+
+ # noinspection PyPep8Naming
+ ConfigurationItem = apps.get_model("web", "ConfigurationItem")
+ item = ConfigurationItem.objects.create()
+ item.type = item_type
+ item.value = value
+ item.name = name
+ item.save()
+
+
+# noinspection PyUnusedLocal
+def configuration_items(apps, schema_editor):
+ email_from = getattr(settings, "DEFAULT_FROM_EMAIL", '')
+ create_item(apps, DEFAULT_FROM_EMAIL, email_from,
+ "Default email address used in the from field when sending emails")
+
+ subject_import_file = getattr(settings, "DAILY_SUBJECT_IMPORT_FILE", '')
+ create_item(apps, DAILY_SUBJECT_IMPORT_FILE, subject_import_file, "File used to import subjects automatically")
+
+ subject_export_file = getattr(settings, "DAILY_SUBJECT_EXPORT_FILE", '')
+ create_item(apps, DAILY_SUBJECT_EXPORT_FILE, subject_export_file, "File used to export subjects automatically")
+
+ visit_import_file = getattr(settings, "DAILY_VISIT_IMPORT_FILE", '')
+ create_item(apps, DAILY_VISIT_IMPORT_FILE, visit_import_file, "File used to import visits automatically")
+
+ visit_export_file = getattr(settings, "DAILY_VISIT_EXPORT_FILE", '')
+ create_item(apps, DAILY_VISIT_EXPORT_FILE, visit_export_file, "File used to export visits automatically")
+
+ subject_import_run_at_times = getattr(settings, "SUBJECT_IMPORT_RUN_AT", ['23:45'])
+ create_item(apps, SUBJECT_IMPORT_RUN_AT, ';'.join(subject_import_run_at_times),
+ "At what times should the subject importer run")
+
+ export_run_at_times = getattr(settings, "EXPORT_RUN_AT", ['23:55'])
+ create_item(apps, SUBJECT_EXPORT_RUN_AT, ';'.join(export_run_at_times),
+ "At what times should the subject exporter run")
+ create_item(apps, VISIT_EXPORT_RUN_AT, ';'.join(export_run_at_times),
+ "At what times should the visit exporter run")
+
+ visit_import_run_at_times = getattr(settings, "VISIT_IMPORT_RUN_AT", ['23:55'])
+ create_item(apps, VISIT_IMPORT_RUN_AT, ';'.join(visit_import_run_at_times),
+ "At what times should the visit importer run")
+
+ importer_user_name = getattr(settings, "IMPORTER_USER", '')
+ create_item(apps, IMPORTER_USER, importer_user_name,
+ "User that should be assigned to changes introduced by importer")
+
+ appointment_code = getattr(settings, "IMPORT_APPOINTMENT_TYPE", "SAMPLES")
+ create_item(apps, IMPORT_APPOINTMENT_TYPE, appointment_code,
+ "Type of appointment assigned to imported visits")
+
+ nexmo_api_key = getattr(settings, 'NEXMO_API_KEY', '')
+ create_item(apps, NEXMO_API_KEY, nexmo_api_key, "NEXMO API KEY")
+
+ nexmo_api_secret = getattr(settings, 'NEXMO_API_SECRET', '')
+ create_item(apps, NEXMO_API_SECRET, nexmo_api_secret, "NEXMO API SECRET")
+
+ nexmo_api_from = getattr(settings, 'NEXMO_DEFAULT_FROM', '')
+ create_item(apps, NEXMO_DEFAULT_FROM, nexmo_api_from, "The sender of the message from NEXMO (phone number or text)")
+
+ background_image = getattr(settings, "LOGIN_PAGE_BACKGROUND_IMAGE", "background.jpg")
+ create_item(apps, LOGIN_PAGE_BACKGROUND_IMAGE, background_image,
+ "Path to a static file containing background image, used in login.html")
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ('web', '0175_auto_20201109_1404'),
+ ]
+
+ operations = [
+ migrations.RunPython(configuration_items),
+ ]
diff --git a/smash/web/models/constants.py b/smash/web/models/constants.py
index 5b7c92f906c90c11377ac8ebc039a68185971d97..f061f3061fe03099a3355dd489092b1cb96f3fcf 100644
--- a/smash/web/models/constants.py
+++ b/smash/web/models/constants.py
@@ -56,6 +56,21 @@ KIT_EMAIL_DAY_OF_WEEK_CONFIGURATION_TYPE = "KIT_EMAIL_DAY_OF_WEEK_CONFIGURATION_
KIT_DAILY_EMAIL_DAYS_PERIOD_TYPE = "KIT_DAILY_EMAIL_DAYS_PERIOD_TYPE"
KIT_DAILY_EMAIL_TIME_FORMAT_TYPE = "KIT_DAILY_EMAIL_TIME_FORMAT_TYPE"
VIRUS_EMAIL_HOUR_CONFIGURATION_TYPE = "VIRUS_EMAIL_HOUR_CONFIGURATION_TYPE"
+DEFAULT_FROM_EMAIL = "DEFAULT_FROM_EMAIL"
+DAILY_SUBJECT_IMPORT_FILE = "DAILY_SUBJECT_IMPORT_FILE"
+DAILY_SUBJECT_EXPORT_FILE = "DAILY_SUBJECT_EXPORT_FILE"
+DAILY_VISIT_IMPORT_FILE = "DAILY_VISIT_IMPORT_FILE"
+DAILY_VISIT_EXPORT_FILE = "DAILY_VISIT_EXPORT_FILE"
+SUBJECT_IMPORT_RUN_AT = "SUBJECT_IMPORT_RUN_AT"
+SUBJECT_EXPORT_RUN_AT = "SUBJECT_EXPORT_RUN_AT"
+VISIT_EXPORT_RUN_AT = "VISIT_EXPORT_RUN_AT"
+VISIT_IMPORT_RUN_AT = "VISIT_IMPORT_RUN_AT"
+IMPORTER_USER = "IMPORTER_USER"
+IMPORT_APPOINTMENT_TYPE = "IMPORT_APPOINTMENT_TYPE"
+NEXMO_API_KEY = "NEXMO_API_KEY"
+NEXMO_API_SECRET = "NEXMO_API_SECRET"
+NEXMO_DEFAULT_FROM = "NEXMO_DEFAULT_FROM"
+LOGIN_PAGE_BACKGROUND_IMAGE = "LOGIN_PAGE_BACKGROUND_IMAGE"
RED_CAP_LANGUAGE_4_FIELD_TYPE = 'RED_CAP_LANGUAGE_4_FIELD_TYPE'
RED_CAP_LANGUAGE_3_FIELD_TYPE = 'RED_CAP_LANGUAGE_3_FIELD_TYPE'
@@ -72,7 +87,6 @@ RED_CAP_SAMPLE_DATE_FIELD_TYPE = "RED_CAP_SAMPLE_DATE_FIELD_TYPE"
RED_CAP_IGA_STATUS_FIELD_TYPE = "RED_CAP_IGA_STATUS_FIELD_TYPE"
RED_CAP_IGG_STATUS_FIELD_TYPE = "RED_CAP_IGG_STATUS_FIELD_TYPE"
-
MAIL_TEMPLATE_CONTEXT_SUBJECT = 'S'
MAIL_TEMPLATE_CONTEXT_APPOINTMENT = 'A'
MAIL_TEMPLATE_CONTEXT_VISIT = 'V'
diff --git a/smash/web/nexmo_gateway.py b/smash/web/nexmo_gateway.py
index 0b7190bab23a30ad0c22c79dd8759960056e7422..4191639277ed298ed9a3675dc3ac75166d1de78c 100644
--- a/smash/web/nexmo_gateway.py
+++ b/smash/web/nexmo_gateway.py
@@ -1,7 +1,9 @@
import logging
import nexmo
-from django.conf import settings
+
+from web.models import ConfigurationItem
+from web.models.constants import NEXMO_API_KEY, NEXMO_API_SECRET, NEXMO_DEFAULT_FROM
logger = logging.getLogger(__name__)
@@ -26,8 +28,10 @@ class Nexmo:
"""
def __init__(self):
- self.client = nexmo.Client(key=getattr(settings, 'NEXMO_API_KEY'), secret=getattr(settings, 'NEXMO_API_SECRET'))
- self.default_from = getattr(settings, 'NEXMO_DEFAULT_FROM')
+ api_key = ConfigurationItem.objects.get(type=NEXMO_API_KEY).value
+ api_secret = ConfigurationItem.objects.get(type=NEXMO_API_SECRET).value
+ self.client = nexmo.Client(key=api_key, secret=api_secret)
+ self.default_from = ConfigurationItem.objects.get(type=NEXMO_DEFAULT_FROM).value
def send_sms(self, device, token):
body = 'Your authentication token is %s' % token
diff --git a/smash/web/redcap_connector.py b/smash/web/redcap_connector.py
index fde5e61eb13e30a2ad7ea0d1b4d2304b63e6616f..ef62c8bfabd6f7dfbc6ccca165285fcade332571 100644
--- a/smash/web/redcap_connector.py
+++ b/smash/web/redcap_connector.py
@@ -7,7 +7,6 @@ import logging
import certifi
import pycurl
import timeout_decorator
-from django.conf import settings
from django.forms.models import model_to_dict
from django_cron import CronJobBase, Schedule
@@ -20,7 +19,7 @@ from web.models.constants import REDCAP_TOKEN_CONFIGURATION_TYPE, \
RED_CAP_LANGUAGE_2_FIELD_TYPE, RED_CAP_LANGUAGE_1_FIELD_TYPE, RED_CAP_MPOWER_ID_FIELD_TYPE, RED_CAP_DEAD_FIELD_TYPE, \
RED_CAP_SEX_FIELD_TYPE, RED_CAP_DATE_BORN_FIELD_TYPE, RED_CAP_ND_NUMBER_FIELD_TYPE, RED_CAP_VIRUS_FIELD_TYPE, \
GLOBAL_STUDY_ID, RED_CAP_SAMPLE_DATE_FIELD_TYPE, RED_CAP_KIT_ID_FIELD_TYPE, RED_CAP_IGA_STATUS_FIELD_TYPE, \
- RED_CAP_IGG_STATUS_FIELD_TYPE
+ RED_CAP_IGG_STATUS_FIELD_TYPE, IMPORTER_USER, IMPORT_APPOINTMENT_TYPE
from web.models.inconsistent_subject import InconsistentField, InconsistentSubject
from web.models.missing_subject import MissingSubject
@@ -114,11 +113,11 @@ class RedcapConnector(object):
self.importer_user = None
- importer_user_name = getattr(settings, "IMPORTER_USER", None)
- if importer_user_name is not None:
+ importer_user_name = ConfigurationItem.objects.get(type=IMPORTER_USER).value
+ if importer_user_name is not None and importer_user_name != '':
user = User.objects.filter(username=importer_user_name)
if user is None:
- logger.warn("User does not exist: " + importer_user_name)
+ logger.warning("User does not exist: " + importer_user_name)
else:
self.importer_user = Worker.objects.filter(user=user)
@@ -196,7 +195,7 @@ class RedcapConnector(object):
self.add_inconsistent(inconsistent)
def find_inconsistent(self):
- appointment_type_code_to_finish = getattr(settings, "IMPORT_APPOINTMENT_TYPE", None)
+ appointment_type_code_to_finish = ConfigurationItem.objects.get(type=IMPORT_APPOINTMENT_TYPE).value
appointment_type_to_finish = None
if appointment_type_code_to_finish is not None:
appointment_types = AppointmentType.objects.filter(code=appointment_type_code_to_finish)
diff --git a/smash/web/smash_email.py b/smash/web/smash_email.py
index f6fe326c7d9b8500602a26a1d99a3d6dcbc70d6b..1f06b7b60e6955df4f9045d5811ad4873aec1887 100644
--- a/smash/web/smash_email.py
+++ b/smash/web/smash_email.py
@@ -2,10 +2,11 @@
import logging
-from django.conf import settings
-from django.core import mail
from django.core.mail import EmailMessage
+from web.models import ConfigurationItem
+from web.models.constants import DEFAULT_FROM_EMAIL
+
logger = logging.getLogger(__name__)
@@ -13,7 +14,7 @@ class EmailSender(object):
def send_email(self, subject, body, recipients, cc_recipients=None):
if cc_recipients is None:
cc_recipients = []
- email_from = getattr(settings, "DEFAULT_FROM_EMAIL", None)
+ email_from = ConfigurationItem.objects.get(type=DEFAULT_FROM_EMAIL).value
recipient_list = []
for recipient in recipients.split(";"):
recipient_list.append(recipient)
diff --git a/smash/web/tests/importer/test_exporter_cron_job.py b/smash/web/tests/importer/test_exporter_cron_job.py
index 7bb15fc9e5924e97912e7a19d65f9e6c1e7dd67a..e2b657c13727fbf5aeee6c2d381df7e26191121a 100644
--- a/smash/web/tests/importer/test_exporter_cron_job.py
+++ b/smash/web/tests/importer/test_exporter_cron_job.py
@@ -3,24 +3,19 @@
import logging
import tempfile
-from django.conf import settings
+from django.core import mail
from django.test import TestCase
+from django_cron.models import CronJobLog
from web.importer import SubjectExporterCronJob
+from web.models import ConfigurationItem
+from web.models.constants import DAILY_SUBJECT_EXPORT_FILE
logger = logging.getLogger(__name__)
-from django.core import mail
-from django_cron.models import CronJobLog
class TestCronJobExporter(TestCase):
- def setUp(self):
- setattr(settings, "DAILY_SUBJECT_EXPORT_FILE", None)
-
- def tearDown(self):
- setattr(settings, "DAILY_SUBJECT_EXPORT_FILE", None)
-
def test_import_without_configuration(self):
CronJobLog.objects.all().delete()
@@ -34,7 +29,10 @@ class TestCronJobExporter(TestCase):
def test_import(self):
new_file, tmp = tempfile.mkstemp()
- setattr(settings, "DAILY_SUBJECT_EXPORT_FILE", tmp)
+ item = ConfigurationItem.objects.get(type=DAILY_SUBJECT_EXPORT_FILE)
+ item.value = tmp
+ item.save()
+
CronJobLog.objects.all().delete()
job = SubjectExporterCronJob()
diff --git a/smash/web/tests/importer/test_importer_cron_job.py b/smash/web/tests/importer/test_importer_cron_job.py
index 685d5159688408cbb9792d65a17fdf1b61cd513b..2fbfe03ffe435e085239594b7475ce95ac335e47 100644
--- a/smash/web/tests/importer/test_importer_cron_job.py
+++ b/smash/web/tests/importer/test_importer_cron_job.py
@@ -4,22 +4,20 @@ import logging
import tempfile
from shutil import copyfile
-from django.conf import settings
+from django.core import mail
from django.test import TestCase
+from django_cron.models import CronJobLog
from web.importer import SubjectImporterCronJob
+from web.models import ConfigurationItem
+from web.models.constants import DAILY_SUBJECT_IMPORT_FILE
from web.tests.functions import get_resource_path
logger = logging.getLogger(__name__)
-from django.core import mail
-from django_cron.models import CronJobLog
class TestCronJobImporter(TestCase):
- def tearDown(self):
- setattr(settings, "DAILY_SUBJECT_IMPORT_FILE", None)
-
def test_import_without_configuration(self):
CronJobLog.objects.all().delete()
@@ -35,7 +33,9 @@ class TestCronJobImporter(TestCase):
new_file, tmp = tempfile.mkstemp()
copyfile(filename, tmp)
- setattr(settings, "DAILY_SUBJECT_IMPORT_FILE", tmp)
+ conf = ConfigurationItem.objects.get(type=DAILY_SUBJECT_IMPORT_FILE)
+ conf.value = tmp
+ conf.save()
CronJobLog.objects.all().delete()
job = SubjectImporterCronJob()
diff --git a/smash/web/tests/importer/test_tns_csv_visit_import_reader.py b/smash/web/tests/importer/test_tns_csv_visit_import_reader.py
index 475bcf4726a894eff54750c8b88fd452e919d0cb..d15bc9f823833b628c92a0886a06e17fb87cd0dc 100644
--- a/smash/web/tests/importer/test_tns_csv_visit_import_reader.py
+++ b/smash/web/tests/importer/test_tns_csv_visit_import_reader.py
@@ -2,12 +2,13 @@
import logging
-from django.conf import settings
+import pytz
from django.test import TestCase
from django.utils import timezone
from web.importer import TnsCsvVisitImportReader, MsgCounterHandler
-from web.models import Appointment, Visit, StudySubject, AppointmentTypeLink, AppointmentType
+from web.models import Appointment, Visit, StudySubject, AppointmentTypeLink, AppointmentType, ConfigurationItem
+from web.models.constants import IMPORT_APPOINTMENT_TYPE
from web.tests.functions import get_resource_path, create_study_subject, create_appointment_type, create_location
logger = logging.getLogger(__name__)
@@ -17,7 +18,10 @@ class TestTnsCsvVisitReader(TestCase):
def setUp(self):
self.warning_counter = MsgCounterHandler()
logging.getLogger('').addHandler(self.warning_counter)
- setattr(settings, "IMPORT_APPOINTMENT_TYPE", "SAMPLE_2")
+
+ item = ConfigurationItem.objects.get(type=IMPORT_APPOINTMENT_TYPE)
+ item.value = "SAMPLE_2"
+ item.save()
create_appointment_type(code="SAMPLE_2")
create_study_subject(nd_number='cov-000111')
@@ -29,7 +33,6 @@ class TestTnsCsvVisitReader(TestCase):
create_location(name="Ketterthill 1-3, rue de la Continentale 4917 Bascharage")
def tearDown(self):
- setattr(settings, "IMPORT_APPOINTMENT_TYPE", None)
logging.getLogger('').removeHandler(self.warning_counter)
def test_load_data(self):