Added some basic charting support, using highcharts, and charts showing new-revision timelines for document search results.

 - Legacy-Id: 11927

Author: levkowetz

debug.py

@@ -36,7 +36,7 @@
 # Number of times to indent output
 # A list is used to force access by reference
 _report_indent = [4]
-_mark = [ timeutils.clock() ]
+_mark = [ timeutils.time() ]
 
 def set_indent(i):
     _report_indent[0] = i
@@ -82,27 +82,29 @@ def wrap(fn, *params,**kwargs):
         return fn
 
 def mark():
-    _mark[0] = timeutils.clock()
+    _mark[0] = timeutils.time()
 
 def lap(s):
-    tau = timeutils.clock() - _mark[0]
-    say(">  %s: %.3fs since mark" % (s, tau))
+    clk = timeutils.time()
+    tau = clk - _mark[0]
+    ts = timeutils.strftime("%H:%M:%S", timeutils.localtime(clk))
+    say("%s: %.3fs since mark: %s" % (ts, tau, s))
 
 def clock(s):
     lap(s)
-    _mark[0] = timeutils.clock()
+    _mark[0] = timeutils.time()
 
 def time(fn):
     """Decorator to print timing information about a function call.
     """
     def wrap(fn, *params,**kwargs):
-        mark = timeutils.clock()
+        mark = timeutils.time()
 
         indent = ' ' * _report_indent[0]
         fc = "%s.%s()" % (fn.__module__, fn.__name__,)
 
         ret = fn(*params,**kwargs)
-        tau = timeutils.clock() - mark
+        tau = timeutils.time() - mark
         sys.stderr.write("%s| %s | %.3fs\n" % (indent, fc, tau))
 
         return ret
@@ -160,6 +162,7 @@ def say(s):
     if debug:
         indent = ' ' * (_report_indent[0])
         sys.stderr.write("%s%s\n" % (indent, s))
+        sys.stderr.flush()
 
 def profile(fn):
     def wrapper(*args, **kwargs):

ietf/bower.json

@@ -8,6 +8,7 @@
     "d3": "~3",
     "font-awesome": "~4",
     "html5shiv": "~3",
+    "highcharts": "~4.2", 
     "jquery": "~1",
     "jquery.cookie": "~1",
     "jquery.tablesorter": "~2",
@@ -31,6 +32,16 @@
     },
     "respond": {
       "main": "dest/respond.min.js"
+    },
+    "highcharts": {
+	"main": [
+	  "highcharts.js",
+	  "highcharts-more.js",
+	  "highstock.js",
+	  "highmaps.js",
+	  "modules/exporting.js",
+	  "modules/map.js"
+	]
     }
   }
 }

ietf/doc/models.py

@@ -415,6 +415,8 @@ def latest_event(self, *args, **filter_args):
 
     def canonical_name(self):
         from ietf.doc.utils_charter import charter_name_for_group # Imported locally to avoid circular imports
+        if hasattr(self, '_canonical_name'):
+            return self._canonical_name
         name = self.name
         if self.type_id == "draft" and self.get_state_slug() == "rfc":
             a = self.docalias_set.filter(name__startswith="rfc")
@@ -459,6 +461,8 @@ def save(self, *args, **kwargs):
         super(Document, self).save(*args, **kwargs)
 
     def telechat_date(self, e=None):
+        if hasattr(self, '_telechat_date'):
+            return self._telechat_date
         if not e:
             e = self.latest_event(TelechatDocEvent, type="scheduled_for_telechat")
         return e.telechat_date if e and e.telechat_date and e.telechat_date >= datetime.date.today() else None
@@ -574,6 +578,8 @@ def __unicode__(self):
         return unicode(self.doc.name)
 
     def canonical_name(self):
+        if hasattr(self, '_canonical_name'):
+            return self._canonical_name
         return self.name
 
     def latest_event(self, *args, **kwargs):

ietf/doc/tests.py

@@ -15,6 +15,8 @@
 from django.core.urlresolvers import reverse as urlreverse
 from django.conf import settings
 
+from tastypie.test import ResourceTestCaseMixin
+
 import debug                            # pyflakes:ignore
 
 from ietf.doc.models import ( Document, DocAlias, DocRelationshipName, RelatedDocument, State,
@@ -1097,3 +1099,35 @@ def test_add_document_session(self):
         response = self.client.post(url,{'session':self.future.pk,'version':'current'})
         self.assertEqual(response.status_code,302)
         self.assertEqual(2,doc.docevent_set.count())
+
+
+class ChartTests(ResourceTestCaseMixin, TestCase):
+    def test_stats(self):
+        doc = DocumentFactory.create(states=[('draft','active')])
+
+        data_url = urlreverse("ietf.doc.views_stats.chart_data_newrevisiondocevent")
+
+        # No qurey arguments; expect an empty json object
+        r = self.client.get(data_url)
+        self.assertValidJSONResponse(r)
+        self.assertEqual(r.content, "{}")
+
+        # No match
+        r = self.client.get(data_url + "?activedrafts=on&name=thisisnotadocumentname")
+        self.assertValidJSONResponse(r)
+        d = json.loads(r.content)
+        self.assertEqual(d['series'][0]['data'], [])
+
+        r = self.client.get(data_url + "?activedrafts=on&name=%s"%doc.name[6:12])
+        self.assertValidJSONResponse(r)
+        d = json.loads(r.content)
+        self.assertEqual(len(d['series'][0]['data']), 1)
+
+        chart_url = urlreverse("ietf.doc.views_stats.chart_newrevisiondocevent")
+        r = self.client.get(chart_url)
+        self.assertEqual(r.status_code, 200)
+
+        r = self.client.get(chart_url + "?activedrafts=on&name=%s"%doc.name[6:12])
+        self.assertEqual(r.status_code, 200)
+        
+        

ietf/doc/urls.py

@@ -34,9 +34,7 @@
 from django.views.generic import RedirectView
 from django.conf import settings
 
-from ietf.doc import views_search, views_draft, views_ballot
-from ietf.doc import views_status_change
-from ietf.doc import views_doc
+from ietf.doc import views_search, views_draft, views_ballot, views_status_change, views_doc, views_stats
 
 session_patterns = [
     url(r'^add$', views_doc.add_sessionpresentation),
@@ -55,6 +53,8 @@
     url(r'^start-rfc-status-change/(?:%(name)s/)?$' % settings.URL_REGEXPS, views_status_change.start_rfc_status_change, name='start_rfc_status_change'),
     url(r'^iesg/(?P<last_call_only>[A-Za-z0-9.-]+/)?$', views_search.drafts_in_iesg_process, name="drafts_in_iesg_process"),
     url(r'^email-aliases/$', views_doc.email_aliases),
+    url(r'^stats/newrevisiondocevent/?$', views_stats.chart_newrevisiondocevent),
+    url(r'^stats/data/newrevisiondocevent/?$', views_stats.chart_data_newrevisiondocevent),
 
     url(r'^all/$', views_search.index_all_drafts, name="index_all_drafts"),
     url(r'^active/$', views_search.index_active_drafts, name="index_active_drafts"),

ietf/doc/utils.py

@@ -3,6 +3,8 @@
 import urllib
 import math
 import datetime
+import hashlib
+import json
 
 from django.conf import settings
 from django.db.models.query import EmptyQuerySet
@@ -631,3 +633,12 @@ def get_ancestors(doc):
             history[url]['pages'] = doc.history_set.filter(rev=e.newrevisiondocevent.rev).first().pages
     history = history.values()
     return sorted(history, key=lambda x: x['published'])
+
+
+def get_search_cache_key(params):
+    from ietf.doc.views_search import SearchForm
+    fields = set(SearchForm.base_fields) - set(['sort',])
+    kwargs = dict([ (k,v) for (k,v) in params.items() if k in fields ])
+    key = "doc:document:search:" + hashlib.sha512(json.dumps(kwargs, sort_keys=True)).hexdigest()
+    return key
+    

ietf/doc/views_search.py

@@ -30,14 +30,15 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import datetime, re
+import re
+import datetime
 
 from django import forms
 from django.conf import settings
 from django.core.cache import cache
 from django.core.urlresolvers import reverse as urlreverse
 from django.db.models import Q
-from django.http import Http404, HttpResponseBadRequest, HttpResponse, HttpResponseRedirect
+from django.http import Http404, HttpResponseBadRequest, HttpResponse, HttpResponseRedirect, QueryDict
 from django.shortcuts import render
 from django.utils.cache import _generate_cache_key
 
@@ -46,6 +47,7 @@
 from ietf.doc.models import ( Document, DocHistory, DocAlias, State,
     LastCallDocEvent, IESG_SUBSTATE_TAGS )
 from ietf.doc.fields import select2_id_doc_name_json
+from ietf.doc.utils import get_search_cache_key
 from ietf.group.models import Group
 from ietf.idindex.index import active_drafts_index_by_group
 from ietf.name.models import DocTagName, DocTypeName, StreamName
@@ -164,7 +166,7 @@ def retrieve_search_results(form, all_types=False):
     # radio choices
     by = query["by"]
     if by == "author":
-        docs = docs.filter(authors__person__name__icontains=query["author"])
+        docs = docs.filter(authors__person__alias__name__icontains=query["author"])
     elif by == "group":
         docs = docs.filter(group__acronym=query["group"])
     elif by == "area":
@@ -197,16 +199,22 @@ def search(request):
         if not form.is_valid():
             return HttpResponseBadRequest("form not valid: %s" % form.errors)
 
-        results = retrieve_search_results(form)
+        key = get_search_cache_key(get_params)
+        results = cache.get(key)
+        if not results:
+            results = retrieve_search_results(form)
+            cache.set(key, results)
+
         results, meta = prepare_document_table(request, results, get_params)
         meta['searching'] = True
     else:
         form = SearchForm()
         results = []
         meta = { 'by': None, 'searching': False }
+        get_params = QueryDict('')
 
     return render(request, 'doc/search/search.html', {
-        'form':form, 'docs':results, 'meta':meta, },
+        'form':form, 'docs':results, 'meta':meta, 'queryargs':get_params.urlencode() },
     )
 
 def frontpage(request):