fix: return same bibxml for versioned and versionless references (ietf-tools#4470)

* fix: return same bibxml for versioned and versionless references

Fixes ietf-tools#4384.

Refactors bibxml production to remove repeated logic.

Abandons the half-implemented idea that returning information
from the Submission object might be better than the Document or
DocHistory objects.

* fix: test for None with `is not` and simplify choice from multiple qs objects

Addresses review comments.

Author: rjsparks

ietf/doc/management/commands/generate_draft_bibxml_files.py

@@ -10,11 +10,11 @@
 
 from django.conf import settings
 from django.core.management.base import BaseCommand
-from django.template.loader import render_to_string
 
 import debug                            # pyflakes:ignore
 
 from ietf.doc.models import NewRevisionDocEvent
+from ietf.doc.utils import bibxml_for_draft
 
 DEFAULT_DAYS = 7
 
@@ -76,21 +76,8 @@ def handle(self, *args, **options):
             self.mutter('%s %s' % (e.time, e.doc.name))
             try:
                 doc = e.doc
-                if e.rev != doc.rev:
-                    for h in doc.history_set.order_by("-time"):
-                        if e.rev == h.rev:
-                            doc = h
-                            break
-                doc.date = e.time.date()
-                ref_text = '%s' % render_to_string('doc/bibxml.xml', {'name':doc.name, 'doc': doc, 'doc_bibtype':'I-D'})
-                # if e.rev == e.doc.rev:
-                #     for name in (doc.name, doc.name[6:]):
-                #         ref_file_name = os.path.join(bibxmldir, 'reference.I-D.%s.xml' % (name, ))
-                #         self.write(ref_file_name, ref_text)
-                # for name in (doc.name, doc.name[6:]):
-                #     ref_rev_file_name = os.path.join(bibxmldir, 'reference.I-D.%s-%s.xml' % (name, doc.rev))
-                #     self.write(ref_rev_file_name, ref_text)
-                ref_rev_file_name = os.path.join(bibxmldir, 'reference.I-D.%s-%s.xml' % (doc.name, doc.rev))
-                self.write(ref_rev_file_name, ref_text)
+                bibxml = bibxml_for_draft(doc, e.rev)
+                ref_rev_file_name = os.path.join(bibxmldir, 'reference.I-D.%s-%s.xml' % (doc.name, e.rev))
+                self.write(ref_rev_file_name, bibxml)
             except Exception as ee:
                 sys.stderr.write('\n%s-%s: %s\n' % (doc.name, doc.rev, ee))

ietf/doc/utils.py

@@ -17,6 +17,7 @@
 from django.conf import settings
 from django.contrib import messages
 from django.forms import ValidationError
+from django.http import Http404
 from django.template.loader import render_to_string
 from django.utils.html import escape
 from django.urls import reverse as urlreverse
@@ -1317,3 +1318,33 @@ def fuzzy_find_documents(name, rev=None):
 
     FoundDocuments = namedtuple('FoundDocuments', 'documents matched_name matched_rev')
     return FoundDocuments(docs, name, rev)
+
+def bibxml_for_draft(doc, rev=None):
+
+    if rev is not None and rev != doc.rev:
+        # find the entry in the history
+        for h in doc.history_set.order_by("-time"):
+            if rev == h.rev:
+                doc = h
+                break
+    if rev and rev != doc.rev:
+        raise Http404("Revision not found")
+
+    # Build the date we want to claim for the document in the bibxml
+    # For documents that have relevent NewRevisionDocEvents, use the date of the event.
+    # Very old documents don't have NewRevisionDocEvents - just use the document time.
+        
+    latest_revision_event = doc.latest_event(NewRevisionDocEvent, type="new_revision")
+    latest_revision_rev = latest_revision_event.rev if latest_revision_event else None
+    best_events = NewRevisionDocEvent.objects.filter(doc__name=doc.name, rev=(rev or latest_revision_rev))
+    if best_events.exists():
+        # There was a period where it was possible to get more than one NewRevisionDocEvent for a revision.
+        # A future data cleanup would allow this to be simplified
+        best_event = best_events.order_by('time').first()
+        log.assertion('doc.rev == best_event.rev')
+        doc.date = best_event.time.date()
+    else:
+        doc.date = doc.time.date()      # Even if this may be incoreect, what would be better?
+
+    return render_to_string('doc/bibxml.xml', {'name':doc.name, 'doc': doc, 'doc_bibtype':'I-D'})
+

ietf/doc/views_doc.py

@@ -63,7 +63,8 @@
     get_initial_notify, make_notify_changed_event, make_rev_history, default_consensus,
     add_events_message_info, get_unicode_document_content, build_doc_meta_block,
     augment_docs_and_user_with_user_info, irsg_needed_ballot_positions, add_action_holder_change_event,
-    build_doc_supermeta_block, build_file_urls, update_documentauthors, fuzzy_find_documents)
+    build_doc_supermeta_block, build_file_urls, update_documentauthors, fuzzy_find_documents,
+    bibxml_for_draft)
 from ietf.doc.utils_bofreq import bofreq_editors, bofreq_responsible
 from ietf.group.models import Role, Group
 from ietf.group.utils import can_manage_all_groups_of_type, can_manage_materials, group_features_role_filter
@@ -1020,41 +1021,9 @@ def document_bibxml(request, name, rev=None):
             rev = None
 
     doc = get_object_or_404(Document, name=name, type_id='draft')
-
-    latest_revision = doc.latest_event(NewRevisionDocEvent, type="new_revision")
-    latest_rev = latest_revision.rev if latest_revision else None
-
-    if rev != None:
-        # find the entry in the history
-        for h in doc.history_set.order_by("-time"):
-            if rev == h.rev:
-                doc = h
-                break
-    if rev and rev != doc.rev:
-        raise Http404("Revision not found")
-
-    ### PATCH to deal with unexpected multiple NewRevisionDocEvent objects for the same revision on a document
-    doc_event_qs = NewRevisionDocEvent.objects.filter(doc__name=doc.name, rev=(rev or latest_rev))
-    if doc_event_qs.count():
-        doc_event = doc_event_qs.order_by('time').last()
-        doc.date = doc_event.time.date()
-    else:
-        doc.date = doc.time.date()      # Even if this may be incoreect, what would be better?
 
-#    try:
-#        doc_event = NewRevisionDocEvent.objects.get(doc__name=doc.name, rev=(rev or latest_rev))
-#        doc.date = doc_event.time.date()
-#    except DocEvent.DoesNotExist:
-#        doc.date = doc.time.date()      # Even if this may be incoreect, what would be better?
-
-    return render(request, "doc/bibxml.xml",
-                              dict(
-                                  name=name,
-                                  doc=doc,
-                                  doc_bibtype='I-D',
-                               ),
-                              content_type="application/xml; charset=utf-8",
-                          )
+    return HttpResponse(bibxml_for_draft(doc, rev), content_type="application/xml; charset=utf-8")
+
 
 
 def document_writeup(request, name):

ietf/submit/utils.py

@@ -20,7 +20,6 @@
 from django.db import transaction
 from django.http import HttpRequest     # pyflakes:ignore
 from django.utils.module_loading import import_string
-from django.template.loader import render_to_string
 from django.contrib.auth.models import AnonymousUser
 
 import debug                            # pyflakes:ignore
@@ -29,9 +28,10 @@
     DocumentAuthor, AddedMessageEvent )
 from ietf.doc.models import NewRevisionDocEvent
 from ietf.doc.models import RelatedDocument, DocRelationshipName, DocExtResource
-from ietf.doc.utils import add_state_change_event, rebuild_reference_relations
-from ietf.doc.utils import ( set_replaces_for_document, prettify_std_name,
-    update_doc_extresources, can_edit_docextresources, update_documentauthors, update_action_holders )
+from ietf.doc.utils import (add_state_change_event, rebuild_reference_relations,
+    set_replaces_for_document, prettify_std_name, update_doc_extresources, 
+    can_edit_docextresources, update_documentauthors, update_action_holders,
+    bibxml_for_draft )
 from ietf.doc.mails import send_review_possibly_replaces_request, send_external_resource_change_request
 from ietf.group.models import Group
 from ietf.ietfauth.utils import has_role
@@ -485,14 +485,7 @@ def post_submission(request, submission, approved_doc_desc, approved_subm_desc):
     create_submission_event(request, submission, approved_subm_desc)
 
     # Create bibxml-ids entry
-    ref_text = '%s' % render_to_string('doc/bibxml.xml', {'name':draft.name, 'doc': draft, 'doc_bibtype':'I-D'})
-    # for name in (draft.name, draft.name[6:]):
-    #     ref_file_name = os.path.join(os.path.join(settings.BIBXML_BASE_PATH, 'bibxml-ids'), 'reference.I-D.%s.xml' % (name, ))
-    #     with io.open(ref_file_name, "w", encoding='utf-8') as f:
-    #         f.write(ref_text)
-    #     ref_rev_file_name = os.path.join(os.path.join(settings.BIBXML_BASE_PATH, 'bibxml-ids'), 'reference.I-D.%s-%s.xml' % (name, draft.rev ))
-    #     with io.open(ref_rev_file_name, "w", encoding='utf-8') as f:
-    #         f.write(ref_text)
+    ref_text = bibxml_for_draft(draft, draft.rev)
     ref_rev_file_name = os.path.join(os.path.join(settings.BIBXML_BASE_PATH, 'bibxml-ids'), 'reference.I-D.%s-%s.xml' % (draft.name, draft.rev ))
     with io.open(ref_rev_file_name, "w", encoding='utf-8') as f:
         f.write(ref_text)

ietf/templates/doc/bibxml.xml

@@ -1,13 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <reference anchor="{{doc_bibtype}}.{{name|slice:"6:"}}">
    <front>
-      <title>{{doc.title}}</title>{% if doc.submission %}{% for author in doc.submission.authors %}
-      <author fullname="{{ author.name }}">
-	 {% if author.affiliation %}<organization>{{ author.affiliation }}</organization>
-      {% endif %}</author>{% endfor %}{% else %}{% for author in doc.documentauthor_set.all %}
+      <title>{{doc.title}}</title>{% for author in doc.documentauthor_set.all %}
       <author initials="{{ author.person.initials }}" surname="{{ author.person.last_name }}" fullname="{{ author.person.name }}">
          {% if author.affiliation %}<organization>{{ author.affiliation }}</organization>
-      {% endif %}</author>{% endfor %}{% endif %}
+      {% endif %}</author>{% endfor %}
       <date month="{{doc.date|date:"F"}}" day="{{doc.date.day}}" year="{{doc.date.year}}" />
       <abstract>
 	 <t>{{doc.abstract}}