X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=plugins%2Fhazelnut%2Fhazelnut.js;h=5f1c27a0068c26ef2a208f9bfbf07271247b4699;hb=e256853ef256809864927b91deb42e713baea769;hp=861f33c33a25e0e0cf0e87985bd3a6c54d0fd28b;hpb=d36cb74e23439c1d0982a3a004c0bff486ca910f;p=myslice.git diff --git a/plugins/hazelnut/hazelnut.js b/plugins/hazelnut/hazelnut.js index 861f33c3..5f1c27a0 100644 --- a/plugins/hazelnut/hazelnut.js +++ b/plugins/hazelnut/hazelnut.js @@ -1,8 +1,5 @@ /** - * MySlice Hazelnut plugin - * URL: http://trac.myslice.info * Description: display a query result in a datatables-powered - * Author: The MySlice Team * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA * License: GPLv3 */ @@ -34,33 +31,52 @@ var methods = { + /** + * @brief Plugin initialization + * @param options : an associative array of setting values + * @return : a jQuery collection of objects on which the plugin is + * applied, which allows to maintain chainability of calls + */ init : function ( options ) { + /* Default settings */ var options = $.extend( { 'checkboxes': false }, options); return this.each(function() { + var $this = $(this); + /* Events */ - $(this).on('show.Datatables', methods.show); + $this.on('show.Datatables', methods.show); /* An object that will hold private variables and methods */ - var hazelnut = new Hazelnut (options); - $(this).data('Hazelnut', hazelnut); - + var hazelnut = new Hazelnut (options); + $this.data('Hazelnut', hazelnut); var query_channel = '/query/' + options.query_uuid + '/changed'; var update_channel = '/update-set/' + options.query_uuid; var results_channel = '/results/' + options.query_uuid + '/changed'; - $.subscribe(query_channel, function(e, query) { hazelnut.set_query(query); });; + // xxx not tested yet + $.subscribe(query_channel, function(e, query) { hazelnut.set_query(query); }); + // xxx not tested yet $.subscribe(update_channel, function(e, resources, instance) { hazelnut.set_resources(resources, instance); }); + // expected to work $.subscribe(results_channel, $this, function(e, rows) { hazelnut.update_plugin(e,rows); }); + if (debug) + messages.debug("hazelnut '" + this.id + "' subscribed to e.g." + results_channel); }); // this.each }, // init + /** + * @brief Plugin destruction + * @return : a jQuery collection of objects on which the plugin is + * applied, which allows to maintain chainability of calls + */ destroy : function( ) { + return this.each(function() { var $this = $(this); var hazelnut = $this.data('Hazelnut'); @@ -75,11 +91,13 @@ }, // destroy show : function( ) { - var $this=$(this); - // xxx wtf. why [1] ? would expect 0... + var $this=$(this); + // xxx wtf. why [1] ? would expect 0... + if (debug) + messages.debug("Hitting suspicious line in hazelnut.show"); var oTable = $($('.dataTable', $this)[1]).dataTable(); oTable.fnAdjustColumnSizing() - + /* Refresh dataTabeles if click on the menu to display it : fix dataTables 1.9.x Bug */ $(this).each(function(i,elt) { if (jQuery(elt).hasClass('dataTables')) { @@ -94,48 +112,44 @@ }; // var methods; - /*************************************************************************** * Hazelnut object ***************************************************************************/ - function Hazelnut(options) { + + function Hazelnut(options) + { /* member variables */ this.options = options; - /* constructor */ - this.table = null; - // xxx thierry : init this here - it was not, I expect this relied on set_query somehow.. + + // xxx thierry : initialize this here - it was not, I expect this relied on set_query somehow.. //this.current_query = null; - this.current_query=manifold.find_query(this.options.query_uuid); - if (debug) console.log("Hazelnut constructor: have set current_query -> " + this.current_query); - this.query_update = null; + this.current_query=manifold.find_query(this.options.query_uuid); + // if (debug) messages.debug("Hazelnut constructor: have set current_query -> " + this.current_query.__repr()); + this.query_update = null; this.current_resources = Array(); var object = this; /* Transforms the table into DataTable, and keep a pointer to it */ - this.table = $('#hazelnut-' + options.plugin_uuid).dataTable({ + actual_options = { // Customize the position of Datatables elements (length,filter,button,...) - // inspired from : - // http://datatables.net/release-datatables/examples/advanced_init/dom_toolbar.html - // http://www.datatables.net/forums/discussion/3914/adding-buttons-to-header-or-footer/p1 - //"sDom": 'lf<"#datatableSelectAll-'+ options.plugin_uuid+'">rtip', - sDom: '<"H"Tfr>t<"F"ip>', - bJQueryUI: true, - sPaginationType: 'full_numbers', + // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time + sDom: "<'row-fluid'<'span5'l><'span1'r><'span6'f>>t<'row-fluid'<'span5'i><'span7'p>>", + sPaginationType: 'bootstrap', // Handle the null values & the error : Datatables warning Requested unknown parameter // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2 aoColumnDefs: [{sDefaultContent: '',aTargets: [ '_all' ]}], - bRetrieve: true, - sScrollX: '100%', /* Horizontal scrolling */ + // WARNING: this one causes tables in a 'tabs' that are not exposed at the time this is run to show up empty + // sScrollX: '100%', /* Horizontal scrolling */ bProcessing: true, /* Loading */ - fnRowCallback: function( nRow, aData, iDisplayIndex, iDisplayIndexFull ) { - $(nRow).attr('id', get_value(aData[3])); - return nRow; - }, fnDrawCallback: function() { hazelnut_draw_callback.call(object, options); } - }); + }; + // the intention here is that options.datatables_options as coming from the python object take precedence + // XXX DISABLED by jordan: was causing errors in datatables.js $.extend(actual_options, options.datatables_options ); + this.table = $('#hazelnut-' + options.plugin_uuid).dataTable(actual_options); /* Setup the SelectAll button in the dataTable header */ + /* xxx not sure this is still working */ var oSelectAll = $('#datatableSelectAll-'+ options.plugin_uuid); oSelectAll.html("Select All"); oSelectAll.button(); @@ -146,9 +160,6 @@ oSelectAll.unbind('click'); oSelectAll.click(selectAll); - /* Spinner (could be done when the query is received = a query is in progress, also for update) */ -// $('#' + options.plugin_uuid).spin() - /* Add a filtering function to the current table * Note: we use closure to get access to the 'options' */ @@ -162,22 +173,25 @@ /* methods */ this.set_query = function(query) { - if (debug) console.log("entering set_query"); - var o = this.options; + messages.info('hazelnut.set_query'); + var options = this.options; /* Compare current and advertised query to get added and removed fields */ previous_query = this.current_query; /* Save the query as the current query */ this.current_query = query; - if (debug) console.log("set_query, current_query is now -> " + this.current_query); + if (debug) + messages.debug("hazelnut.set_query, current_query is now -> " + this.current_query); + /* We check all necessary fields : in column editor I presume XXX */ // XXX ID naming has no plugin_uuid if (typeof(query.fields) != 'undefined') { $.each (query.fields, function(index, value) { - if (!$('#hazelnut-checkbox-' + o.plugin_uuid + "-" + value).attr('checked')) - $('#hazelnut-checkbox-' + o.plugin_uuid + "-" + value).attr('checked', true); + if (!$('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked')) + $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked', true); }); } - /*Process updates in filters / current_query must be updated before this call for filtering ! */ + + /* Process updates in filters / current_query must be updated before this call for filtering ! */ this.table.fnDraw(); /* @@ -216,16 +230,17 @@ } this.set_resources = function(resources, instance) { - if (debug) console.log("entering set_resources"); - var o = this.options; + if (debug) + messages.debug("entering hazelnut.set_resources"); + var options = this.options; var previous_resources = this.current_resources; this.current_resources = resources; /* We uncheck all checkboxes ... */ - $('hazelnut-checkbox-' + o.plugin_uuid).attr('checked', false); + $('hazelnut-checkbox-' + options.plugin_uuid).attr('checked', false); /* ... and check the ones specified in the resource list */ $.each(this.current_resources, function(index, urn) { - $('#hazelnut-checkbox-' + o.plugin_uuid + "-" + urn).attr('checked', true) + $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + urn).attr('checked', true) }); } @@ -245,7 +260,7 @@ * XXX will be removed/replaced */ this.selected_changed = function(e, change) { - if (debug) console.log("entering selected_changed"); + if (debug) messages.debug("entering hazelnut.selected_changed"); var actions = change.split("/"); if (actions.length > 1) { var oNodes = this.table.fnGetNodes(); @@ -266,90 +281,112 @@ } this.update_plugin = function(e, rows) { - if (debug) console.log("entering update_plugin"); - // e.data is what we passed in second argument to subscribe - // so here it is the jquery object attached to the plugin
- var $plugindiv=e.data; - // clear the spinning wheel: look up an ancestor that has the need-spin class - // do this before we might return - $plugindiv.closest('.need-spin').spin(false); + // e.data is what we passed in second argument to subscribe + // so here it is the jquery object attached to the plugin
+ var $plugindiv=e.data; + if (debug) messages.debug("entering hazelnut.update_plugin on id '" + $plugindiv.attr('id') + "'"); + // clear the spinning wheel: look up an ancestor that has the need-spin class + // do this before we might return + $plugindiv.closest('.need-spin').spin(false); var options = this.options; var hazelnut = this; + /* if we get no result, or an error, try to make that clear, and exit */ if (rows.length==0) { - this.table.html(errorDisplay("No Result")); + if (debug) messages.debug("Empty result on hazelnut " + this.options.domid); + var placeholder=$(this.table).find("td.dataTables_empty"); + console.log("placeholder "+placeholder); + if (placeholder.length==1) placeholder.html(unfold.warning("Empty result")); + else this.table.html(unfold.warning("Empty result")); + return; + } else if (typeof(rows[0].error) != 'undefined') { + // we now should have another means to report errors that this inline/embedded hack + if (debug) messages.error ("undefined result on " + this.options.domid + " - should not happen anymore"); + this.table.html(unfold.error(rows[0].error)); return; - } else { - if (typeof(rows[0].error) != 'undefined') { - this.table.html(errorDisplay(rows[0].error)); - return; - } } - newlines = new Array(); + + /* + * fill the dataTables object + * we cannot set html content directly here, need to use fnAddData + */ + var lines = new Array(); this.current_resources = Array(); - $.each(rows, function(index, obj) { - newline = new Array(); - + $.each(rows, function(index, row) { + // this models a line in dataTables, each element in the line describes a cell + line = new Array(); + // go through table headers to get column names we want // in order (we have temporarily hack some adjustments in names) var cols = hazelnut.table.fnSettings().aoColumns; var colnames = cols.map(function(x) {return x.sTitle}) - var nb_col = colnames.length; - if (options.checkboxes) - nb_col -= 1; + var nb_col = cols.length; + /* if we've requested checkboxes, then forget about the checkbox column for now */ + if (options.checkboxes) nb_col -= 1; + + /* fill in stuff depending on the column name */ for (var j = 0; j < nb_col; j++) { if (typeof colnames[j] == 'undefined') { - newline.push('...'); + line.push('...'); } else if (colnames[j] == 'hostname') { - if (obj['type'] == 'resource,link') + if (row['type'] == 'resource,link') //TODO: we need to add source/destination for links - newline.push(''); + line.push(''); else - newline.push(obj['hostname']); + line.push(row['hostname']); } else { - if (obj[colnames[j]]) - newline.push(obj[colnames[j]]); + if (row[colnames[j]]) + line.push(row[colnames[j]]); else - newline.push(''); + line.push(''); } } + /* catch up with the last column if checkboxes were requested */ if (options.checkboxes) { var checked = ''; - if (typeof(obj['sliver']) != 'undefined') { /* It is equal to null when is present */ + // xxx problem is, we don't get this 'sliver' thing set apparently + if (typeof(row['sliver']) != 'undefined') { /* It is equal to null when is present */ checked = 'checked '; - hazelnut.current_resources.push(obj['urn']); + hazelnut.current_resources.push(row['urn']); } // Use a key instead of hostname (hard coded...) - newline.push(hazelnut.checkbox(options.plugin_uuid, obj['urn'], obj['type'], checked, false)); + line.push(hazelnut.checkbox(options.plugin_uuid, row['urn'], row['type'], checked, false)); } - newlines.push(newline); - + lines.push(line); }); -// console.log ("end of each, newlines=" + newlines.length); - this.table.fnAddData(newlines); + this.table.fnClearTable(); + if (debug) messages.debug("hazelnut.update_plugin: total of " + lines.length + " rows"); + this.table.fnAddData(lines); -// console.log (" exiting update_plugin = "); }; this.checkbox = function (plugin_uuid, header, field, selected_str, disabled_str) { - var result=""; - /* Prefix id with plugin_uuid */ - result += "