Allow assignment of Person as "action holder" for a Doc, plus rudimentary automation of assignment. Fixes ietf-tools#3146. Commit ready for merge.

 - Legacy-Id: 18829

Author: jennifer-richards

ietf/doc/admin.py

@@ -11,7 +11,7 @@
     StateDocEvent, ConsensusDocEvent, BallotType, BallotDocEvent, WriteupDocEvent, LastCallDocEvent,
     TelechatDocEvent, BallotPositionDocEvent, ReviewRequestDocEvent, InitialReviewDocEvent,
     AddedMessageEvent, SubmissionDocEvent, DeletedEvent, EditedAuthorsDocEvent, DocumentURL,
-    ReviewAssignmentDocEvent, IanaExpertDocEvent, IRSGBallotDocEvent, DocExtResource )
+    ReviewAssignmentDocEvent, IanaExpertDocEvent, IRSGBallotDocEvent, DocExtResource, DocumentActionHolder )
 
 from ietf.utils.validators import validate_external_resource_value
 
@@ -34,6 +34,11 @@ class DocAuthorInline(admin.TabularInline):
     raw_id_fields = ['person', 'email']
     extra = 1
 
+class DocActionHolderInline(admin.TabularInline):
+    model = DocumentActionHolder
+    raw_id_fields = ['person']
+    extra = 1
+
 class RelatedDocumentInline(admin.TabularInline):
     model = RelatedDocument
     def this(self, instance):
@@ -72,7 +77,7 @@ class DocumentAdmin(admin.ModelAdmin):
     search_fields = ['name']
     list_filter = ['type']
     raw_id_fields = ['group', 'shepherd', 'ad']
-    inlines = [DocAuthorInline, RelatedDocumentInline, AdditionalUrlInLine]
+    inlines = [DocAuthorInline, DocActionHolderInline, RelatedDocumentInline, AdditionalUrlInLine]
     form = DocumentForm
 
     def save_model(self, request, obj, form, change):
@@ -137,6 +142,13 @@ class BallotTypeAdmin(admin.ModelAdmin):
     list_display = ["slug", "doc_type", "name", "question"]
 admin.site.register(BallotType, BallotTypeAdmin)
 
+
+class DocumentActionHolderAdmin(admin.ModelAdmin):
+    list_display = ['id', 'document', 'person', 'time_added']
+    raw_id_fields = ['document', 'person']
+admin.site.register(DocumentActionHolder, DocumentActionHolderAdmin)
+
+
 # events
 
 class DocEventAdmin(admin.ModelAdmin):

ietf/doc/expire.py

@@ -15,7 +15,7 @@
 from ietf.doc.models import Document, DocEvent, State, IESG_SUBSTATE_TAGS
 from ietf.person.models import Person 
 from ietf.meeting.models import Meeting
-from ietf.doc.utils import add_state_change_event
+from ietf.doc.utils import add_state_change_event, update_action_holders
 from ietf.mailtrigger.utils import gather_address_lists
 
 
@@ -171,6 +171,9 @@ def expire_draft(doc):
             e = add_state_change_event(doc, system, prev_state, new_state, prev_tags=prev_tags, new_tags=[])
             if e:
                 events.append(e)
+            e = update_action_holders(doc, prev_state, new_state, prev_tags=prev_tags, new_tags=[])
+            if e:
+                events.append(e)
 
     events.append(DocEvent.objects.create(doc=doc, rev=doc.rev, by=system, type="expired_document", desc="Document has expired"))
 

ietf/doc/factories.py

@@ -12,7 +12,8 @@
 from django.conf import settings
 
 from ietf.doc.models import ( Document, DocEvent, NewRevisionDocEvent, DocAlias, State, DocumentAuthor,
-    StateDocEvent, BallotPositionDocEvent, BallotDocEvent, BallotType, IRSGBallotDocEvent, TelechatDocEvent)
+    StateDocEvent, BallotPositionDocEvent, BallotDocEvent, BallotType, IRSGBallotDocEvent, TelechatDocEvent,
+    DocumentActionHolder)
 from ietf.group.models import Group
 
 def draft_name_generator(type_id,group,n):
@@ -358,3 +359,9 @@ class Meta:
     balloter = factory.SubFactory('ietf.person.factories.PersonFactory')
     pos_id = 'discuss'
 
+class DocumentActionHolderFactory(factory.DjangoModelFactory):
+    class Meta:
+        model = DocumentActionHolder
+        
+    document = factory.SubFactory(WgDraftFactory)
+    person = factory.SubFactory('ietf.person.factories.PersonFactory')

ietf/doc/forms.py

@@ -10,6 +10,8 @@
 from ietf.doc.models import RelatedDocument
 from ietf.iesg.models import TelechatDate
 from ietf.iesg.utils import telechat_page_count
+from ietf.person.fields import SearchablePersonsField
+
 
 class TelechatForm(forms.Form):
     telechat_date = forms.TypedChoiceField(coerce=lambda x: datetime.datetime.strptime(x, '%Y-%m-%d').date(), empty_value=None, required=False, help_text="Page counts are the current page counts for the telechat, before this telechat date edit is made.")
@@ -54,6 +56,15 @@ def clean_notify(self):
         addrspecs = [x.strip() for x in self.cleaned_data["notify"].split(',')]
         return ', '.join(addrspecs)
 
+class ActionHoldersForm(forms.Form):
+    action_holders = SearchablePersonsField(required=False)    
+    reason = forms.CharField(
+        label='Reason for change',
+        required=False,
+        max_length=255,
+        strip=True,
+    )
+
 IESG_APPROVED_STATE_LIST = ("ann", "rfcqueue", "pub")
 
 class AddDownrefForm(forms.Form):

ietf/doc/lastcall.py

@@ -7,7 +7,7 @@
 from ietf.doc.models import Document, State, DocEvent, LastCallDocEvent, WriteupDocEvent
 from ietf.doc.models import IESG_SUBSTATE_TAGS
 from ietf.person.models import Person
-from ietf.doc.utils import add_state_change_event
+from ietf.doc.utils import add_state_change_event, update_action_holders
 from ietf.doc.mails import generate_ballot_writeup, generate_approval_mail, generate_last_call_announcement
 from ietf.doc.mails import send_last_call_request, email_last_call_expired, email_last_call_expired_with_downref
 
@@ -60,9 +60,14 @@ def expire_last_call(doc):
     doc.tags.remove(*prev_tags)
 
     system = Person.objects.get(name="(System)")
+    events = []
     e = add_state_change_event(doc, system, prev_state, new_state, prev_tags=prev_tags, new_tags=[])
     if e:
-        doc.save_with_history([e])
+        events.append(e)
+    e = update_action_holders(doc, prev_state, new_state, prev_tags=prev_tags, new_tags=[])
+    if e:
+        events.append(e)
+    doc.save_with_history(events)
 
     email_last_call_expired(doc)
 

ietf/doc/mails.py

@@ -15,6 +15,7 @@
 import debug                            # pyflakes:ignore
 from ietf.doc.templatetags.mail_filters import std_level_prompt
 
+from ietf.utils import log
 from ietf.utils.mail import send_mail, send_mail_text
 from ietf.ipr.utils import iprs_from_docs, related_docs
 from ietf.doc.models import WriteupDocEvent, LastCallDocEvent, DocAlias, ConsensusDocEvent
@@ -127,6 +128,22 @@ def email_iesg_processing_document(request, doc, changes):
                    url=settings.IDTRACKER_BASE_URL + doc.get_absolute_url()),
               cc=addrs.cc)
 
+def email_remind_action_holders(request, doc, note=None):
+    addrs = gather_address_lists('doc_remind_action_holders', doc=doc)
+    log.assertion(
+        'not doc.action_holders.exclude(email__in=addrs.to).exists()',
+        note='All action holders should receive a reminder email. Failed for %s.' % doc.name,
+    )
+    send_mail(request, addrs.to, None,
+              'Reminder: action needed for %s' % doc.display_name(),
+              'doc/mail/remind_action_holders_mail.txt',
+              dict(
+                  doc=doc,
+                  doc_url=settings.IDTRACKER_BASE_URL + doc.get_absolute_url(),
+                  note=note,
+              ),
+              cc=addrs.cc)
+
 def html_to_text(html):
     return strip_tags(html.replace("&lt;", "<").replace("&gt;", ">").replace("&amp;", "&").replace("<br>", "\n"))
 

ietf/doc/migrations/0040_add_changed_action_holders_docevent_type.py

@@ -0,0 +1,19 @@
+# Generated by Django 2.2.17 on 2021-01-15 12:50
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('group', '0040_lengthen_used_roles_fields'),  # only needed for schema vs data ordering
+        ('doc', '0039_auto_20201109_0439'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='docevent',
+            name='type',
+            field=models.CharField(choices=[('new_revision', 'Added new revision'), ('new_submission', 'Uploaded new revision'), ('changed_document', 'Changed document metadata'), ('added_comment', 'Added comment'), ('added_message', 'Added message'), ('edited_authors', 'Edited the documents author list'), ('deleted', 'Deleted document'), ('changed_state', 'Changed state'), ('changed_stream', 'Changed document stream'), ('expired_document', 'Expired document'), ('extended_expiry', 'Extended expiry of document'), ('requested_resurrect', 'Requested resurrect'), ('completed_resurrect', 'Completed resurrect'), ('changed_consensus', 'Changed consensus'), ('published_rfc', 'Published RFC'), ('added_suggested_replaces', 'Added suggested replacement relationships'), ('reviewed_suggested_replaces', 'Reviewed suggested replacement relationships'), ('changed_action_holders', 'Changed action holders for document'), ('changed_group', 'Changed group'), ('changed_protocol_writeup', 'Changed protocol writeup'), ('changed_charter_milestone', 'Changed charter milestone'), ('initial_review', 'Set initial review time'), ('changed_review_announcement', 'Changed WG Review text'), ('changed_action_announcement', 'Changed WG Action text'), ('started_iesg_process', 'Started IESG process on document'), ('created_ballot', 'Created ballot'), ('closed_ballot', 'Closed ballot'), ('sent_ballot_announcement', 'Sent ballot announcement'), ('changed_ballot_position', 'Changed ballot position'), ('changed_ballot_approval_text', 'Changed ballot approval text'), ('changed_ballot_writeup_text', 'Changed ballot writeup text'), ('changed_rfc_editor_note_text', 'Changed RFC Editor Note text'), ('changed_last_call_text', 'Changed last call text'), ('requested_last_call', 'Requested last call'), ('sent_last_call', 'Sent last call'), ('scheduled_for_telechat', 'Scheduled for telechat'), ('iesg_approved', 'IESG approved document (no problem)'), ('iesg_disapproved', 'IESG disapproved document (do not publish)'), ('approved_in_minute', 'Approved in minute'), ('iana_review', 'IANA review comment'), ('rfc_in_iana_registry', 'RFC is in IANA registry'), ('rfc_editor_received_announcement', 'Announcement was received by RFC Editor'), ('requested_publication', 'Publication at RFC Editor requested'), ('sync_from_rfc_editor', 'Received updated information from RFC Editor'), ('requested_review', 'Requested review'), ('assigned_review_request', 'Assigned review request'), ('closed_review_request', 'Closed review request'), ('closed_review_assignment', 'Closed review assignment'), ('downref_approved', 'Downref approved'), ('posted_related_ipr', 'Posted related IPR'), ('removed_related_ipr', 'Removed related IPR')], max_length=50),
+        ),
+    ]

ietf/doc/migrations/0041_add_documentactionholder.py

@@ -0,0 +1,35 @@
+# Generated by Django 2.2.17 on 2021-01-15 12:50
+
+import datetime
+from django.db import migrations, models
+import django.db.models.deletion
+import ietf.utils.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('person', '0018_auto_20201109_0439'),
+        ('doc', '0040_add_changed_action_holders_docevent_type'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DocumentActionHolder',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('time_added', models.DateTimeField(default=datetime.datetime.now)),
+                ('document', ietf.utils.models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='doc.Document')),
+                ('person', ietf.utils.models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='person.Person')),
+            ],
+        ),
+        migrations.AddField(
+            model_name='document',
+            name='action_holders',
+            field=models.ManyToManyField(blank=True, through='doc.DocumentActionHolder', to='person.Person'),
+        ),
+        migrations.AddConstraint(
+            model_name='documentactionholder',
+            constraint=models.UniqueConstraint(fields=('document', 'person'), name='unique_action_holder'),
+        ),
+    ]

ietf/doc/models.py

@@ -630,6 +630,45 @@ def __str__(self):
         return u"%s %s (%s)" % (self.document.name, self.person, self.order)
 
 
+class DocumentActionHolder(models.Model):
+    """Action holder for a document"""
+    document = ForeignKey('Document')
+    person = ForeignKey(Person)
+    time_added = models.DateTimeField(default=datetime.datetime.now)
+
+    CLEAR_ACTION_HOLDERS_STATES = ['approved', 'ann', 'rfcqueue', 'pub', 'dead']  # draft-iesg state slugs
+    GROUP_ROLES_OF_INTEREST = ['chair', 'techadv', 'editor', 'secr']
+
+    def __str__(self):
+        return str(self.person)
+
+    class Meta:
+        constraints = [
+            models.UniqueConstraint(fields=['document', 'person'], name='unique_action_holder')
+        ]
+
+    def role_for_doc(self):
+        """Brief string description of this person's relationship to the doc"""
+        roles = []
+        if self.person in self.document.authors():
+            roles.append('Author')
+        if self.person == self.document.ad:
+            roles.append('Responsible AD')
+        if self.document.shepherd and self.person == self.document.shepherd.person:
+            roles.append('Shepherd')
+        if self.document.group:
+            roles.extend([
+                'Group %s' % role.name.name 
+                for role in self.document.group.role_set.filter(
+                    name__in=self.GROUP_ROLES_OF_INTEREST,
+                    person=self.person,
+                )
+            ])
+
+        if not roles:
+            roles.append('Action Holder')
+        return ', '.join(roles) 
+
 validate_docname = RegexValidator(
     r'^[-a-z0-9]+$',
     "Provide a valid document name consisting of lowercase letters, numbers and hyphens.",
@@ -638,6 +677,8 @@ def __str__(self):
 
 class Document(DocumentInfo):
     name = models.CharField(max_length=255, validators=[validate_docname,], unique=True)           # immutable
+    
+    action_holders = models.ManyToManyField(Person, through=DocumentActionHolder, blank=True)
 
     def __str__(self):
         return self.name
@@ -869,6 +910,11 @@ def fake_history_obj(self, rev):
 
         return dh
 
+    def action_holders_enabled(self):
+        """Is the action holder list active for this document?"""
+        iesg_state = self.get_state('draft-iesg')
+        return iesg_state and iesg_state.slug != 'idexists'
+
 class DocumentURL(models.Model):
     doc  = ForeignKey(Document)
     tag  = ForeignKey(DocUrlTagName)
@@ -1000,6 +1046,7 @@ class DocReminder(models.Model):
     ("published_rfc", "Published RFC"),
     ("added_suggested_replaces", "Added suggested replacement relationships"),
     ("reviewed_suggested_replaces", "Reviewed suggested replacement relationships"),
+    ("changed_action_holders", "Changed action holders for document"),
 
     # WG events
     ("changed_group", "Changed group"),

ietf/doc/resources.py

@@ -17,7 +17,7 @@
     InitialReviewDocEvent, DocHistoryAuthor, BallotDocEvent, RelatedDocument,
     RelatedDocHistory, BallotPositionDocEvent, AddedMessageEvent, SubmissionDocEvent,
     ReviewRequestDocEvent, ReviewAssignmentDocEvent, EditedAuthorsDocEvent, DocumentURL,
-    IanaExpertDocEvent, IRSGBallotDocEvent, DocExtResource )
+    IanaExpertDocEvent, IRSGBallotDocEvent, DocExtResource, DocumentActionHolder )
 
 from ietf.name.resources import BallotPositionNameResource, DocTypeNameResource
 class BallotTypeResource(ModelResource):
@@ -787,3 +787,22 @@ class Meta:
             "name": ALL_WITH_RELATIONS,
         }
 api.doc.register(DocExtResourceResource())
+
+
+from ietf.person.resources import PersonResource
+class DocumentActionHolderResource(ModelResource):
+    document         = ToOneField(DocumentResource, 'document')
+    person           = ToOneField(PersonResource, 'person')
+    class Meta:
+        queryset = DocumentActionHolder.objects.all()
+        serializer = api.Serializer()
+        cache = SimpleCache()
+        #resource_name = 'documentactionholder'
+        ordering = ['id', ]
+        filtering = { 
+            "id": ALL,
+            "time_added": ALL,
+            "document": ALL_WITH_RELATIONS,
+            "person": ALL_WITH_RELATIONS,
+        }
+api.doc.register(DocumentActionHolderResource())