Merged in /personal/lars/6.11.1.dev0@10590 from lars@netapp.com, which brings in a timeline view at the top of document pages.

 - Legacy-Id: 10597

Author: levkowetz

.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+    rules: {
+        indent: [2, 4],
+        camelcase: 0,
+        "require-jsdoc": 0,
+        quotes: [2, "double"],
+        "no-multiple-empty-lines": [2, {max: 2}],
+        "quote-props": [2, "as-needed"],
+        "brace-style": [2, "1tbs", {allowSingleLine: true}]
+    },
+    env: {
+        browser: true,
+        jquery: true
+    },
+    globals: {
+        d3: true
+    },
+    extends: "google"
+};

ietf/bower.json

@@ -5,6 +5,7 @@
   "main": [],
   "dependencies": {
     "bootstrap-datepicker": "1.5.0",
+    "d3": "3.5.10",
     "font-awesome": "4.5.0",
     "html5shiv": "3.7.3",
     "jquery": "1.11.3",

ietf/doc/urls.py

@@ -65,7 +65,7 @@
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/ballot/(?P<ballot_id>[0-9]+)/emailposition/$', views_ballot.send_ballot_comment, name='doc_send_ballot_comment'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/ballot/(?P<ballot_id>[0-9]+)/$', views_doc.document_ballot, name="doc_ballot"),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/ballot/$', views_doc.document_ballot, name="doc_ballot"),
-    (r'^(?P<name>[A-Za-z0-9._+-]+)/doc.json$', views_doc.document_json),
+    (r'^(?P<name>[A-Za-z0-9._+-]+)/(?:(?P<rev>[0-9-]+)/)?doc.json$', views_doc.document_json),
     (r'^(?P<name>[A-Za-z0-9._+-]+)/ballotpopup/(?P<ballot_id>[0-9]+)/$', views_doc.ballot_popup),
 
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/email-aliases/$', RedirectView.as_view(pattern_name='doc_email', permanent=False),name='doc_specific_email_aliases'),

ietf/doc/utils.py

@@ -8,6 +8,7 @@
 from django.db.models.query import EmptyQuerySet
 from django.forms import ValidationError
 from django.utils.html import strip_tags, escape
+from django.core.urlresolvers import reverse as urlreverse
 
 from ietf.doc.models import Document, DocHistory, State
 from ietf.doc.models import DocAlias, RelatedDocument, BallotType, DocReminder
@@ -27,7 +28,7 @@ def email_update_telechat(request, doc, text):
 
     if not to:
         return
-    
+
     text = strip_tags(text)
     send_mail(request, to, None,
               "Telechat update notice: %s" % doc.file_tag(),
@@ -41,7 +42,7 @@ def get_state_types(doc):
 
     if not doc:
         return res
-    
+
     res.append(doc.type_id)
 
     if doc.type_id == "draft":
@@ -52,7 +53,7 @@ def get_state_types(doc):
         res.append("draft-iana-review")
         res.append("draft-iana-action")
         res.append("draft-rfceditor")
-        
+
     return res
 
 def get_tags_for_stream_id(stream_id):
@@ -144,7 +145,7 @@ def needed_ballot_positions(doc, active_positions):
             answer.append("Has enough positions to pass.")
 
     return " ".join(answer)
-    
+
 def create_ballot_if_not_open(doc, by, ballot_slug, time=None):
     if not doc.ballot_open(ballot_slug):
         if time:
@@ -359,7 +360,7 @@ def make_notify_changed_event(request, doc, by, new_notify, time=None):
 
 def update_telechat(request, doc, by, new_telechat_date, new_returning_item=None):
     from ietf.doc.models import TelechatDocEvent
-    
+
     on_agenda = bool(new_telechat_date)
 
     prev = doc.latest_event(TelechatDocEvent, type="scheduled_for_telechat")
@@ -378,7 +379,7 @@ def update_telechat(request, doc, by, new_telechat_date, new_returning_item=None
 
     # auto-set returning item _ONLY_ if the caller did not provide a value
     if (     new_returning_item != None
-         and on_agenda 
+         and on_agenda
          and prev_agenda
          and new_telechat_date != prev_telechat
          and prev_telechat < datetime.date.today()
@@ -392,7 +393,7 @@ def update_telechat(request, doc, by, new_telechat_date, new_returning_item=None
     e.doc = doc
     e.returning_item = returning
     e.telechat_date = new_telechat_date
-    
+
     if on_agenda != prev_agenda:
         if on_agenda:
             e.desc = "Placed on agenda for telechat - %s" % (new_telechat_date)
@@ -426,7 +427,7 @@ def rebuild_reference_relations(doc,filename=None):
        refs = draft.Draft(draft._gettext(filename), filename).get_refs()
     except IOError as e:
        return { 'errors': ["%s :%s" %  (e.strerror, filename)] }
-    
+
     doc.relateddocument_set.filter(relationship__slug__in=['refnorm','refinfo','refold','refunk']).delete()
 
     warnings = []
@@ -449,11 +450,11 @@ def rebuild_reference_relations(doc,filename=None):
 
     ret = {}
     if errors:
-        ret['errors']=errors 
+        ret['errors']=errors
     if warnings:
-        ret['warnings']=warnings 
+        ret['warnings']=warnings
     if unfound:
-        ret['unfound']=list(unfound) 
+        ret['unfound']=list(unfound)
 
     return ret
 
@@ -539,3 +540,41 @@ def uppercase_std_abbreviated_name(name):
         return name.upper()
     else:
         return name
+
+def crawl_history(doc):
+    # return document history data for inclusion in doc.json (used by timeline)
+    def ancestors(doc):
+        retval = []
+        if hasattr(doc, 'relateddocument_set'):
+            for rel in doc.relateddocument_set.filter(relationship__slug='replaces'):
+                if rel.target.document not in retval:
+                    retval.append(rel.target.document)
+                    retval.extend(ancestors(rel.target.document))
+            return retval
+
+    retval = []
+    history = ancestors(doc)
+    if history is not None:
+        history.append(doc)
+        for d in history:
+            for e in d.docevent_set.filter(type='new_revision'):
+                if hasattr(e, 'newrevisiondocevent'):
+                    retval.append({
+                        'name': d.name,
+                        'rev': e.newrevisiondocevent.rev,
+                        'published': e.time.isoformat(),
+                        'url': urlreverse("doc_view", kwargs=dict(name=d)) + e.newrevisiondocevent.rev + "/"
+                    })
+
+    if doc.type_id == "draft":
+        e = doc.latest_event(type='published_rfc')
+    else:
+        e = doc.latest_event(type='iesg_approved')
+    if e:
+        retval.append({
+            'name': e.doc.canonical_name(),
+            'rev': e.doc.canonical_name(),
+            'published': e.time.isoformat(),
+            'url': urlreverse("doc_view", kwargs=dict(name=e.doc))
+        })
+    return sorted(retval, key=lambda x: x['published'])

ietf/doc/views_doc.py

@@ -49,7 +49,7 @@
 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, update_telechat, has_same_ballot,
-    get_initial_notify, make_notify_changed_event )
+    get_initial_notify, make_notify_changed_event, crawl_history)
 from ietf.community.models import CommunityList
 from ietf.group.models import Role
 from ietf.group.utils import can_manage_group_type, can_manage_materials
@@ -878,7 +878,7 @@ def ballot_popup(request, name, ballot_id):
                               context_instance=RequestContext(request))
 
 
-def document_json(request, name):
+def document_json(request, name, rev=None):
     doc = get_object_or_404(Document, docalias__name=name)
 
     def extract_name(s):
@@ -911,6 +911,9 @@ def extract_name(s):
     data["shepherd"] = doc.shepherd.formatted_email() if doc.shepherd else None
     data["ad"] = doc.ad.role_email("ad").formatted_email() if doc.ad else None
 
+    latest_revision = doc.latest_event(NewRevisionDocEvent, type="new_revision")
+    data["rev_history"] = crawl_history(latest_revision.doc if latest_revision else doc)
+
     if doc.type_id == "draft":
         data["iesg_state"] = extract_name(doc.get_state("draft-iesg"))
         data["rfceditor_state"] = extract_name(doc.get_state("draft-rfceditor"))
@@ -922,7 +925,7 @@ def extract_name(s):
             data["consensus"] = e.consensus if e else None
         data["stream"] = extract_name(doc.stream)
 
-    return HttpResponse(json.dumps(data, indent=2), content_type='text/plain')
+    return HttpResponse(json.dumps(data, indent=2), content_type='application/json')
 
 class AddCommentForm(forms.Form):
     comment = forms.CharField(required=True, widget=forms.Textarea)

ietf/externals/static/d3/d3.min.js

@@ -431,3 +431,32 @@ h1 small .pull-right { margin-top: 10.5px; }
 */
 form.navbar-form input.form-control.input-sm { width: 141px; }
 
+
+
+/* Styles for d3.js graphical SVG timelines */
+#timeline { font-size: small; }
+
+#timeline .axis path, #timeline .axis line {
+    fill: none;
+    stroke: black;
+}
+
+#timeline .axis.y path, #timeline .axis.y line { stroke: none; }
+
+#timeline .axis.x text { dominant-baseline: central; }
+
+#timeline .bar text {
+    fill: white;
+    dominant-baseline: central;
+    pointer-events: none;
+}
+
+/* like label-success */
+#timeline .bar:nth-child(odd) rect { fill: #5CB85C; }
+
+/* like label-primary */
+#timeline .bar:nth-child(even) rect { fill: #337AB7; }
+
+/* like label-warning */
+#timeline .gradient.left { stop-color: #F0AD4E; }
+#timeline .gradient.right { stop-color: white; }