installations and journals can now set a base theme. #2992

ajrbyers · ajrbyers · commit 565fe9b721b5 · 2022-09-22T15:18:19.000+01:00
diff --git a/src/core/janeway_global_settings.py b/src/core/janeway_global_settings.py
@@ -116,7 +116,6 @@
     'django.middleware.security.SecurityMiddleware',
     'core.middleware.TimezoneMiddleware',
     'core.middleware.SiteSettingsMiddleware',
-    'utils.template_override_middleware.ThemeEngineMiddleware',
     'core.middleware.MaintenanceModeMiddleware',
     'cron.middleware.CronMiddleware',
     'core.middleware.CounterCookieMiddleware',
@@ -548,3 +547,11 @@ def __len__(self):
     CORE_FILETEXT_MODEL = "core.PGFileText"
 
 ENABLE_FULL_TEXT_SEARCH = False
+
+# A core theme must include ALL templates.
+CORE_THEMES = [
+    'OLH',
+    'material',
+    'clean',
+]
+INSTALLATION_BASE_THEME = 'OLH'
diff --git a/src/core/logic.py b/src/core/logic.py
@@ -222,7 +222,7 @@ def get_settings_to_edit(display_group, journal):
         review_form_choices.append([form.pk, form])
 
     if display_group == 'submission':
-        settings = [
+        group_of_settings = [
             {'name': 'disable_journal_submission',
              'object': setting_handler.get_setting('general', 'disable_journal_submission', journal)
              },
@@ -320,7 +320,7 @@ def get_settings_to_edit(display_group, journal):
         setting_group = 'general'
 
     elif display_group == 'review':
-        settings = [
+        group_of_settings = [
             {
                 'name': 'reviewer_guidelines',
                 'object': setting_handler.get_setting('general', 'reviewer_guidelines', journal),
@@ -401,15 +401,15 @@ def get_settings_to_edit(display_group, journal):
             'doi_pattern', 'doi_manager_action_maximum_size', 'title_doi', 'issue_doi_pattern', 'register_issue_dois'
         ]
 
-        settings = process_setting_list(xref_settings, 'Identifiers', journal)
+        group_of_settings = process_setting_list(xref_settings, 'Identifiers', journal)
         setting_group = 'Identifiers'
 
     elif display_group == 'crosscheck':
         xref_settings = [
             'enable', 'username', 'password'
         ]
 
-        settings = process_setting_list(xref_settings, 'crosscheck', journal)
+        group_of_settings = process_setting_list(xref_settings, 'crosscheck', journal)
         setting_group = 'crosscheck'
 
     elif display_group == 'journal':
@@ -421,23 +421,29 @@ def get_settings_to_edit(display_group, journal):
             'switch_language', 'enable_language_text', 'google_analytics_code',
             'use_ga_four', 'display_login_page_notice', 'login_page_notice', 
             'display_register_page_notice', 'register_page_notice',
-            'support_email', 'support_contact_message_for_staff',
-            'replyto_address',
+            'from_address', 'replyto_address',
         ]
 
-        settings = process_setting_list(journal_settings, 'general', journal)
-        settings[3]['choices'] = get_theme_list()
+        group_of_settings = process_setting_list(journal_settings, 'general', journal)
+        group_of_settings[3]['choices'] = get_theme_list()
         setting_group = 'general'
-        settings.append({
-            'name': 'from_address',
-            'object': setting_handler.get_setting('general', 'from_address', journal),
-        })
+
+        if group_of_settings[3].get('object').value not in settings.CORE_THEMES:
+            group_of_settings.append(
+                {
+                    'name': 'journal_base_theme',
+                    'object': setting_handler.get_setting('general', 'journal_base_theme', journal),
+                    'choices': [
+                        [theme, theme]
+                    for theme in settings.CORE_THEMES]
+                },
+            )
 
     elif display_group == 'proofing':
         proofing_settings = [
             'max_proofreaders'
         ]
-        settings = process_setting_list(proofing_settings, 'general', journal)
+        group_of_settings = process_setting_list(proofing_settings, 'general', journal)
         setting_group = 'general'
     elif display_group == 'article':
         article_settings = [
@@ -450,10 +456,10 @@ def get_settings_to_edit(display_group, journal):
             'altmetric_badge_type',
             'hide_author_email_links',
         ]
-        settings = process_setting_list(article_settings, 'article', journal)
+        group_of_settings = process_setting_list(article_settings, 'article', journal)
         setting_group = 'article'
     elif display_group == 'styling':
-        settings = [
+        group_of_settings = [
             {
                 'name': 'enable_editorial_images',
                 'object': setting_handler.get_setting('styling',
@@ -475,18 +481,18 @@ def get_settings_to_edit(display_group, journal):
         ]
         setting_group = 'styling'
     elif display_group == 'news':
-        settings = [
+        group_of_settings = [
             {
                 'name': 'news_title',
                 'object': setting_handler.get_setting('news', 'news_title', journal),
             },
         ]
         setting_group = 'news'
     else:
-        settings = []
+        group_of_settings = []
         setting_group = None
 
-    return settings, setting_group
+    return group_of_settings, setting_group
 
 
 def get_theme_list():
diff --git a/src/templates/admin/elements/forms/group_journal.html b/src/templates/admin/elements/forms/group_journal.html
@@ -7,6 +7,9 @@ <h2>General Journal Settings</h2>
     {% include "admin/elements/forms/field.html" with field=edit_form.journal_issn %}
     {% include "admin/elements/forms/field.html" with field=edit_form.print_issn %}
     {% include "admin/elements/forms/field.html" with field=edit_form.journal_theme %}
+    {% if edit_form.journal_base_theme %}
+        {% include "admin/elements/forms/field.html" with field=edit_form.journal_base_theme %}
+    {% endif %}
     {% include "admin/elements/forms/field.html" with field=edit_form.publisher_name %}
     {% include "admin/elements/forms/field.html" with field=edit_form.publisher_url %}
     {% include "admin/elements/forms/field.html" with field=edit_form.main_contact %}
diff --git a/src/utils/install/journal_defaults.json b/src/utils/install/journal_defaults.json
@@ -719,6 +719,21 @@
             "default": "OLH"
         }
     },
+    {
+        "group": {
+            "name": "general"
+        },
+        "setting": {
+            "description": "When using a custom theme you can set the base theme, when a template from a custom theme is missing templates from the base theme will be used as a backup.",
+            "is_translatable": false,
+            "name": "journal_base_theme",
+            "pretty_name": "Journal Base Theme",
+            "type": "select"
+        },
+        "value": {
+            "default": "OLH"
+        }
+    },
     {
         "group": {
             "name": "general"
diff --git a/src/utils/template_override_middleware.py b/src/utils/template_override_middleware.py
@@ -6,7 +6,6 @@
 import errno
 import io
 import os
-import threading
 import warnings
 
 from django.conf import settings
@@ -16,60 +15,70 @@
 from django.utils._os import safe_join
 from django.utils.deprecation import RemovedInDjango20Warning
 
-from utils import setting_handler, function_cache
-
-_local = threading.local()
-
-
-class ThemeEngineMiddleware(object):
-    """ Handles theming through middleware
-    """
-
-    def process_request(self, request):
-        _local.request = request
-
-    def process_response(self, request, response):
-        if hasattr(_local, 'request'):
-            del _local.request
-        return response
+from utils import setting_handler, function_cache, logic as utils_logic
 
 
 class Loader(BaseLoader):
 
+    @staticmethod
     @function_cache.cache(120)
-    def query_theme_dirs(self, journal):
+    def journal_theme(journal):
         return setting_handler.get_setting('general', 'journal_theme', journal).value
 
-    def get_theme_dirs(self):
+    @staticmethod
+    @function_cache.cache(120)
+    def base_theme(journal):
+        return setting_handler.get_setting('general', 'journal_base_theme', journal).value
 
-        if hasattr(_local, 'request'):
+    def get_theme_dirs(self):
+        from core import models as core_models
+        request = utils_logic.get_current_request()
+        base_theme, theme_setting = None, None
 
-            if _local.request.journal:
+        if request:
+            if request.journal:
                 # this is a journal and we should attempt to retrieve any theme settings
                 try:
-                    theme_setting = self.query_theme_dirs(_local.request.journal)
-                except Exception:
-                    theme_setting = 'clean'
+                    theme_setting = self.journal_theme(request.journal)
+                except core_models.Setting.DoesNotExist:
+                    pass
 
-            elif _local.request.repository:
+                try:
+                    base_theme = self.base_theme(request.journal)
+                except core_models.Setting.DoesNotExist:
+                    pass
+
+            elif request.repository:
+                # only the material theme supports repositories at the moment.
                 theme_setting = 'material'
             else:
                 # this is the press site
-                theme_setting = _local.request.press.theme
-        else:
-            # for some reason the request has not been pulled into the local thread.
-            # we shouldn't really ever arrive here during a request that requires a template
-            theme_setting = 'clean'
+                theme_setting = request.press.theme
 
-        # this is a backup for a missed setting get above.
-        if not theme_setting:
-            theme_setting = 'clean'
+        # allows servers in debug mode to override the theme with ?theme=name in the URL
+        if settings.DEBUG and request and request.GET.get('theme'):
+            theme_setting = request.GET.get('theme')
 
-        if settings.DEBUG and hasattr(_local, 'request') and _local.request.GET.get('theme'):
-            theme_setting = _local.request.GET.get('theme')
+        # order up the themes and return them with engine dirs
+        themes_in_order = list()
+
+        if theme_setting:
+            themes_in_order.append(
+                os.path.join(settings.BASE_DIR, 'themes', theme_setting, 'templates')
+            )
+        if base_theme:
+            themes_in_order.append(
+                os.path.join(settings.BASE_DIR, 'themes', base_theme, 'templates')
+            )
+
+        # if the base_theme and INSTALLATION_BASE_THEME are different,
+        # # append the INSTALLATION_BASE_THEME.
+        if not base_theme == settings.INSTALLATION_BASE_THEME:
+            themes_in_order.append(
+                os.path.join(settings.BASE_DIR, 'themes', settings.INSTALLATION_BASE_THEME, 'templates')
+            )
 
-        return [os.path.join(settings.BASE_DIR, 'themes', theme_setting, 'templates'),
-                os.path.join(settings.BASE_DIR, 'themes', 'clean', 'templates')] + self.engine.dirs
+        return themes_in_order + self.engine.dirs
 
     def get_dirs(self):
         return self.get_theme_dirs()
diff --git a/src/utils/tests.py b/src/utils/tests.py
