Added the ability to send reminders to complete questionnaires to nominees in the accepted state.

Changed the send_reminders management command to not take any arguments and run against all active nomcoms.
Removed bugs from the send_reminders management command and added tests for it.
Adjusted several dbtemplate titles and content.

Fixes bug 1157

Commit ready for merge
 - Legacy-Id: 6465

Author: rjsparks

ietf/dbtemplate/fixtures/nomcom_templates.xml

@@ -96,8 +96,8 @@ $position: Position</field>
 </field>
         <field to="group.group" name="group" rel="ManyToOneRel"><None></None></field>
     </object>
-    <object p="8" model="dbtemplate.dbtemplate">
-        <field type="CharField" name="path">/nomcom/defaults/email/nomination_reminder.txt</field>
+    <object pk="8" model="dbtemplate.dbtemplate">
+        <field type="CharField" name="path">/nomcom/defaults/email/nomination_accept_reminder.txt</field>
         <field type="CharField" name="title">Email sent to nominees asking them to accept (or decline) the nominations.</field>
         <field type="TextField" name="variables">$positions: Nomination positions</field>
         <field to="name.dbtemplatetypename" name="type" rel="ManyToOneRel">plain</field>
@@ -114,7 +114,7 @@ If you accept, you will need to fill out a questionnaire.
 Best regards,</field>
         <field to="group.group" name="group" rel="ManyToOneRel"><None></None></field>
     </object>
-    <object p="9" model="dbtemplate.dbtemplate">
+    <object pk="9" model="dbtemplate.dbtemplate">
         <field type="CharField" name="path">/nomcom/defaults/email/nomination_receipt.txt</field>
         <field type="CharField" name="title">Email sent to nominator to get a confirmation mail containing feedback in cleartext</field>
         <field type="TextField" name="variables">$nominee: Full name of the nominee
@@ -137,7 +137,7 @@ $comments
 Thank you,</field>
         <field to="group.group" name="group" rel="ManyToOneRel"><None></None></field>
     </object>
-    <object p="10" model="dbtemplate.dbtemplate">
+    <object pk="10" model="dbtemplate.dbtemplate">
         <field type="CharField" name="path">/nomcom/defaults/email/feedback_receipt.txt</field>
         <field type="CharField" name="title">Email sent to feedback author to get a confirmation mail containing feedback in cleartext</field>
         <field type="TextField" name="variables">$nominee: Full name of the nominee
@@ -158,4 +158,18 @@ $comments
 Thank you,</field>
         <field to="group.group" name="group" rel="ManyToOneRel"><None></None></field>
     </object>
+    <object pk="11" model="dbtemplate.dbtemplate">
+        <field type="CharField" name="path">/nomcom/defaults/email/questionnaire_reminder.txt</field>
+        <field type="CharField" name="title">Email sent to nominees reminding them to complete a questionnaire</field>
+        <field type="TextField" name="variables">$positions: Nomination positions</field>
+        <field to="name.dbtemplatetypename" name="type" rel="ManyToOneRel">plain</field>
+        <field type="TextField" name="content">
+Thank you for accepting your nomination for the position of $position.
+
+Please remember to complete and return the questionnaire for this position at your earliest opportunity.
+The questionaire is repeated below for your convenience.
+
+--------</field>
+        <field to="group.group" name="group" rel="ManyToOneRel"><None></None></field>
+    </object>
 </django-objects>

ietf/nomcom/management/commands/send_reminders.py

@@ -1,48 +1,35 @@
 import datetime
 import syslog
 from optparse import make_option
+from django.core.management.base import BaseCommand
+from ietf.nomcom.models import NomCom, NomineePosition
+from nomcom.utils import send_accept_reminder_to_nominee,send_questionnaire_reminder_to_nominee
 
-from django.core.management.base import BaseCommand, CommandError
-
-from ietf.nomcom.models import Nominee, NomCom
-from nomcom.utils import send_reminder_to_nominee
+def log(message):
+    syslog.syslog(message)
 
+def is_time_to_send(nomcom,send_date,nomination_date):
+    if nomcom.reminder_interval:
+        days_passed = (send_date - nomination_date).days
+        return days_passed > 0 and days_passed % nomcom.reminder_interval == 0
+    else:
+        return bool(nomcom.reminderdates_set.filter(date=send_date))
 
 class Command(BaseCommand):
-    help = (u"Send reminders to nominees")
-    option_list = BaseCommand.option_list + (
-         make_option('--nomcom-year', dest='year', help='NomCom year'),)
+    help = (u"Send acceptance and questionnaire reminders to nominees")
 
     def handle(self, *args, **options):
-        year = options.get('year', None)
-        help_message = 'Usage: send_reminders --nomcom-year <nomcom-year>'
-
-        if not year:
-            raise CommandError(help_message)
-
-        try:
-            nomcom = NomCom.objects.get(group__acronym__icontains=year,
-                                        group__state__slug='active')
-        except NomCom.DoesNotExist:
-            raise CommandError("NomCom %s does not exist or it isn't active" % year)
-
-        today = datetime.date.today()
-
-        if nomcom.reminder_interval:
-            nominees = Nominee.objects.get_by_nomcom(nomcom).not_duplicated().filter(nomineeposition__state='pending').distinct()
-            for nominee in nominees:
-                for nominee_position in nominee.nomineeposition_set.all():
-                    nomination_date = nominee_position.time.date()
-                    if not (today - nomination_date).days <= 0:
-                        if (today - nomination_date).days % nomcom.reminder_interval == 0:
-                            send_reminder_to_nominee(nominee_position)
-                            syslog.syslog(u"Sent reminder to %s" % nominee_position.nominee.email.address)
-                            print u"Sent reminder to %s" % nominee_position.nominee.email.address
-        else:
-            if nomcom.reminderdates_set.filter(date=today):
-                nominees = Nominee.objects.get_by_nomcom(nomcom).not_duplicated().filter(nomineeposition__state='pending').distinct()
-                for nominee in nominees:
-                    for nominee_position in nominee.nomineeposition_set.pending():
-                        send_reminder_to_nominee(nominee_position)
-                        syslog.syslog(u"Sent reminder to %s" % nominee_position.nominee.email.address)
-                        print u"Sent reminder (by dates) to %s" % nominee_position.nominee.email.address
+        for nomcom in NomCom.objects.filter(group__state__slug='active'):
+            for state in ('pending','accepted'):
+                for nominee_position in NomineePosition.objects.filter(nominee__nomcom=nomcom,
+                                                                       state=state,
+                                                                       nominee__duplicated__isnull=True):
+                    if is_time_to_send(nomcom, datetime.date.today(), nominee_position.time.date()):
+                        if state=='pending':
+                            send_accept_reminder_to_nominee(nominee_position)
+                            log('Sent accept reminder to %s' % nominee_position.nominee.email.address)
+                        elif state=='accepted':
+                            send_questionnaire_reminder_to_nominee(nominee_position)
+                            log('Sent questionnaire reminder to %s' % nominee_position.nominee.email.address)
+                        else:
+                            pass

ietf/nomcom/tests.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import os
 import tempfile
+import datetime
 
 from ietf.utils import TestCase
 from django.db import IntegrityError
@@ -9,6 +10,7 @@
 from django.contrib.formtools.preview import security_hash
 
 from ietf.utils.test_utils import login_testing_unauthorized
+from ietf.utils.mail import outbox
 
 
 from ietf.person.models import Email, Person
@@ -20,7 +22,8 @@
                                NomineePositionState, Feedback, FeedbackType, \
                                Nomination
 from ietf.nomcom.forms import EditChairForm, EditMembersForm
-from ietf.nomcom.utils import get_nomcom_by_year
+from ietf.nomcom.utils import get_nomcom_by_year, get_or_create_nominee
+from ietf.nomcom.management.commands.send_reminders import Command, is_time_to_send
 
 
 class NomcomViewsTest(TestCase):
@@ -653,3 +656,63 @@ def test_encrypted_comments(self):
 
         os.unlink(self.privatekey_file.name)
         os.unlink(self.cert_file.name)
+
+class ReminderCommandTest(TestCase):
+    perma_fixtures = ['names', 'nomcom_templates']
+
+    def setUp(self):
+        nomcom_test_data()
+        self.nomcom = get_nomcom_by_year(NOMCOM_YEAR)
+
+        gen = Position.objects.get(nomcom=self.nomcom,name='GEN')
+        rai = Position.objects.get(nomcom=self.nomcom,name='RAI')
+        iab = Position.objects.get(nomcom=self.nomcom,name='IAB')
+
+        today = datetime.date.today()
+        t_minus_3 = today - datetime.timedelta(days=3)
+        t_minus_4 = today - datetime.timedelta(days=4)
+        n = get_or_create_nominee(self.nomcom,"Nominee 1","nominee1@example.org",gen,None)
+        np = n.nomineeposition_set.get(position=gen)
+        np.time = t_minus_3
+        np.save()
+        n = get_or_create_nominee(self.nomcom,"Nominee 1","nominee1@example.org",iab,None)
+        np = n.nomineeposition_set.get(position=iab)
+        np.state = NomineePositionState.objects.get(slug='accepted')
+        np.time = t_minus_3
+        np.save()
+        n = get_or_create_nominee(self.nomcom,"Nominee 2","nominee2@example.org",rai,None)
+        np = n.nomineeposition_set.get(position=rai)
+        np.time = t_minus_4
+        np.save()
+
+    def test_is_time_to_send(self):
+        self.nomcom.reminder_interval = 4
+        today = datetime.date.today()
+        self.assertTrue(is_time_to_send(self.nomcom,today+datetime.timedelta(days=4),today))
+        for delta in range(4):
+            self.assertFalse(is_time_to_send(self.nomcom,today+datetime.timedelta(days=delta),today))
+        self.nomcom.reminder_interval = None
+        self.assertFalse(is_time_to_send(self.nomcom,today,today))
+        self.nomcom.reminderdates_set.create(date=today)
+        self.assertTrue(is_time_to_send(self.nomcom,today,today))
+
+    def test_command(self):
+        c = Command()
+        messages_before=len(outbox)
+        self.nomcom.reminder_interval = 3
+        self.nomcom.save()
+        c.handle(None,None)
+        self.assertEqual(len(outbox), messages_before + 2)
+        self.assertTrue('nominee1@example.org' in outbox[-1]['To'])
+        self.assertTrue('please complete' in outbox[-1]['Subject'])
+        self.assertTrue('nominee1@example.org' in outbox[-2]['To'])
+        self.assertTrue('please accept' in outbox[-2]['Subject'])
+        messages_before=len(outbox)
+        self.nomcom.reminder_interval = 4
+        self.nomcom.save()
+        c.handle(None,None)
+        self.assertEqual(len(outbox), messages_before + 1)
+        self.assertTrue('nominee2@example.org' in outbox[-1]['To'])
+        self.assertTrue('please accept' in outbox[-1]['Subject'])
+ 
+     

ietf/nomcom/urls.py

@@ -1,5 +1,6 @@
 from django.conf.urls.defaults import patterns, url
-from django.views.generic.simple import direct_to_template
+from django.views.generic.simple import direct_to_template, redirect_to
+from ietf.utils.lazy import reverse_lazy
 from ietf.nomcom.forms import EditChairForm, EditChairFormPreview, \
                               EditMembersForm, EditMembersFormPreview
 
@@ -17,7 +18,8 @@
     url(r'^(?P<year>\d{4})/private/view-feedback/nominee/(?P<nominee_id>\d+)$', 'view_feedback_nominee', name='nomcom_view_feedback_nominee'),
     url(r'^(?P<year>\d{4})/private/edit/nominee/(?P<nominee_id>\d+)$', 'edit_nominee', name='nomcom_edit_nominee'),
     url(r'^(?P<year>\d{4})/private/merge/$', 'private_merge', name='nomcom_private_merge'),
-    url(r'^(?P<year>\d{4})/private/send-reminder-mail/$', 'send_reminder_mail', name='nomcom_send_reminder_mail'),
+#    url(r'^(?P<year>\d{4})/private/send-reminder-mail/$', redirect_to, { 'url': reverse_lazy('nomcom_send_reminder_mail',kwargs={'year':year,'type':'accept'})}),
+    url(r'^(?P<year>\d{4})/private/send-reminder-mail/(?P<type>\w+)/$', 'send_reminder_mail', name='nomcom_send_reminder_mail'),
     url(r'^(?P<year>\d{4})/private/edit-members/$', EditMembersFormPreview(EditMembersForm), name='nomcom_edit_members'),
     url(r'^(?P<year>\d{4})/private/edit-chair/$', EditChairFormPreview(EditChairForm), name='nomcom_edit_chair'),
     url(r'^(?P<year>\d{4})/private/edit-nomcom/$', 'edit_nomcom', name='nomcom_edit_nomcom'),

ietf/nomcom/utils.py

@@ -32,15 +32,17 @@
 INEXISTENT_PERSON_TEMPLATE = 'email/inexistent_person.txt'
 NOMINEE_EMAIL_TEMPLATE = 'email/new_nominee.txt'
 NOMINATION_EMAIL_TEMPLATE = 'email/new_nomination.txt'
-NOMINEE_REMINDER_TEMPLATE = 'email/nomination_reminder.txt'
+NOMINEE_ACCEPT_REMINDER_TEMPLATE = 'email/nomination_accept_reminder.txt'
+NOMINEE_QUESTIONNAIRE_REMINDER_TEMPLATE = 'email/questionnaire_reminder.txt'
 NOMINATION_RECEIPT_TEMPLATE = 'email/nomination_receipt.txt'
 FEEDBACK_RECEIPT_TEMPLATE = 'email/feedback_receipt.txt'
 
 DEFAULT_NOMCOM_TEMPLATES = [HOME_TEMPLATE,
                             INEXISTENT_PERSON_TEMPLATE,
                             NOMINEE_EMAIL_TEMPLATE,
                             NOMINATION_EMAIL_TEMPLATE,
-                            NOMINEE_REMINDER_TEMPLATE,
+                            NOMINEE_ACCEPT_REMINDER_TEMPLATE,
+                            NOMINEE_QUESTIONNAIRE_REMINDER_TEMPLATE,
                             NOMINATION_RECEIPT_TEMPLATE,
                             FEEDBACK_RECEIPT_TEMPLATE]
 
@@ -107,7 +109,7 @@ def initialize_questionnaire_for_position(position):
         content=header_template.content)
     questionnaire = DBTemplate.objects.create(
         group=position.nomcom.group,
-        title=template.title + '[%s]' % position.name,
+        title=template.title + ' [%s]' % position.name,
         path='/nomcom/' + position.nomcom.group.acronym + '/' + str(position.id) + '/' + QUESTIONNAIRE_TEMPLATE,
         variables=template.variables,
         type_id=template.type_id,
@@ -191,15 +193,15 @@ def validate_public_key(public_key):
     return (not error, error)
 
 
-def send_reminder_to_nominee(nominee_position):
+def send_accept_reminder_to_nominee(nominee_position):
     today = datetime.date.today().strftime('%Y%m%d')
-    subject = 'IETF Nomination Information'
+    subject = 'Reminder: please accept (or decline) your nomination.'
     from_email = settings.NOMCOM_FROM_EMAIL
     domain = Site.objects.get_current().domain
     position = nominee_position.position
     nomcom = position.nomcom
     nomcom_template_path = '/nomcom/%s/' % nomcom.group.acronym
-    mail_path = nomcom_template_path + NOMINEE_REMINDER_TEMPLATE
+    mail_path = nomcom_template_path + NOMINEE_ACCEPT_REMINDER_TEMPLATE
     nominee = nominee_position.nominee
     to_email = nominee.email.address
 
@@ -229,11 +231,42 @@ def send_reminder_to_nominee(nominee_position):
     body += '\n\n%s' % render_to_string(path, context)
     send_mail_text(None, to_email, from_email, subject, body)
 
+def send_questionnaire_reminder_to_nominee(nominee_position):
+    today = datetime.date.today().strftime('%Y%m%d')
+    subject = 'Reminder: please complete the Nomcom questionnaires for your nomination.'
+    from_email = settings.NOMCOM_FROM_EMAIL
+    domain = Site.objects.get_current().domain
+    position = nominee_position.position
+    nomcom = position.nomcom
+    nomcom_template_path = '/nomcom/%s/' % nomcom.group.acronym
+    mail_path = nomcom_template_path + NOMINEE_QUESTIONNAIRE_REMINDER_TEMPLATE
+    nominee = nominee_position.nominee
+    to_email = nominee.email.address
+
+    hash = get_hash_nominee_position(today, nominee_position.id)
+
+    context = {'nominee': nominee,
+               'position': position,
+               'domain': domain,
+               }
+    body = render_to_string(mail_path, context)
+    path = '%s%d/%s' % (nomcom_template_path, position.id, QUESTIONNAIRE_TEMPLATE)
+    body += '\n\n%s' % render_to_string(path, context)
+    send_mail_text(None, to_email, from_email, subject, body)
 
-def send_reminder_to_nominees(nominees):
-    for nominee in nominees:
-        for nominee_position in nominee.nomineeposition_set.pending():
-            send_reminder_to_nominee(nominee_position)
+def send_reminder_to_nominees(nominees,type):
+    addrs = []
+    if type=='accept':
+        for nominee in nominees:
+            for nominee_position in nominee.nomineeposition_set.pending():
+                send_accept_reminder_to_nominee(nominee_position)
+                addrs.append(nominee_position.nominee.email.address)
+    elif type=='questionnaire':
+        for nominee in nominees:
+            for nominee_position in nominee.nomineeposition_set.accepted():
+                send_questionnaire_reminder_to_nominee(nominee_position)
+                addrs.append(nominee_position.nominee.email.address)
+    return addrs
 
 
 def get_or_create_nominee(nomcom, candidate_name, candidate_email, position, author):