simplelist is datatables-aware
[unfold.git] / plugins / static / js / simplelist.js
index 282f6b8..7862211 100644 (file)
@@ -1 +1,129 @@
-/* simplelist.js */
+/**
+ * MySlice SimpleList plugin
+ * Version: 0.1.0
+ * URL: http://www.myslice.info
+ * Description: display simple lists like slices or testbeds
+ * Requires: 
+ * Author: The MySlice Team
+ * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
+ * License: GPLv3
+ */
+
+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');
+            })
+    },
+       update : function( content ) { }
+    };
+
+    $.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 {
+            $.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);
+
+        if (rows.length == 0) {
+           if (use_datatables) datatables_set_message ("No result");
+           else                regular_set_message ("No result");
+            return;
+        }
+        if (typeof rows[0].error != 'undefined') {
+           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;
+       if (use_datatables)     datatables_update_table ($table,$tbody,rows,options.key);
+       else                    regular_update_table ($table,$tbody,rows,options.key);
+
+    }
+
+    // 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 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 );