plugins/hazelnut/hazelnut.js

   1 /**
   2  * MySlice Hazelnut plugin
   3  * URL: http://trac.myslice.info
   4  * Description: display a query result in a datatables-powered <table>
   5  * Author: The MySlice Team
   6  * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
   7  * License: GPLv3
   8  */
   9
  10 /*
  11  * It's a best practice to pass jQuery to an IIFE (Immediately Invoked Function
  12  * Expression) that maps it to the dollar sign so it can't be overwritten by
  13  * another library in the scope of its execution.
  14  */
  15 (function($){
  16
  17     var debug=false;
  18     debug=true
  19
  20     // routing calls
  21     $.fn.Hazelnut = function( method ) {
  22         if ( methods[method] ) {
  23             return methods[method].apply( this, Array.prototype.slice.call( arguments, 1 ));
  24         } else if ( typeof method === 'object' || ! method ) {
  25             return methods.init.apply( this, arguments );
  26         } else {
  27             $.error( 'Method ' +  method + ' does not exist on jQuery.Hazelnut' );
  28         }
  29     };
  30
  31     /***************************************************************************
  32      * Public methods
  33      ***************************************************************************/
  34
  35     var methods = {
  36
  37         init : function ( options ) {
  38             /* Default settings */
  39             var options = $.extend( {
  40                 'checkboxes': false
  41             }, options);
  42
  43             return this.each(function() {
  44                 var $this = $(this);
  45                 /* Events */
  46                 $(this).on('show.Datatables', methods.show);
  47
  48                 /* An object that will hold private variables and methods */
  49                 var hazelnut = new Hazelnut (options);
  50                 if (debug) console.log("Hazelnut object created");
  51                 $(this).data('Hazelnut', hazelnut);
  52
  53                 var query_channel   = '/query/' + options.query_uuid + '/changed';
  54                 var update_channel  = '/update-set/' + options.query_uuid;
  55                 var results_channel = '/results/' + options.query_uuid + '/changed';
  56
  57                 $.subscribe(query_channel,  function(e, query) { hazelnut.set_query(query); });;
  58                 $.subscribe(update_channel, function(e, resources, instance) { hazelnut.set_resources(resources, instance); });
  59                 $.subscribe(results_channel, $this, function(e, rows) { hazelnut.update_plugin(e,rows); });
  60
  61             }); // this.each
  62         }, // init
  63
  64         destroy : function( ) {
  65             return this.each(function() {
  66                 var $this = $(this);
  67                 var hazelnut = $this.data('Hazelnut');
  68
  69                 // Unbind all events using namespacing
  70                 $(window).unbind('Hazelnut');
  71
  72                 // Remove associated data
  73                 hazelnut.remove();
  74                 $this.removeData('Hazelnut');
  75             });
  76         }, // destroy
  77
  78         show : function( ) {
  79             var $this=$(this);
  80             // xxx wtf. why [1] ? would expect 0...
  81             var oTable = $($('.dataTable', $this)[1]).dataTable();
  82             oTable.fnAdjustColumnSizing()
  83
  84             /* Refresh dataTabeles if click on the menu to display it : fix dataTables 1.9.x Bug */
  85             $(this).each(function(i,elt) {
  86                 if (jQuery(elt).hasClass('dataTables')) {
  87                     var myDiv=jQuery('#hazelnut-' + this.id).parent();
  88                     if(myDiv.height()==0) {
  89                         var oTable=$('#hazelnut-' + this.id).dataTable();
  90                         oTable.fnDraw();
  91                     }
  92                 }
  93             });
  94         } // show
  95
  96     }; // var methods;
  97
  98
  99     /***************************************************************************
 100      * Hazelnut object
 101      ***************************************************************************/
 102     function Hazelnut(options) {
 103         /* member variables */
 104         this.options = options;
 105         /* constructor */
 106         this.table = null;
 107         // xxx thierry : init this here - it was not, I expect this relied on set_query somehow..
 108         //this.current_query = null;
 109         this.current_query=manifold.find_query(this.options.query_uuid);
 110         this.query_update = null;
 111         this.current_resources = Array();
 112
 113         var object = this;
 114
 115         /* Transforms the table into DataTable, and keep a pointer to it */
 116         this.table = $('#hazelnut-' + options.plugin_uuid).dataTable({
 117             // Customize the position of Datatables elements (length,filter,button,...)
 118             // inspired from :
 119             // http://datatables.net/release-datatables/examples/advanced_init/dom_toolbar.html
 120             // http://www.datatables.net/forums/discussion/3914/adding-buttons-to-header-or-footer/p1
 121             //"sDom": 'lf<"#datatableSelectAll-'+ options.plugin_uuid+'">rtip',
 122             sDom: '<"H"Tfr>t<"F"ip>',
 123             bJQueryUI: true,
 124             sPaginationType: 'full_numbers',
 125             // Handle the null values & the error : Datatables warning Requested unknown parameter
 126             // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2
 127             aoColumnDefs: [{sDefaultContent: '',aTargets: [ '_all' ]}],
 128             bRetrieve: true,
 129             sScrollX: '100%',       /* Horizontal scrolling */
 130             bProcessing: true,      /* Loading */
 131             fnRowCallback: function( nRow, aData, iDisplayIndex, iDisplayIndexFull ) {
 132                 $(nRow).attr('id', get_value(aData[3]));
 133                 return nRow;
 134             },
 135             fnDrawCallback: function() { hazelnut_draw_callback.call(object, options); }
 136         });
 137
 138         /* Setup the SelectAll button in the dataTable header */
 139         var oSelectAll = $('#datatableSelectAll-'+ options.plugin_uuid);
 140         oSelectAll.html("<span class='ui-icon ui-icon-check' style='float:right;display:inline-block;'></span>Select All");
 141         oSelectAll.button();
 142         oSelectAll.css('font-size','11px');
 143         oSelectAll.css('float','right');
 144         oSelectAll.css('margin-right','15px');
 145         oSelectAll.css('margin-bottom','5px');
 146         oSelectAll.unbind('click');
 147         oSelectAll.click(selectAll);
 148
 149         /* Spinner (could be done when the query is received = a query is in progress, also for update) */
 150 //        $('#' + options.plugin_uuid).spin()
 151
 152         /* Add a filtering function to the current table
 153          * Note: we use closure to get access to the 'options'
 154          */
 155         $.fn.dataTableExt.afnFiltering.push(function( oSettings, aData, iDataIndex ) {
 156             /* No filtering if the table does not match */
 157             if (oSettings.nTable.id != "hazelnut-" + options.plugin_uuid)
 158                 return true;
 159             return hazelnut_filter.call(object, oSettings, aData, iDataIndex);
 160         });
 161
 162         /* methods */
 163
 164         this.set_query = function(query) {
 165             if (debug) console.log("entering set_query");
 166             var o = this.options;
 167             /* Compare current and advertised query to get added and removed fields */
 168             previous_query = this.current_query;
 169             /* Save the query as the current query */
 170             this.current_query = query;
 171             /* We check all necessary fields : in column editor I presume XXX */
 172             // XXX ID naming has no plugin_uuid
 173             if (typeof(query.fields) != 'undefined') {
 174                 $.each (query.fields, function(index, value) {
 175                     if (!$('#hazelnut-checkbox-' + o.plugin_uuid + "-" + value).attr('checked'))
 176                         $('#hazelnut-checkbox-' + o.plugin_uuid + "-" + value).attr('checked', true);
 177                 });
 178             }
 179             /*Process updates in filters / current_query must be updated before this call for filtering ! */
 180             this.table.fnDraw();
 181
 182             /*
 183              * Process updates in fields
 184              */
 185             if (typeof(query.fields) != 'undefined') {
 186                 /* DataTable Settings */
 187                 var oSettings = this.table.dataTable().fnSettings();
 188                 var cols = oSettings.aoColumns;
 189                 var colnames = cols.map(function(x) {return x.sTitle});
 190                 colnames = $.grep(colnames, function(value) {return value != "+/-";});
 191
 192                 if (previous_query == null) {
 193                     var added_fields = query.fields;
 194                     var removed_fields = colnames;
 195                     removed_fields = $.grep(colnames, function(x) { return $.inArray(x, added_fields) == -1});
 196                 } else {
 197                     var tmp = previous_query.diff_fields(query);
 198                     var added_fields = tmp.added;
 199                     var removed_fields = tmp.removed;
 200                 }
 201
 202                 /* Hide/unhide columns to match added/removed fields */
 203                 var object = this;
 204                 $.each(added_fields, function (index, field) {
 205                     var index = object.getColIndex(field,cols);
 206                     if(index != -1)
 207                         object.table.fnSetColumnVis(index, true);
 208                 });
 209                 $.each(removed_fields, function (index, field) {
 210                     var index = object.getColIndex(field,cols);
 211                     if(index != -1)
 212                         object.table.fnSetColumnVis(index, false);
 213                 });
 214             }
 215         }
 216
 217         this.set_resources = function(resources, instance) {
 218             if (debug) console.log("entering set_resources");
 219             var o = this.options;
 220             var previous_resources = this.current_resources;
 221             this.current_resources = resources;
 222
 223             /* We uncheck all checkboxes ... */
 224             $('hazelnut-checkbox-' + o.plugin_uuid).attr('checked', false);
 225             /* ... and check the ones specified in the resource list */
 226             $.each(this.current_resources, function(index, urn) {
 227                 $('#hazelnut-checkbox-' + o.plugin_uuid + "-" + urn).attr('checked', true)
 228             });
 229
 230         }
 231
 232         /**
 233          * @brief Determine index of key in the table columns
 234          * @param key
 235          * @param cols
 236          */
 237         this.getColIndex = function(key, cols) {
 238             var tabIndex = $.map(cols, function(x, i) { if (x.sTitle == key) return i; });
 239             return (tabIndex.length > 0) ? tabIndex[0] : -1;
 240         }
 241
 242         /**
 243          * @brief
 244          * XXX will be removed/replaced
 245          */
 246         this.selected_changed = function(e, change) {
 247             if (debug) console.log("entering selected_changed");
 248             var actions = change.split("/");
 249             if (actions.length > 1) {
 250                 var oNodes = this.table.fnGetNodes();
 251                 var myNode = $.grep(oNodes, function(value) {
 252                     if (value.id == actions[1]) { return value; }
 253                 });
 254                 if( myNode.length>0 ) {
 255                     if ((actions[2]=="add" && actions[0]=="cancel") || actions[0]=="del")
 256                         checked='';
 257                     else
 258                         checked="checked='checked' ";
 259                     var newValue = this.checkbox(actions[1], 'node', checked, false);
 260                     var columnPos = this.table.fnSettings().aoColumns.length - 1;
 261                     this.table.fnUpdate(newValue, myNode[0], columnPos);
 262                     this.table.fnDraw();
 263                 }
 264             }
 265         }
 266
 267         this.update_plugin = function(e, rows) {
 268             if (debug) console.log("entering update_plugin");
 269             // e.data is what we passed in second argument to subscribe
 270             // so here it is the jquery object attached to the plugin <div>
 271             var $plugindiv=e.data;
 272             console.log("incoming plugindiv= " + $plugindiv);
 273             // clear the spinning wheel: look up an ancestor that has the need-spin class
 274             // do this before we might return
 275             $plugindiv.closest('.need-spin').spin(false);
 276
 277             var options = this.options;
 278             var hazelnut = this;
 279
 280             if (rows.length==0) {
 281                 this.table.html(errorDisplay("No Result"));
 282                 return;
 283             } else {
 284                 if (typeof(rows[0].error) != 'undefined') {
 285                     this.table.html(errorDisplay(rows[0].error));
 286                     return;
 287                 }
 288             }
 289             newlines = new Array();
 290
 291             this.current_resources = Array();
 292
 293             $.each(rows, function(index, obj) {
 294                 newline = new Array();
 295
 296                 // go through table headers to get column names we want
 297                 // in order (we have temporarily hack some adjustments in names)
 298                 var cols = hazelnut.table.fnSettings().aoColumns;
 299                 var colnames = cols.map(function(x) {return x.sTitle})
 300                 var nb_col = colnames.length;
 301                 if (options.checkboxes)
 302                     nb_col -= 1;
 303                 for (var j = 0; j < nb_col; j++) {
 304                     if (typeof colnames[j] == 'undefined') {
 305                         newline.push('...');
 306                     } else if (colnames[j] == 'hostname') {
 307                         if (obj['type'] == 'resource,link')
 308                             //TODO: we need to add source/destination for links
 309                             newline.push('');
 310                         else
 311                             newline.push(obj['hostname']);
 312                     } else {
 313                         if (obj[colnames[j]])
 314                             newline.push(obj[colnames[j]]);
 315                         else
 316                             newline.push('');
 317                     }
 318                 }
 319
 320                 if (options.checkboxes) {
 321                     var checked = '';
 322                     if (typeof(obj['sliver']) != 'undefined') { /* It is equal to null when <sliver/> is present */
 323                         checked = 'checked ';
 324                         hazelnut.current_resources.push(obj['urn']);
 325                     }
 326                     // Use a key instead of hostname (hard coded...)
 327                     newline.push(hazelnut.checkbox(options.plugin_uuid, obj['urn'], obj['type'], checked, false));
 328                 }
 329
 330                 newlines.push(newline);
 331
 332
 333             });
 334
 335 //          console.log ("end of each, newlines=" + newlines.length);
 336             this.table.fnAddData(newlines);
 337
 338 //          console.log (" exiting update_plugin = ");
 339         };
 340
 341         this.checkbox = function (plugin_uuid, header, field, selected_str, disabled_str) {
 342             var result="";
 343             /* Prefix id with plugin_uuid */
 344             result += "<input class='hazelnut-checkbox-" + plugin_uuid + "' id='hazelnut-checkbox-" + plugin_uuid + "-" + get_value(header) + "'";
 345             result += " name='" + get_value(field) + "' type='checkbox' " + selected_str + disabled_str + " autocomplete='off' value='" + get_value(header) + "'";
 346             result +="></input>";
 347             return result;
 348         };
 349     } // constructor
 350
 351     /***************************************************************************
 352      * Private methods
 353      ***************************************************************************/
 354
 355     /**
 356      * @brief Hazelnut filtering function
 357      */
 358     function hazelnut_filter (oSettings, aData, iDataIndex) {
 359         var cur_query = this.current_query;
 360         var ret = true;
 361
 362         /* We have an array of filters : a filter is an array (key op val)
 363          * field names (unless shortcut)    : oSettings.aoColumns  = [ sTitle ]
 364          *     can we exploit the data property somewhere ?
 365          * field values (unless formatting) : aData
 366          *     formatting should leave original data available in a hidden field
 367          *
 368          * The current line should validate all filters
 369          */
 370         $.each (cur_query.filter, function(index, filter) {
 371             /* XXX How to manage checkbox ? */
 372             var key = filter[0];
 373             var op = filter[1];
 374             var value = filter[2];
 375
 376             /* Determine index of key in the table columns */
 377             var col = $.map(oSettings.aoColumns, function(x, i) {if (x.sTitle == key) return i;})[0];
 378
 379             /* Unknown key: no filtering */
 380             if (typeof(col) == 'undefined')
 381                 return;
 382
 383             col_value=get_value(aData[col]);
 384             /* Test whether current filter is compatible with the column */
 385             if (op == '=' || op == '==') {
 386                 if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a")
 387                     ret = false;
 388             }else if (op == '!=') {
 389                 if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a")
 390                     ret = false;
 391             } else if(op=='<') {
 392                 if ( parseFloat(col_value) >= value || col_value==null || col_value=="" || col_value=="n/a")
 393                     ret = false;
 394             } else if(op=='>') {
 395                 if ( parseFloat(col_value) <= value || col_value==null || col_value=="" || col_value=="n/a")
 396                     ret = false;
 397             } else if(op=='<=' || op=='≤') {
 398                 if ( parseFloat(col_value) > value || col_value==null || col_value=="" || col_value=="n/a")
 399                     ret = false;
 400             } else if(op=='>=' || op=='≥') {
 401                 if ( parseFloat(col_value) < value || col_value==null || col_value=="" || col_value=="n/a")
 402                     ret = false;
 403             }else{
 404                 // How to break out of a loop ?
 405                 alert("filter not supported");
 406                 return false;
 407             }
 408
 409         });
 410         return ret;
 411     }
 412
 413     function hazelnut_draw_callback() {
 414         var options = this.options;
 415         /*
 416          * Handle clicks on checkboxes: reassociate checkbox click every time
 417          * the table is redrawn
 418          */
 419         $('.hazelnut-checkbox-' + options.plugin_uuid).unbind('click');
 420         $('.hazelnut-checkbox-' + options.plugin_uuid).click({instance: this}, check_click);
 421
 422         if (!this.table)
 423             return;
 424
 425         /* Remove pagination if we show only a few results */
 426         var wrapper = this.table; //.parent().parent().parent();
 427         var rowsPerPage = this.table.fnSettings()._iDisplayLength;
 428         var rowsToShow = this.table.fnSettings().fnRecordsDisplay();
 429         var minRowsPerPage = this.table.fnSettings().aLengthMenu[0];
 430
 431         if ( rowsToShow <= rowsPerPage || rowsPerPage == -1 ) {
 432             $('.hazelnut_paginate', wrapper).css('visibility', 'hidden');
 433         } else {
 434             $('.hazelnut_paginate', wrapper).css('visibility', 'visible');
 435         }
 436
 437         if ( rowsToShow <= minRowsPerPage ) {
 438             $('.hazelnut_length', wrapper).css('visibility', 'hidden');
 439         } else {
 440             $('.hazelnut_length', wrapper).css('visibility', 'visible');
 441         }
 442     }
 443
 444     function check_click (e) {
 445         var object = e.data.instance;
 446         var value = this.value;
 447
 448         if (this.checked) {
 449             object.current_resources.push(value);
 450         } else {
 451             tmp = $.grep(object.current_resources, function(x) { return x != value; });
 452             object.current_resources = tmp;
 453         }
 454
 455         /* inform slice that our selected resources have changed */
 456         $.publish('/update-set/' + object.options.query_uuid, [object.current_resources, true]);
 457
 458     }
 459
 460     function selectAll() {
 461         // requires jQuery id
 462         var uuid=this.id.split("-");
 463         var oTable=$("#hazelnut-"+uuid[1]).dataTable();
 464         // Function available in Hazelnut 1.9.x
 465         // Filter : displayed data only
 466         var filterData = oTable._('tr', {"filter":"applied"});
 467         /* TODO: WARNING if too many nodes selected, use filters to reduce nuber of nodes */
 468         if(filterData.length<=100){
 469             $.each(filterData, function(index, obj) {
 470                 var last=$(obj).last();
 471                 var key_value=get_value(last[0]);
 472                 if(typeof($(last[0]).attr('checked'))=="undefined"){
 473                     $.publish('selected', 'add/'+key_value);
 474                 }
 475             });
 476         }
 477     }
 478
 479 })( jQuery );