Merge pull request #5475 from mrpau/feature/5452-about-diagnose-page

About/Diagnose Page

Author: benjaoming

docs/installguide/release_notes.rst

@@ -21,6 +21,7 @@ New Features
 ^^^^^^^^^^^^
 
 * Enabled captions by default for English dubbed videos. :url-issue:`5464`
+* About/Diagnose page. :url-issue:`5452`
 
 
 0.17.1

kalite/cli.py

@@ -662,32 +662,7 @@ def status():
     STATUS_UNKNOW: 'Could not determine status',
 }
 
-
-def diagnose():
-    """
-    This command diagnoses an installation of KA Lite
-
-    It has to be able to work with instances of KA Lite that users do not
-    actually own, however it's assumed that the path and the 'kalite' commands
-    are configured and work.
-
-    The function is currently non-robust, meaning that not all aspects of
-    diagnose data collection is guaranteed to succeed, thus the command could
-    potentially fail :(
-
-    Example: KALITE_HOME=/home/otheruser/.kalite kalite diagnose --port=7007
-    """
-
-    print("")
-    print("KA Lite diagnostics")
-    print("")
-
-    # Tell users we are calculating, because checking the size of the
-    # content directory is slow. Flush immediately after.
-    print("Calculating diagnostics...")
-    sys.stdout.flush()
-    print("")
-
+def get_diagnostics():
     # Key, value store for diagnostics
     # Not using OrderedDict because of python 2.6
     diagnostics = []
@@ -733,6 +708,35 @@ def diagnose():
         except:
             diag("Device failure", traceback.format_exc())
 
+    return diagnostics
+
+def diagnose():
+    """
+    This command diagnoses an installation of KA Lite
+
+    It has to be able to work with instances of KA Lite that users do not
+    actually own, however it's assumed that the path and the 'kalite' commands
+    are configured and work.
+
+    The function is currently non-robust, meaning that not all aspects of
+    diagnose data collection is guaranteed to succeed, thus the command could
+    potentially fail :(
+
+    Example: KALITE_HOME=/home/otheruser/.kalite kalite diagnose --port=7007
+    """
+
+    print("")
+    print("KA Lite diagnostics")
+    print("")
+
+    # Tell users we are calculating, because checking the size of the
+    # content directory is slow. Flush immediately after.
+    print("Calculating diagnostics...")
+    sys.stdout.flush()
+    print("")
+
+    diagnostics = get_diagnostics()
+
     for k, v in diagnostics:
 
         # Pad all the values to match the key column

kalite/distributed/static/js/distributed/about/hbtemplates/about.handlebars

@@ -0,0 +1,8 @@
+<table class="table table-hover table-bordered">
+    {{#each diagnostics }}
+        <tr>
+            <td>{{ @key }}</td>
+            <td>{{ breaklines this }}</td>
+        </tr>
+    {{/each}}
+</table>

kalite/distributed/static/js/distributed/about/views.js

@@ -0,0 +1,42 @@
+var Backbone = require("base/backbone");
+
+var diagnostics = {};
+
+var AboutView = Backbone.View.extend({
+    template: require("./hbtemplates/about.handlebars"),
+
+    initialize: function() {
+        this.generate_diagnostics();
+    },
+    render: function() {
+        console.log(JSON.stringify(diagnostics));
+        this.$el.html(this.template({
+            diagnostics: diagnostics
+        }));
+
+        return this;
+    },
+    generate_diagnostics: function() {
+        var self = this;
+        $.ajax({
+            type: 'get',
+            url: 'data/',
+            dataType: 'json',
+            success: function(data) {
+                if(data.status == 'success') {
+                    for(var diag in data.diagnostics) {
+                        diagnostics[data.diagnostics[diag][0].toUpperCase()] = data.diagnostics[diag][1];
+                    }
+                    self.render();
+                }
+            },
+            error: function() {
+                console.log("An error has occurred while calculating diagnostics.");
+            }
+        });
+    }
+});
+
+module.exports = {
+    AboutView: AboutView
+};

kalite/distributed/static/js/distributed/base/handlebars.js

@@ -121,4 +121,11 @@ Handlebars.registerHelper("current_language_is", function(lc, options) {
     }
 });
 
+//from https://stackoverflow.com/questions/12331077/does-handlebars-js-replace-newline-characters-with-br/12397602#12397602
+Handlebars.registerHelper('breaklines', function(text) {
+    text = Handlebars.Utils.escapeExpression(text);
+    text = text.replace(/(\r\n|\n|\r)/gm, '<br>');
+    return new Handlebars.SafeString(text);
+});
+
 module.exports = Handlebars;

kalite/distributed/static/js/distributed/bundle_modules/about.js

@@ -0,0 +1,5 @@
+var $ = require("base/jQuery");
+var AboutView = require("../about/views").AboutView;
+
+global.$ = $;
+global.AboutView = AboutView;

kalite/distributed/static/js/distributed/user/hbtemplates/navigation.handlebars

@@ -45,6 +45,11 @@
       </li>
       <li role="presentation" class="divider"></li>
     {{/unless}}
+    {{#if is_admin}}
+        <li role="presentation">
+          <a role="menuitem" tabindex="-1" href="{{ url "about" }}" id="nav_about">{{_ "About" }}</a>
+      </li>
+    {{/if}}
       {{!-- Logout goes at the bottom! --}}
       <li role="presentation" id="logout">
         <a role="menuitem" tabindex="-1" id="nav_logout" href="#">

kalite/distributed/templates/distributed/about.html

@@ -0,0 +1,26 @@
+{% extends "distributed/base.html" %}
+{% load i18n %}
+{% load staticfiles %}
+
+{% block title %}{% trans "About" %}{% endblock title %}
+{% block headjs %}
+    {{ block.super }}
+    <script src="{% static 'js/distributed/bundles/bundle_about.js' %}"></script>
+    <script>
+        $(function() {
+            var about_view = new window.AboutView({
+                el: $("#about-diagnostics-container")
+            });
+        });
+    </script>
+{% endblock %}
+
+{% block content %}
+    <div class="container">
+        <h2>{% trans "Diagnostics" %}</h2>
+        <div id="about-diagnostics-container">
+            <p><em>{% trans "Calculating diagnostics..." %}</em></p>
+            <p>{% trans "This can take several minutes." %}</p>
+        </div>
+    </div>
+{% endblock content %}

kalite/distributed/tests/__init__.py

@@ -1,3 +1,4 @@
 from cli_tests import *
 from url_tests import *
 from browser_tests import *
+from about_tests import *

kalite/distributed/tests/about_tests.py

@@ -0,0 +1,13 @@
+from django.core.urlresolvers import reverse
+
+from kalite.testing.base import KALiteTestCase
+
+class AboutTestCase(KALiteTestCase):
+
+    def test_about(self):
+        response = self.client.get(reverse('about'))
+        self.assertEqual(response.status_code, 200)
+
+    def test_about_data(self):
+        response = self.client.get(reverse('about_data'))
+        self.assertIn('success', response.content)