Summary: Resolve person/email/document multiselect issue by importing

select2 and switching the widgets over to using that. Port the
milestones editing page to Bootstrap.
 - Legacy-Id: 8713

Author: OleLaursen

ietf/doc/fields.py

@@ -8,17 +8,16 @@
 
 from ietf.doc.models import Document, DocAlias
 
-def tokeninput_id_doc_name_json(objs):
-    return json.dumps([{ "id": o.pk, "name": escape(o.name) } for o in objs])
+def select2_id_doc_name_json(objs):
+    return json.dumps([{ "id": o.pk, "text": escape(o.name) } for o in objs])
 
-class AutocompletedDocumentsField(forms.CharField):
-    """Tokenizing autocompleted multi-select field for choosing
-    documents using jquery.tokeninput.js.
+class SearchableDocumentsField(forms.CharField):
+    """Server-based multi-select field for choosing documents using
+    select2.js.
 
     The field uses a comma-separated list of primary keys in a
-    CharField element as its API, the tokeninput Javascript adds some
-    selection magic on top of this so we have to pass it a JSON
-    representation of ids and user-understandable labels."""
+    CharField element as its API with some extra attributes used by
+    the Javascript part."""
 
     def __init__(self,
                  max_entries=None, # max number of selected objs
@@ -31,39 +30,45 @@ def __init__(self,
         self.doc_type = doc_type
         self.model = model
 
-        super(AutocompletedDocumentsField, self).__init__(*args, **kwargs)
+        super(SearchableDocumentsField, self).__init__(*args, **kwargs)
 
-        self.widget.attrs["class"] = "tokenized-field"
-        self.widget.attrs["data-hint-text"] = hint_text
+        self.widget.attrs["class"] = "select2-field"
+        self.widget.attrs["data-placeholder"] = hint_text
         if self.max_entries != None:
             self.widget.attrs["data-max-entries"] = self.max_entries
 
-    def parse_tokenized_value(self, value):
+    def parse_select2_value(self, value):
         return [x.strip() for x in value.split(",") if x.strip()]
 
     def prepare_value(self, value):
         if not value:
             value = ""
         if isinstance(value, basestring):
-            pks = self.parse_tokenized_value(value)
-            value = self.model.objects.filter(pk__in=pks, type=self.doc_type)
+            pks = self.parse_select2_value(value)
+            value = self.model.objects.filter(pk__in=pks)
+            filter_args = {}
+            if self.model == DocAlias:
+                filter_args["document__type"] = self.doc_type
+            else:
+                filter_args["type"] = self.doc_type
+            value = value.filter(**filter_args)
         if isinstance(value, self.model):
             value = [value]
 
-        self.widget.attrs["data-pre"] = tokeninput_id_doc_name_json(value)
+        self.widget.attrs["data-pre"] = select2_id_doc_name_json(value)
 
         # doing this in the constructor is difficult because the URL
         # patterns may not have been fully constructed there yet
-        self.widget.attrs["data-ajax-url"] = urlreverse("ajax_tokeninput_search_docs", kwargs={
+        self.widget.attrs["data-ajax-url"] = urlreverse("ajax_select2_search_docs", kwargs={
             "doc_type": self.doc_type,
             "model_name": self.model.__name__.lower()
         })
 
-        return ",".join(o.pk for o in value)
+        return u",".join(unicode(o.pk) for o in value)
 
     def clean(self, value):
-        value = super(AutocompletedDocumentsField, self).clean(value)
-        pks = self.parse_tokenized_value(value)
+        value = super(SearchableDocumentsField, self).clean(value)
+        pks = self.parse_select2_value(value)
 
         objs = self.model.objects.filter(pk__in=pks)
 
@@ -77,7 +82,7 @@ def clean(self, value):
 
         return objs
 
-class AutocompletedDocAliasField(AutocompletedDocumentsField):
+class SearchableDocAliasesField(SearchableDocumentsField):
     def __init__(self, model=DocAlias, *args, **kwargs):
-        super(AutocompletedDocAliasField, self).__init__(model=model, *args, **kwargs)
+        super(SearchableDocAliasesField, self).__init__(model=model, *args, **kwargs)
 

ietf/doc/tests.py

@@ -127,7 +127,7 @@ def test_ajax_search_docs(self):
         draft = make_test_data()
 
         # Document
-        url = urlreverse("ajax_tokeninput_search_docs", kwargs={
+        url = urlreverse("ajax_select2_search_docs", kwargs={
             "model_name": "document",
             "doc_type": "draft",
         })
@@ -139,7 +139,7 @@ def test_ajax_search_docs(self):
         # DocAlias
         doc_alias = draft.docalias_set.get()
 
-        url = urlreverse("ajax_tokeninput_search_docs", kwargs={
+        url = urlreverse("ajax_select2_search_docs", kwargs={
             "model_name": "docalias",
             "doc_type": "draft",
         })

ietf/doc/tests_draft.py

@@ -1227,32 +1227,28 @@ def test_change_replaces(self):
 
         # Post that says replacea replaces base a
         self.assertEqual(self.basea.get_state().slug,'active')
-        repljson='{"%d":"%s"}'%(DocAlias.objects.get(name=self.basea.name).id,self.basea.name)
-        r = self.client.post(url, dict(replaces=repljson))
+        r = self.client.post(url, dict(replaces=str(DocAlias.objects.get(name=self.basea.name).id)))
         self.assertEqual(r.status_code, 302)
         self.assertEqual(RelatedDocument.objects.filter(relationship__slug='replaces',source=self.replacea).count(),1) 
         self.assertEqual(Document.objects.get(name='draft-test-base-a').get_state().slug,'repl')
 
         # Post that says replaceboth replaces both base a and base b
         url = urlreverse('doc_change_replaces', kwargs=dict(name=self.replaceboth.name))
         self.assertEqual(self.baseb.get_state().slug,'expired')
-        repljson='{"%d":"%s","%d":"%s"}'%(DocAlias.objects.get(name=self.basea.name).id,self.basea.name,
-                                          DocAlias.objects.get(name=self.baseb.name).id,self.baseb.name)
-        r = self.client.post(url, dict(replaces=repljson))
+        r = self.client.post(url, dict(replaces=str(DocAlias.objects.get(name=self.basea.name).id) + "," + str(DocAlias.objects.get(name=self.baseb.name).id)))
         self.assertEqual(r.status_code, 302)
         self.assertEqual(Document.objects.get(name='draft-test-base-a').get_state().slug,'repl')
         self.assertEqual(Document.objects.get(name='draft-test-base-b').get_state().slug,'repl')
 
         # Post that undoes replaceboth
-        repljson='{}'
-        r = self.client.post(url, dict(replaces=repljson))
+        r = self.client.post(url, dict(replaces=""))
         self.assertEqual(r.status_code, 302)
         self.assertEqual(Document.objects.get(name='draft-test-base-a').get_state().slug,'repl') # Because A is still also replaced by replacea
         self.assertEqual(Document.objects.get(name='draft-test-base-b').get_state().slug,'expired')
 
         # Post that undoes replacea
         url = urlreverse('doc_change_replaces', kwargs=dict(name=self.replacea.name))
-        r = self.client.post(url, dict(replaces=repljson))
+        r = self.client.post(url, dict(replaces=""))
         self.assertEqual(r.status_code, 302)
         self.assertEqual(Document.objects.get(name='draft-test-base-a').get_state().slug,'active')
 

ietf/doc/urls.py

@@ -49,7 +49,7 @@
 
     url(r'^all/$', views_search.index_all_drafts, name="index_all_drafts"),
     url(r'^active/$', views_search.index_active_drafts, name="index_active_drafts"),
-    url(r'^tokeninputsearch/(?P<model_name>(document|docalias))/(?P<doc_type>draft)/$', views_search.ajax_tokeninput_search_docs, name="ajax_tokeninput_search_docs"),
+    url(r'^select2search/(?P<model_name>(document|docalias))/(?P<doc_type>draft)/$', views_search.ajax_select2_search_docs, name="ajax_select2_search_docs"),
 
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/(?:(?P<rev>[0-9-]+)/)?$', views_doc.document_main, name="doc_view"),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/history/$', views_doc.document_history, name="doc_history"),

ietf/doc/views_draft.py

@@ -1,6 +1,6 @@
 # changing state and metadata on Internet Drafts
 
-import datetime, json
+import datetime
 
 from django import forms
 from django.http import HttpResponseRedirect, HttpResponseForbidden, Http404
@@ -24,13 +24,14 @@
     get_tags_for_stream_id, nice_consensus,
     update_reminder, update_telechat, make_notify_changed_event, get_initial_notify )
 from ietf.doc.lastcall import request_last_call
+from ietf.doc.fields import SearchableDocAliasesField
 from ietf.group.models import Group, Role
 from ietf.iesg.models import TelechatDate
 from ietf.ietfauth.utils import has_role, is_authorized_in_doc_stream, user_is_person
 from ietf.ietfauth.utils import role_required
 from ietf.message.models import Message
 from ietf.name.models import IntendedStdLevelName, DocTagName, StreamName
-from ietf.person.fields import AutocompletedEmailField
+from ietf.person.fields import SearchableEmailField
 from ietf.person.models import Person, Email
 from ietf.secr.lib.template import jsonapi
 from ietf.utils.mail import send_mail, send_mail_message
@@ -307,35 +308,21 @@ def collect_email_addresses(emails, doc):
     return emails
 
 class ReplacesForm(forms.Form):
-    replaces = forms.CharField(max_length=512,widget=forms.HiddenInput)
+    replaces = SearchableDocAliasesField(required=False)
     comment = forms.CharField(widget=forms.Textarea, required=False)
 
     def __init__(self, *args, **kwargs):
         self.doc = kwargs.pop('doc')
         super(ReplacesForm, self).__init__(*args, **kwargs)
-        drafts = {}
-        for d in self.doc.related_that_doc("replaces"):
-            drafts[d.id] = d.document.name
-        self.initial['replaces'] = json.dumps(drafts)
+        self.initial['replaces'] = self.doc.related_that_doc("replaces")
 
     def clean_replaces(self):
-        data = self.cleaned_data['replaces'].strip()
-        if data:
-            ids = [int(x) for x in json.loads(data)]
-        else:
-            return []
-        objects = []
-        for id in ids:
-            try:
-                d = DocAlias.objects.get(pk=id)
-            except DocAlias.DoesNotExist:
-                raise forms.ValidationError("ERROR: %s not found for id %d" % DocAlias._meta.verbos_name, id)
+        for d in self.cleaned_data['replaces']:
             if d.document == self.doc:
-                raise forms.ValidationError("ERROR: A draft can't replace itself")
+                raise forms.ValidationError("A draft can't replace itself")
             if d.document.type_id == "draft" and d.document.get_state_slug() == "rfc":
-                raise forms.ValidationError("ERROR: A draft can't replace an RFC")
-            objects.append(d)
-        return objects
+                raise forms.ValidationError("A draft can't replace an RFC")
+        return self.cleaned_data['replaces']
 
 def replaces(request, name):
     """Change 'replaces' set of a Document of type 'draft' , notifying parties 
@@ -942,7 +929,7 @@ def edit_shepherd_writeup(request, name):
                               context_instance=RequestContext(request))
 
 class ShepherdForm(forms.Form):
-    shepherd = AutocompletedEmailField(required=False, only_users=True)
+    shepherd = SearchableEmailField(required=False, only_users=True)
 
 def edit_shepherd(request, name):
     """Change the shepherd for a Document"""
@@ -968,7 +955,7 @@ def edit_shepherd(request, name):
                 c.desc = "Document shepherd changed to "+ (doc.shepherd.person.name if doc.shepherd else "(None)")
                 c.save()
 
-                if doc.shepherd.formatted_email() not in doc.notify:
+                if doc.shepherd and doc.shepherd.formatted_email() not in doc.notify:
                     login = request.user.person
                     addrs = doc.notify
                     if addrs:

ietf/doc/views_search.py

@@ -45,7 +45,7 @@
 from ietf.doc.models import ( Document, DocAlias, State, RelatedDocument, DocEvent,
     LastCallDocEvent, TelechatDocEvent, IESG_SUBSTATE_TAGS )
 from ietf.doc.expire import expirable_draft
-from ietf.doc.fields import tokeninput_id_doc_name_json
+from ietf.doc.fields import select2_id_doc_name_json
 from ietf.group.models import Group
 from ietf.idindex.index import active_drafts_index_by_group
 from ietf.ipr.models import IprDocAlias
@@ -629,7 +629,7 @@ def index_active_drafts(request):
 
     return render_to_response("doc/index_active_drafts.html", { 'groups': groups }, context_instance=RequestContext(request))
 
-def ajax_tokeninput_search_docs(request, model_name, doc_type):
+def ajax_select2_search_docs(request, model_name, doc_type):
     if model_name == "docalias":
         model = DocAlias
     else:
@@ -652,4 +652,4 @@ def ajax_tokeninput_search_docs(request, model_name, doc_type):
 
         objs = qs.distinct().order_by("name")[:20]
 
-    return HttpResponse(tokeninput_id_doc_name_json(objs), content_type='application/json')
+    return HttpResponse(select2_id_doc_name_json(objs), content_type='application/json')

ietf/group/edit.py

@@ -19,7 +19,7 @@
 from ietf.group.utils import save_group_in_history, can_manage_group_type
 from ietf.group.utils import get_group_or_404
 from ietf.ietfauth.utils import has_role
-from ietf.person.fields import AutocompletedEmailsField
+from ietf.person.fields import SearchableEmailsField
 from ietf.person.models import Person, Email
 from ietf.group.mails import email_iesg_secretary_re_charter
 
@@ -29,11 +29,11 @@ class GroupForm(forms.Form):
     name = forms.CharField(max_length=255, label="Name", required=True)
     acronym = forms.CharField(max_length=10, label="Acronym", required=True)
     state = forms.ModelChoiceField(GroupStateName.objects.all(), label="State", required=True)
-    chairs = AutocompletedEmailsField(label="Chairs", required=False, only_users=True)
-    secretaries = AutocompletedEmailsField(label="Secretarias", required=False, only_users=True)
-    techadv = AutocompletedEmailsField(label="Technical Advisors", required=False, only_users=True)
-    delegates = AutocompletedEmailsField(label="Delegates", required=False, only_users=True, max_entries=MAX_GROUP_DELEGATES,
-                                          help_text=mark_safe("Chairs can delegate the authority to update the state of group documents - at most %s persons at a given time." % MAX_GROUP_DELEGATES))
+    chairs = SearchableEmailsField(label="Chairs", required=False, only_users=True)
+    secretaries = SearchableEmailsField(label="Secretarias", required=False, only_users=True)
+    techadv = SearchableEmailsField(label="Technical Advisors", required=False, only_users=True)
+    delegates = SearchableEmailsField(label="Delegates", required=False, only_users=True, max_entries=MAX_GROUP_DELEGATES,
+                                      help_text=mark_safe("Chairs can delegate the authority to update the state of group documents - at most %s persons at a given time." % MAX_GROUP_DELEGATES))
     ad = forms.ModelChoiceField(Person.objects.filter(role__name="ad", role__group__state="active").order_by('name'), label="Shepherding AD", empty_label="(None)", required=False)
     parent = forms.ModelChoiceField(Group.objects.filter(state="active").order_by('name'), empty_label="(None)", required=False)
     list_email = forms.CharField(max_length=64, required=False)

ietf/group/info.py

@@ -303,7 +303,7 @@ def construct_group_menu_context(request, group, selected, group_type, others):
 
     if group.features.has_milestones:
         if group.state_id != "proposed" and (is_chair or can_manage):
-            actions.append((u"Add or edit milestones", urlreverse("group_edit_milestones", kwargs=kwargs)))
+            actions.append((u"Edit milestones", urlreverse("group_edit_milestones", kwargs=kwargs)))
 
     if group.features.has_materials and can_manage_materials(request.user, group):
         actions.append((u"Upload material", urlreverse("ietf.doc.views_material.choose_material_type", kwargs=kwargs)))