simplelist is datatables-aware
[unfold.git] / plugins / static / js / simplelist.js
index b916d11..7862211 100644 (file)
  * MySlice SimpleList plugin
  * Version: 0.1.0
  * URL: http://www.myslice.info
- * Description: Google maps display of geolocated data
+ * Description: display simple lists like slices or testbeds
  * Requires: 
  * Author: The MySlice Team
- * Copyright: Copyright 2012 UPMC Sorbonne Universités
+ * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
  * License: GPLv3
  */
 
-(function(jQuery){
-
-  var methods = {
-     init : function( options ) {
-
-       return this.each(function(){
-         
-         var $this = jQuery(this),
-             data = $this.data('SimpleList'), SimpleList = jQuery('<div />', { text : $this.attr('title') });
-         
-         // If the plugin hasn't been initialized yet
-         if ( ! data ) {
-         
-            /* Plugin initialization */
-
-            /* Subscribe to query updates */
-            jQuery.subscribe('/results/' + options.query_uuid + '/changed', {instance: $this}, update_list);
-
-            /* End of plugin initialization */
-
-            $this.data('SimpleList', {
-                options: options,
-                target : $this,
-                SimpleList : SimpleList
-            });
-
-         }
-       });
-     },
-    destroy : function( ) {
-
-        return this.each(function(){
-            var $this = jQuery(this), data = $this.data('SimpleList');
-            jQuery(window).unbind('SimpleList');
-            data.SimpleList.remove();
-            $this.removeData('SimpleList');
-        })
-
+simplelist_debug=true;
+
+(function($){
+    var methods = {
+       init : function( options ) {
+           return this.each(function(){
+               var $this = $(this);
+               var data = $this.data('SimpleList');
+               /* create an empty DOM object */                
+               var SimpleList = $('<div />', { text : $this.attr('title') });
+               // If the plugin hasn't been initialized yet
+               if ( ! data ) {
+                   /* 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_plugin);
+                   if (simplelist_debug) window.console.log('subscribing to ' + channel);
+                   $this.data('SimpleList', {options: options, SimpleList : SimpleList});
+               }
+           });
+       },
+       destroy : function( ) {
+            return this.each(function(){
+               var $this = $(this), data = $this.data('SimpleList');
+               $(window).unbind('SimpleList');
+               data.SimpleList.remove();
+               $this.removeData('SimpleList');
+            })
     },
-/*
-    reposition : function( ) { // ... },
-    show : function( ) { // ... },
-    hide : function( ) { // ... },
-*/
-    update : function( content ) { }
-  };
+       update : function( content ) { }
+    };
 
-    jQuery.fn.SimpleList = function( method ) {
+    $.fn.SimpleList = function( method ) {
         /* Method calling logic */
         if ( methods[method] ) {
             return methods[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));
         } else if ( typeof method === 'object' || ! method ) {
             return methods.init.apply( this, arguments );
         } else {
-            jQuery.error( 'Method ' +  method + ' does not exist on jQuery.SimpleList' );
+            $.error( 'Method ' +  method + ' does not exist on jQuery.SimpleList' );
         }    
-
     };
 
     /* Private methods */
+    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 <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);
 
-    function update_list(e, rows)
-    {
         if (rows.length == 0) {
-            e.data.instance.html('No result !');
+           if (use_datatables) datatables_set_message ("No result");
+           else                regular_set_message ("No result");
             return;
         }
         if (typeof rows[0].error != 'undefined') {
-            e.data.instance.html('ERROR: ' + rows[0].error);
+           var error="ERROR: " + rows[0].error;
+           if (use_datatables) datatables_set_message (error);
+           else                regular_set_message (error);
             return;
         }
-        options = e.data.instance.data().SimpleList.options;
-        is_cached = options.query.ts != 'now' ? true : false;
-        e.data.instance.html(myslice_html_ul(rows, options.key, options.value, is_cached)+"<br/>");
-        
+        var options = e.data.data().SimpleList.options;
+       if (use_datatables)     datatables_update_table ($table,$tbody,rows,options.key);
+       else                    regular_update_table ($table,$tbody,rows,options.key);
+
     }
 
-    function myslice_html_li(type, value, is_cached) {
-        var cached = '';
-        //if (is_cached)
-        //    cached='<div class="cache"><span><b>Cached information from the database</b><br/>Timestamp: XX/XX/XX XX:XX:XX<br/><br/><i>Refresh in progress...</i></span></div>';
-        if (type == 'slice_hrn') {
-            return "<li class='icn icn-play'><a href='/view/slice/" + value + "'>" + value + cached + "</a></li>";
-        } else if (type == 'network_hrn') {
-            return "<li class='icn icn-play'>" + value + cached + "</li>";
+    // hard-wire a separate presentation depending on the key being used....
+    function cell(key, value) {
+        if (key == 'slice_hrn') {
+            return "<i class='icon-play-circle'></i><a href='/slice/" + value + "'>" + value + "</a>";
+        } else if (key == 'network_hrn') {
+            return "<i class='icon-play-circle'></i>" + value ;
         } else {
-            return "<li>" + value + "</li>";
+            return value;
         }
     }
 
-
-    function myslice_html_ul(data, key, value, is_cached) {
-        var out = "<ul>";
-        for (var i = 0; i < data.length; i++) {
-            out += myslice_html_li(key, data[i][value], is_cached);
-            //out += myslice_html_li(key, myslice_html_a(data[i][key], data[i][value], key), is_cached);
-        }
-        out += "</ul>";
-
-        return out;
+    function regular_set_message ($table, $tbody, message) {
+       $tbody.html("<tr><td>"+message+"</td></tr>");
     }
 
-    /*
-    function myslice_async_render_list(data, key, value, is_cached) {
-        // we suppose we only have one column, or we need more precisions
-        var col = [];
-        if (myslice_array_size(data[0]) == 1) {
-            for (var k in data[0]) {
-                key = k;
-                value = k;
-            }
-        } else {
-            for (var k in data[0]) {
-                if (k.substr(-4) == '_hrn') {
-                    key = k;
-                } else {
-                    value = k;
-                }
-            }
-        }
-        return myslice_html_ul(data, key, value, is_cached);
+    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 );