wip #4138

Author: joemull

docs/md/sequence-fields.md

@@ -0,0 +1,23 @@
+# Sequence fields
+
+A few patterns have become common in Janeway for keeping track of 
+sequence or order with a `PositiveIntegerField`.
+
+Because we sometimes expose this number to end users in form inputs,
+it is worth thinking about the usability of the default value.
+The number 1 is low enough to be easy for end users to manipulate.
+Zero is sometimes most convenient from a programming perspective,
+but avoid it if possible, since it can be counter-intuitive for
+non-programmers.
+
+```py
+    sequence = models.PositiveIntegerField(default=1)
+```
+
+Of course, it is best if end users do not have to deal with
+this number at all. User interfaces should use accessible buttons that
+move things up or down in the sequence. This allows
+us to write an algorithm to check that multiple things have not been
+given the same sequence, and it keeps the user from having to
+recall off-screen information about the order of other items 
+whilst performing an action.

src/core/admin.py

@@ -358,14 +358,28 @@ def _journal(self, obj):
         return obj.group.journal if obj else ''
 
 
-class ContactsAdmin(admin.ModelAdmin):
-    list_display = ('name', 'email', 'role', 'object', 'sequence')
+class ContactPersonAdmin(admin.ModelAdmin):
+    list_display = ('_name', '_email', 'role', 'object', 'sequence')
     list_filter = (admin_utils.GenericRelationJournalFilter,
                    admin_utils.GenericRelationPressFilter)
-    search_fields = ('name', 'email', 'role')
+    search_fields = (
+        'account__first_name',
+        'account__middle_name',
+        'account__last_name',
+        'account__email',
+        'role',
+    )
+    raw_id_fields = ('account', )
+
+    def _name(self, obj):
+        return obj.account.full_name() if obj and obj.account else ''
+
+    def _email(self, obj):
+        return obj.account.email if obj and obj.account else ''
+
 
 
-class ContactAdmin(admin.ModelAdmin):
+class ContactMessageAdmin(admin.ModelAdmin):
     list_display = ('subject', 'sender', 'recipient',
                     'client_ip', 'date_sent', 'object')
     list_filter = (admin_utils.GenericRelationJournalFilter,
@@ -515,8 +529,8 @@ def _person(self, obj):
     (models.Workflow, WorkflowAdmin),
     (models.WorkflowLog, WorkflowLogAdmin),
     (models.LoginAttempt, LoginAttemptAdmin),
-    (models.Contacts, ContactsAdmin),
-    (models.Contact, ContactAdmin),
+    (models.ContactPerson, ContactPersonAdmin),
+    (models.ContactMessage, ContactMessageAdmin),
     (models.AccessRequest, AccessRequestAdmin),
     (models.Organization, OrganizationAdmin),
     (models.OrganizationName, OrganizationNameAdmin),

src/core/forms/__init__.py

@@ -20,7 +20,7 @@
     GetResetTokenForm,
     JournalArticleForm,
     JournalAttributeForm,
-    JournalContactForm,
+    ContactPersonForm,
     JournalImageForm,
     JournalStylingForm,
     JournalSubmissionForm,

src/core/forms/forms.py

@@ -84,19 +84,25 @@ def clean(self):
         return cleaned_data
 
 
-class JournalContactForm(JanewayTranslationModelForm):
+class ContactPersonForm(JanewayTranslationModelForm):
     def __init__(self, *args, **kwargs):
         next_sequence = kwargs.pop('next_sequence', None)
-        super(JournalContactForm, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
         if next_sequence:
             self.fields['sequence'].initial = next_sequence
 
     class Meta:
-        model = models.Contacts
-        fields = ('name', 'email', 'role', 'sequence',)
+        model = models.ContactPerson
+        fields = ('role', 'sequence',)
         exclude = ('content_type', 'object_id',)
 
 
+class JournalContactForm(ContactPersonForm):
+    def __init__(self, *args, **kwargs):
+        return DeprecationWarning("Use ContactPersonForm instead.")
+        super().__init__(*args, **kwargs)
+
+
 class EditorialGroupForm(JanewayTranslationModelForm):
 
     def __init__(self, *args, **kwargs):

src/core/include_urls.py

@@ -174,11 +174,32 @@
     re_path(r'^manager/article/images/edit/(?P<article_pk>\d+)/$', core_views.article_image_edit,
         name='core_article_image_edit'),
 
-    # Journal Contacts
-    re_path(r'^manager/contacts/$', core_views.contacts, name='core_journal_contacts'),
-    re_path(r'^manager/contacts/add/$', core_views.edit_contacts, name='core_new_journal_contact'),
-    re_path(r'^manager/contacts/(?P<contact_id>\d+)/$', core_views.edit_contacts, name='core_journal_contact'),
-    re_path(r'^manager/contacts/order/$', core_views.contacts_order, name='core_journal_contacts_order'),
+    # Contact People
+    re_path(
+        r'^manager/contacts/$',
+        core_views.contact_people,
+        name='core_contact_people',
+    ),
+    re_path(
+        r'^manager/contacts/order/$',
+        core_views.contact_people_reorder,
+        name='core_contact_people_reorder',
+    ),
+    re_path(
+        r'^manager/contacts/search/$',
+        core_views.PotentialContactListView.as_view(),
+        name='core_contact_person_search',
+    ),
+    re_path(
+        r'^manager/contacts/add/(?P<account_id>\d+)/$',
+        core_views.contact_person_create,
+        name='core_contact_person_create',
+    ),
+    re_path(
+        r'^manager/contacts/(?P<contact_person_id>\d+)/$',
+        core_views.contact_person_update,
+        name='core_contact_person_update',
+    ),
 
     # Editorial Team
     re_path(r'^manager/editorial/$', core_views.editorial_team, name='core_editorial_team'),

src/core/middleware.py

@@ -194,8 +194,9 @@ def process_request(request):
                 'core_confirm_account', 'core_orcid_registration', 'core_get_reset_token', 'core_reset_password',
                 'core_edit_profile', 'core_logout', 'press_cover_download', 'core_manager_index',
                 'django_summernote-editor', 'django_summernote-upload_attachment', 'cms_index', 'cms_page_new',
-                'cms_page_edit', 'cms_page', 'cms_nav', 'website_index', 'core_journal_contacts',
-                'core_journal_contact', 'core_journal_contacts_order', 'contact', 'core_edit_settings_group',
+                'cms_page_edit', 'cms_page', 'cms_nav', 'website_index', 'core_contact_people',
+                'core_contact_person_search', 'core_contact_person_create', 'core_contact_person_update',
+                'core_contact_people_reorder', 'contact', 'core_edit_settings_group',
             ]
             allowed_pattern = 'press_'
 

src/core/migrations/0108_rename_contact_contactmessage_and_more.py

@@ -0,0 +1,109 @@
+# Generated by Django 4.2.21 on 2025-07-07 16:18
+
+from django.conf import settings
+from django.db import migrations, models
+from django.utils import translation
+import django.db.models.deletion
+
+
+def connect_contact_person_to_account(apps, schema_editor):
+    ContactPerson = apps.get_model("core", "ContactPerson")
+    Account = apps.get_model("core", "Account")
+    languages = ['cy', 'de', 'en', 'en-us', 'en_us', 'es', 'fr', 'it', 'nl']
+    for contact_person in ContactPerson.objects.all():
+        account, created = Account.objects.get_or_create(
+            username=contact_person.email.lower(),
+            defaults={
+                'first_name': ' '.join(contact_person.name.split()[:-1]),
+                'last_name': contact_person.name.split()[-1],
+                'email': contact_person.email,
+            }
+        )
+        contact_person.account = account
+        for language in languages:
+            with translation.override(language):
+                language_var = "name_{}".format(language)
+                setattr(contact_person, language_var, '')
+        contact_person.email = ''
+        contact_person.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+        ('core', '0107_alter_controlledaffiliation_options_and_more'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='Contact',
+            new_name='ContactMessage',
+        ),
+        migrations.RenameModel(
+            old_name='Contacts',
+            new_name='ContactPerson',
+        ),
+        migrations.AddField(
+            model_name='contactperson',
+            name='account',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='email',
+            field=models.EmailField(blank=True, help_text="The 'email' field is deprecated. Use 'account.email'.", max_length=254),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name_cy',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300, null=True),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name_de',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300, null=True),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name_en',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300, null=True),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name_en_us',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300, null=True),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name_es',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300, null=True),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name_fr',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300, null=True),
+        ),
+        migrations.AlterField(
+            model_name='contactperson',
+            name='name_nl',
+            field=models.CharField(blank=True, help_text="The 'name' field is deprecated. Use 'account.full_name'.", max_length=300, null=True),
+        ),
+        migrations.AlterModelOptions(
+            name='contactmessage',
+            options={},
+        ),
+        migrations.AlterModelOptions(
+            name='contactperson',
+            options={'ordering': ('sequence',)},
+        ),
+        migrations.RunPython(
+            connect_contact_person_to_account,
+            reverse_code=migrations.RunPython.noop,
+        )
+    ]

src/core/models.py

@@ -1662,29 +1662,56 @@ def __str__(self):
         return f'{self.user} in {self.group}'
 
 
-class Contacts(models.Model):
+class ContactPerson(models.Model):
     content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE,
                                      related_name='contact_content_type', null=True)
     object_id = models.PositiveIntegerField(blank=True, null=True)
     object = GenericForeignKey('content_type', 'object_id')
 
-    name = models.CharField(max_length=300)
-    email = models.EmailField()
+    account = models.ForeignKey(
+        Account,
+        on_delete=models.CASCADE,
+        blank=True,
+        null=True,
+    )
     role = models.CharField(max_length=200)
-    sequence = models.PositiveIntegerField(default=999)
+    sequence = models.PositiveIntegerField(default=1)
+
+    name = models.CharField(
+        max_length=300,
+        blank=True,
+        help_text="The 'name' field is deprecated. Use 'account.full_name'.",
+    )
+    email = models.EmailField(
+        blank=True,
+        help_text="The 'email' field is deprecated. Use 'account.email'.",
+    )
 
     class Meta:
-        # This verbose name will hopefully more clearly
-        # distinguish this model from the below model `Contact`
-        # in the admin area.
-        verbose_name_plural = 'contacts'
-        ordering = ('sequence', 'name')
+        ordering = ('sequence',)
+        verbose_name_plural = 'contact people'
 
     def __str__(self):
-        return "{0}, {1} - {2}".format(self.name, self.object, self.role)
+        name = self.account.full_name() if self.account else ''
+        return "{0}, {1} - {2}".format(name, self.object, self.role)
+
+    def __getattribute__(self, name):
+        if name == "name":
+            warnings.warn(
+                "The 'name' field is deprecated. Use 'account.full_name'.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        elif name == "email":
+            warnings.warn(
+                "The 'email' field is deprecated. Use 'account.email'.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        return super().__getattribute__(name)
 
 
-class Contact(models.Model):
+class ContactMessage(models.Model):
     recipient = models.EmailField(max_length=200, verbose_name=_('Who would you like to contact?'))
     sender = models.EmailField(max_length=200, verbose_name=_('Your contact email address'))
     subject = models.CharField(max_length=300, verbose_name=_('Subject'))
@@ -1697,12 +1724,6 @@ class Contact(models.Model):
     object_id = models.PositiveIntegerField(blank=True, null=True)
     object = GenericForeignKey('content_type', 'object_id')
 
-    class Meta:
-        # This verbose name will hopefully more clearly
-        # distinguish this model from the above model `Contacts`
-        # in the admin area.
-        verbose_name_plural = 'contact messages'
-
 
 class DomainAlias(AbstractSiteModel):
     redirect = models.BooleanField(

src/core/translation.py

@@ -13,6 +13,6 @@ class EditorialGroupTranslationOptions(TranslationOptions):
     fields = ('name', 'description',)
 
 
-@register(models.Contacts)
+@register(models.ContactPerson)
 class ContactTranslationOptions(TranslationOptions):
     fields = ('name', 'role',)