Feature hooks

src/core/models.py

@@ -1160,6 +1160,11 @@ def articles(self):
             journal=self.journal,
         )
 
+    @property
+    def settings(self):
+        from core import workflow
+        return workflow.workflow_plugin_settings(self)
+
     def __str__(self):
         return self.element_name
 

src/core/plugin_loader.py

@@ -11,7 +11,7 @@
 from django.db.utils import OperationalError, ProgrammingError
 
 from core.workflow import ELEMENT_STAGES
-from submission.models import STAGE_CHOICES
+from submission.models import PLUGIN_WORKFLOW_STAGES
 from utils import models
 from utils.logic import get_janeway_version
 
@@ -49,7 +49,7 @@ def load(directory="plugins", prefix="plugins", permissive=False):
             workflow_check = check_plugin_workflow(plugin_settings)
             if workflow_check:
                 settings.WORKFLOW_PLUGINS[workflow_check] = module_name
-                STAGE_CHOICES.append(
+                PLUGIN_WORKFLOW_STAGES.append(
                     (plugin_settings.STAGE, plugin_settings.PLUGIN_NAME)
                 )
                 ELEMENT_STAGES[

src/core/workflow.py

@@ -174,6 +174,10 @@ def articles_in_workflow_stages(request):
     return workflow_list
 
 
+def core_workflow_element_names():
+    return [element.get('name') for element in models.BASE_ELEMENTS]
+
+
 def element_names(elements):
     return [element.element_name for element in elements]
 
@@ -208,3 +212,33 @@ def remove_element(request, journal_workflow, element):
             messages.SUCCESS,
             'Element removed from workflow.'
         )
+
+
+def workflow_plugin_settings(element):
+    """
+    Gets the plugin settings module for a plugin and returns useful settings
+    :param element: a WorkflowElement object
+    :return: dict of useful settings
+    """
+    try:
+        settings_module = import_module(
+            settings.WORKFLOW_PLUGINS[element.element_name],
+        )
+
+        return {
+            'display_name': getattr(settings_module, 'DISPLAY_NAME', ''),
+            'description': getattr(settings_module, 'DESCRIPTION', ''),
+            'kanban_card': getattr(settings_module, 'KANBAN_CARD', ''),
+            'dashboard_template': getattr(
+                settings_module, 'DASHBOARD_TEMPLATE', ''
+            )
+        }
+
+    except (ImportError, KeyError) as e:
+        if settings.DEBUG:
+            print(e)
+        pass
+
+    return {}
+
+

src/journal/models.py

@@ -407,6 +407,12 @@ def article_keywords(self):
             article__in=self.published_articles
         ).order_by('word')
 
+    @property
+    def workflow_plugin_elements(self):
+        return self.workflowelement_set.exclude(
+            element_name__in=workflow.core_workflow_element_names()
+        )
+
 
 class PinnedArticle(models.Model):
     journal = models.ForeignKey(Journal)

src/submission/models.py

@@ -17,7 +17,7 @@
 from hvad.models import TranslatableModel, TranslatedFields
 from django.db.models.signals import pre_delete
 from django.dispatch import receiver
-from django.core.exceptions import ObjectDoesNotExist
+from django.core import exceptions
 
 from core.file_system import JanewayFileSystemStorage
 from identifiers import logic as id_logic
@@ -243,6 +243,8 @@ def article_media_upload(instance, filename):
     (STAGE_PREPRINT_PUBLISHED, 'Preprint Published')
 ]
 
+PLUGIN_WORKFLOW_STAGES = []
+
 
 class ArticleStageLog(models.Model):
     article = models.ForeignKey('Article')
@@ -297,17 +299,28 @@ def get_queryset(self):
         return super(PreprintManager, self).get_queryset().filter(is_preprint=True)
 
 
-class SomeClass(ChoiceField):
-    def valid_value(self):
-        valid = super().valid_value()
-        if valid is False:
-#            check plugin stages
-
-
 class DynamicChoiceField(models.CharField):
+    def __init__(self, dynamic_choices=(), *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.dynamic_choices = dynamic_choices
+
     def formfield(self, *args, **kwargs):
-        kwargs["choices_form_class"] = SomeClass
-        super().formfield(**kwargs)
+        form_element = super().formfield(**kwargs)
+        for choice in self.dynamic_choices:
+            form_element.choices.append(choice)
+        return form_element
+
+    def validate(self, value, model_instance):
+        """
+        Validates value and throws ValidationError.
+        """
+        try:
+            super().validate(value, model_instance)
+        except exceptions.ValidationError:
+            # Check if the value is in dynamic choices and remove the
+            # error message if it is
+            if 'invalid_choice' in self.error_messages and value in self.dynamic_choices:
+                self.error_messages.pop('invalid_choice')
 
 
 class Article(models.Model):
@@ -385,6 +398,7 @@ class Article(models.Model):
         null=False,
         default=STAGE_UNSUBMITTED,
         choices=STAGE_CHOICES,
+        dynamic_choices=PLUGIN_WORKFLOW_STAGES,
     )
 
     # Agreements
@@ -1077,7 +1091,7 @@ def close_core_workflow_objects(self):
     def production_assignment_or_none(self):
         try:
             return self.productionassignment
-        except ObjectDoesNotExist:
+        except exceptions.ObjectDoesNotExist:
             return None
 
     @property

src/templates/admin/core/dashboard.html

@@ -155,6 +155,10 @@ <h2>Proofing Corrections</h2>
             </div>
         {% endif %}
 
+        {% for element in request.journal.workflow_plugin_elements %}
+            {% include element.settings.dashboard_template %}
+        {% endfor %}
+
 
         {% user_has_role request 'section-editor' as sectioneditor %}
         {% if sectioneditor %}