Snapshot of dev work to add session purpose annotation

 - Legacy-Id: 19415

Author: jennifer-richards

ietf/doc/templatetags/ietf_filters.py

@@ -613,6 +613,93 @@ def action_holder_badge(action_holder):
     else:
         return ''  # no alert needed
 
+@register.filter
+def is_regular_agenda_item(assignment):
+    """Is this agenda item a regular session item?
+
+    A regular item appears as a sub-entry in a timeslot within the agenda
+
+    >>> from collections import namedtuple  # use to build mock objects
+    >>> mock_timeslot = namedtuple('t2', ['slug'])
+    >>> mock_assignment = namedtuple('t1', ['slot_type'])  # slot_type must be a callable
+    >>> factory = lambda t: mock_assignment(slot_type=lambda: mock_timeslot(slug=t))
+    >>> is_regular_agenda_item(factory('regular'))
+    True
+
+    >>> any(is_regular_agenda_item(factory(t)) for t in ['plenary', 'break', 'reg', 'other', 'officehours'])
+    False
+    """
+    return assignment.slot_type().slug == 'regular'
+
+@register.filter
+def is_plenary_agenda_item(assignment):
+    """Is this agenda item a regular session item?
+
+    A regular item appears as a sub-entry in a timeslot within the agenda
+
+    >>> from collections import namedtuple  # use to build mock objects
+    >>> mock_timeslot = namedtuple('t2', ['slug'])
+    >>> mock_assignment = namedtuple('t1', ['slot_type'])  # slot_type must be a callable
+    >>> factory = lambda t: mock_assignment(slot_type=lambda: mock_timeslot(slug=t))
+    >>> is_plenary_agenda_item(factory('plenary'))
+    True
+
+    >>> any(is_plenary_agenda_item(factory(t)) for t in ['regular', 'break', 'reg', 'other', 'officehours'])
+    False
+    """
+    return assignment.slot_type().slug == 'plenary'
+
+@register.filter
+def is_special_agenda_item(assignment):
+    """Is this agenda item a special item?
+
+    Special items appear as top-level agenda entries with their own timeslot information.
+
+    >>> from collections import namedtuple  # use to build mock objects
+    >>> mock_timeslot = namedtuple('t2', ['slug'])
+    >>> mock_assignment = namedtuple('t1', ['slot_type'])  # slot_type must be a callable
+    >>> factory = lambda t: mock_assignment(slot_type=lambda: mock_timeslot(slug=t))
+    >>> all(is_special_agenda_item(factory(t)) for t in ['break', 'reg', 'other', 'officehours'])
+    True
+
+    >>> any(is_special_agenda_item(factory(t)) for t in ['regular', 'plenary'])
+    False
+    """
+    return assignment.slot_type().slug in [
+        'break',
+        'reg',
+        'other',
+        'officehours',
+    ]
+
+@register.filter
+def should_show_agenda_session_buttons(assignment):
+    """Should this agenda item show the session buttons (jabber link, etc)?
+
+    In IETF-111 and earlier, office hours sessions were designated by a name ending
+    with ' office hours' and belonged to the IESG or some other group. This led to
+    incorrect session buttons being displayed. Suppress session buttons for
+    when name ends with 'office hours' in the pre-111 meetings.
+    >>> from collections import namedtuple  # use to build mock objects
+    >>> mock_meeting = namedtuple('t3', ['number'])
+    >>> mock_session = namedtuple('t2', ['name'])
+    >>> mock_assignment = namedtuple('t1', ['meeting', 'session'])  # meeting must be a callable
+    >>> factory = lambda num, name: mock_assignment(session=mock_session(name), meeting=lambda: mock_meeting(num))
+    >>> test_cases = [('105', 'acme office hours'), ('111', 'acme office hours')]
+    >>> any(should_show_agenda_session_buttons(factory(*tc)) for tc in test_cases)
+    False
+    >>> test_cases = [('interim-2020-acme-112', 'acme'), ('112', 'acme'), ('150', 'acme'), ('105', 'acme'),]
+    >>> test_cases.extend([('111', 'acme'), ('interim-2020-acme-112', 'acme office hours')])
+    >>> test_cases.extend([('112', 'acme office hours'), ('150', 'acme office hours')])
+    >>> all(should_show_agenda_session_buttons(factory(*tc)) for tc in test_cases)
+    True
+    """
+    num = assignment.meeting().number
+    if num.isdigit() and int(num) <= settings.MEETING_LEGACY_OFFICE_HOURS_END:
+        return not assignment.session.name.lower().endswith(' office hours')
+    else:
+        return True
+
 
 @register.simple_tag
 def absurl(viewname, **kwargs):

ietf/group/admin.py

@@ -188,6 +188,7 @@ class GroupFeaturesAdmin(admin.ModelAdmin):
         'customize_workflow',
         'is_schedulable',
         'show_on_agenda',
+        'agenda_filter_type',
         'req_subm_approval',
         'agenda_type',
         'material_types',

ietf/group/migrations/0049_groupfeatures_agenda_filter_type.py

@@ -0,0 +1,20 @@
+# Copyright The IETF Trust 2021 All Rights Reserved
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('name', '0033_populate_agendafiltertypename'),
+        ('group', '0048_has_session_materials'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='groupfeatures',
+            name='agenda_filter_type',
+            field=models.ForeignKey(default='none', on_delete=django.db.models.deletion.PROTECT, to='name.AgendaFilterTypeName'),
+        ),
+    ]

ietf/group/migrations/0050_populate_groupfeatures_agenda_filter_type.py

@@ -0,0 +1,35 @@
+# Copyright The IETF Trust 2021 All Rights Reserved
+
+from django.db import migrations
+
+
+def forward(apps, schema_editor):
+    GroupFeatures = apps.get_model('group', 'GroupFeatures')
+
+    # map AgendaFilterTypeName slug to group types - unlisted get 'none'
+    filter_types = dict(
+        # list previously hard coded in agenda view, plus 'review'
+        normal={'wg', 'ag', 'rg', 'rag', 'iab', 'program', 'review'},
+        heading={'area', 'ietf', 'irtf'},
+        special={'team', 'adhoc'},
+    )
+
+    for ft, group_types in filter_types.items():
+        for gf in GroupFeatures.objects.filter(type__slug__in=group_types):
+            gf.agenda_filter_type_id = ft
+            gf.save()
+
+
+def reverse(apps, schema_editor):
+    pass  # nothing to do, model will be deleted anyway
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('group', '0049_groupfeatures_agenda_filter_type'),
+    ]
+
+    operations = [
+        migrations.RunPython(forward, reverse),
+    ]

ietf/group/migrations/0051_groupfeatures_session_purposes.py

@@ -0,0 +1,24 @@
+# Copyright The IETF Trust 2021 All Rights Reserved
+
+# Generated by Django 2.2.24 on 2021-09-26 11:29
+
+from django.db import migrations
+import ietf.group.models
+import ietf.name.models
+import jsonfield.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('group', '0050_populate_groupfeatures_agenda_filter_type'),
+        ('name', '0035_sessionpurposename'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='groupfeatures',
+            name='session_purposes',
+            field=jsonfield.fields.JSONField(default=[], help_text='Allowed session purposes for this group type', max_length=256, validators=[ietf.group.models.JSONForeignKeyListValidator(ietf.name.models.SessionPurposeName)]),
+        ),
+    ]

ietf/group/migrations/0052_populate_groupfeatures_session_purposes.py

@@ -0,0 +1,48 @@
+# Copyright The IETF Trust 2021 All Rights Reserved
+
+# Generated by Django 2.2.24 on 2021-09-26 11:29
+
+from django.db import migrations
+
+
+default_purposes = dict(
+    dir=['presentation', 'social', 'tutorial'],
+    ietf=['admin', 'presentation', 'social'],
+    rg=['session'],
+    team=['coding', 'presentation', 'social', 'tutorial'],
+    wg=['session'],
+)
+
+
+def forward(apps, schema_editor):
+    GroupFeatures = apps.get_model('group', 'GroupFeatures')
+    SessionPurposeName = apps.get_model('name', 'SessionPurposeName')
+
+    # verify that we're not about to use an invalid purpose
+    for purposes in default_purposes.values():
+        for purpose in purposes:
+            SessionPurposeName.objects.get(pk=purpose)  # throws an exception unless exists
+
+    for type_, purposes in default_purposes.items():
+        GroupFeatures.objects.filter(
+            type=type_
+        ).update(
+            session_purposes=purposes
+        )
+
+def reverse(apps, schema_editor):
+    GroupFeatures = apps.get_model('group', 'GroupFeatures')
+    GroupFeatures.objects.update(session_purposes=[])  # clear back out to default
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('group', '0051_groupfeatures_session_purposes'),
+        ('name', '0036_populate_sessionpurposename'),
+
+    ]
+
+    operations = [
+        migrations.RunPython(forward, reverse),
+    ]

ietf/group/models.py

@@ -13,19 +13,21 @@
 from django.conf import settings
 from django.core.validators import RegexValidator
 from django.db import models
-from django.db.models.deletion import CASCADE
+from django.db.models.deletion import CASCADE, PROTECT
 from django.dispatch import receiver
 
 #from simple_history.models import HistoricalRecords
 
 import debug                            # pyflakes:ignore
 
 from ietf.group.colors import fg_group_colors, bg_group_colors
-from ietf.name.models import GroupStateName, GroupTypeName, DocTagName, GroupMilestoneStateName, RoleName, AgendaTypeName, ExtResourceName
+from ietf.name.models import (GroupStateName, GroupTypeName, DocTagName, GroupMilestoneStateName, RoleName, 
+                              AgendaTypeName, AgendaFilterTypeName, ExtResourceName, SessionPurposeName)
 from ietf.person.models import Email, Person
 from ietf.utils.mail import formataddr, send_mail_text
 from ietf.utils import log
 from ietf.utils.models import ForeignKey, OneToOneField
+from ietf.utils.validators import JSONForeignKeyListValidator
 
 
 class GroupInfo(models.Model):
@@ -250,6 +252,7 @@ def get_description(self):
     code='invalid',
 )
 
+
 class GroupFeatures(models.Model):
     type = OneToOneField(GroupTypeName, primary_key=True, null=False, related_name='features')
     #history = HistoricalRecords()
@@ -277,6 +280,7 @@ class GroupFeatures(models.Model):
     customize_workflow      = models.BooleanField("Workflow",   default=False)
     is_schedulable          = models.BooleanField("Schedulable",default=False)
     show_on_agenda          = models.BooleanField("On Agenda",  default=False)
+    agenda_filter_type      = models.ForeignKey(AgendaFilterTypeName, default='none', on_delete=PROTECT)
     req_subm_approval       = models.BooleanField("Subm. Approval",  default=False)
     #
     agenda_type             = models.ForeignKey(AgendaTypeName, null=True, default="ietf", on_delete=CASCADE)
@@ -290,7 +294,10 @@ class GroupFeatures(models.Model):
     groupman_authroles      = jsonfield.JSONField(max_length=128, blank=False, default=["Secretariat",])
     matman_roles            = jsonfield.JSONField(max_length=128, blank=False, default=["ad","chair","delegate","secr"])
     role_order              = jsonfield.JSONField(max_length=128, blank=False, default=["chair","secr","member"],
-                                                help_text="The order in which roles are shown, for instance on photo pages.  Enter valid JSON.")
+                                                  help_text="The order in which roles are shown, for instance on photo pages.  Enter valid JSON.")
+    session_purposes        = jsonfield.JSONField(max_length=256, blank=False, default=[],
+                                                  help_text="Allowed session purposes for this group type",
+                                                  validators=[JSONForeignKeyListValidator(SessionPurposeName)])
 
 
 class GroupHistory(GroupInfo):