simplelist is datatables-aware

diff --git a/plugins/simplelist.py b/plugins/simplelist.py
index c8fbdb2..a9ae38d 100644 (file)
--- a/plugins/simplelist.py
+++ b/plugins/simplelist.py
@@ -3,10 +3,9 @@ from engine.plugin import Plugin
 class SimpleList (Plugin) :
 
     # only deal with our own stuff here and let Plugin handle the rest
-    def __init__ (self, key, value, with_datatables=False, **settings):
+    def __init__ (self, key, with_datatables=False, **settings):
         Plugin.__init__ (self, **settings)
         self.key=key
-        self.value=value
         self.with_datatables = with_datatables
 
     # SimpleList is useless per se anyways
@@ -31,5 +30,5 @@ class SimpleList (Plugin) :
             reqs['js_files'].append ("js/with-datatables.js")
         return reqs
     
-    def json_settings_list (self): return ['plugin_uuid', 'query','query_uuid','key','value']
+    def json_settings_list (self): return ['plugin_uuid', 'query','query_uuid','key']
 

diff --git a/plugins/slicelist.py b/plugins/slicelist.py
index 92673f2..c70e412 100644 (file)
--- a/plugins/slicelist.py
+++ b/plugins/slicelist.py
@@ -5,7 +5,7 @@ from plugins.simplelist import SimpleList
 class SliceList (SimpleList):
     
     def __init__ (self, **settings):
-        SimpleList.__init__(self, key='slice_hrn', value='slice_hrn', **settings)
+        SimpleList.__init__(self, key='slice_hrn', **settings)
 
     # writing a js plugin for that would be overkill, just use SimpleList
     def plugin_classname (self):

diff --git a/plugins/static/js/simplelist.js b/plugins/static/js/simplelist.js
index 2c05345..7862211 100644 (file)
--- a/plugins/static/js/simplelist.js
+++ b/plugins/static/js/simplelist.js
@@ -24,7 +24,7 @@ simplelist_debug=true;
                    /* Subscribe to query updates */
                    var channel='/results/' + options.query_uuid + '/changed';
                    /* passing $this as 2nd arg: callbacks will retrieve $this as e.data */
-                   $.subscribe(channel, $this, update_table);
+                   $.subscribe(channel, $this, update_plugin);
                    if (simplelist_debug) window.console.log('subscribing to ' + channel);
                    $this.data('SimpleList', {options: options, SimpleList : SimpleList});
                }
@@ -53,67 +53,77 @@ simplelist_debug=true;
     };
 
     /* Private methods */
-    function update_table(e, rows) {
+    function update_plugin(e, rows) {
        // e.data is what we passed in second argument to subscribe
        // so here it is the jquery object attached to the plugin <div>
        var $this=e.data;
-       // locate the <tbody>, expected layout being
-       // <div class='plugin'> <table> <thead /> <tbody /tbody> </table> </div>
-       // -- or, if we don't have a header --
-       // <div class='plugin'> <table> <tbody /tbody> </table> </div>
-       var $tbody=$this.find("tbody.simplelist").first();
-       if (simplelist_debug) console.log("$tbody goes with "+$tbody.get(0));
+       // locate the <table> element; with datatables in the way,
+       // this might not be a direct son of the div-plugin
+       var $table=$this.find("table.simplelist").first();
+       // also we may or may not have a header
+       var $tbody=$table.find("tbody.simplelist").first();
+       var use_datatables = $table.hasClass("with-datatables");
+       if (simplelist_debug) console.log($this.attr('id') + " udt= " + use_datatables);
+       
+       // clear the spinning wheel: look up an ancestor that has the need-spin class
+       // do this before we might return
+       $this.closest('.need-spin').spin(false);
 
         if (rows.length == 0) {
-            $tbody.html("<tr><td class='simplelist-empty'>No result !</tr></td>");
+           if (use_datatables) datatables_set_message ("No result");
+           else                regular_set_message ("No result");
             return;
         }
         if (typeof rows[0].error != 'undefined') {
-            e.data.html("<tr><td class='simplelist-error'>ERROR: " + rows[0].error + "</td></tr>");
+           var error="ERROR: " + rows[0].error;
+           if (use_datatables) datatables_set_message (error);
+           else                regular_set_message (error);
             return;
         }
         var options = e.data.data().SimpleList.options;
-        var is_cached = options.query.timestamp != 'now' ? true : false;
-       // here is where we use 'key' and 'value' from the SimpleList (python) constructor
-       html_code=myslice_html_tbody(rows, options.key, options.value, is_cached);
-       // locate the tbody from the template, set its text
-        $tbody.html(html_code);
-
-       // clear the spinning wheel: look up an ancestor that has the need-spin class
-       $this.closest('.need-spin').spin(false);
-
-       // in case we run in datatables mode
-       // xxx this is not working yet
-       // http://datatables.net/forums/discussion/14556/can039t-get-my-table-to-refresh-properly#Item_1
-       // http://live.datatables.net/ufihuc/2/edit#javascript,html
-       // most likely when using datatables we'll have to change the contents using some other way..
-       var datatables_table=$this.find("table.with-datatables");
-       if (simplelist_debug) console.log ("running fnDraw() on " + datatables_table.length + " items");
-       // only try this if needed as datatables might not be loaded at all
-       if (datatables_table.length >0) datatables_table.dataTable().fnDraw();
+       if (use_datatables)     datatables_update_table ($table,$tbody,rows,options.key);
+       else                    regular_update_table ($table,$tbody,rows,options.key);
 
     }
 
-    function myslice_html_tbody(data, key, value, is_cached) {
-//     return $.map (...)
-        var out = "";
-        for (var i = 0; i < data.length; i++) {
-            out += myslice_html_tr(key, data[i][value], is_cached);
-        }
-        return out;
-    }
-    
-    function myslice_html_tr(key, value,is_cached) {
-// could not understand what sense this 'cache' stuff could actually make      
-//        var cached = is_cached ? "(cached)" : "";
-        var cached = "";
+    // hard-wire a separate presentation depending on the key being used....
+    function cell(key, value) {
         if (key == 'slice_hrn') {
-            return "<tr><td class='simplelist'><i class='icon-play-circle'></i><a href='/slice/" + value + "'>" + value + cached + "</a></td></tr>";
+            return "<i class='icon-play-circle'></i><a href='/slice/" + value + "'>" + value + "</a>";
         } else if (key == 'network_hrn') {
-            return "<tr><td class='simplelist'><i class='icon-play-circle'></i>" + value + cached + "</td></tr>";
+            return "<i class='icon-play-circle'></i>" + value ;
         } else {
-            return "<tr><td class='simplelist'>" + value + "</td></tr>";
+            return value;
         }
     }
+
+    function regular_set_message ($table, $tbody, message) {
+       $tbody.html("<tr><td>"+message+"</td></tr>");
+    }
+
+    function regular_update_table ($table, $tbody, rows, key) {
+       console.log('regular_update_table ' + rows.length + " rows");
+       var html=$.map(rows, function (row) { return html_row ( cell (key, row[key])); }).join();
+       console.log("html="+html);
+       $tbody.html(html);
+    }
+    
+    function datatables_set_message ($table, $tbody, message) {
+       $table.dataTable().fnClearTable();
+       $table.dataTable().fnAddData( [ message ] );
+       $table.dataTable().fnDraw();
+    }
+
+    function datatables_update_table ($table, $tbody, rows, key) {
+       console.log('datatables_update_table ' + rows.length + " rows");
+       $table.dataTable().fnClearTable();
+       // the lambda here returns a [[]] because $.map is kind of broken; as per the doc:
+       // The function can return any value to add to the array. A returned array will be flattened into the resulting array.
+       // this is wrong indeed so let's work around that
+       $table.dataTable().fnAddData( $.map(rows, function (row) { return [[ cell (key,row[key]) ]] }) );
+       $table.dataTable().fnDraw();
+    }  
+    
+    function html_row (cell) { return "<tr><td class='simplelist'>"+cell+"</td></tr>"; }
     
 })( jQuery );

diff --git a/plugins/templates/simplelist.html b/plugins/templates/simplelist.html
index ca30c0c..1ac9010 100644 (file)
--- a/plugins/templates/simplelist.html
+++ b/plugins/templates/simplelist.html
@@ -1,7 +1,4 @@
 <table class='simplelist{%if with_datatables %} with-datatables{% endif %}'>
-{% if header %}
-<thead><tr><th class='simplelist'>{{ header }}</th></tr></thead>
-{% endif %}
-<tbody class='simplelist'>
-</tbody>
+{% if header %} <thead><tr><th class='simplelist'>{{ header }}</th></tr></thead> {% endif %}
+<tbody class='simplelist'></tbody>
 </table>