Merge of typesetting plugin to core

src/core/include_urls.py

@@ -23,30 +23,32 @@
 logger = get_logger(__name__)
 
 urlpatterns = [
-    path('submit/', include('submission.urls')),
     path('', include(journal_urls)),
-    path('review/', include('review.urls')),
-    path('metrics/', include('metrics.urls')),
-    path('identifiers/', include('identifiers.urls')),
-    path('production/', include('production.urls')),
-    path('proofing/', include('proofing.urls')),
+    path('api/', include('api.urls')),
+    path('api-auth/',
+         include('rest_framework.urls', namespace='rest_framework')),
     path('cms/', include('cms.urls')),
-    path('transform/', include('transform.urls')),
     path('copyediting/', include('copyediting.urls')),
-    path('rss/', include('rss.urls')),
-    path('feed/', include('rss.urls')),
     path('cron/', include('cron.urls')),
-    path('install/', include('install.urls')),
+    path('discussion/', include('discussion.urls')),
+    path('feed/', include('rss.urls')),
     path('i18n/', include('django.conf.urls.i18n')),
-    path('api/', include('api.urls')),
-    path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
+    path('identifiers/', include('identifiers.urls')),
+    path('install/', include('install.urls')),
+    path('metrics/', include('metrics.urls')),
     path('news/', include('comms.urls')),
+    path('oidc/', include('mozilla_django_oidc.urls')),
+    path('production/', include('production.urls')),
+    path('proofing/', include('proofing.urls')),
     path('reports/', include('reports.urls')),
     path('repository/', include('repository.urls')),
+    path('review/', include('review.urls')),
+    path('rss/', include('rss.urls')),
+    path('submit/', include('submission.urls')),
+    path('transform/', include('transform.urls')),
+    path('typesetting/', include('typesetting.urls')),
     path('utils/', include('utils.urls')),
     path('workflow/', include('workflow.urls')),
-    path('discussion/', include('discussion.urls')),
-    path('oidc/', include('mozilla_django_oidc.urls')),
 
     # Root Site URLS
     re_path(r'^$', press_views.index, name='website_index'),

src/core/janeway_global_settings.py

@@ -87,6 +87,7 @@
     'security',
     'submission',
     'transform',
+    'typesetting',
     'utils',
     'workflow',
 

src/core/models.py

@@ -1662,16 +1662,11 @@ class Meta:
      'jump_url': 'article_copyediting',
      'stage': submission_models.STAGE_EDITOR_COPYEDITING,
      'article_url': True},
-    {'name': 'production',
-     'handshake_url': 'production_list',
-     'jump_url': 'production_article',
-     'stage': submission_models.STAGE_TYPESETTING,
-     'article_url': False},
-    {'name': 'proofing',
-     'handshake_url': 'proofing_list',
-     'jump_url': 'proofing_article',
-     'stage': submission_models.STAGE_PROOFING,
-     'article_url': False},
+    {'name': 'typesetting',
+     'handshake_url': 'typesetting_articles',
+     'jump_url': 'typesetting_article',
+     'stage': submission_models.STAGE_TYPESETTING_PLUGIN,
+     'article_url': True},
     {'name': 'prepublication',
      'handshake_url': 'publish',
      'jump_url': 'publish_article',

src/events/logic.py

@@ -284,6 +284,18 @@ class Events:
     # raised when a user access request is evaluated by staff.
     ON_ACCESS_REQUEST_COMPLETE = 'on_access_request_complete'
 
+    # Typesetting Events
+    ON_TYPESETTING_COMPLETE = "on_typesetting_complete"
+    ON_TYPESETTING_ASSIGN_NOTIFICATION = "on_typesetting_assign_notification"
+    ON_TYPESETTING_ASSIGN_DECISION = "on_typesetting_assign_decision"
+    ON_TYPESETTING_ASSIGN_CANCELLED = "on_typesetting_assign_cancelled"
+    ON_TYPESETTING_ASSIGN_DELETED = "on_typesetting_assign_deleted"
+    ON_TYPESETTING_ASSIGN_COMPLETE = "on_typesetting_assign_complete"
+    ON_PROOFREADER_ASSIGN_NOTIFICATION = "on_proofreader_assign_notification"
+    ON_PROOFREADER_ASSIGN_CANCELLED = "on_proofreader_assign_cancelled"
+    ON_PROOFREADER_ASSIGN_RESET = "on_proofreader_assign_reset"
+    ON_PROOFREADER_ASSIGN_COMPLETE = "on_proofreader_assign_complete"
+
     DEPRECATED_EVENTS = {
         ON_AUTHOR_PUBLICATION,
     }

src/events/registration.py

@@ -8,11 +8,9 @@
 from events import logic as event_logic
 from journal import logic as journal_logic
 from identifiers import logic as id_logic
+from typesetting.notifications import emails
 
 # wire up event notifications
-
-from events import logic as event_logic  # We always import this as event_logic
-
 # Submission
 event_logic.Events.register_for_event(event_logic.Events.ON_ARTICLE_SUBMITTED,
                                       transactional_emails.send_submission_acknowledgement,
@@ -187,10 +185,67 @@
 event_logic.Events.register_for_event(event_logic.Events.ON_WORKFLOW_ELEMENT_COMPLETE,
                                       workflow.workflow_element_complete)
 
+
+# Typesetting Events
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_TYPESETTING_ASSIGN_NOTIFICATION,
+    emails.send_typesetting_assign_notification,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_TYPESETTING_ASSIGN_DECISION,
+    emails.send_typesetting_assign_decision,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_TYPESETTING_ASSIGN_CANCELLED,
+    emails.send_typesetting_assign_cancelled,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_TYPESETTING_ASSIGN_DELETED,
+    emails.send_typesetting_assign_deleted,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_TYPESETTING_ASSIGN_COMPLETE,
+    emails.send_typesetting_assign_complete,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_PROOFREADER_ASSIGN_NOTIFICATION,
+    emails.send_proofreader_assign_notification,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_PROOFREADER_ASSIGN_CANCELLED,
+    emails.send_proofreader_assign_transaction_email,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_PROOFREADER_ASSIGN_RESET,
+    emails.send_proofreader_assign_transaction_email,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_PROOFREADER_ASSIGN_COMPLETE,
+    emails.send_proofreader_assign_transaction_email,
+)
+
+event_logic.Events.register_for_event(
+    event_logic.Events.ON_TYPESETTING_COMPLETE,
+    emails.send_typesetting_complete,
+)
+
 # wire up the core task destroyer
-# N.B. this is critical to the operation of the task framework. It automatically tears down tasks that have registered
+# N.B. this is critical to the operation of the task framework.
+# It automatically tears down tasks that have registered
 # for event listeners
-event_logic.Events.register_for_event('destroy_tasks', core_models.Task.destroyer)
+event_logic.Events.register_for_event(
+    'destroy_tasks',
+    core_models.Task.destroyer,
+)
 
 event_logic.Events.register_for_event(
     event_logic.Events.ON_ARTICLE_ASSIGNED_TO_ISSUE,

src/journal/views.py

@@ -39,7 +39,7 @@
 )
 from identifiers import models as id_models
 from journal import logic, models, issue_forms, forms, decorators
-from journal.logic import get_best_galley, get_galley_content
+from journal.logic import get_best_galley
 from metrics.logic import store_article_access
 from review import forms as review_forms, models as review_models
 from submission import encoding
@@ -61,7 +61,7 @@
 from utils import models as utils_models, shared, setting_handler
 from utils.logger import get_logger
 from events import logic as event_logic
-from repository import models as repo_models
+from typesetting import models as typesetting_models
 
 logger = get_logger(__name__)
 
@@ -2517,46 +2517,37 @@ def document_management(request, article_id):
             )
 
         if 'proofing' in request.POST:
-            from core import files as core_files
             file = request.FILES.get('proofing-file')
-            new_file = core_files.save_file_to_article(
+            new_file = files.save_file_to_article(
                 file,
                 document_article,
                 request.user,
                 label=label,
             )
-            try:
-                typesetting_models = import_module('plugins.typesetting.models')
-                rounds = typesetting_models.TypesettingRound.objects.filter(
+            rounds = typesetting_models.TypesettingRound.objects.filter(
+                article=document_article,
+            )
+            if rounds:
+                current_round = rounds.first()
+            else:
+                current_round = typesetting_models.TypesettingRound.objects.create(
                     article=document_article,
                 )
-                if rounds:
-                    current_round = rounds.first()
-                else:
-                    current_round = typesetting_models.TypesettingRound.objects.create(
-                        article=document_article,
-                    )
-                request.user.add_account_role('proofreader', request.journal)
-                proofing = typesetting_models.GalleyProofing.objects.create(
-                    round=current_round,
-                    manager=request.user,
-                    proofreader=request.user,
-                    due=timezone.now(),
-                    accepted=timezone.now(),
-                    completed=timezone.now(),
-                )
-                proofing.annotated_files.add(new_file)
-                messages.add_message(
-                    request,
-                    messages.SUCCESS,
-                    _('Proofing file uploaded.'),
-                )
-            except ModuleNotFoundError:
-                messages.add_message(
-                    request,
-                    messages.SUCCESS,
-                    _('Saved file.'),
-                )
+            request.user.add_account_role('proofreader', request.journal)
+            proofing = typesetting_models.GalleyProofing.objects.create(
+                round=current_round,
+                manager=request.user,
+                proofreader=request.user,
+                due=timezone.now(),
+                accepted=timezone.now(),
+                completed=timezone.now(),
+            )
+            proofing.annotated_files.add(new_file)
+            messages.add_message(
+                request,
+                messages.SUCCESS,
+                _('Proofing file uploaded.'),
+            )
 
         if 'supp' in request.POST:
             from production import logic as prod_logic

src/submission/models.py

@@ -241,6 +241,7 @@ def get_jats_article_types():
 STAGE_AUTHOR_COPYEDITING = 'Author Copyediting'
 STAGE_FINAL_COPYEDITING = 'Final Copyediting'
 STAGE_TYPESETTING = 'Typesetting'
+STAGE_TYPESETTING_PLUGIN = 'typesetting_plugin'
 STAGE_PROOFING = 'Proofing'
 STAGE_READY_FOR_PUBLICATION = 'pre_publication'
 STAGE_PUBLISHED = 'Published'
@@ -302,6 +303,7 @@ def get_jats_article_types():
     (STAGE_AUTHOR_COPYEDITING, 'Author Copyediting'),
     (STAGE_FINAL_COPYEDITING, 'Final Copyediting'),
     (STAGE_TYPESETTING, 'Typesetting'),
+    (STAGE_TYPESETTING_PLUGIN, 'typesetting_plugin'),
     (STAGE_PROOFING, 'Proofing'),
     (STAGE_READY_FOR_PUBLICATION, 'Pre Publication'),
     (STAGE_PUBLISHED, 'Published'),

src/templates/admin/core/dashboard.html

@@ -161,6 +161,8 @@ <h2>Proofing Corrections</h2>
             </div>
         {% endif %}
 
+        {% include "typesetting/elements/dashboard.html" %}
+
         {% for element in request.journal.workflow_plugin_elements %}
             {% if element.settings.dashboard_template %}
                 {% include element.settings.dashboard_template %}

src/templates/common/elements/orcid_registration.html

@@ -5,7 +5,7 @@
     {% if orcid %}
         <p>
             ORCiD                            
-            <a href="{{ orcid }}"><img alt="ORCID logo" src="{% static 'common/img/icons/orcid.gif' %}"> {{ orcid }}</a>&nbsp;
+            <a href="{{ orcid }}"><img alt="ORCID logo" src="{% static 'common/img/icons/orcid.png' %}"> {{ orcid }}</a>&nbsp;
             [<a href="{% url 'core_register' %}">remove</a>]
         </p>
     {% else %}

src/themes/OLH/templates/core/accounts/activate_account.html

@@ -1,8 +1,8 @@
+{% extends "core/base.html" %}
 {% comment %}
   This template is deprecated. Account pages are now part of the back-office.
 {% endcomment %}
 
-{% extends "core/base.html" %}
 {% load foundation %}
 {% load i18n %}
 

src/themes/OLH/templates/core/accounts/edit_profile.html

@@ -1,8 +1,8 @@
+{% extends "core/base.html" %}
 {% comment %}
   This template is deprecated. Account pages are now part of the back-office.
 {% endcomment %}
 
-{% extends "core/base.html" %}
 {% load i18n %}
 
 {% block title %}{% trans "Edit Profile" %}{% endblock title %}

src/themes/OLH/templates/core/accounts/get_reset_token.html

@@ -1,8 +1,8 @@
+{% extends "core/base.html" %}
 {% comment %}
   This template is deprecated. Account pages are now part of the back-office.
 {% endcomment %}
 
-{% extends "core/base.html" %}
 {% load i18n foundation %}
 
 

src/themes/OLH/templates/core/accounts/orcid_registration.html

@@ -1,8 +1,8 @@
+{% extends "core/base.html" %}
 {% comment %}
   This template is deprecated. Account pages are now part of the back-office.
 {% endcomment %}
 
-{% extends "core/base.html" %}
 {% load foundation %}
 {% load i18n %}
 

src/themes/OLH/templates/core/accounts/public_profile.html

@@ -1,7 +1,3 @@
-{% comment %}
-  This template is deprecated. Account pages are now part of the back-office.
-{% endcomment %}
-
 {% extends "core/base.html" %}
 {% load static %}
 {% load i18n %}

src/themes/OLH/templates/core/accounts/register.html

@@ -1,8 +1,8 @@
+{% extends "core/base.html" %}
 {% comment %}
   This template is deprecated. Account pages are now part of the back-office.
 {% endcomment %}
 
-{% extends "core/base.html" %}
 {% load foundation %}
 {% load i18n %}
 

src/themes/OLH/templates/core/accounts/reset_password.html

@@ -1,8 +1,8 @@
+{% extends "core/base.html" %}
 {% comment %}
   This template is deprecated. Account pages are now part of the back-office.
 {% endcomment %}
 
-{% extends "core/base.html" %}
 {% load foundation %}
 {% load i18n %}