Use Roles instead of dedicated model for liaison statement group contacts. Fixes ietf-tools#3100. Commit ready for merge.

 - Legacy-Id: 18828

Author: jennifer-richards

ietf/bin/set_admin_permissions

@@ -61,8 +61,6 @@ def main():
              'group.add_groupevent','group.change_groupevent','group.delete_groupevent',
              'iesg.add_telechatagendaitem','iesg.change_telechatagendaitem','iesg.delete_telechatagendaitem',
              'iesg.add_telechatdate','iesg.change_telechatdate','iesg.delete_telechatdate',
-             'liaisons.add_liaisonstatementgroupcontacts','liaisons.change_liaisonstatementgroupcontacts',
-             'liaisons.delete_liaisonstatementgroupcontacts',
              'mailinglists.add_list','mailinglists.change_list','mailinglists.delete_list',
              'mailtrigger.add_mailtrigger','mailtrigger.change_mailtrigger','mailtrigger.delete_mailtrigger',
              'mailtrigger.add_recipient','mailtrigger.change_recipient','mailtrigger.delete_recipient',

ietf/group/migrations/0040_lengthen_used_roles_fields.py

@@ -0,0 +1,35 @@
+# Generated by Django 2.2.17 on 2020-12-11 08:48
+
+from django.db import migrations
+import jsonfield.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('group', '0039_remove_historicalgroupfeatures'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='group',
+            name='used_roles',
+            field=jsonfield.fields.JSONField(blank=True, default=[], help_text="Leave an empty list to get the group_type's default used roles", max_length=256),
+        ),
+        migrations.AlterField(
+            model_name='groupfeatures',
+            name='default_used_roles',
+            field=jsonfield.fields.JSONField(default=[], max_length=256),
+        ),
+        migrations.AlterField(
+            model_name='grouphistory',
+            name='used_roles',
+            field=jsonfield.fields.JSONField(blank=True, default=[], help_text="Leave an empty list to get the group_type's default used roles", max_length=256),
+        ),
+        # historicalgroupfeatures has been removed
+        # migrations.AlterField(
+        #     model_name='historicalgroupfeatures',
+        #     name='default_used_roles',
+        #     field=jsonfield.fields.JSONField(default=[], max_length=256),
+        # ),
+    ]

ietf/group/migrations/0041_create_liaison_contact_roles.py

@@ -0,0 +1,158 @@
+# Generated by Django 2.2.17 on 2020-12-09 06:59
+
+from django.db import migrations
+
+from ietf.person.name import plain_name
+from ietf.utils.mail import parseaddr
+
+
+def find_or_create_email(email_model, person_model, formatted_email, group):
+    """Look up an email address or create if needed
+    
+    Also creates a Person if the email does not have one. Created Email will have
+    the origin field set to the origin parameter to this method.
+    """
+    name, address = parseaddr(formatted_email)
+    if not address:
+        raise ValueError('Could not parse email "%s"' % formatted_email)
+    email, _ = email_model.objects.get_or_create(
+        address=address,
+        defaults=dict(origin='liaison contact: ' + group.acronym)
+    )
+
+    if not email.person:
+        person = person_model.objects.create(name=name if name else address)
+        email.person = person
+        email.save()
+
+    # Display an alert if the formatted address sent from the Role will differ
+    # from what was in the original contacts list
+    if not email.person.plain and email.person.name == email.address:
+        recreated_contact_email = email.address
+    else:
+        person_plain = email.person.plain if email.person.plain else plain_name(email.person.name)
+        recreated_contact_email = "%s <%s>" % (person_plain, email.address)
+    if recreated_contact_email != formatted_email:
+        print('>> Note: address "%s" is now "%s" (%s)' % (
+            formatted_email,
+            recreated_contact_email,
+            group.acronym,
+        ))    
+    return email
+
+
+def forward(apps, schema_editor):
+    """Perform forward migration
+    
+    Creates liaison_contact and liaison_cc_contact Roles corresponding to existing
+    LiaisonStatementGroupContact instances.
+    """
+    Group = apps.get_model('group', 'Group')
+    Role = apps.get_model('group', 'Role')
+    Email = apps.get_model('person', 'Email')
+    Person = apps.get_model('person', 'Person')
+    
+    RoleName = apps.get_model('name', 'RoleName')
+    contact_role_name = RoleName.objects.get(slug='liaison_contact')
+    cc_contact_role_name = RoleName.objects.get(slug='liaison_cc_contact')
+    
+    print()
+    LiaisonStatementGroupContacts = apps.get_model('liaisons', 'LiaisonStatementGroupContacts')
+    for lsgc in LiaisonStatementGroupContacts.objects.all():
+        group = lsgc.group
+        for contact_email in lsgc.contacts.split(','):
+            if contact_email:
+                email = find_or_create_email(Email, Person, 
+                                             contact_email.strip(), 
+                                             group)
+                Role.objects.create(
+                    group=group,
+                    name=contact_role_name,
+                    person=email.person,
+                    email=email,
+                )
+
+        for contact_email in lsgc.cc_contacts.split(','):
+            if contact_email:
+                email = find_or_create_email(Email, Person, 
+                                             contact_email.strip(), 
+                                             group)
+                Role.objects.create(
+                    group=group,
+                    name=cc_contact_role_name,
+                    person=email.person,
+                    email=email,
+                )
+            
+    # Now validate that we got them all. As much as possible, use independent code
+    # to avoid replicating any bugs from the original migration.
+    for group in Group.objects.all():
+        lsgc = LiaisonStatementGroupContacts.objects.filter(group_id=group.pk).first()
+        
+        if not lsgc:
+            if group.role_set.filter(name__in=[contact_role_name, cc_contact_role_name]).exists():
+                raise ValueError('%s group has contact roles after migration but had no LiaisonStatementGroupContacts' % (
+                    group.acronym,
+                ))
+        else:
+            contacts = group.role_set.filter(name=contact_role_name)
+            num_lsgc_contacts = len(lsgc.contacts.split(',')) if lsgc.contacts else 0
+            if len(contacts) != num_lsgc_contacts:
+                raise ValueError(
+                    '%s group has %d contact(s) but only %d address(es) in its LiaisonStatementGroupContacts (contact addresses = "%s", LSGC.contacts="%s")' % (
+                        group.acronym, len(contacts), num_lsgc_contacts,
+                        '","'.join([c.email.address for c in contacts]),
+                        lsgc.contacts,
+                    )
+                )
+            for contact in contacts:
+                email = contact.email.address
+                if email.lower() not in lsgc.contacts.lower():
+                    raise ValueError(
+                        '%s group has "%s" contact but not found in LiaisonStatementGroupContacts.contacts = "%s"' % (
+                            group.acronym, email, lsgc.contacts,
+                        )
+                    )
+
+            cc_contacts = group.role_set.filter(name=cc_contact_role_name)
+            num_lsgc_cc_contacts = len(lsgc.cc_contacts.split(',')) if lsgc.cc_contacts else 0
+            if len(cc_contacts) != num_lsgc_cc_contacts:
+                raise ValueError(
+                    '%s group has %d CC contact(s) but %d address(es) in its LiaisonStatementGroupContacts (cc_contact addresses = "%s", LSGC.cc_contacts="%s")' % (
+                        group.acronym, len(cc_contacts), num_lsgc_cc_contacts,
+                        '","'.join([c.email.address for c in cc_contacts]),
+                        lsgc.cc_contacts,
+                    )
+                )
+            for cc_contact in cc_contacts:
+                email = cc_contact.email.address
+                if email.lower() not in lsgc.cc_contacts.lower():
+                    raise ValueError(
+                        '%s group has "%s" CC contact but not found in LiaisonStatementGroupContacts.cc_contacts = "%s"' % (
+                            group.acronym, email, lsgc.cc_contacts,
+                        )
+                    )
+
+def reverse(apps, schema_editor):
+    """Perform reverse migration
+    
+    Removes liaison_contact and liaison_cc_contact Roles. The forward migration creates missing
+    Email and Person instances, but these are not removed because it's difficult to do this
+    safely and correctly.
+    """
+    Role = apps.get_model('group', 'Role')
+    Role.objects.filter(
+        name_id__in=['liaison_contact', 'liaison_cc_contact']
+    ).delete()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('group', '0040_lengthen_used_roles_fields'),
+        ('name', '0022_add_liaison_contact_rolenames'),
+    ]
+
+    operations = [
+        migrations.RunPython(forward, reverse),
+    ]

ietf/group/migrations/0042_add_liaison_contact_roles_to_used_roles.py

@@ -0,0 +1,63 @@
+# Generated by Django 2.2.17 on 2020-12-11 08:52
+
+from django.db import migrations
+
+
+def forward(apps, schema_editor):
+    role_names_to_add = ['liaison_contact', 'liaison_cc_contact']
+    
+    Group = apps.get_model('group', 'Group')
+    GroupFeatures = apps.get_model('group', 'GroupFeatures')
+    Role = apps.get_model('group', 'Role')
+    
+    # Add new liaison contact roles to default_used_fields for wg, sdo, and area groups
+    for group_type in ['wg', 'sdo', 'area']:
+        gf = GroupFeatures.objects.get(type_id=group_type)
+        for role_name in role_names_to_add:
+            if role_name not in gf.default_used_roles:
+                gf.default_used_roles.append(role_name)
+        gf.save()
+        
+        # Add new role names to any groups that both have liaison contacts
+        # and use a custom used_roles list.
+        for group in Group.objects.filter(type_id=group_type):
+            used_roles_is_set = len(group.used_roles) > 0
+            has_contacts = Role.objects.filter(name_id__in=role_names_to_add).exists()
+            if used_roles_is_set and has_contacts:
+                for role_name in role_names_to_add:
+                    if role_name not in group.used_roles:
+                        print('>> Adding %s to used_roles for %s' % (role_name, group.acronym))
+                        group.used_roles.append(role_name)
+                group.save()
+
+
+def reverse(apps, schema_editor):
+    role_names_to_remove = ['liaison_contact', 'liaison_cc_contact']
+    
+    Group = apps.get_model('group', 'Group')
+    GroupFeatures = apps.get_model('group', 'GroupFeatures')
+
+    for group in Group.objects.all():
+        for role_name in role_names_to_remove:
+            if role_name in group.used_roles:
+                print('>> Removing %s from used_roles for %s' % (role_name, group.acronym))
+                group.used_roles.remove(role_name)
+                group.save()
+
+    for gf in GroupFeatures.objects.all():
+        for role_name in role_names_to_remove:
+            if role_name in gf.default_used_roles:
+                print('>> Removing %s from default_used_roles for %s' % (role_name, gf.type_id))
+                gf.default_used_roles.remove(role_name)
+                gf.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('group', '0041_create_liaison_contact_roles'),
+    ]
+
+    operations = [
+        migrations.RunPython(forward, reverse),
+    ]

ietf/group/models.py

@@ -45,7 +45,7 @@ class GroupInfo(models.Model):
     unused_states = models.ManyToManyField('doc.State', help_text="Document states that have been disabled for the group.", blank=True)
     unused_tags = models.ManyToManyField(DocTagName, help_text="Document tags that have been disabled for the group.", blank=True)
 
-    used_roles = jsonfield.JSONField(max_length=128, blank=True, default=[], help_text="Leave an empty list to get the group_type's default used roles")
+    used_roles = jsonfield.JSONField(max_length=256, blank=True, default=[], help_text="Leave an empty list to get the group_type's default used roles")
 
     uses_milestone_dates = models.BooleanField(default=True)
 
@@ -272,7 +272,7 @@ class GroupFeatures(models.Model):
     about_page              = models.CharField(max_length=64, blank=False, default="ietf.group.views.group_about" )
     default_tab             = models.CharField(max_length=64, blank=False, default="ietf.group.views.group_about" )
     material_types          = jsonfield.JSONField(max_length=64, blank=False, default=["slides"])
-    default_used_roles      = jsonfield.JSONField(max_length=128, blank=False, default=[])
+    default_used_roles      = jsonfield.JSONField(max_length=256, blank=False, default=[])
     admin_roles             = jsonfield.JSONField(max_length=64, blank=False, default=["chair"]) # Trac Admin
     docman_roles            = jsonfield.JSONField(max_length=128, blank=False, default=["ad","chair","delegate","secr"])
     groupman_roles          = jsonfield.JSONField(max_length=128, blank=False, default=["ad","chair",])