checkpoint

 - Legacy-Id: 10016

Author: rjsparks

ietf/doc/mails.py

@@ -9,12 +9,12 @@
 
 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, BallotPositionDocEvent, LastCallDocEvent, DocAlias, ConsensusDocEvent, DocTagName
+from ietf.doc.models import WriteupDocEvent, BallotPositionDocEvent, LastCallDocEvent, DocAlias, ConsensusDocEvent
 from ietf.doc.utils import needed_ballot_positions
 from ietf.person.models import Person
 from ietf.group.models import Role
 from ietf.doc.models import Document
-from ietf.mailtoken.utils import gather_addresses
+from ietf.mailtoken.utils import gather_addresses, gather_address_list
 
 def email_state_changed(request, doc, text):
     to = [x.strip() for x in doc.notify.replace(';', ',').split(',')]
@@ -35,7 +35,7 @@ def email_stream_changed(request, doc, old_stream, new_stream, text=""):
         streams.append(old_stream.slug)
     if new_stream:
         streams.append(new_stream.slug)
-    to = gather_addresses('doc_stream_changed',doc=doc,streams=streams)
+    to = gather_address_list('doc_stream_changed',doc=doc,streams=streams)
 
     if not to:
         return
@@ -74,6 +74,7 @@ def email_authors(request, doc, subject, text):
 def html_to_text(html):
     return strip_tags(html.replace("&lt;", "<").replace("&gt;", ">").replace("&amp;", "&").replace("<br>", "\n"))
 
+#TODO Expunge this
 def email_ad(request, doc, ad, changed_by, text, subject=None):
     if not ad or not changed_by or ad == changed_by:
         return
@@ -406,7 +407,7 @@ def email_last_call_expired(doc):
     text = "IETF Last Call has ended, and the state has been changed to\n%s." % doc.get_state("draft-iesg").name
 
     send_mail(None,
-              gather_addresses('last_call_expired',doc=doc)
+              gather_addresses('last_call_expired',doc=doc),
               "DraftTracker Mail System <iesg-secretary@ietf.org>",
               "Last Call Expired: %s" % doc.file_tag(),
               "doc/mail/change_notice.txt",
@@ -416,27 +417,8 @@ def email_last_call_expired(doc):
               cc = gather_addresses('last_call_expired_cc',doc=doc)
               )
 
-def stream_state_email_recipients(doc, extra_recipients=[]):
-    persons = set()
-    res = []
-    for r in Role.objects.filter(group=doc.group, name__in=("chair", "delegate")).select_related("person", "email"):
-        res.append(r.formatted_email())
-        persons.add(r.person)
-
-    for email in doc.authors.all():
-        if email.person not in persons:
-            res.append(email.formatted_email())
-            persons.add(email.person)
-
-    for e in extra_recipients:
-        if e.person not in persons:
-            res.append(e.formatted_email())
-            persons.add(e.person)
-
-    return res
-
 def email_stream_state_changed(request, doc, prev_state, new_state, by, comment=""):
-    recipients = stream_state_email_recipients(doc)
+    recipients = gather_address_list('doc_stream_state_edited',doc=doc)
 
     state_type = (prev_state or new_state).type
 
@@ -452,12 +434,8 @@ def email_stream_state_changed(request, doc, prev_state, new_state, by, comment=
                    comment=comment))
 
 def email_stream_tags_changed(request, doc, added_tags, removed_tags, by, comment=""):
-    extra_recipients = []
-
-    if DocTagName.objects.get(slug="sheph-u") in added_tags and doc.shepherd:
-        extra_recipients.append(doc.shepherd)
 
-    recipients = stream_state_email_recipients(doc, extra_recipients)
+    recipients = gather_address_list('doc_stream_state_edited',doc=doc)
 
     send_mail(request, recipients, settings.DEFAULT_FROM_EMAIL,
               u"Tags changed for %s" % doc.name,

ietf/doc/tests_ballot.py

@@ -232,7 +232,7 @@ def test_request_last_call(self):
                 send_last_call_request="1"))
         draft = Document.objects.get(name=draft.name)
         self.assertEqual(draft.get_state_slug("draft-iesg"), "lc-req")
-        self.assertEqual(len(outbox), mailbox_before + 3)
+        self.assertEqual(len(outbox), mailbox_before + 2)
         self.assertTrue("Last Call" in outbox[-1]['Subject'])
         self.assertTrue(draft.name in outbox[-1]['Subject'])
 
@@ -387,7 +387,7 @@ def test_approve_ballot(self):
 
         draft = Document.objects.get(name=draft.name)
         self.assertEqual(draft.get_state_slug("draft-iesg"), "ann")
-        self.assertEqual(len(outbox), mailbox_before + 4)
+        self.assertEqual(len(outbox), mailbox_before + 3)
         self.assertTrue("Protocol Action" in outbox[-2]['Subject'])
         # the IANA copy
         self.assertTrue("Protocol Action" in outbox[-1]['Subject'])
@@ -409,7 +409,7 @@ def test_disapprove_ballot(self):
 
         draft = Document.objects.get(name=draft.name)
         self.assertEqual(draft.get_state_slug("draft-iesg"), "dead")
-        self.assertEqual(len(outbox), mailbox_before + 3)
+        self.assertEqual(len(outbox), mailbox_before + 2)
         self.assertTrue("NOT be published" in str(outbox[-1]))
 
 
@@ -441,11 +441,11 @@ def test_make_last_call(self):
         draft = Document.objects.get(name=draft.name)
         self.assertEqual(draft.get_state_slug("draft-iesg"), "lc")
         self.assertEqual(draft.latest_event(LastCallDocEvent, "sent_last_call").expires.strftime("%Y-%m-%d"), expire_date)
-        self.assertEqual(len(outbox), mailbox_before + 4)
+        self.assertEqual(len(outbox), mailbox_before + 3)
 
-        self.assertTrue("Last Call" in outbox[-4]['Subject'])
-        # the IANA copy
         self.assertTrue("Last Call" in outbox[-3]['Subject'])
+        # the IANA copy
+        self.assertTrue("Last Call" in outbox[-2]['Subject'])
         self.assertTrue("Last Call" in draft.message_set.order_by("-time")[0].subject)
 
 class DeferUndeferTestCase(TestCase):

ietf/doc/tests_draft.py

@@ -72,9 +72,8 @@ def test_change_state(self):
         self.assertEqual(draft.docevent_set.count(), events_before + 2)
         self.assertTrue("Test comment" in draft.docevent_set.all()[0].desc)
         self.assertTrue("IESG state changed" in draft.docevent_set.all()[1].desc)
-        self.assertEqual(len(outbox), mailbox_before + 2)
-        self.assertTrue("State Update Notice" in outbox[-2]['Subject'])
-        self.assertTrue(draft.name in outbox[-1]['Subject'])
+        self.assertEqual(len(outbox), mailbox_before + 1)
+        self.assertTrue("State Update Notice" in outbox[-1]['Subject'])
 
 
         # check that we got a previous state now
@@ -101,7 +100,7 @@ def test_pull_from_rfc_queue(self):
 
         draft = Document.objects.get(name=draft.name)
         self.assertEqual(draft.get_state_slug("draft-iesg"), "review-e")
-        self.assertEqual(len(outbox), mailbox_before + 2 + 1)
+        self.assertEqual(len(outbox), mailbox_before + 2)
         self.assertTrue(draft.name in outbox[-1]['Subject'])
         self.assertTrue("changed state" in outbox[-1]['Subject'])
         self.assertTrue("is no longer" in str(outbox[-1]))
@@ -1095,7 +1094,7 @@ def test_adopt_document(self):
         self.assertEqual(draft.notify,"aliens@example.mars")
         self.assertEqual(len(outbox), mailbox_before + 1)
         self.assertTrue("state changed" in outbox[-1]["Subject"].lower())
-        self.assertTrue("marschairman@ietf.org" in unicode(outbox[-1]))
+        self.assertTrue("mars-chairs@ietf.org" in unicode(outbox[-1]))
         self.assertTrue("marsdelegate@ietf.org" in unicode(outbox[-1]))
 
         self.assertFalse(mars.list_email in draft.notify)
@@ -1137,7 +1136,7 @@ def test_set_tags(self):
         self.assertEqual(draft.docevent_set.count() - events_before, 2)
         self.assertEqual(len(outbox), mailbox_before + 1)
         self.assertTrue("tags changed" in outbox[-1]["Subject"].lower())
-        self.assertTrue("marschairman@ietf.org" in unicode(outbox[-1]))
+        self.assertTrue("mars-chairs@ietf.org" in unicode(outbox[-1]))
         self.assertTrue("marsdelegate@ietf.org" in unicode(outbox[-1]))
         self.assertTrue("plain@example.com" in unicode(outbox[-1]))
 
@@ -1181,7 +1180,7 @@ def test_set_state(self):
         self.assertTrue(due - datetime.timedelta(days=1) <= reminder[0].due <= due + datetime.timedelta(days=1))
         self.assertEqual(len(outbox), mailbox_before + 1)
         self.assertTrue("state changed" in outbox[-1]["Subject"].lower())
-        self.assertTrue("marschairman@ietf.org" in unicode(outbox[-1]))
+        self.assertTrue("mars-chairs@ietf.org" in unicode(outbox[-1]))
         self.assertTrue("marsdelegate@ietf.org" in unicode(outbox[-1]))
 
 class ChangeReplacesTests(TestCase):

ietf/doc/utils.py

@@ -18,18 +18,18 @@
 from ietf.ietfauth.utils import has_role
 from ietf.utils import draft, markup_txt
 from ietf.utils.mail import send_mail
+from ietf.mailtoken.utils import gather_address_list
 
-#FIXME - it would be better if this lived in ietf/doc/mails.py, but there's
+#TODO FIXME - it would be better if this lived in ietf/doc/mails.py, but there's
 #        an import order issue to work out.
 def email_update_telechat(request, doc, text):
-    to = set(['iesg@ietf.org','iesg-secretary@ietf.org'])
-    to.update(set([x.strip() for x in doc.notify.replace(';', ',').split(',')]))
+    to = gather_address_list('doc_telechat_details_changed',doc=doc)
 
     if not to:
         return
 
     text = strip_tags(text)
-    send_mail(request, list(to), None,
+    send_mail(request, to, None,
               "Telechat update notice: %s" % doc.file_tag(),
               "doc/mail/update_telechat.txt",
               dict(text=text,

ietf/doc/views_ballot.py

@@ -17,7 +17,7 @@
     BallotType, LastCallDocEvent, WriteupDocEvent, save_document_in_history, IESG_SUBSTATE_TAGS )
 from ietf.doc.utils import ( add_state_change_event, close_ballot, close_open_ballots,
     create_ballot_if_not_open, update_telechat )
-from ietf.doc.mails import ( email_ad, email_ballot_deferred, email_ballot_undeferred, 
+from ietf.doc.mails import ( email_ballot_deferred, email_ballot_undeferred, 
     email_state_changed, extra_automation_headers, generate_last_call_announcement, 
     generate_issue_ballot_mail, generate_ballot_writeup, generate_approval_mail )
 from ietf.doc.lastcall import request_last_call
@@ -464,7 +464,6 @@ def lastcalltext(request, name):
 
                     if e:
                         email_state_changed(request, doc, e.desc)
-                        email_ad(request, doc, doc.ad, login, e.desc)
 
                     request_last_call(request, doc)
 
@@ -708,7 +707,6 @@ def approve_ballot(request, name):
         doc.save()
 
         email_state_changed(request, doc, change_description)
-        email_ad(request, doc, doc.ad, login, change_description)
 
         # send announcement
 
@@ -790,7 +788,6 @@ def make_last_call(request, name):
             change_description = "Last call has been made for %s and state has been changed to %s" % (doc.name, new_state.name)
 
             email_state_changed(request, doc, change_description)
-            email_ad(request, doc, doc.ad, login, change_description)
 
             e = LastCallDocEvent(doc=doc, by=login)
             e.type = "sent_last_call"

ietf/doc/views_doc.py

@@ -51,14 +51,14 @@
     needed_ballot_positions, nice_consensus, prettify_std_name, update_telechat, has_same_ballot,
     get_initial_notify, make_notify_changed_event )
 from ietf.community.models import CommunityList
-from ietf.doc.mails import email_ad
 from ietf.group.models import Role
 from ietf.group.utils import can_manage_group_type, can_manage_materials
 from ietf.ietfauth.utils import has_role, is_authorized_in_doc_stream, user_is_person, role_required
 from ietf.name.models import StreamName, BallotPositionName
 from ietf.person.models import Email
 from ietf.utils.history import find_history_active_at
 from ietf.doc.forms import TelechatForm, NotifyForm
+from ietf.doc.mails import email_ad
 
 def render_document_top(request, doc, tab, name):
     tabs = []
@@ -878,6 +878,7 @@ def add_comment(request, name):
             e.save()
 
             if doc.type_id == "draft":
+                # TODO - build an explicit message for when a comment is added
                 email_ad(request, doc, doc.ad, login,
                             "A new comment added by %s" % login.name)
             return redirect("doc_history", name=doc.name)

ietf/doc/views_draft.py

@@ -111,7 +111,6 @@ def change_state(request, name):
                 doc.save()
 
                 email_state_changed(request, doc, msg)
-                email_ad(request, doc, doc.ad, login, msg)
 
 
                 if prev_state and prev_state.slug in ("ann", "rfcqueue") and new_state.slug not in ("rfcqueue", "pub"):
@@ -450,6 +449,7 @@ def change_intention(request, name):
                 doc.time = e.time
                 doc.save()
 
+                # TODO: Build explicit changed_intended_publication_status
                 email_ad(request, doc, doc.ad, login, email_desc)
 
             return HttpResponseRedirect(doc.get_absolute_url())
@@ -726,6 +726,7 @@ def diff(attr, name):
             doc.time = datetime.datetime.now()
 
             if changes and not new_document:
+                #TODO - use the 'this thing changed' messages instead
                 email_ad(request, doc, orig_ad, login, "\n".join(changes))
 
             doc.save()

ietf/group/mails.py

@@ -12,6 +12,7 @@
 from ietf.utils.mail import send_mail, send_mail_text
 from ietf.group.models import Group
 from ietf.group.utils import milestone_reviewer_for_group_type
+from ietf.mailtoken.utils import gather_address_list
 
 def email_iesg_secretary_re_charter(request, group, subject, text):
     to = ["iesg-secretary@ietf.org"]
@@ -77,26 +78,18 @@ def wrap_up_email(to, text):
 
         send_mail_text(request, to, None, subject, text)
 
-    # first send to management and chairs
-    to = []
-    if group.ad_role():
-        to.append(group.ad_role().email.formatted_email())
-    elif group.type_id == "rg":
-        to.append("IRTF Chair <irtf-chair@irtf.org>")
-
-    for r in group.role_set.filter(name="chair"):
-        to.append(r.formatted_email())
-
+    # first send to those who should see any edits (such as management and chairs)
+    to = gather_address_list('group_milestones_edited',group=group)
     if to:
         wrap_up_email(to, u"\n\n".join(c + "." for c in changes))
 
-    # then send to group
-    if group.list_email:
-        review_re = re.compile("Added .* for review, due")
-        to = [ group.list_email ]
-        msg = u"\n\n".join(c + "." for c in changes if not review_re.match(c))
-        if msg:
-            wrap_up_email(to, msg)
+    # then send only the approved milestones to those who shouldn't be 
+    # bothered with milestones pending approval 
+    review_re = re.compile("Added .* for review, due")
+    to = gather_address_list('group_approved_milestones_edited',group=group)
+    msg = u"\n\n".join(c + "." for c in changes if not review_re.match(c))
+    if to and msg:
+        wrap_up_email(to, msg)
 
 
 def email_milestone_review_reminder(group, grace_period=7):

ietf/mailtoken/migrations/0002_auto_20150809_1314.py

@@ -37,6 +37,10 @@ def make_recipients(apps):
        desc="The document's group chairs (if the document is assigned to a working or research group)",
        template=None)
 
+    rc(slug='doc_group_delegates',
+       desc="The document's group delegates (if the document is assigned to a working or research group)",
+       template=None)
+
     rc(slug='doc_affecteddoc_authors',
        desc="The authors of the subject documents of a conflict-review or status-change",
        template=None)
@@ -105,6 +109,9 @@ def make_recipients(apps):
        desc="The group's chairs",
        template="{{group.acronym}}-chairs@ietf.org")
 
+    rc(slug='group_responsible_directors',
+       desc="The group's responsible AD(s) or IRTF chair",
+       template=None)
 
 def make_mailtokens(apps):
 
@@ -300,7 +307,51 @@ def mt_factory(slug,desc,recipient_slugs):
                recipient_slugs=['stream_managers',
                                 'doc_notify',
                                ])
+
+    mt_factory(slug='doc_stream_state_edited',
+               desc="Recipients when the stream state of a document is manually edited",
+               recipient_slugs=['doc_group_chairs',
+                                'doc_group_delegates',
+                                'doc_shepherd',
+                                'doc_authors',
+                               ]) 
+
+    mt_factory(slug='group_milestones_edited',
+               desc="Recipients when any of a group's milestones are edited",
+               recipient_slugs=['group_responsible_directors',
+                                'group_chairs',
+                               ])
 
+    mt_factory(slug='group_approved_milestones_edited',
+               desc="Recipients when the set of approved milestones for a group are edited",
+               recipient_slugs=['group_mail_list',
+                               ])
+
+    mt_factory(slug='doc_state_edited',
+               desc="Recipients when a document's state is manutally edited",
+               recipient_slugs=['doc_notify',
+                                'doc_ad',
+                                'doc_authors',
+                                'doc_shepherd',
+                                'doc_group_chairs',
+                                'doc_affecteddoc_authors',
+                                'doc_affecteddoc_group_chairs',
+                                'doc_affecteddoc_notify',
+                               ])
+
+    mt_factory(slug='doc_telechat_details_changed',
+               desc="Recipients when a document's telechat date or other telechat specific details are changed",
+               recipient_slugs=['iesg',
+                                'iesg-secretary',
+                                'doc_notify',
+                                'doc_authors',
+                                'doc_shepherd',
+                                'doc_group_chairs',
+                                'doc_affecteddoc_authors',
+                                'doc_affecteddoc_group_chairs',
+                                'doc_affecteddoc_notify',
+                               ])
+
 
 def forward(apps, schema_editor):