Visualize the revision timeline of drafts, chartes, status changes and conflict

reviews using a Google Chart Timeline.
 - Legacy-Id: 9920

Author: larseggert

ietf/doc/utils.py

@@ -3,6 +3,7 @@
 import urllib
 import math
 import datetime
+import operator
 
 from django.conf import settings
 from django.db.models import Q
@@ -590,3 +591,26 @@ def uppercase_std_abbreviated_name(name):
         return name.upper()
     else:
         return name
+
+
+def crawl_history(doc):
+    # return document history data for use in ietf/templates/doc/timeline.html
+    def ancestors(doc):
+        retval = []
+        for rel in doc.relateddocument_set.filter(relationship__slug='replaces'):
+            if not rel.target.document in retval:
+                retval.append(rel.target.document)
+                retval.extend(ancestors(rel.target.document))
+        return retval
+
+    history = ancestors(doc)
+    history.append(doc)
+
+    retval = []
+    for d in history:
+        for e in d.docevent_set.filter(type='new_revision'):
+            retval.append((d.name, e.newrevisiondocevent.rev, e.time.isoformat()))
+    e = doc.latest_event(type='published_rfc')
+    if e:
+        retval.append((doc.name, e.doc.canonical_name, e.time.isoformat()))
+    return sorted(retval, key=operator.itemgetter(2))

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.doc.mails import email_ad
 from ietf.group.models import Role
@@ -414,6 +414,7 @@ def document_main(request, name, rev=None):
                                        search_archive=search_archive,
                                        actions=actions,
                                        tracking_document=tracking_document,
+                                       rev_history=crawl_history(doc),
                                        ),
                                   context_instance=RequestContext(request))
 
@@ -453,6 +454,7 @@ def document_main(request, name, rev=None):
                                        group=group,
                                        milestones=milestones,
                                        can_manage=can_manage,
+                                       rev_history=crawl_history(doc),
                                        ),
                                   context_instance=RequestContext(request))
 
@@ -481,6 +483,7 @@ def document_main(request, name, rev=None):
                                        conflictdoc=conflictdoc,
                                        ballot_summary=ballot_summary,
                                        approved_states=('appr-reqnopub-pend','appr-reqnopub-sent','appr-noprob-pend','appr-noprob-sent'),
+                                       rev_history=crawl_history(doc),
                                        ),
                                   context_instance=RequestContext(request))
 
@@ -516,6 +519,7 @@ def document_main(request, name, rev=None):
                                        ballot_summary=ballot_summary,
                                        approved_states=('appr-pend','appr-sent'),
                                        sorted_relations=sorted_relations,
+                                       rev_history=crawl_history(doc),
                                        ),
                                   context_instance=RequestContext(request))
 

ietf/templates/doc/document_charter.html

@@ -8,13 +8,20 @@
   <link rel="alternate" type="application/atom+xml" href="/feed/group-changes/{{ group.acronym }}/">
 {% endblock %}
 
+{% block js %}
+$(window).on("resize", function (event) {
+    draw_timeline();
+});
+{% endblock %}
+
 {% block title %}{{ doc.title }}{% endblock %}
 
 {% block content %}
   {% origin %}
   {{ top|safe }}
 
   {% include "doc/revisions_list.html" %}
+  {% include "doc/timeline.html" %}
 
   <table class="table table-condensed">
     <thead id="message-row">

ietf/templates/doc/document_conflict_review.html

@@ -4,13 +4,20 @@
 
 {% load ietf_filters %}
 
+{% block js %}
+$(window).on("resize", function (event) {
+    draw_timeline();
+});
+{% endblock %}
+
 {% block title %}{{ doc.title }}{% endblock %}
 
 {% block content %}
   {% origin %}
   {{ top|safe }}
 
   {% include "doc/revisions_list.html" %}
+  {% include "doc/timeline.html" %}
 
   <table class="table table-condensed">
     <thead id="message-row">

ietf/templates/doc/document_draft.html

@@ -13,6 +13,12 @@
   .inline	{ display: inline; }
 {% endblock %}
 
+{% block js %}
+$(window).on("resize", function (event) {
+    draw_timeline();
+});
+{% endblock %}
+
 {% block title %}
   {% if doc.get_state_slug == "rfc" %}
     RFC {{ rfc_number }}
@@ -26,6 +32,7 @@
   {{ top|safe }}
 
   {% include "doc/revisions_list.html" %}
+  {% include "doc/timeline.html" %}
 
   <table class="table table-condensed">
     <thead id="message-row">

ietf/templates/doc/document_status_change.html

@@ -4,13 +4,20 @@
 
 {% load ietf_filters %}
 
+{% block js %}
+$(window).on("resize", function (event) {
+    draw_timeline();
+});
+{% endblock %}
+
 {% block title %}{{ doc.title }}{% endblock %}
 
 {% block content %}
   {% origin %}
   {{ top|safe }}
 
   {% include "doc/revisions_list.html" %}
+  {% include "doc/timeline.html" %}
 
   <table class="table table-condensed">
     <thead id="message-row">

ietf/templates/doc/timeline.html

@@ -0,0 +1,46 @@
+<script type="text/javascript" src="https://www.google.com/jsapi?autoload={'modules':[{'name':'visualization', 'version':'1','packages':['timeline']}]}"></script>
+
+<script>
+google.setOnLoadCallback(draw_timeline);
+
+function draw_timeline() {
+  var data = [
+    {% for r in rev_history %}
+      [ '{{r.0}}', '{{r.1}}', new Date('{{ r.2 }}') ],
+    {% endfor %}
+  ];
+
+  if (data[0]) {
+    var t = $('#timeline')[0];
+    var c = new google.visualization.Timeline(t);
+    var d = new google.visualization.DataTable();
+
+    d.addColumn({ type: 'string', id: 'Name' });
+    d.addColumn({ type: 'string', id: 'Revision' });
+    d.addColumn({ type: 'date', id: 'Start' });
+    d.addColumn({ type: 'date', id: 'End' });
+
+    for (i = 0; i < data.length-1; i++) { 
+      d.addRow([ data[0][0], data[i][0] + "-" + data[i][1], data[i][2], data[i+1][2] ]);
+    }
+    if (!data[i][1].match(/rfc/)) {
+      d.addRow([ data[0][0], data[i][0] + "-" + data[i][1], data[i][2], new Date() ]);
+    }
+
+    var options = {
+      tooltip: {  isHtml: true, },
+      timeline: { showRowLabels: false,
+          rowLabelStyle: { fontName: "PT Serif", fontSize: 13 },
+                  barLabelStyle: { fontName: "PT Serif", fontSize: 13 }
+          },
+      hAxis: {  
+          textStyle: { fontName: "PT Serif", fontSize: 13 },
+    }
+    };
+    $('#timeline').css('height', '100');
+    c.draw(d, options);
+  }
+}
+</script>
+
+<div id="timeline"></div>