Refactored multiple edit_telechat functions into one function in doc_views.

Added a helper function for determining if ballots have changed to isolate the implementation.
Fixed the issue with update_agenda setting the returning item bit even when the user explicitly said not to.
Added prompting to encourage proper setting of the returning item bit to the edit_telechat view.

Fixes ietf-tools#1209
Commit ready for merge.
 - Legacy-Id: 8263

Author: rjsparks

ietf/doc/urls.py

@@ -76,7 +76,7 @@
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/replaces/$', views_draft.replaces, name='doc_change_replaces'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/notify/$', views_draft.edit_notices, name='doc_change_notify'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/status/$', views_draft.change_intention, name='doc_change_intended_status'),
-    url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/telechat/$', views_draft.telechat_date, name='doc_change_telechat_date'),
+    url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/telechat/$', views_doc.telechat_date, name='doc_change_telechat_date'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/iesgnote/$', views_draft.edit_iesg_note, name='doc_change_iesg_note'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/ad/$', views_draft.edit_ad, name='doc_change_ad'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/consensus/$', views_draft.edit_consensus, name='doc_edit_consensus'),

ietf/doc/urls_charter.py

@@ -5,7 +5,7 @@
 urlpatterns = patterns('',
     url(r'^state/$', "ietf.doc.views_charter.change_state", name='charter_change_state'),
     url(r'^(?P<option>initcharter|recharter|abandon)/$', "ietf.doc.views_charter.change_state", name='charter_startstop_process'),
-    url(r'^telechat/$', "ietf.doc.views_charter.telechat_date", name='charter_telechat_date'),
+    url(r'^telechat/$', "ietf.doc.views_doc.telechat_date", name='charter_telechat_date'),
     url(r'^notify/$', "ietf.doc.views_charter.edit_notify", name='charter_edit_notify'),
     url(r'^ad/$', "ietf.doc.views_charter.edit_ad", name='charter_edit_ad'),
     url(r'^(?P<ann>action|review)/$', "ietf.doc.views_charter.announcement_text", name="charter_edit_announcement"),

ietf/doc/urls_conflict_review.py

@@ -7,6 +7,10 @@
     url(r'^ad/$',                    "edit_ad",       name='conflict_review_ad'),
     url(r'^approve/$',               "approve",       name='conflict_review_approve'),
     url(r'^start_conflict_review/$', "start_review",  name='conflict_review_start'),
+)
+
+urlpatterns += patterns('ietf.doc.views_doc',
     url(r'^telechat/$',              "telechat_date", name='conflict_review_telechat_date'),
 )
 
+

ietf/doc/urls_status_change.py

@@ -7,8 +7,12 @@
     url(r'^ad/$',                    "edit_ad",        name='status_change_ad'),
     url(r'^title/$',                 "edit_title",     name='status_change_title'),
     url(r'^approve/$',               "approve",        name='status_change_approve'),
-    url(r'^telechat/$',              "telechat_date",  name='status_change_telechat_date'),
     url(r'^relations/$',             "edit_relations", name='status_change_relations'),
     url(r'^last-call/$',             "last_call",      name='status_change_last_call'),
 )
 
+urlpatterns += patterns('ietf.doc.views_doc',
+    url(r'^telechat/$',              "telechat_date",  name='status_change_telechat_date'),
+)
+
+

ietf/doc/utils.py

@@ -307,6 +307,14 @@ def nice_consensus(consensus):
         }
     return mapping[consensus]
 
+def has_same_ballot(doc, date1, date2=datetime.date.today()):
+    """ Test if the most recent ballot created before the end of date1
+        is the same as the most recent ballot created before the
+        end of date 2. """
+    ballot1 = doc.latest_event(BallotDocEvent,type='created_ballot',time__lt=date1+datetime.timedelta(days=1))
+    ballot2 = doc.latest_event(BallotDocEvent,type='created_ballot',time__lt=date2+datetime.timedelta(days=1))
+    return ballot1==ballot2
+
 def update_telechat(request, doc, by, new_telechat_date, new_returning_item=None):
     from ietf.doc.models import TelechatDocEvent
 
@@ -316,15 +324,6 @@ def update_telechat(request, doc, by, new_telechat_date, new_returning_item=None
     prev_returning = bool(prev and prev.returning_item)
     prev_telechat = prev.telechat_date if prev else None
     prev_agenda = bool(prev_telechat)
-    prev_telechat_happened = prev_telechat and prev_telechat < datetime.date.today()
-
-    prev_same_ballot = False
-    if prev_telechat:
-         prev_ballot = doc.docevent_set.filter(ballotdocevent__type='created_ballot').exclude(time__gt=prev_telechat).order_by('-time').first()
-         cur_ballot  = doc.docevent_set.filter(ballotdocevent__type='created_ballot').order_by('-time').first()
-         prev_same_ballot = (prev_ballot == cur_ballot)
-
-    returning_item_changed = bool(new_returning_item != None and new_returning_item != prev_returning)
 
     if new_returning_item == None:
         returning = prev_returning
@@ -335,13 +334,13 @@ def update_telechat(request, doc, by, new_telechat_date, new_returning_item=None
         # fully updated, nothing to do
         return
 
-    # auto-update returning item
-    if (     not returning_item_changed 
+    # auto-set returning item _ONLY_ if the caller did not provide a value
+    if (     new_returning_item != None
          and on_agenda 
          and prev_agenda
          and new_telechat_date != prev_telechat
-         and prev_telechat_happened
-         and prev_same_ballot
+         and prev_telechat < datetime.date.today()
+         and has_same_ballot(doc,prev.telechat_date)
        ):
         returning = True
 

ietf/doc/views_charter.py

@@ -14,16 +14,15 @@
 import debug                            # pyflakes:ignore
 
 from ietf.doc.models import ( Document, DocHistory, State, DocEvent, BallotDocEvent,
-    BallotPositionDocEvent, InitialReviewDocEvent, NewRevisionDocEvent, TelechatDocEvent,
+    BallotPositionDocEvent, InitialReviewDocEvent, NewRevisionDocEvent, 
     WriteupDocEvent, save_document_in_history )
 from ietf.doc.utils import ( add_state_change_event, close_open_ballots,
-    create_ballot_if_not_open, get_chartering_type, update_telechat )
+    create_ballot_if_not_open, get_chartering_type )
 from ietf.doc.utils_charter import ( historic_milestones_for_charter,
     approved_revision, default_review_text, default_action_text, email_state_changed,
     generate_ballot_writeup, generate_issue_ballot_mail, next_approved_revision, next_revision )
 from ietf.group.models import ChangeStateGroupEvent, MilestoneGroupEvent
 from ietf.group.utils import save_group_in_history, save_milestone_in_history, can_manage_group_type
-from ietf.iesg.models import TelechatDate
 from ietf.ietfauth.utils import has_role, role_required
 from ietf.name.models import GroupStateName
 from ietf.person.models import Person
@@ -32,7 +31,6 @@
 from ietf.utils.textupload import get_cleaned_text_file_content
 from ietf.group.mails import email_iesg_secretary_re_charter
 
-
 class ChangeStateForm(forms.Form):
     charter_state = forms.ModelChoiceField(State.objects.filter(used=True, type="charter"), label="Charter state", empty_label=None, required=False)
     initial_time = forms.IntegerField(initial=0, label="Review time", help_text="(in weeks)", required=False)
@@ -227,46 +225,6 @@ def state_pk(slug):
                                    ),
                               context_instance=RequestContext(request))
 
-class TelechatForm(forms.Form):
-    telechat_date = forms.TypedChoiceField(coerce=lambda x: datetime.datetime.strptime(x, '%Y-%m-%d').date(), empty_value=None, required=False)
-
-    def __init__(self, *args, **kwargs):
-        super(self.__class__, self).__init__(*args, **kwargs)
-
-        dates = [d.date for d in TelechatDate.objects.active().order_by('date')]
-        init = kwargs['initial'].get("telechat_date")
-        if init and init not in dates:
-            dates.insert(0, init)
-
-        self.fields['telechat_date'].choices = [("", "(not on agenda)")] + [(d, d.strftime("%Y-%m-%d")) for d in dates]
-        
-
-@role_required("Area Director", "Secretariat")
-def telechat_date(request, name):
-    doc = get_object_or_404(Document, type="charter", name=name)
-    login = request.user.person
-
-    e = doc.latest_event(TelechatDocEvent, type="scheduled_for_telechat")
-
-    initial = dict(telechat_date=e.telechat_date if e else None)
-    if request.method == "POST":
-        form = TelechatForm(request.POST, initial=initial)
-
-        if form.is_valid():
-            update_telechat(request, doc, login, form.cleaned_data['telechat_date'])
-            return redirect("doc_view", name=doc.name)
-    else:
-        form = TelechatForm(initial=initial)
-
-    return render_to_response('doc/charter/edit_telechat_date.html',
-                              dict(doc=doc,
-                                   form=form,
-                                   user=request.user,
-                                   login=login,
-                                   okstates=['intrev','extrev','iesgrev'],
-                                   ),
-                              context_instance=RequestContext(request))
-
 class NotifyForm(forms.Form):
     notify = forms.CharField(max_length=255, help_text="List of email addresses to receive state notifications, separated by comma", label="Notification list", required=False)
 

ietf/doc/views_conflict_review.py

@@ -9,11 +9,11 @@
 from django.conf import settings
 
 from ietf.doc.models import ( BallotDocEvent, BallotPositionDocEvent, DocAlias, DocEvent,
-    Document, NewRevisionDocEvent, State, TelechatDocEvent, save_document_in_history )
+    Document, NewRevisionDocEvent, State, save_document_in_history )
 from ietf.doc.utils import ( add_state_change_event, close_open_ballots,
     create_ballot_if_not_open, get_document_content, update_telechat )
 from ietf.doc.mails import email_iana
-from ietf.doc.forms import TelechatForm, AdForm, NotifyForm
+from ietf.doc.forms import AdForm, NotifyForm
 from ietf.group.models import Role, Group
 from ietf.iesg.models import TelechatDate
 from ietf.ietfauth.utils import has_role, role_required, is_authorized_in_doc_stream
@@ -512,31 +512,3 @@ def start_review_as_stream_owner(request, name):
                                'doc_to_review': doc_to_review,
                               },
                               context_instance = RequestContext(request))
-
-@role_required("Area Director", "Secretariat")
-def telechat_date(request, name):
-    doc = get_object_or_404(Document, type="conflrev", name=name)
-    login = request.user.person
-
-    e = doc.latest_event(TelechatDocEvent, type="scheduled_for_telechat")
-    initial_returning_item = bool(e and e.returning_item)
-
-    initial = dict(telechat_date=e.telechat_date if e else None,
-                   returning_item = initial_returning_item,
-                  )
-    if request.method == "POST":
-        form = TelechatForm(request.POST, initial=initial)
-
-        if form.is_valid():
-            update_telechat(request, doc, login, form.cleaned_data['telechat_date'], form.cleaned_data['returning_item'])
-            return redirect("doc_view", name=doc.name)
-    else:
-        form = TelechatForm(initial=initial)
-
-    return render_to_response('doc/edit_telechat_date.html',
-                              dict(doc=doc,
-                                   form=form,
-                                   user=request.user,
-                                   login=login),
-                              context_instance=RequestContext(request))
-

ietf/doc/views_doc.py

@@ -46,7 +46,7 @@
     IESG_BALLOT_ACTIVE_STATES)
 from ietf.doc.utils import ( add_links_in_new_revision_events, augment_events_with_revision,
     can_adopt_draft, get_chartering_type, get_document_content, get_tags_for_stream_id,
-    needed_ballot_positions, nice_consensus, prettify_std_name)
+    needed_ballot_positions, nice_consensus, prettify_std_name, update_telechat, has_same_ballot)
 from ietf.community.models import CommunityList
 from ietf.doc.mails import email_ad
 from ietf.doc.views_status_change import RELATION_SLUGS as status_change_relationships
@@ -56,6 +56,7 @@
 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
 
 def render_document_top(request, doc, tab, name):
     tabs = []
@@ -849,3 +850,50 @@ def add_comment(request, name):
                                    form=form),
                               context_instance=RequestContext(request))
 
+@role_required("Area Director", "Secretariat")
+def telechat_date(request, name):
+    doc = get_object_or_404(Document, name=name)
+    login = request.user.person
+
+    e = doc.latest_event(TelechatDocEvent, type="scheduled_for_telechat")
+    initial_returning_item = bool(e and e.returning_item)
+
+    prompts = []
+    if e and doc.type.slug != 'charter':
+        if e.telechat_date==datetime.date.today():
+            prompts.append( "This document is currently scheduled for today's telechat. "
+                           +"Please set the returning item bit carefully.")
+
+        elif e.telechat_date<datetime.date.today() and has_same_ballot(doc,e.telechat_date):
+            initial_returning_item = True
+            prompts.append(  "This document appears to have been on a previous telechat with the same ballot, "
+                            +"so the returning item bit has been set. Clear it if that is not appropriate.")
+
+        else:
+            pass
+
+    initial = dict(telechat_date=e.telechat_date if e else None,
+                   returning_item = initial_returning_item,
+                  )
+    if request.method == "POST":
+        form = TelechatForm(request.POST, initial=initial)
+
+        if form.is_valid():
+            if doc.type.slug=='charter':
+                cleaned_returning_item = None
+            else:
+                cleaned_returning_item = form.cleaned_data['returning_item']
+            update_telechat(request, doc, login, form.cleaned_data['telechat_date'],cleaned_returning_item)
+            return redirect('doc_view', name=doc.name)
+    else:
+        form = TelechatForm(initial=initial)
+        if doc.type.slug=='charter':
+            del form.fields['returning_item']
+
+    return render_to_response('doc/edit_telechat_date.html',
+                              dict(doc=doc,
+                                   form=form,
+                                   user=request.user,
+                                   prompts=prompts,
+                                   login=login),
+                              context_instance=RequestContext(request))

ietf/doc/views_draft.py

@@ -29,7 +29,6 @@
 from ietf.ietfauth.utils import role_required
 from ietf.message.models import Message
 from ietf.name.models import IntendedStdLevelName, DocTagName, StreamName
-from ietf.doc.forms import TelechatForm
 from ietf.person.forms import EmailsField
 from ietf.person.models import Person, Email
 from ietf.secr.lib.template import jsonapi
@@ -878,34 +877,6 @@ def edit_notices(request, name):
                               },
                               context_instance = RequestContext(request))
 
-@role_required("Area Director", "Secretariat")
-def telechat_date(request, name):
-    doc = get_object_or_404(Document, type="draft", name=name)
-    login = request.user.person
-
-    e = doc.latest_event(TelechatDocEvent, type="scheduled_for_telechat")
-    initial_returning_item = bool(e and e.returning_item)
-
-    initial = dict(telechat_date=e.telechat_date if e else None,
-                   returning_item = initial_returning_item,
-                  )
-    if request.method == "POST":
-        form = TelechatForm(request.POST, initial=initial)
-
-        if form.is_valid():
-            update_telechat(request, doc, login, form.cleaned_data['telechat_date'],form.cleaned_data['returning_item'])
-            return redirect('doc_view', name=doc.name)
-    else:
-        form = TelechatForm(initial=initial)
-
-    return render_to_response('doc/edit_telechat_date.html',
-                              dict(doc=doc,
-                                   form=form,
-                                   user=request.user,
-                                   login=login),
-                              context_instance=RequestContext(request))
-
-
 class IESGNoteForm(forms.Form):
     note = forms.CharField(widget=forms.Textarea, label="IESG note", required=False)
 

ietf/doc/views_status_change.py

@@ -9,9 +9,9 @@
 from django.conf import settings
 
 from ietf.doc.models import ( Document, DocAlias, State, DocEvent, BallotDocEvent,
-    BallotPositionDocEvent, NewRevisionDocEvent, TelechatDocEvent, WriteupDocEvent,
+    BallotPositionDocEvent, NewRevisionDocEvent, WriteupDocEvent,
     save_document_in_history )
-from ietf.doc.forms import TelechatForm, AdForm, NotifyForm
+from ietf.doc.forms import AdForm, NotifyForm
 from ietf.doc.lastcall import request_last_call
 from ietf.doc.utils import get_document_content, add_state_change_event, update_telechat, close_open_ballots, create_ballot_if_not_open
 from ietf.doc.views_ballot import LastCallTextForm
@@ -590,34 +590,6 @@ def start_rfc_status_change(request,name):
                               },
                               context_instance = RequestContext(request))
 
-
-@role_required("Area Director", "Secretariat")
-def telechat_date(request, name):
-    doc = get_object_or_404(Document, type="statchg", name=name)
-    login = request.user.person
-
-    e = doc.latest_event(TelechatDocEvent, type="scheduled_for_telechat")
-    initial_returning_item = bool(e and e.returning_item)
-
-    initial = dict(telechat_date=e.telechat_date if e else None,
-                   returning_item = initial_returning_item,
-                  )
-    if request.method == "POST":
-        form = TelechatForm(request.POST, initial=initial)
-
-        if form.is_valid():
-            update_telechat(request, doc, login, form.cleaned_data['telechat_date'], form.cleaned_data['returning_item'])
-            return redirect("doc_view", name=doc.name)
-    else:
-        form = TelechatForm(initial=initial)
-
-    return render_to_response('doc/edit_telechat_date.html',
-                              dict(doc=doc,
-                                   form=form,
-                                   user=request.user,
-                                   login=login),
-                              context_instance=RequestContext(request))
-
 @role_required("Area Director", "Secretariat")
 def edit_relations(request, name):
     """Change the affected set of RFCs"""