plugins/lists/static/js/simplelist.js

   1 /**
   2  * Description: display simple lists like slices or testbeds
   3  * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
   4  * License: GPLv3
   5  */
   6
   7 (function($){
   8
   9     var debug=false;
  10     // debug=true
  11
  12     $.fn.SimpleList = function( method ) {
  13         /* Method calling logic */
  14         if ( methods[method] ) {
  15             return methods[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));
  16         } else if ( typeof method === 'object' || ! method ) {
  17             return methods.init.apply( this, arguments );
  18         } else {
  19             $.error( 'Method ' +  method + ' does not exist on jQuery.SimpleList' );
  20         }
  21     };
  22
  23     var methods = {
  24         init : function( options ) {
  25             return this.each(function(){
  26                 var $this = $(this), data = $this.data('SimpleList');
  27                 /* Subscribe to query updates */
  28                 var channel='/results/' + options.query_uuid + '/changed';
  29                 /* passing $this as 2nd arg: callbacks will retrieve $this as e.data */
  30                 $.subscribe(channel, $this, update_plugin);
  31                 if (debug) window.messages.debug('subscribing to ' + channel);
  32                 $this.data('SimpleList', options);
  33             });
  34         },
  35         destroy : function( ) {
  36             if (debug) messages.debug("SimpleList.destroy...");
  37             return this.each(function(){
  38                 var $this = $(this), data = $this.data('SimpleList');
  39                 // xxx not too sure what this is about
  40                 $(window).unbind('SimpleList');
  41                 $this.removeData('SimpleList');
  42             });
  43         },
  44         update : function( content ) {
  45             if (debug) messages.debug("SimpleList.update...");
  46         },
  47     }; // methods
  48
  49     /* Private methods */
  50     // complexity here is mostly because a datatables-enabled table cannot
  51     // be updated in a "normal" way using .html()
  52     function update_plugin(e, rows) {
  53         // e.data is what we passed in second argument to subscribe
  54         // so here it is the jquery object attached to the plugin <div>
  55         var $plugindiv = e.data;
  56         // locate the <table> element; with datatables in the way,
  57         // this might not be a direct son of the div-plugin
  58         var $table = $plugindiv.find("table.simplelist").first();
  59         // also we may or may not have a header
  60         var $tbody = $table.find("tbody.simplelist").first();
  61         var use_datatables = $table.hasClass("with-datatables");
  62         if (debug)
  63             messages.debug($plugindiv.attr('id') + " udt= " + use_datatables);
  64
  65         // clear the spinning wheel: look up an ancestor that has the need-spin class
  66         // do this before we might return
  67             $plugindiv.closest('.need-spin').spin(false);
  68
  69         if (rows.length == 0) {
  70                 if (use_datatables)
  71                  datatables_set_message ($table, $tbody, unfold.warning("No result"));
  72                 else
  73                         regular_set_message ($table, $tbody, unfold.warning("No result"));
  74             return;
  75         }
  76
  77         if (typeof rows[0].error != 'undefined') {
  78                 var error="ERROR: " + rows[0].error;
  79                 if (use_datatables)
  80                 datatables_set_message ($table, $tbody, unfold.error(error));
  81                 else
  82                         regular_set_message ($table, $tbody, unfold.error(error));
  83             return;
  84         }
  85
  86         var options = $plugindiv.data().SimpleList;
  87             if (use_datatables)
  88             datatables_update_table($table, $tbody, rows, options.key);
  89             else
  90                         regular_update_table($table, $tbody, rows, options.key);
  91
  92         }
  93
  94     // hard-wire a separate presentation depending on the key being used....
  95     function cell(key, value) {
  96         if (key == 'slice.slice_hrn') {
  97             return "<i class='icon-play-circle'></i><a href='/portal/slice/" + value + "'>" + value + "</a>";
  98         } else if (key == 'network_hrn') {
  99             return "<i class='icon-play-circle'></i><a href='/portal/platform/" + value + "'>" + value + "</a>";
 100         } else {
 101             return value;
 102         }
 103     }
 104
 105     function regular_set_message ($table, $tbody, message) {
 106         $tbody.html("<tr><td>"+message+"</td></tr>");
 107     }
 108
 109     function regular_update_table ($table, $tbody, rows, key) {
 110         if (debug)
 111             messages.debug('regular_update_table ' + rows.length + " rows");
 112             var html=$.map(rows, function (row) {
 113             value = row;
 114             $.each(key.split('.'), function(i, k) {
 115                 if ($.isArray(value)) {
 116                     value = $.map(value, function(val, i) { return val[k]});
 117                 } else {
 118                     value = value[k];
 119                 }
 120             });
 121             if ($.isArray(value)) {
 122                 x = $.map(value, function(val, i) { return html_row ( cell (key, val)); });
 123                 return x;
 124             } else {
 125                 return html_row ( cell (key, value));
 126             }
 127         }).join();
 128         $tbody.html(html);
 129     }
 130
 131     function datatables_set_message ($table, $tbody, message) {
 132         $table.dataTable().fnClearTable();
 133         $table.dataTable().fnAddData( [ message ] );
 134         $table.dataTable().fnDraw();
 135     }
 136
 137     function datatables_update_table ($table, $tbody, rows, key) {
 138         if (debug) messages.debug('datatables_update_table ' + rows.length + " rows");
 139         $table.dataTable().fnClearTable();
 140         // the lambda here returns a [[]] because $.map is kind of broken; as per the doc:
 141         // The function can return any value to add to the array. A returned array will be flattened into the resulting array.
 142         // this is wrong indeed so let's work around that
 143         $table.dataTable().fnAddData( $.map(rows, function (row) { return [[ cell (key,row[key]) ]] }) );
 144         $table.dataTable().fnDraw();
 145     }
 146
 147     function html_row (cell) {
 148         return "<tr><td class='simplelist'>"+cell+"</td></tr>";
 149     }
 150
 151 })( jQuery );