Add support for displaying and editing author affiliation and country

when submitting a draft, replace the Submission.authors line-based
text field with a JSON field
 - Legacy-Id: 12745

Author: OleLaursen

ietf/mailtrigger/models.py

@@ -177,7 +177,7 @@ def gather_submission_authors(self, **kwargs):
         addrs = []
         if 'submission' in kwargs:
             submission = kwargs['submission']
-            addrs.extend(["%s <%s>" % (author["name"], author["email"]) for author in submission.authors_parsed() if author["email"]]) 
+            addrs.extend(["%s <%s>" % (author["name"], author["email"]) for author in submission.authors if author.get("email")])
         return addrs
 
     def gather_submission_group_chairs(self, **kwargs):
@@ -200,7 +200,7 @@ def gather_submission_confirmers(self, **kwargs):
             doc=submission.existing_document()
             if doc:
                 old_authors = [author.formatted_email() for author in doc.documentauthor_set.all() if author.email]
-                new_authors = [u'"%s" <%s>' % (author["name"], author["email"]) for author in submission.authors_parsed() if author["email"]]
+                new_authors = [u'"%s" <%s>' % (author["name"], author["email"]) for author in submission.authors if author.get("email")]
                 addrs.extend(old_authors)
                 if doc.group and set(old_authors)!=set(new_authors):
                     if doc.group.type_id in ['wg','rg','ag']:
@@ -212,7 +212,7 @@ def gather_submission_confirmers(self, **kwargs):
                     if doc.stream_id and doc.stream_id not in ['ietf']:
                         addrs.extend(Recipient.objects.get(slug='stream_managers').gather(**{'streams':[doc.stream_id]}))
             else:
-                addrs.extend([u"%s <%s>" % (author["name"], author["email"]) for author in submission.authors_parsed() if author["email"]])
+                addrs.extend([u"%s <%s>" % (author["name"], author["email"]) for author in submission.authors if author.get("email")])
                 if submission.submitter_parsed()["email"]: 
                     addrs.append(submission.submitter)
         return addrs

ietf/secr/drafts/views.py

@@ -574,8 +574,6 @@ def authors(request, id):
 
             return redirect('drafts_view', id=id)
 
-        print form.is_valid(), form.errors
-
         if form.is_valid():
             person = form.cleaned_data['person']
             email = form.cleaned_data['email']

ietf/submit/forms.py

@@ -12,6 +12,8 @@
 from django.utils.html import mark_safe
 from django.core.urlresolvers import reverse as urlreverse
 
+from django_countries.fields import countries
+
 import debug                            # pyflakes:ignore
 
 from ietf.doc.models import Document
@@ -30,6 +32,14 @@
 from ietf.submit.parsers.xml_parser import XMLParser
 from ietf.utils.draft import Draft
 
+def clean_country(country):
+    country = country.upper()
+    for code, name in countries:
+        if country == code:
+            return code
+        if country == name.upper():
+            return code
+    return "" # unknown
 
 class SubmissionUploadForm(forms.Form):
     txt = forms.FileField(label=u'.txt format', required=False)
@@ -178,18 +188,14 @@ def clean(self):
                 self.abstract = self.xmlroot.findtext('front/abstract').strip()
                 if type(self.abstract) is unicode:
                     self.abstract = unidecode(self.abstract)
-                self.author_list = []
                 author_info = self.xmlroot.findall('front/author')
                 for author in author_info:
-                    author_dict = dict(
-                        company = author.findtext('organization'),
-                        last_name = author.attrib.get('surname'),
-                        full_name = author.attrib.get('fullname'),
-                        email = author.findtext('address/email'),
-                    )
-                    self.author_list.append(author_dict)
-                    line = "%(full_name)s <%(email)s>" % author_dict
-                    self.authors.append(line)
+                    self.authors.append({
+                        "name": author.attrib.get('fullname'),
+                        "email": author.findtext('address/email'),
+                        "affiliation": author.findtext('organization'),
+                        "country": clean_country(author.findtext('address/postal/country')),
+                    })
             except forms.ValidationError:
                 raise
             except Exception as e:
@@ -325,18 +331,12 @@ def deduce_group(self):
                 return None
 
 class NameEmailForm(forms.Form):
-    """For validating supplied submitter and author information."""
     name = forms.CharField(required=True)
-    email = forms.EmailField(label=u'Email address')
-
-    #Fields for secretariat only
-    approvals_received = forms.BooleanField(label=u'Approvals received', required=False, initial=False)
+    email = forms.EmailField(label=u'Email address', required=True)
 
     def __init__(self, *args, **kwargs):
-        email_required = kwargs.pop("email_required", True)
         super(NameEmailForm, self).__init__(*args, **kwargs)
 
-        self.fields["email"].required = email_required
         self.fields["name"].widget.attrs["class"] = "name"
         self.fields["email"].widget.attrs["class"] = "email"
 
@@ -346,6 +346,18 @@ def clean_name(self):
     def clean_email(self):
         return self.cleaned_data["email"].replace("\n", "").replace("\r", "").replace("<", "").replace(">", "").strip()
 
+class AuthorForm(NameEmailForm):
+    affiliation = forms.CharField(max_length=100, required=False)
+    country = forms.ChoiceField(choices=[('', "(Not specified)")] + list(countries), required=False)
+
+    def __init__(self, *args, **kwargs):
+        super(AuthorForm, self).__init__(*args, **kwargs)
+        self.fields["email"].required = False
+
+class SubmitterForm(NameEmailForm):
+    #Fields for secretariat only
+    approvals_received = forms.BooleanField(label=u'Approvals received', required=False, initial=False)
+
     def cleaned_line(self):
         line = self.cleaned_data["name"]
         email = self.cleaned_data.get("email")

ietf/submit/models.py

@@ -39,7 +39,7 @@ class Submission(models.Model):
     words = models.IntegerField(null=True, blank=True)
     formal_languages = models.ManyToManyField(FormalLanguageName, blank=True, help_text="Formal languages used in document")
 
-    authors = models.TextField(blank=True, help_text="List of author names and emails, one author per line, e.g. \"John Doe <john@example.org>\".")
+    authors = jsonfield.JSONField(default=list, help_text="List of authors with name, email, affiliation and country code.")
     note = models.TextField(blank=True)
     replaces = models.CharField(max_length=1000, blank=True)
 
@@ -56,21 +56,6 @@ class Submission(models.Model):
     def __unicode__(self):
         return u"%s-%s" % (self.name, self.rev)
 
-    def authors_parsed(self):
-        if not hasattr(self, '_cached_authors_parsed'):
-            from ietf.submit.utils import ensure_person_email_info_exists
-            res = []
-            for line in self.authors.replace("\r", "").split("\n"):
-                line = line.strip()
-                if line:
-                    parsed = parse_email_line(line)
-                    if not parsed["email"]:
-                        person, email = ensure_person_email_info_exists(**parsed)
-                        parsed["email"] = email.address
-                    res.append(parsed)
-            self._cached_authors_parsed = res
-        return self._cached_authors_parsed
-
     def submitter_parsed(self):
         return parse_email_line(self.submitter)
 

ietf/submit/tests.py

@@ -125,18 +125,20 @@ def do_submission(self, name, rev, group=None, formats=["txt",]):
             q = PyQuery(r.content)
             print(q('div.has-error div.alert').text())
 
-        self.assertEqual(r.status_code, 302)
+        self.assertNoFormPostErrors(r, ".has-error,.alert-danger")
 
         status_url = r["Location"]
         for format in formats:
             self.assertTrue(os.path.exists(os.path.join(self.staging_dir, u"%s-%s.%s" % (name, rev, format))))
         self.assertEqual(Submission.objects.filter(name=name).count(), 1)
         submission = Submission.objects.get(name=name)
         self.assertTrue(all([ c.passed!=False for c in submission.checks.all() ]))
-        self.assertEqual(len(submission.authors_parsed()), 1)
-        author = submission.authors_parsed()[0]
+        self.assertEqual(len(submission.authors), 1)
+        author = submission.authors[0]
         self.assertEqual(author["name"], "Author Name")
         self.assertEqual(author["email"], "author@example.com")
+        self.assertEqual(author["affiliation"], "Test Centre Inc.")
+        # FIXMEself.assertEqual(author["country"], "UK")
 
         return status_url
 
@@ -664,7 +666,7 @@ def test_edit_submission_and_force_post(self):
 
             "authors-prefix": ["authors-", "authors-0", "authors-1", "authors-2"],
         })
-        self.assertEqual(r.status_code, 302)
+        self.assertNoFormPostErrors(r, ".has-error,.alert-danger")
 
         submission = Submission.objects.get(name=name)
         self.assertEqual(submission.title, "some title")
@@ -676,14 +678,14 @@ def test_edit_submission_and_force_post(self):
         self.assertEqual(submission.replaces, draft.docalias_set.all().first().name)
         self.assertEqual(submission.state_id, "manual")
 
-        authors = submission.authors_parsed()
+        authors = submission.authors
         self.assertEqual(len(authors), 3)
         self.assertEqual(authors[0]["name"], "Person 1")
         self.assertEqual(authors[0]["email"], "person1@example.com")
         self.assertEqual(authors[1]["name"], "Person 2")
         self.assertEqual(authors[1]["email"], "person2@example.com")
         self.assertEqual(authors[2]["name"], "Person 3")
-        self.assertEqual(authors[2]["email"], "unknown-email-Person-3")
+        self.assertEqual(authors[2]["email"], "")
 
         self.assertEqual(len(outbox), mailbox_before + 1)
         self.assertTrue("Manual Post Requested" in outbox[-1]["Subject"])
@@ -939,7 +941,6 @@ def test_submit_nonascii_name(self):
         files = {"txt": submission_file(name, rev, group, "txt", "test_submission.nonascii", author=author) }
 
         r = self.client.post(url, files)
-
         self.assertEqual(r.status_code, 302)
         status_url = r["Location"]
         r = self.client.get(status_url)
@@ -1443,8 +1444,8 @@ def do_submission(self, name, rev, group=None, formats=["txt",]):
         self.assertEqual(Submission.objects.filter(name=name).count(), 1)
         submission = Submission.objects.get(name=name)
         self.assertTrue(all([ c.passed!=False for c in submission.checks.all() ]))
-        self.assertEqual(len(submission.authors_parsed()), 1)
-        author = submission.authors_parsed()[0]
+        self.assertEqual(len(submission.authors), 1)
+        author = submission.authors[0]
         self.assertEqual(author["name"], "Author Name")
         self.assertEqual(author["email"], "author@example.com")
 

ietf/submit/utils.py

@@ -42,7 +42,7 @@ def validate_submission(submission):
     if not submission.abstract:
         errors['abstract'] = 'Abstract is empty or was not found'
 
-    if not submission.authors_parsed():
+    if not submission.authors:
         errors['authors'] = 'No authors found'
 
     # revision
@@ -427,14 +427,16 @@ def ensure_person_email_info_exists(name, email):
 
 def update_authors(draft, submission):
     persons = []
-    for order, author in enumerate(submission.authors_parsed()):
-        person, email = ensure_person_email_info_exists(author["name"], author["email"])
+    for order, author in enumerate(submission.authors):
+        person, email = ensure_person_email_info_exists(author["name"], author.get("email"))
 
         a = DocumentAuthor.objects.filter(document=draft, person=person).first()
         if not a:
             a = DocumentAuthor(document=draft, person=person)
 
         a.email = email
+        a.affiliation = author.get("affiliation") or ""
+        a.country = author.get("country") or ""
         a.order = order
         a.save()