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) {
15 this.classname="querytable";
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 // xx somehow non of these triggers at all for now
36 this.elmt().on('show', this, this.on_show);
37 this.elmt().on('shown.bs.tab', this, this.on_show);
38 this.elmt().on('resize', this, this.on_resize);
40 var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
41 this.object = query.object;
43 //// we need 2 different keys
44 // * canonical_key is the primary key as derived from metadata (typically: urn)
45 // and is used to communicate about a given record with the other plugins
46 // * init_key is a key that both kinds of records
47 // (i.e. records returned by both queries) must have (typically: hrn or hostname)
48 // in general query_all will return well populated records, but query
49 // returns records with only the fields displayed on startup
50 var keys = manifold.metadata.get_key(this.object);
51 this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
53 this.init_key = this.options.init_key;
54 // have init_key default to canonical_key
55 this.init_key = this.init_key || this.canonical_key;
57 if ( ! this.init_key ) messages.warning ("QueryTable : cannot find init_key");
58 if ( ! this.canonical_key ) messages.warning ("QueryTable : cannot find canonical_key");
59 if (debug) messages.debug("querytable: canonical_key="+this.canonical_key+" init_key="+this.init_key);
61 /* Setup query and record handlers */
62 this.listen_query(options.query_uuid);
63 this.listen_query(options.query_all_uuid, 'all');
65 /* GUI setup and event binding */
66 this.initialize_table();
71 on_show: function(e) {
72 if (debug) messages.debug("querytable.on_show");
74 self.table.fnAdjustColumnSizing();
77 on_resize: function(e) {
78 if (debug) messages.debug("querytable.on_resize");
80 self.table.fnAdjustColumnSizing();
85 /* GUI MANIPULATION */
87 initialize_table: function()
89 /* Transforms the table into DataTable, and keep a pointer to it */
91 var actual_options = {
92 // Customize the position of Datatables elements (length,filter,button,...)
93 // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time
94 sDom: "<'row'<'col-xs-5'l><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'p>>",
95 // XXX as of sept. 2013, I cannot locate a bootstrap3-friendly mode for now
96 // hopefully this would come with dataTables v1.10 ?
97 // in any case, search for 'sPaginationType' all over the code for more comments
98 sPaginationType: 'bootstrap',
99 // Handle the null values & the error : Datatables warning Requested unknown parameter
100 // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2
101 aoColumnDefs: [{sDefaultContent: '',aTargets: [ '_all' ]}],
102 // WARNING: this one causes tables in a 'tabs' that are not exposed at the time this is run to show up empty
103 // sScrollX: '100%', /* Horizontal scrolling */
104 bProcessing: true, /* Loading */
105 fnDrawCallback: function() { self._querytable_draw_callback.call(self); }
106 // XXX use $.proxy here !
108 // the intention here is that options.datatables_options as coming from the python object take precedence
109 // xxx DISABLED by jordan: was causing errors in datatables.js
110 // xxx turned back on by Thierry - this is the code that takes python-provided options into account
111 // check your datatables_options tag instead
112 // however, we have to accumulate in aoColumnDefs from here (above)
113 // and from the python wrapper (checkboxes management, plus any user-provided aoColumnDefs)
114 if ( 'aoColumnDefs' in this.options.datatables_options) {
115 actual_options['aoColumnDefs']=this.options.datatables_options['aoColumnDefs'].concat(actual_options['aoColumnDefs']);
116 delete this.options.datatables_options['aoColumnDefs'];
118 $.extend(actual_options, this.options.datatables_options );
119 this.table = this.elmt('table').dataTable(actual_options);
121 /* Setup the SelectAll button in the dataTable header */
122 /* xxx not sure this is still working */
123 var oSelectAll = $('#datatableSelectAll-'+ this.options.plugin_uuid);
124 oSelectAll.html("<span class='glyphicon glyphicon-ok' style='float:right;display:inline-block;'></span>Select All");
126 oSelectAll.css('font-size','11px');
127 oSelectAll.css('float','right');
128 oSelectAll.css('margin-right','15px');
129 oSelectAll.css('margin-bottom','5px');
130 oSelectAll.unbind('click');
131 oSelectAll.click(this._selectAll);
133 /* Add a filtering function to the current table
134 * Note: we use closure to get access to the 'options'
136 $.fn.dataTableExt.afnFiltering.push(function( oSettings, aData, iDataIndex ) {
137 /* No filtering if the table does not match */
138 if (oSettings.nTable.id != self.options.plugin_uuid + '__table')
140 return self._querytable_filter.call(self, oSettings, aData, iDataIndex);
143 /* Processing hidden_columns */
144 $.each(this.options.hidden_columns, function(i, field) {
145 //manifold.raise_event(self.options.query_all_uuid, FIELD_REMOVED, field);
146 self.hide_column(field);
148 }, // initialize_table
151 * @brief Determine index of key in the table columns
155 getColIndex: function(key, cols) {
156 var tabIndex = $.map(cols, function(x, i) { if (x.sTitle == key) return i; });
157 return (tabIndex.length > 0) ? tabIndex[0] : -1;
160 // create a checkbox <input> tag
161 // computes 'id' attribute from canonical_key
162 // computes 'init_id' from init_key for initialization phase
163 // no need to used convoluted ids with plugin-uuid or others, since
164 // we search using table.$ which looks only in this table
165 checkbox_html : function (record) {
167 // Prefix id with plugin_uuid
169 result += " class='querytable-checkbox'";
170 // compute id from canonical_key
171 var id = record[this.canonical_key]
172 // compute init_id form init_key
173 var init_id=record[this.init_key];
174 // set id - for retrieving from an id, or for posting events upon user's clicks
175 result += " id='"+record[this.canonical_key]+"'";
177 result += "init_id='" + init_id + "'";
179 result += " type='checkbox'";
180 result += " autocomplete='off'";
181 result += "></input>";
186 new_record: function(record)
188 // this models a line in dataTables, each element in the line describes a cell
191 // go through table headers to get column names we want
192 // in order (we have temporarily hack some adjustments in names)
193 var cols = this.table.fnSettings().aoColumns;
194 var colnames = cols.map(function(x) {return x.sTitle})
195 var nb_col = cols.length;
196 /* if we've requested checkboxes, then forget about the checkbox column for now */
197 if (this.options.checkboxes) nb_col -= 1;
199 /* fill in stuff depending on the column name */
200 for (var j = 0; j < nb_col; j++) {
201 if (typeof colnames[j] == 'undefined') {
203 } else if (colnames[j] == 'hostname') {
204 if (record['type'] == 'resource,link')
205 //TODO: we need to add source/destination for links
208 line.push(record['hostname']);
210 } else if (colnames[j] == this.init_key && typeof(record) != 'undefined') {
218 /* XXX TODO: Remove this and have something consistant */
220 line.push('<a href="../'+obj+'/'+record['urn']+'"><span class="glyphicon glyphicon-search"></span></a> '+record[this.init_key]);
222 line.push('<a href="../'+obj+'/'+record[this.init_key]+'"><span class="glyphicon glyphicon-search"></span></a> '+record[this.init_key]);
225 if (record[colnames[j]])
226 line.push(record[colnames[j]]);
232 // catch up with the last column if checkboxes were requested
233 if (this.options.checkboxes) {
234 // Use a key instead of hostname (hard coded...)
235 line.push(this.checkbox_html(record));
238 // adding an array in one call is *much* more efficient
239 // this.table.fnAddData(line);
240 this.buffered_lines.push(line);
243 clear_table: function()
245 this.table.fnClearTable();
248 redraw_table: function()
253 show_column: function(field)
255 var oSettings = this.table.fnSettings();
256 var cols = oSettings.aoColumns;
257 var index = this.getColIndex(field,cols);
259 this.table.fnSetColumnVis(index, true);
262 hide_column: function(field)
264 var oSettings = this.table.fnSettings();
265 var cols = oSettings.aoColumns;
266 var index = this.getColIndex(field,cols);
268 this.table.fnSetColumnVis(index, false);
271 // this is used at init-time, at which point only init_key can make sense
272 // (because the argument record, if it comes from query, might not have canonical_key set
273 set_checkbox_from_record: function (record, checked) {
274 if (checked === undefined) checked = true;
275 var init_id = record[this.init_key];
276 if (debug) messages.debug("querytable.set_checkbox_from_record, init_id="+init_id);
277 // using table.$ to search inside elements that are not visible
278 var element = this.table.$('[init_id="'+init_id+'"]');
279 element.attr('checked',checked);
282 // id relates to canonical_key
283 set_checkbox_from_data: function (id, checked) {
284 if (checked === undefined) checked = true;
285 if (debug) messages.debug("querytable.set_checkbox_from_data, id="+id);
286 // using table.$ to search inside elements that are not visible
287 var element = this.table.$("[id='"+id+"']");
288 element.attr('checked',checked);
291 /*************************** QUERY HANDLER ****************************/
293 on_filter_added: function(filter)
295 this.filters.push(filter);
299 on_filter_removed: function(filter)
301 // Remove corresponding filters
302 this.filters = $.grep(this.filters, function(x) {
308 on_filter_clear: function()
314 on_field_added: function(field)
316 this.show_column(field);
319 on_field_removed: function(field)
321 this.hide_column(field);
324 on_field_clear: function()
326 alert('QueryTable::clear_fields() not implemented');
329 /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
330 /*************************** ALL QUERY HANDLER ****************************/
332 on_all_filter_added: function(filter)
338 on_all_filter_removed: function(filter)
344 on_all_filter_clear: function()
350 on_all_field_added: function(field)
352 this.show_column(field);
355 on_all_field_removed: function(field)
357 this.hide_column(field);
360 on_all_field_clear: function()
362 alert('QueryTable::clear_fields() not implemented');
366 /*************************** RECORD HANDLER ***************************/
368 on_new_record: function(record)
370 if (this.received_all_query) {
371 // if the 'all' query has been dealt with already we may turn on the checkbox
372 this.set_checkbox_from_record(record, true);
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_checkbox_from_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 ("querytable 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';