2 * Description: display a query result in a datatables-powered <table>
3 * Copyright (c) 2012-2013 UPMC Sorbonne Universite - INRIA
12 var QueryTable = Plugin.extend({
14 init: function(options, element)
16 this._super(options, element);
18 /* Member variables */
19 // in general we expect 2 queries here
20 // query_uuid refers to a single object (typically a slice)
21 // query_all_uuid refers to a list (typically resources or users)
22 // these can return in any order so we keep track of which has been received yet
23 this.received_all_query = false;
24 this.received_query = false;
26 // We need to remember the active filter for datatables filtering
27 this.filters = Array();
29 // an internal buffer for records that are 'in' and thus need to be checked
30 this.buffered_records_to_check = [];
31 // an internal buffer for keeping lines and display them in one call to fnAddData
32 this.buffered_lines = [];
35 // this.$element.on('show.Datatables', this.on_show);
36 this.elmt().on('show', this, this.on_show);
37 // Unbind all events using namespacing
39 // $(window).unbind('QueryTable');
41 var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
42 this.object = query.object;
44 //// we need 2 different keys
45 // * canonical_key is the primary key as derived from metadata (typically: urn)
46 // and is used to communicate about a given record with the other plugins
47 // * init_key is a key that both kinds of records
48 // (i.e. records returned by both queries) must have (typically: hrn or hostname)
49 // in general query_all will return well populated records, but query
50 // returns records with only the fields displayed on startup
51 var keys = manifold.metadata.get_key(this.object);
52 this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
54 this.init_key = this.options.init_key;
55 // have init_key default to canonical_key
56 this.init_key = this.init_key || this.canonical_key;
58 if ( ! this.init_key ) messages.warning ("QueryTable : cannot find init_key");
59 if ( ! this.canonical_key ) messages.warning ("QueryTable : cannot find canonical_key");
60 if (debug) messages.debug("querytable: canonical_key="+this.canonical_key+" init_key="+this.init_key);
62 /* Setup query and record handlers */
63 this.listen_query(options.query_uuid);
64 this.listen_query(options.query_all_uuid, 'all');
66 /* GUI setup and event binding */
67 this.initialize_table();
76 self.table.fnAdjustColumnSizing()
78 /* Refresh dataTabeles if click on the menu to display it : fix dataTables 1.9.x Bug */
79 /* temp disabled... useful ? -- jordan
80 $(this).each(function(i,elt) {
81 if (jQuery(elt).hasClass('dataTables')) {
82 var myDiv=jQuery('#querytable-' + this.id).parent();
83 if(myDiv.height()==0) {
84 var oTable=$('#querytable-' + this.id).dataTable();
94 /* GUI MANIPULATION */
96 initialize_table: function()
98 /* Transforms the table into DataTable, and keep a pointer to it */
100 var actual_options = {
101 // Customize the position of Datatables elements (length,filter,button,...)
102 // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time
103 sDom: "<'row'<'col-xs-5'l><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'p>>",
104 // XXX as of sept. 2013, I cannot locate a bootstrap3-friendly mode for now
105 // hopefully this would come with dataTables v1.10 ?
106 // in any case, search for 'sPaginationType' all over the code for more comments
107 sPaginationType: 'bootstrap',
108 // Handle the null values & the error : Datatables warning Requested unknown parameter
109 // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2
110 aoColumnDefs: [{sDefaultContent: '',aTargets: [ '_all' ]}],
111 // WARNING: this one causes tables in a 'tabs' that are not exposed at the time this is run to show up empty
112 // sScrollX: '100%', /* Horizontal scrolling */
113 bProcessing: true, /* Loading */
114 fnDrawCallback: function() { self._querytable_draw_callback.call(self); }
115 // XXX use $.proxy here !
117 // the intention here is that options.datatables_options as coming from the python object take precedence
118 // xxx DISABLED by jordan: was causing errors in datatables.js
119 // xxx turned back on by Thierry - this is the code that takes python-provided options into account
120 // check your datatables_options tag instead
121 // however, we have to accumulate in aoColumnDefs from here (above)
122 // and from the python wrapper (checkboxes management, plus any user-provided aoColumnDefs)
123 if ( 'aoColumnDefs' in this.options.datatables_options) {
124 actual_options['aoColumnDefs']=this.options.datatables_options['aoColumnDefs'].concat(actual_options['aoColumnDefs']);
125 delete this.options.datatables_options['aoColumnDefs'];
127 $.extend(actual_options, this.options.datatables_options );
128 this.table = this.elmt('table').dataTable(actual_options);
130 /* Setup the SelectAll button in the dataTable header */
131 /* xxx not sure this is still working */
132 var oSelectAll = $('#datatableSelectAll-'+ this.options.plugin_uuid);
133 oSelectAll.html("<span class='glyphicon glyphicon-ok' style='float:right;display:inline-block;'></span>Select All");
135 oSelectAll.css('font-size','11px');
136 oSelectAll.css('float','right');
137 oSelectAll.css('margin-right','15px');
138 oSelectAll.css('margin-bottom','5px');
139 oSelectAll.unbind('click');
140 oSelectAll.click(this._selectAll);
142 /* Add a filtering function to the current table
143 * Note: we use closure to get access to the 'options'
145 $.fn.dataTableExt.afnFiltering.push(function( oSettings, aData, iDataIndex ) {
146 /* No filtering if the table does not match */
147 if (oSettings.nTable.id != self.options.plugin_uuid + '__table')
149 return self._querytable_filter.call(self, oSettings, aData, iDataIndex);
152 /* Processing hidden_columns */
153 $.each(this.options.hidden_columns, function(i, field) {
154 //manifold.raise_event(self.options.query_all_uuid, FIELD_REMOVED, field);
155 self.hide_column(field);
157 }, // initialize_table
160 * @brief Determine index of key in the table columns
164 getColIndex: function(key, cols) {
165 var tabIndex = $.map(cols, function(x, i) { if (x.sTitle == key) return i; });
166 return (tabIndex.length > 0) ? tabIndex[0] : -1;
169 // create a checkbox <input> tag
170 // computes 'id' attribute from canonical_key
171 // computes 'init_id' from init_key for initialization phase
172 // no need to used convoluted ids with plugin-uuid or others, since
173 // we search using table.$ which looks only in this table
174 checkbox_html : function (record) {
176 // Prefix id with plugin_uuid
178 result += " class='querytable-checkbox'";
179 // compute id from canonical_key
180 var id = record[this.canonical_key]
181 // if (debug) messages.debug("checkbox_html, id="+id);
182 // compute init_id form init_key
183 var init_id=record[this.init_key];
184 // set id - for retrieving from an id, or for posting events upon user's clicks
185 result += " id='"+record[this.canonical_key]+"'";
187 result += "init_id='" + init_id + "'";
189 result += " type='checkbox'";
190 result += " autocomplete='off'";
191 result += "></input>";
196 new_record: function(record)
198 // this models a line in dataTables, each element in the line describes a cell
201 // go through table headers to get column names we want
202 // in order (we have temporarily hack some adjustments in names)
203 var cols = this.table.fnSettings().aoColumns;
204 var colnames = cols.map(function(x) {return x.sTitle})
205 var nb_col = cols.length;
206 /* if we've requested checkboxes, then forget about the checkbox column for now */
207 if (this.options.checkboxes) nb_col -= 1;
209 /* fill in stuff depending on the column name */
210 for (var j = 0; j < nb_col; j++) {
211 if (typeof colnames[j] == 'undefined') {
213 } else if (colnames[j] == 'hostname') {
214 if (record['type'] == 'resource,link')
215 //TODO: we need to add source/destination for links
218 line.push(record['hostname']);
220 } else if (colnames[j] == 'hrn' && typeof(record) != 'undefined') {
221 line.push('<a href="../resource/'+record['urn']+'"><span class="glyphicon glyphicon-search"></span></a> '+record['hrn']);
223 if (record[colnames[j]])
224 line.push(record[colnames[j]]);
230 // catch up with the last column if checkboxes were requested
231 if (this.options.checkboxes) {
232 // Use a key instead of hostname (hard coded...)
233 line.push(this.checkbox_html(record));
236 // adding an array in one call is *much* more efficient
237 // this.table.fnAddData(line);
238 this.buffered_lines.push(line);
241 clear_table: function()
243 this.table.fnClearTable();
246 redraw_table: function()
251 show_column: function(field)
253 var oSettings = this.table.fnSettings();
254 var cols = oSettings.aoColumns;
255 var index = this.getColIndex(field,cols);
257 this.table.fnSetColumnVis(index, true);
260 hide_column: function(field)
262 var oSettings = this.table.fnSettings();
263 var cols = oSettings.aoColumns;
264 var index = this.getColIndex(field,cols);
266 this.table.fnSetColumnVis(index, false);
269 // this is used at init-time, at which point only init_key can make sense
270 // (because the argument record, if it comes from query, might not have canonical_key set
271 set_checkbox_from_record: function (record, checked) {
272 if (checked === undefined) checked = true;
273 var init_id = record[this.init_key];
274 if (debug) messages.debug("set_checkbox_from_record, init_id="+init_id);
275 // using table.$ to search inside elements that are not visible
276 var element = this.table.$('[init_id="'+init_id+'"]');
277 element.attr('checked',checked);
280 // id relates to canonical_key
281 set_checkbox_from_data: function (id, checked) {
282 if (checked === undefined) checked = true;
283 if (debug) messages.debug("set_checkbox_from_data, id="+id);
284 // using table.$ to search inside elements that are not visible
285 var element = this.table.$("[id='"+id+"']");
286 element.attr('checked',checked);
289 /*************************** QUERY HANDLER ****************************/
291 on_filter_added: function(filter)
293 this.filters.push(filter);
297 on_filter_removed: function(filter)
299 // Remove corresponding filters
300 this.filters = $.grep(this.filters, function(x) {
306 on_filter_clear: function()
312 on_field_added: function(field)
314 this.show_column(field);
317 on_field_removed: function(field)
319 this.hide_column(field);
322 on_field_clear: function()
324 alert('QueryTable::clear_fields() not implemented');
327 /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
328 /*************************** ALL QUERY HANDLER ****************************/
330 on_all_filter_added: function(filter)
336 on_all_filter_removed: function(filter)
342 on_all_filter_clear: function()
348 on_all_field_added: function(field)
350 this.show_column(field);
353 on_all_field_removed: function(field)
355 this.hide_column(field);
358 on_all_field_clear: function()
360 alert('QueryTable::clear_fields() not implemented');
364 /*************************** RECORD HANDLER ***************************/
366 on_new_record: function(record)
368 if (this.received_all_query) {
369 // if the 'all' query has been dealt with already we may turn on the checkbox
370 this.set_checkbox_from_record(record, true);
372 // otherwise we need to remember that and do it later on
373 if (debug) messages.debug("Remembering record to check " + record[this.init_key]);
374 this.buffered_records_to_check.push(record);
378 on_clear_records: function()
382 // Could be the default in parent
383 on_query_in_progress: function()
388 on_query_done: function()
390 this.received_query = true;
391 // unspin once we have received both
392 if (this.received_all_query && this.received_query) this.unspin();
395 on_field_state_changed: function(data)
397 switch(data.request) {
398 case FIELD_REQUEST_ADD:
399 case FIELD_REQUEST_ADD_RESET:
400 this.set_checkbox_from_data(data.value, true);
402 case FIELD_REQUEST_REMOVE:
403 case FIELD_REQUEST_REMOVE_RESET:
404 this.set_checkbox_from_data(data.value, false);
411 /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
413 on_all_field_state_changed: function(data)
415 switch(data.request) {
416 case FIELD_REQUEST_ADD:
417 case FIELD_REQUEST_ADD_RESET:
418 this.set_checkboxfrom_data(data.value, true);
420 case FIELD_REQUEST_REMOVE:
421 case FIELD_REQUEST_REMOVE_RESET:
422 this.set_checkbox_from_data(data.value, false);
429 on_all_new_record: function(record)
431 this.new_record(record);
434 on_all_clear_records: function()
440 on_all_query_in_progress: function()
444 }, // on_all_query_in_progress
446 on_all_query_done: function()
448 if (debug) messages.debug("1-shot initializing dataTables content with " + this.buffered_lines.length + " lines");
449 this.table.fnAddData (this.buffered_lines);
450 this.buffered_lines=[];
453 // if we've already received the slice query, we have not been able to set
454 // checkboxes on the fly at that time (dom not yet created)
455 $.each(this.buffered_records_to_check, function(i, record) {
456 if (debug) messages.debug ("delayed turning on checkbox " + i + " record= " + record);
457 self.set_checkbox_from_record(record, true);
459 this.buffered_records_to_check = [];
461 this.received_all_query = true;
462 // unspin once we have received both
463 if (this.received_all_query && this.received_query) this.unspin();
465 }, // on_all_query_done
467 /************************** PRIVATE METHODS ***************************/
470 * @brief QueryTable filtering function
472 _querytable_filter: function(oSettings, aData, iDataIndex)
475 $.each (this.filters, function(index, filter) {
476 /* XXX How to manage checkbox ? */
479 var value = filter[2];
481 /* Determine index of key in the table columns */
482 var col = $.map(oSettings.aoColumns, function(x, i) {if (x.sTitle == key) return i;})[0];
484 /* Unknown key: no filtering */
485 if (typeof(col) == 'undefined')
488 col_value=unfold.get_value(aData[col]);
489 /* Test whether current filter is compatible with the column */
490 if (op == '=' || op == '==') {
491 if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a")
493 }else if (op == '!=') {
494 if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a")
497 if ( parseFloat(col_value) >= value || col_value==null || col_value=="" || col_value=="n/a")
500 if ( parseFloat(col_value) <= value || col_value==null || col_value=="" || col_value=="n/a")
502 } else if(op=='<=' || op=='≤') {
503 if ( parseFloat(col_value) > value || col_value==null || col_value=="" || col_value=="n/a")
505 } else if(op=='>=' || op=='≥') {
506 if ( parseFloat(col_value) < value || col_value==null || col_value=="" || col_value=="n/a")
509 // How to break out of a loop ?
510 alert("filter not supported");
518 _querytable_draw_callback: function()
521 * Handle clicks on checkboxes: reassociate checkbox click every time
522 * the table is redrawn
524 this.elts('querytable-checkbox').unbind('click').click(this, this._check_click);
529 /* Remove pagination if we show only a few results */
530 var wrapper = this.table; //.parent().parent().parent();
531 var rowsPerPage = this.table.fnSettings()._iDisplayLength;
532 var rowsToShow = this.table.fnSettings().fnRecordsDisplay();
533 var minRowsPerPage = this.table.fnSettings().aLengthMenu[0];
535 if ( rowsToShow <= rowsPerPage || rowsPerPage == -1 ) {
536 $('.querytable_paginate', wrapper).css('visibility', 'hidden');
538 $('.querytable_paginate', wrapper).css('visibility', 'visible');
541 if ( rowsToShow <= minRowsPerPage ) {
542 $('.querytable_length', wrapper).css('visibility', 'hidden');
544 $('.querytable_length', wrapper).css('visibility', 'visible');
548 _check_click: function(e)
555 // this.id = key of object to be added... what about multiple keys ?
556 if (debug) messages.debug("querytable._check_click key="+this.canonical_key+"->"+id+" checked="+this.checked);
557 manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, id);
558 //return false; // prevent checkbox to be checked, waiting response from manifold plugin api
562 _selectAll: function()
564 // requires jQuery id
565 var uuid=this.id.split("-");
566 var oTable=$("#querytable-"+uuid[1]).dataTable();
567 // Function available in QueryTable 1.9.x
568 // Filter : displayed data only
569 var filterData = oTable._('tr', {"filter":"applied"});
570 /* TODO: WARNING if too many nodes selected, use filters to reduce nuber of nodes */
571 if(filterData.length<=100){
572 $.each(filterData, function(index, obj) {
573 var last=$(obj).last();
574 var key_value=unfold.get_value(last[0]);
575 if(typeof($(last[0]).attr('checked'))=="undefined"){
576 $.publish('selected', 'add/'+key_value);
584 $.plugin('QueryTable', QueryTable);
586 /* define the 'dom-checkbox' type for sorting in datatables
587 http://datatables.net/examples/plug-ins/dom_sort.html
588 using trial and error I found that the actual column number
589 was in fact given as a third argument, and not second
590 as the various online resources had it - go figure */
591 $.fn.dataTableExt.afnSortData['dom-checkbox'] = function ( oSettings, _, iColumn ) {
592 return $.map( oSettings.oApi._fnGetTrNodes(oSettings), function (tr, i) {
593 return result=$('td:eq('+iColumn+') input', tr).prop('checked') ? '1' : '0';