datatracker/ietf/ipr/fields.py

157 lines
6.3 KiB
Python

import json
from django.utils.html import escape
from django import forms
from django.core.urlresolvers import reverse as urlreverse
import debug # pyflakes:ignore
from ietf.doc.models import DocAlias
from ietf.ipr.models import IprDisclosureBase
def tokeninput_id_name_json(objs):
"""Returns objects as JSON string.
NOTE: double quotes in the object name are replaced with single quotes to avoid
problems with representation of the JSON string in the HTML widget attribute"""
def format_ipr(x):
text = x.title.replace('"',"'")
return escape(u"%s <%s>" % (text, x.time.date().isoformat()))
def format_doc(x):
return escape(x.name)
formatter = format_ipr if objs and isinstance(objs[0], IprDisclosureBase) else format_doc
return json.dumps([{ "id": o.pk, "name": formatter(o) } for o in objs])
class AutocompletedIprDisclosuresField(forms.CharField):
"""Tokenizing autocompleted multi-select field for choosing
IPR disclosures using jquery.tokeninput.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."""
def __init__(self,
max_entries=None, # max number of selected objs
model=IprDisclosureBase,
hint_text="Type in term(s) to search disclosure title",
*args, **kwargs):
kwargs["max_length"] = 1000
self.max_entries = max_entries
self.model = model
super(AutocompletedIprDisclosuresField, self).__init__(*args, **kwargs)
self.widget.attrs["class"] = "tokenized-field"
self.widget.attrs["data-hint-text"] = hint_text
if self.max_entries != None:
self.widget.attrs["data-max-entries"] = self.max_entries
def parse_tokenized_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)
if isinstance(value, self.model):
value = [value]
self.widget.attrs["data-pre"] = tokeninput_id_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("ipr_ajax_search")
return ",".join(str(e.pk) for e in value)
def clean(self, value):
value = super(AutocompletedIprDisclosuresField, self).clean(value)
pks = self.parse_tokenized_value(value)
objs = self.model.objects.filter(pk__in=pks)
found_pks = [str(o.pk) for o in objs]
failed_pks = [x for x in pks if x not in found_pks]
if failed_pks:
raise forms.ValidationError(u"Could not recognize the following {model_name}s: {pks}. You can only input {model_name}s already registered in the Datatracker.".format(pks=", ".join(failed_pks), model_name=self.model.__name__.lower()))
if self.max_entries != None and len(objs) > self.max_entries:
raise forms.ValidationError(u"You can select at most %s entries only." % self.max_entries)
return objs
class AutocompletedDraftsField(AutocompletedIprDisclosuresField):
"""Version of AutocompletedPersonsField with the defaults right for Drafts."""
def __init__(self, model=DocAlias, hint_text="Type in name to search draft name",
*args, **kwargs):
super(AutocompletedDraftsField, self).__init__(model=model, hint_text=hint_text, *args, **kwargs)
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)
if isinstance(value, self.model):
value = [value]
if isinstance(value, long):
value = self.model.objects.filter(pk=value)
self.widget.attrs["data-pre"] = tokeninput_id_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("ipr_ajax_draft_search")
return ",".join(str(e.pk) for e in value)
class AutocompletedDraftField(AutocompletedDraftsField):
"""Version of AutocompletedEmailsField specialized to a single object."""
def __init__(self, *args, **kwargs):
kwargs["max_entries"] = 1
super(AutocompletedDraftField, self).__init__(*args, **kwargs)
def clean(self, value):
return super(AutocompletedDraftField, self).clean(value).first()
class AutocompletedRfcsField(AutocompletedIprDisclosuresField):
"""Version of AutocompletedPersonsField with the defaults right for Drafts."""
def __init__(self, model=DocAlias, hint_text="Type in the RFC number",
*args, **kwargs):
super(AutocompletedRfcsField, self).__init__(model=model, hint_text=hint_text, *args, **kwargs)
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)
if isinstance(value, self.model):
value = [value]
if isinstance(value, long):
value = self.model.objects.filter(pk=value)
self.widget.attrs["data-pre"] = tokeninput_id_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("ipr_ajax_rfc_search")
return ",".join(str(e.pk) for e in value)
class AutocompletedRfcField(AutocompletedRfcsField):
"""Version of AutocompletedEmailsField specialized to a single object."""
def __init__(self, *args, **kwargs):
kwargs["max_entries"] = 1
super(AutocompletedRfcField, self).__init__(*args, **kwargs)
def clean(self, value):
return super(AutocompletedRfcField, self).clean(value).first()