X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=plugins%2Fhazelnut%2Fstatic%2Fjs%2Fhazelnut.js;h=f17eb258da2574a924e9f3adcfef5416168d0bc9;hb=3fb8170e3114c0845d95b35542a7bbfe84f7ac1b;hp=8cbc53703dc893a437d4046ec2060f957ecd9c5a;hpb=d1e5d12b2b9519801f7b981a2177b3f36115714a;p=myslice.git diff --git a/plugins/hazelnut/static/js/hazelnut.js b/plugins/hazelnut/static/js/hazelnut.js index 8cbc5370..f17eb258 100644 --- a/plugins/hazelnut/static/js/hazelnut.js +++ b/plugins/hazelnut/static/js/hazelnut.js @@ -1,115 +1,64 @@ /** * Description: display a query result in a datatables-powered - * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA + * Copyright (c) 2012-2013 UPMC Sorbonne Universite - INRIA * License: GPLv3 */ -/* - * It's a best practice to pass jQuery to an IIFE (Immediately Invoked Function - * Expression) that maps it to the dollar sign so it can't be overwritten by - * another library in the scope of its execution. - */ - -// TEMP -var ELEMENT_KEY = 'resource_hrn'; - (function($){ var debug=false; - debug=true +// debug=true - // routing calls - $.fn.Hazelnut = function( method ) { - 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.Hazelnut' ); - } - }; + var Hazelnut = Plugin.extend({ - /*************************************************************************** - * Public methods - ***************************************************************************/ + init: function(options, element) + { + this._super(options, element); - var methods = { + /* Member variables */ + // in general we expect 2 queries here + // query_uuid refers to a single object (typically a slice) + // query_all_uuid refers to a list (typically resources or users) + // these can return in any order so we keep track of which has been received yet + this.received_all_query = false; + this.received_query = false; - /** - * @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); - - /* An object that will hold private variables and methods */ - var plugin = new Hazelnut (options); - $this.data('Hazelnut', plugin); - - /* Events */ - $this.on('show.Datatables', methods.show); - - // This is the new plugin API meant to replace the weird publish_subscribe mechanism - $this.set_query_handler(options.query_uuid, plugin.query_handler); - $this.set_record_handler(options.query_uuid, plugin.record_handler); - $this.set_record_handler(options.query_all_uuid, plugin.record_handler_all); - -// /* Subscriptions */ -// var query_channel = '/query/' + options.query_uuid + '/changed'; -// var update_channel = '/update-set/' + options.query_uuid; -// var results_channel = '/results/' + options.query_uuid + '/changed'; -// -// // 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 + // an internal buffer for records that are 'in' and thus need to be checked + this.buffered_records_to_check = []; + // an internal buffer for keeping lines and display them in one call to fnAddData + this.buffered_lines = []; - /** - * @brief Plugin destruction - * @return : a jQuery collection of objects on which the plugin is - * applied, which allows to maintain chainability of calls - */ - destroy : function( ) { + /* XXX Events XXX */ + // this.$element.on('show.Datatables', this.on_show); + this.elmt().on('show', this, this.on_show); + // Unbind all events using namespacing + // TODO in destructor + // $(window).unbind('Hazelnut'); - return this.each(function() { - var $this = $(this); - var hazelnut = $this.data('Hazelnut'); + var query = manifold.query_store.find_analyzed_query(this.options.query_uuid); + this.method = query.object; - // Unbind all events using namespacing - $(window).unbind('Hazelnut'); + var keys = manifold.metadata.get_key(this.method); + this.key = (keys && keys.length == 1) ? keys[0] : null; - // Remove associated data - hazelnut.remove(); - $this.removeData('Hazelnut'); - }); - }, // destroy - - show : function( ) { - 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() + /* Setup query and record handlers */ + this.listen_query(options.query_uuid); + this.listen_query(options.query_all_uuid, 'all'); + + /* GUI setup and event binding */ + this.initialize_table(); + }, + + /* PLUGIN EVENTS */ + + on_show: function(e) + { + var self = e.data; + + self.table.fnAdjustColumnSizing() /* Refresh dataTabeles if click on the menu to display it : fix dataTables 1.9.x Bug */ + /* temp disabled... useful ? -- jordan $(this).each(function(i,elt) { if (jQuery(elt).hasClass('dataTables')) { var myDiv=jQuery('#hazelnut-' + this.id).parent(); @@ -119,39 +68,24 @@ var ELEMENT_KEY = 'resource_hrn'; } } }); - } // show - - }; // var methods; - - /*************************************************************************** - * Plugin object - ***************************************************************************/ + */ + }, // on_show - function Hazelnut(options) - { - /* member variables */ - this.options = options; + /* GUI EVENTS */ - // 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) messages.debug("Hazelnut constructor: have set current_query -> " + this.current_query.__repr()); - this.query_update = null; - this.current_resources = Array(); + /* GUI MANIPULATION */ - // query status - this.received_all = false; - this.received_set = false; - this.in_set_buffer = Array(); - - var object = this; - - this.initialize = function() { + initialize_table: function() + { /* Transforms the table into DataTable, and keep a pointer to it */ - actual_options = { + var self = this; + var actual_options = { // Customize the position of Datatables elements (length,filter,button,...) // 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>>", + sDom: "<'row'<'col-xs-5'l><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'p>>", + // XXX as of sept. 2013, I cannot locate a bootstrap3-friendly mode for now + // hopefully this would come with dataTables v1.10 ? + // in any case, search for 'sPaginationType' all over the code for more comments 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 @@ -159,279 +93,88 @@ var ELEMENT_KEY = 'resource_hrn'; // 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 */ - fnDrawCallback: function() { hazelnut_draw_callback.call(object, options); } + fnDrawCallback: function() { self._hazelnut_draw_callback.call(self); } + // XXX use $.proxy here ! }; // 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); + // xxx DISABLED by jordan: was causing errors in datatables.js + // xxx turned back on by Thierry - this is the code that takes python-provided options into account + // check your datatables_options tag instead + // however, we have to accumulate in aoColumnDefs from here (above) + // and from the python wrapper (checkboxes management, plus any user-provided aoColumnDefs) + if ( 'aoColumnDefs' in this.options.datatables_options) { + actual_options['aoColumnDefs']=this.options.datatables_options['aoColumnDefs'].concat(actual_options['aoColumnDefs']); + delete this.options.datatables_options['aoColumnDefs']; + } + $.extend(actual_options, this.options.datatables_options ); + this.table = this.elmt('table').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"); + var oSelectAll = $('#datatableSelectAll-'+ this.options.plugin_uuid); + oSelectAll.html("Select All"); oSelectAll.button(); oSelectAll.css('font-size','11px'); oSelectAll.css('float','right'); oSelectAll.css('margin-right','15px'); oSelectAll.css('margin-bottom','5px'); oSelectAll.unbind('click'); - oSelectAll.click(selectAll); + oSelectAll.click(this._selectAll); /* Add a filtering function to the current table * Note: we use closure to get access to the 'options' */ $.fn.dataTableExt.afnFiltering.push(function( oSettings, aData, iDataIndex ) { /* No filtering if the table does not match */ - if (oSettings.nTable.id != "hazelnut-" + options.plugin_uuid) + if (oSettings.nTable.id != "hazelnut-" + self.options.plugin_uuid) return true; - return hazelnut_filter.call(object, oSettings, aData, iDataIndex); + return this._hazelnut_filter.call(self, oSettings, aData, iDataIndex); }); /* Processing hidden_columns */ - $.each(options.hidden_columns, function(i, field) { - object.hide_column(field); + $.each(this.options.hidden_columns, function(i, field) { + self.hide_column(field); }); - } - - /* methods */ - -// DEPRECATED // this.set_query = function(query) { -// DEPRECATED // messages.info('hazelnut.set_query'); -// DEPRECATED // var options = this.options; -// DEPRECATED // /* Compare current and advertised query to get added and removed fields */ -// DEPRECATED // previous_query = this.current_query; -// DEPRECATED // /* Save the query as the current query */ -// DEPRECATED // this.current_query = query; -// DEPRECATED // if (debug) -// DEPRECATED // messages.debug("hazelnut.set_query, current_query is now -> " + this.current_query); -// DEPRECATED // -// DEPRECATED // /* We check all necessary fields : in column editor I presume XXX */ -// DEPRECATED // // XXX ID naming has no plugin_uuid -// DEPRECATED // if (typeof(query.fields) != 'undefined') { -// DEPRECATED // $.each (query.fields, function(index, value) { -// DEPRECATED // if (!$('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked')) -// DEPRECATED // $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked', true); -// DEPRECATED // }); -// DEPRECATED // } -// DEPRECATED // -// DEPRECATED // /* Process updates in filters / current_query must be updated before this call for filtering ! */ -// DEPRECATED // this.table.fnDraw(); -// DEPRECATED // -// DEPRECATED // /* -// DEPRECATED // * Process updates in fields -// DEPRECATED // */ -// DEPRECATED // if (typeof(query.fields) != 'undefined') { -// DEPRECATED // /* DataTable Settings */ -// DEPRECATED // var oSettings = this.table.dataTable().fnSettings(); -// DEPRECATED // var cols = oSettings.aoColumns; -// DEPRECATED // var colnames = cols.map(function(x) {return x.sTitle}); -// DEPRECATED // colnames = $.grep(colnames, function(value) {return value != "+/-";}); -// DEPRECATED // -// DEPRECATED // if (previous_query == null) { -// DEPRECATED // var added_fields = query.fields; -// DEPRECATED // var removed_fields = colnames; -// DEPRECATED // removed_fields = $.grep(colnames, function(x) { return $.inArray(x, added_fields) == -1}); -// DEPRECATED // } else { -// DEPRECATED // var tmp = previous_query.diff_fields(query); -// DEPRECATED // var added_fields = tmp.added; -// DEPRECATED // var removed_fields = tmp.removed; -// DEPRECATED // } -// DEPRECATED // -// DEPRECATED // /* Hide/unhide columns to match added/removed fields */ -// DEPRECATED // var object = this; -// DEPRECATED // $.each(added_fields, function (index, field) { -// DEPRECATED // var index = object.getColIndex(field,cols); -// DEPRECATED // if(index != -1) -// DEPRECATED // object.table.fnSetColumnVis(index, true); -// DEPRECATED // }); -// DEPRECATED // $.each(removed_fields, function (index, field) { -// DEPRECATED // var index = object.getColIndex(field,cols); -// DEPRECATED // if(index != -1) -// DEPRECATED // object.table.fnSetColumnVis(index, false); -// DEPRECATED // }); -// DEPRECATED // } -// DEPRECATED // } - -// DEPRECATED // this.set_resources = function(resources, instance) { -// DEPRECATED // if (debug) -// DEPRECATED // messages.debug("entering hazelnut.set_resources"); -// DEPRECATED // var options = this.options; -// DEPRECATED // var previous_resources = this.current_resources; -// DEPRECATED // this.current_resources = resources; -// DEPRECATED // -// DEPRECATED // /* We uncheck all checkboxes ... */ -// DEPRECATED // $('hazelnut-checkbox-' + options.plugin_uuid).attr('checked', false); -// DEPRECATED // /* ... and check the ones specified in the resource list */ -// DEPRECATED // $.each(this.current_resources, function(index, urn) { -// DEPRECATED // $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + urn).attr('checked', true) -// DEPRECATED // }); -// DEPRECATED // -// DEPRECATED // } + }, // initialize_table /** * @brief Determine index of key in the table columns * @param key * @param cols */ - this.getColIndex = function(key, cols) { + getColIndex: function(key, cols) { var tabIndex = $.map(cols, function(x, i) { if (x.sTitle == key) return i; }); return (tabIndex.length > 0) ? tabIndex[0] : -1; - }; - -// DEPRECATED // /** -// DEPRECATED // * @brief -// DEPRECATED // * XXX will be removed/replaced -// DEPRECATED // */ -// DEPRECATED // this.selected_changed = function(e, change) { -// DEPRECATED // if (debug) messages.debug("entering hazelnut.selected_changed"); -// DEPRECATED // var actions = change.split("/"); -// DEPRECATED // if (actions.length > 1) { -// DEPRECATED // var oNodes = this.table.fnGetNodes(); -// DEPRECATED // var myNode = $.grep(oNodes, function(value) { -// DEPRECATED // if (value.id == actions[1]) { return value; } -// DEPRECATED // }); -// DEPRECATED // if( myNode.length>0 ) { -// DEPRECATED // if ((actions[2]=="add" && actions[0]=="cancel") || actions[0]=="del") -// DEPRECATED // checked=''; -// DEPRECATED // else -// DEPRECATED // checked="checked='checked' "; -// DEPRECATED // var newValue = this.checkbox(actions[1], 'node', checked, false); -// DEPRECATED // var columnPos = this.table.fnSettings().aoColumns.length - 1; -// DEPRECATED // this.table.fnUpdate(newValue, myNode[0], columnPos); -// DEPRECATED // this.table.fnDraw(); -// DEPRECATED // } -// DEPRECATED // } -// DEPRECATED // } - - this.update_plugin = function(e, rows) { - // 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) { - 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; - } + }, // getColIndex - /* - * 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, 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 = object.table.fnSettings().aoColumns; - var colnames = cols.map(function(x) {return x.sTitle}) - 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') { - line.push('...'); - } else if (colnames[j] == 'hostname') { - if (row['type'] == 'resource,link') - //TODO: we need to add source/destination for links - line.push(''); - else - line.push(row['hostname']); - } else { - if (row[colnames[j]]) - line.push(row[colnames[j]]); - else - line.push(''); - } - } - - /* catch up with the last column if checkboxes were requested */ - if (options.checkboxes) { - var checked = ''; - // 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(row[ELEMENT_KEY]); - } - // Use a key instead of hostname (hard coded...) - line.push(hazelnut.checkbox(options.plugin_uuid, row[ELEMENT_KEY], row['type'], checked, false)); - } - - lines.push(line); - - }); - - this.table.fnClearTable(); - if (debug) - messages.debug("hazelnut.update_plugin: total of " + lines.length + " rows"); - this.table.fnAddData(lines); - - }; - - this.checkbox = function (plugin_uuid, header, field, selected_str, disabled_str) + checkbox_html : function (key, value) { var result=""; - if (header === null) - header = ''; // Prefix id with plugin_uuid result += " '+record['hrn']); } else { if (record[colnames[j]]) line.push(record[colnames[j]]); @@ -451,279 +197,337 @@ var ELEMENT_KEY = 'resource_hrn'; } } - /* catch up with the last column if checkboxes were requested */ - if (options.checkboxes) { - var checked = ''; - // xxx problem is, we don't get this 'sliver' thing set apparently - if (typeof(record['sliver']) != 'undefined') { /* It is equal to null when is present */ - checked = 'checked '; - hazelnut.current_resources.push(record[ELEMENT_KEY]); - } + // catch up with the last column if checkboxes were requested + if (this.options.checkboxes) { // Use a key instead of hostname (hard coded...) - line.push(object.checkbox(options.plugin_uuid, record[ELEMENT_KEY], record['type'], checked, false)); - } + line.push(this.checkbox_html(this.key, record[this.key])); + } - // XXX Is adding an array of lines more efficient ? - this.table.fnAddData(line); + // adding an array in one call is *much* more efficient + // this.table.fnAddData(line); + this.buffered_lines.push(line); - }; + }, - this.set_checkbox = function(record) + clear_table: function() { - // XXX urn should be replaced by the key - // XXX we should enforce that both queries have the same key !! - checkbox_id = "#hazelnut-checkbox-" + object.options.plugin_uuid + "-" + unfold.escape_id(record[ELEMENT_KEY].replace(/\\/g, '')) - $(checkbox_id, object.table.fnGetNodes()).attr('checked', true); - } + this.table.fnClearTable(); + }, - this.record_handler = function(e, event_type, record) + redraw_table: function() { - // elements in set - switch(event_type) { - case NEW_RECORD: - /* NOTE in fact we are doing a join here */ - if (object.received_all) - // update checkbox for record - object.set_checkbox(record); - else - // store for later update of checkboxes - object.in_set_buffer.push(record); - break; - case CLEAR_RECORDS: - // nothing to do here + this.table.fnDraw(); + }, + + show_column: function(field) + { + var oSettings = this.table.fnSettings(); + var cols = oSettings.aoColumns; + var index = this.getColIndex(field,cols); + if (index != -1) + this.table.fnSetColumnVis(index, true); + }, + + hide_column: function(field) + { + var oSettings = this.table.fnSettings(); + var cols = oSettings.aoColumns; + var index = this.getColIndex(field,cols); + if (index != -1) + this.table.fnSetColumnVis(index, false); + }, + + set_checkbox: function(record, checked) + { + /* Default: checked = true */ + if (checked === undefined) checked = true; + + var key_value; + /* The function accepts both records and their key */ + switch (manifold.get_type(record)) { + case TYPE_VALUE: + key_value = record; break; - case IN_PROGRESS: - manifold.spin($(this)); + case TYPE_RECORD: + /* XXX Test the key before ? */ + key_value = record[this.key]; break; - case DONE: - if (object.received_all) - manifold.spin($(this), false); - object.received_set = true; + default: + throw "Not implemented"; break; } - }; - this.record_handler_all = function(e, event_type, record) + + var checkbox_id = this.flat_id(this.id('checkbox', key_value)); + checkbox_id = '#' + checkbox_id; + // using dataTables's $ to search also in nodes that are not currently displayed + var element = this.table.$(checkbox_id); + if (debug) messages.debug("set_checkbox checked=" + checked + " id=" + checkbox_id + " matches=" + element.length); + element.attr('checked', checked); + }, + + /*************************** QUERY HANDLER ****************************/ + + on_filter_added: function(filter) { - // all elements - switch(event_type) { - case NEW_RECORD: - // Add the record to the table - object.new_record(record); - break; - case CLEAR_RECORDS: - object.table.fnClearTable(); - break; - case IN_PROGRESS: - manifold.spin($(this)); - break; - case DONE: - if (object.received_set) { - /* XXX needed ? XXX We uncheck all checkboxes ... */ - $("[id^='datatables-checkbox-" + object.options.plugin_uuid +"']").attr('checked', false); + // XXX + this.redraw_table(); + }, - /* ... and check the ones specified in the resource list */ - $.each(object.in_set_buffer, function(i, record) { - object.set_checkbox(record); - }); + on_filter_removed: function(filter) + { + // XXX + this.redraw_table(); + }, + + on_filter_clear: function() + { + // XXX + this.redraw_table(); + }, - manifold.spin($(this), false); - } - object.received_all = true; - break; - } - }; + on_field_added: function(field) + { + this.show_column(field); + }, - this.show_column = function(field) + on_field_removed: function(field) { - var oSettings = object.table.fnSettings(); - var cols = oSettings.aoColumns; - var index = object.getColIndex(field,cols); - if (index != -1) - object.table.fnSetColumnVis(index, true); - } + this.hide_column(field); + }, - this.hide_column = function(field) + on_field_clear: function() { - var oSettings = object.table.fnSettings(); - var cols = oSettings.aoColumns; - var index = object.getColIndex(field,cols); - if (index != -1) - object.table.fnSetColumnVis(index, false); - } + alert('Hazelnut::clear_fields() not implemented'); + }, - this.query_handler = function(e, event_type, data) + /*************************** RECORD HANDLER ***************************/ + + on_new_record: function(record) { - // This replaces the complex set_query function - // The plugin does not need to remember the query anymore - switch(event_type) { - // Filters - case FILTER_ADDED: - case FILTER_REMOVED: - case CLEAR_FILTERS: - // XXX Here we might need to maintain the list of filters ! - /* Process updates in filters / current_query must be updated before this call for filtering ! */ - object.table.fnDraw(); - break; + if (this.received_all_query) { + // if the 'all' query has been dealt with already we may turn on the checkbox + if (debug) messages.debug("turning on checkbox for record "+record[this.key]); + this.set_checkbox(record, true); + } else { + // otherwise we need to remember that and do it later on + if (debug) messages.debug ("Remembering record to check " + record[this.key]); + this.buffered_records_to_check.push(record); + } + }, + + on_clear_records: function() + { + }, + + // Could be the default in parent + on_query_in_progress: function() + { + this.spin(); + }, - // Fields - /* Hide/unhide columns to match added/removed fields */ - case FIELD_ADDED: - object.show_column(data); + on_query_done: function() + { + this.received_query = true; + // unspin once we have received both + if (this.received_all_query && this.received_query) this.unspin(); + }, + + on_field_state_changed: function(data) + { + switch(data.request) { + case FIELD_REQUEST_ADD: + case FIELD_REQUEST_ADD_RESET: + this.set_checkbox(data.value, true); break; - case FIELD_REMOVED: - object.hide_column(data); + case FIELD_REQUEST_REMOVE: + case FIELD_REQUEST_REMOVE_RESET: + this.set_checkbox(data.value, false); break; - case CLEAR_FIELDS: - alert('Hazelnut::clear_fields() not implemented'); + default: break; - } // switch + } + }, + + // all + on_all_new_record: function(record) + { + this.new_record(record); + }, - } + on_all_clear_records: function() + { + this.clear_table(); + + }, + + on_all_query_in_progress: function() + { + // XXX parent + this.spin(); + }, // on_all_query_in_progress - // Constructor - object.initialize(); + on_all_query_done: function() + { + if (debug) messages.debug("1-shot initializing dataTables content with " + this.buffered_lines.length + " lines"); + this.table.fnAddData (this.buffered_lines); + this.buffered_lines=[]; + + var self = this; + // if we've already received the slice query, we have not been able to set + // checkboxes on the fly at that time (dom not yet created) + $.each(this.buffered_records_to_check, function(i, record) { + if (debug) messages.debug ("delayed turning on checkbox " + i + " record= " + record); + self.set_checkbox(record, true); + }); + this.buffered_records_to_check = []; - } // constructor + this.received_all_query = true; + // unspin once we have received both + if (this.received_all_query && this.received_query) this.unspin(); - /*************************************************************************** - * Private methods - * xxx I'm not sure why this should not be methods in the Hazelnut class above - ***************************************************************************/ + }, // on_all_query_done - /** - * @brief Hazelnut filtering function - */ - function hazelnut_filter (oSettings, aData, iDataIndex) { - var cur_query = this.current_query; - if (!cur_query) return true; - var ret = true; + /************************** PRIVATE METHODS ***************************/ - /* We have an array of filters : a filter is an array (key op val) - * field names (unless shortcut) : oSettings.aoColumns = [ sTitle ] - * can we exploit the data property somewhere ? - * field values (unless formatting) : aData - * formatting should leave original data available in a hidden field - * - * The current line should validate all filters + /** + * @brief Hazelnut filtering function */ - $.each (cur_query.filters, function(index, filter) { - /* XXX How to manage checkbox ? */ - var key = filter[0]; - var op = filter[1]; - var value = filter[2]; + _hazelnut_filter: function(oSettings, aData, iDataIndex) + { + var cur_query = this.current_query; + if (!cur_query) return true; + var ret = true; + + /* We have an array of filters : a filter is an array (key op val) + * field names (unless shortcut) : oSettings.aoColumns = [ sTitle ] + * can we exploit the data property somewhere ? + * field values (unless formatting) : aData + * formatting should leave original data available in a hidden field + * + * The current line should validate all filters + */ + $.each (cur_query.filters, function(index, filter) { + /* XXX How to manage checkbox ? */ + var key = filter[0]; + var op = filter[1]; + var value = filter[2]; - /* Determine index of key in the table columns */ - var col = $.map(oSettings.aoColumns, function(x, i) {if (x.sTitle == key) return i;})[0]; + /* Determine index of key in the table columns */ + var col = $.map(oSettings.aoColumns, function(x, i) {if (x.sTitle == key) return i;})[0]; + + /* Unknown key: no filtering */ + if (typeof(col) == 'undefined') + return; + + col_value=unfold.get_value(aData[col]); + /* Test whether current filter is compatible with the column */ + if (op == '=' || op == '==') { + if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a") + ret = false; + }else if (op == '!=') { + if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a") + ret = false; + } else if(op=='<') { + if ( parseFloat(col_value) >= value || col_value==null || col_value=="" || col_value=="n/a") + ret = false; + } else if(op=='>') { + if ( parseFloat(col_value) <= value || col_value==null || col_value=="" || col_value=="n/a") + ret = false; + } else if(op=='<=' || op=='≤') { + if ( parseFloat(col_value) > value || col_value==null || col_value=="" || col_value=="n/a") + ret = false; + } else if(op=='>=' || op=='≥') { + if ( parseFloat(col_value) < value || col_value==null || col_value=="" || col_value=="n/a") + ret = false; + }else{ + // How to break out of a loop ? + alert("filter not supported"); + return false; + } - /* Unknown key: no filtering */ - if (typeof(col) == 'undefined') + }); + return ret; + }, + + _hazelnut_draw_callback: function() + { + /* + * Handle clicks on checkboxes: reassociate checkbox click every time + * the table is redrawn + */ + this.elts('hazelnut-checkbox').unbind('click').click(this, this._check_click); + + if (!this.table) return; - col_value=unfold.get_value(aData[col]); - /* Test whether current filter is compatible with the column */ - if (op == '=' || op == '==') { - if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a") - ret = false; - }else if (op == '!=') { - if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a") - ret = false; - } else if(op=='<') { - if ( parseFloat(col_value) >= value || col_value==null || col_value=="" || col_value=="n/a") - ret = false; - } else if(op=='>') { - if ( parseFloat(col_value) <= value || col_value==null || col_value=="" || col_value=="n/a") - ret = false; - } else if(op=='<=' || op=='≤') { - if ( parseFloat(col_value) > value || col_value==null || col_value=="" || col_value=="n/a") - ret = false; - } else if(op=='>=' || op=='≥') { - if ( parseFloat(col_value) < value || col_value==null || col_value=="" || col_value=="n/a") - ret = false; - }else{ - // How to break out of a loop ? - alert("filter not supported"); - return false; - } + /* Remove pagination if we show only a few results */ + var wrapper = this.table; //.parent().parent().parent(); + var rowsPerPage = this.table.fnSettings()._iDisplayLength; + var rowsToShow = this.table.fnSettings().fnRecordsDisplay(); + var minRowsPerPage = this.table.fnSettings().aLengthMenu[0]; - }); - return ret; - } + if ( rowsToShow <= rowsPerPage || rowsPerPage == -1 ) { + $('.hazelnut_paginate', wrapper).css('visibility', 'hidden'); + } else { + $('.hazelnut_paginate', wrapper).css('visibility', 'visible'); + } - function hazelnut_draw_callback() { - var options = this.options; - /* - * Handle clicks on checkboxes: reassociate checkbox click every time - * the table is redrawn - */ - $('.hazelnut-checkbox-' + options.plugin_uuid).unbind('click'); - $('.hazelnut-checkbox-' + options.plugin_uuid).click({instance: this}, check_click); - - if (!this.table) - return; - - /* Remove pagination if we show only a few results */ - var wrapper = this.table; //.parent().parent().parent(); - var rowsPerPage = this.table.fnSettings()._iDisplayLength; - var rowsToShow = this.table.fnSettings().fnRecordsDisplay(); - var minRowsPerPage = this.table.fnSettings().aLengthMenu[0]; - - if ( rowsToShow <= rowsPerPage || rowsPerPage == -1 ) { - $('.hazelnut_paginate', wrapper).css('visibility', 'hidden'); - } else { - $('.hazelnut_paginate', wrapper).css('visibility', 'visible'); - } - - if ( rowsToShow <= minRowsPerPage ) { - $('.hazelnut_length', wrapper).css('visibility', 'hidden'); - } else { - $('.hazelnut_length', wrapper).css('visibility', 'visible'); - } - } + if ( rowsToShow <= minRowsPerPage ) { + $('.hazelnut_length', wrapper).css('visibility', 'hidden'); + } else { + $('.hazelnut_length', wrapper).css('visibility', 'visible'); + } + }, - function check_click (e) { + _check_click: function(e) + { + e.stopPropagation(); - var object = e.data.instance; + var self = e.data; - /* The key of the object to be added */ - // XXX What about multiple keys ? - var value = this.value; + // XXX this.value = key of object to be added... what about multiple keys ? + if (debug) messages.debug("hazelnut click handler checked=" + this.checked + " hrn=" + this.value); + manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, this.value); + //return false; // prevent checkbox to be checked, waiting response from manifold plugin api + + }, - // NEW PLUGIN API - manifold.raise_event(object.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, value); - - // OLD PLUGIN API BELOW + _selectAll: function() + { + // requires jQuery id + var uuid=this.id.split("-"); + var oTable=$("#hazelnut-"+uuid[1]).dataTable(); + // Function available in Hazelnut 1.9.x + // Filter : displayed data only + var filterData = oTable._('tr', {"filter":"applied"}); + /* TODO: WARNING if too many nodes selected, use filters to reduce nuber of nodes */ + if(filterData.length<=100){ + $.each(filterData, function(index, obj) { + var last=$(obj).last(); + var key_value=unfold.get_value(last[0]); + if(typeof($(last[0]).attr('checked'))=="undefined"){ + $.publish('selected', 'add/'+key_value); + } + }); + } + }, - if (this.checked) { - object.current_resources.push(value); - } else { - tmp = $.grep(object.current_resources, function(x) { return x != value; }); - object.current_resources = tmp; - } + }); - /* inform slice that our selected resources have changed */ - $.publish('/update-set/' + object.options.query_uuid, [object.current_resources, true]); + $.plugin('Hazelnut', Hazelnut); + /* define the 'dom-checkbox' type for sorting in datatables + http://datatables.net/examples/plug-ins/dom_sort.html + using trial and error I found that the actual column number + was in fact given as a third argument, and not second + as the various online resources had it - go figure */ + $.fn.dataTableExt.afnSortData['dom-checkbox'] = function ( oSettings, _, iColumn ) { + return $.map( oSettings.oApi._fnGetTrNodes(oSettings), function (tr, i) { + return result=$('td:eq('+iColumn+') input', tr).prop('checked') ? '1' : '0'; + } ); } - function selectAll() { - // requires jQuery id - var uuid=this.id.split("-"); - var oTable=$("#hazelnut-"+uuid[1]).dataTable(); - // Function available in Hazelnut 1.9.x - // Filter : displayed data only - var filterData = oTable._('tr', {"filter":"applied"}); - /* TODO: WARNING if too many nodes selected, use filters to reduce nuber of nodes */ - if(filterData.length<=100){ - $.each(filterData, function(index, obj) { - var last=$(obj).last(); - var key_value=unfold.get_value(last[0]); - if(typeof($(last[0]).attr('checked'))=="undefined"){ - $.publish('selected', 'add/'+key_value); - } - }); - } - } - -})( jQuery ); +})(jQuery); +