* License: GPLv3
*/
+BGCOLOR_RESET = 0;
+BGCOLOR_ADDED = 1;
+BGCOLOR_REMOVED = 2;
+
(function($){
var debug=false;
var QueryTable = Plugin.extend({
- init: function(options, element)
- {
+ init: function(options, element) {
+ this.classname="querytable";
this._super(options, element);
/* Member variables */
// an internal buffer for keeping lines and display them in one call to fnAddData
this.buffered_lines = [];
- /* XXX Events XXX */
- // this.$element.on('show.Datatables', this.on_show);
+ /* Events */
+ // xx somehow non of these triggers at all for now
this.elmt().on('show', this, this.on_show);
- // Unbind all events using namespacing
- // TODO in destructor
- // $(window).unbind('QueryTable');
+ this.elmt().on('shown.bs.tab', this, this.on_show);
+ this.elmt().on('resize', this, this.on_resize);
var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
- this.method = query.object;
-
- var keys = manifold.metadata.get_key(this.method);
- this.key = (keys && keys.length == 1) ? keys[0] : null;
+ this.object = query.object;
+
+ //// we need 2 different keys
+ // * canonical_key is the primary key as derived from metadata (typically: urn)
+ // and is used to communicate about a given record with the other plugins
+ // * init_key is a key that both kinds of records
+ // (i.e. records returned by both queries) must have (typically: hrn or hostname)
+ // in general query_all will return well populated records, but query
+ // returns records with only the fields displayed on startup
+ var keys = manifold.metadata.get_key(this.object);
+ this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
+ //
+ this.init_key = this.options.init_key;
+ // have init_key default to canonical_key
+ this.init_key = this.init_key || this.canonical_key;
+ // sanity check
+ if ( ! this.init_key ) messages.warning ("QueryTable : cannot find init_key");
+ if ( ! this.canonical_key ) messages.warning ("QueryTable : cannot find canonical_key");
+ if (debug) messages.debug("querytable: canonical_key="+this.canonical_key+" init_key="+this.init_key);
/* Setup query and record handlers */
this.listen_query(options.query_uuid);
- this.listen_query(options.query_all_uuid, 'all');
+ //this.listen_query(options.query_all_uuid, 'all');
/* GUI setup and event binding */
this.initialize_table();
/* PLUGIN EVENTS */
- on_show: function(e)
- {
+ on_show: function(e) {
+ if (debug) messages.debug("querytable.on_show");
var self = e.data;
+ self.table.fnAdjustColumnSizing();
+ },
- 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('#querytable-' + this.id).parent();
- if(myDiv.height()==0) {
- var oTable=$('#querytable-' + this.id).dataTable();
- oTable.fnDraw();
- }
- }
- });
- */
- }, // on_show
+ on_resize: function(e) {
+ if (debug) messages.debug("querytable.on_resize");
+ var self = e.data;
+ self.table.fnAdjustColumnSizing();
+ },
/* GUI EVENTS */
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'<'col-xs-5'l><'col-xs-1'r><'col-xs-6'f>>t<'row'<'col-xs-5'i><'col-xs-7'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>>",
+ sDom: "<'row'<'col-xs-5'f><'col-xs-1'r><'col-xs-6 columns_selector'>>t<'row'<'col-xs-5'l><'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
// 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() { self._querytable_draw_callback.call(self); }
+ fnDrawCallback: function() { self._querytable_draw_callback.call(self); },
+ fnRowCallback: function( nRow, aData, iDisplayIndex, iDisplayIndexFull ) {
+ // This function is called on fnAddData to set the TR id. What about fnUpdate ?
+
+ // Get the key from the raw data array aData
+ var key = self.canonical_key;
+
+ // Get the index of the key in the columns
+ var cols = self.table.fnSettings().aoColumns;
+ var index = self.getColIndex(key, cols);
+ if (index != -1) {
+ // The key is found in the table, set the TR id after the data
+ $(nRow).attr('id', self.id_from_key(key, aData[index]));
+ }
+
+ // That's the usual return value
+ return nRow;
+ }
// XXX use $.proxy here !
};
// the intention here is that options.datatables_options as coming from the python object take precedence
//manifold.raise_event(self.options.query_all_uuid, FIELD_REMOVED, field);
self.hide_column(field);
});
+ $(".dataTables_filter").append("<div style='display:inline-block;height:27px;width:27px;padding-left:6px;padding-top:4px;'><span class='glyphicon glyphicon-search'></span></div>");
+ $(".dataTables_filter input").css("width","100%");
}, // initialize_table
/**
return (tabIndex.length > 0) ? tabIndex[0] : -1;
}, // getColIndex
- checkbox_html : function (key, value)
- {
+ // create a checkbox <input> tag
+ // computes 'id' attribute from canonical_key
+ // computes 'init_id' from init_key for initialization phase
+ // no need to used convoluted ids with plugin-uuid or others, since
+ // we search using table.$ which looks only in this table
+ checkbox_html : function (record) {
var result="";
// Prefix id with plugin_uuid
result += "<input";
result += " class='querytable-checkbox'";
- result += " id='" + this.flat_id(this.id('checkbox', value)) + "'";
- result += " name='" + key + "'";
+ // compute id from canonical_key
+ var id = record[this.canonical_key]
+ // compute init_id form init_key
+ var init_id=record[this.init_key];
+ // set id - for retrieving from an id, or for posting events upon user's clicks
+ result += " id='"+record[this.canonical_key]+"'";
+ // set init_id
+ result += "init_id='" + init_id + "'";
+ // wrap up
result += " type='checkbox'";
result += " autocomplete='off'";
- result += " value='" + value + "'";
result += "></input>";
return result;
- }, // checkbox
+ },
new_record: function(record)
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 (this.options.checkboxes) nb_col -= 1;
-
+ //if (this.options.checkboxes) nb_col -= 1;
+ // catch up with the last column if checkboxes were requested
+ if (this.options.checkboxes) {
+ // Use a key instead of hostname (hard coded...)
+ line.push(this.checkbox_html(record));
+ }
+
/* fill in stuff depending on the column name */
- for (var j = 0; j < nb_col; j++) {
+ for (var j = 1; j < nb_col - 1; j++) { // nb_col includes status
if (typeof colnames[j] == 'undefined') {
line.push('...');
} else if (colnames[j] == 'hostname') {
else
line.push(record['hostname']);
- } else if (colnames[j] == 'hrn' && typeof(record) != 'undefined') {
- line.push('<a href="../resource/'+record['urn']+'"><span class="glyphicon glyphicon-search"></span></a> '+record['hrn']);
+ } else if (colnames[j] == this.init_key && typeof(record) != 'undefined') {
+ obj = this.object
+ o = obj.split(':');
+ if(o.length>1){
+ obj = o[1];
+ }else{
+ obj = o[0];
+ }
+ /* XXX TODO: Remove this and have something consistant */
+ if(obj=='resource'){
+ //line.push('<a href="../'+obj+'/'+record['urn']+'"><span class="glyphicon glyphicon-search"></span></a> '+record[this.init_key]);
+ }else{
+ //line.push('<a href="../'+obj+'/'+record[this.init_key]+'"><span class="glyphicon glyphicon-search"></span></a> '+record[this.init_key]);
+ }
+ line.push(record[this.init_key]);
} else {
if (record[colnames[j]])
line.push(record[colnames[j]]);
line.push('');
}
}
-
- // catch up with the last column if checkboxes were requested
- if (this.options.checkboxes) {
- // Use a key instead of hostname (hard coded...)
- line.push(this.checkbox_html(this.key, record[this.key]));
- }
+ line.push('<span id="' + this.id_from_key('status', record[this.init_key]) + '"></span>'); // STATUS
// adding an array in one call is *much* more efficient
// this.table.fnAddData(line);
- this.buffered_lines.push(line);
+ return line;
},
clear_table: function()
this.table.fnSetColumnVis(index, false);
},
- set_checkbox: function(record, checked)
- {
- /* Default: checked = true */
+ // this is used at init-time, at which point only init_key can make sense
+ // (because the argument record, if it comes from query, might not have canonical_key set
+ set_checkbox_from_record: function (record, checked) {
+ if (checked === undefined) checked = true;
+ var init_id = record[this.init_key];
+ this.set_checkbox_from_record_key(init_id, checked);
+ },
+
+ set_checkbox_from_record_key: function (record_key, checked) {
+ if (checked === undefined) checked = true;
+ if (debug) messages.debug("querytable.set_checkbox_from_record, record_key="+record_key);
+ // using table.$ to search inside elements that are not visible
+ var element = this.table.$('[init_id="'+record_key+'"]');
+ element.attr('checked',checked);
+ },
+
+ // id relates to canonical_key
+ set_checkbox_from_data: function (id, checked) {
if (checked === undefined) checked = true;
+ if (debug) messages.debug("querytable.set_checkbox_from_data, id="+id);
+ // using table.$ to search inside elements that are not visible
+ var element = this.table.$("[id='"+id+"']");
+ element.attr('checked',checked);
+ },
- var key_value;
- /* The function accepts both records and their key */
- switch (manifold.get_type(record)) {
- case TYPE_VALUE:
- key_value = record;
- break;
- case TYPE_RECORD:
- /* XXX Test the key before ? */
- key_value = record[this.key];
- break;
- default:
- throw "Not implemented";
- break;
+ /**
+ * Arguments
+ *
+ * key_value: the key from which we deduce the id
+ * request: STATUS_OKAY, etc.
+ * content: some HTML content
+ */
+ change_status: function(key_value, warnings)
+ {
+ var msg;
+
+ if ($.isEmptyObject(warnings)) {
+ var state = manifold.query_store.get_record_state(this.options.query_uuid, key_value, STATE_SET);
+ switch(state) {
+ case STATE_SET_IN:
+ case STATE_SET_IN_SUCCESS:
+ case STATE_SET_OUT_FAILURE:
+ case STATE_SET_IN_PENDING:
+ // Checkmark sign if no warning for an object in the set
+ msg = '✓';
+ break;
+ default:
+ // Nothing is the object is not in the set
+ msg = '';
+ break;
+ }
+ } else {
+ msg = '<ul class="nav nav-pills">';
+ msg += '<li class="dropdown">'
+ msg += '<a href="#" data-toggle="dropdown" class="dropdown-toggle nopadding"><b>⚠</b></a>';
+ msg += ' <ul class="dropdown-menu dropdown-menu-right" id="menu1">';
+ $.each(warnings, function(i,warning) {
+ msg += '<li><a href="#">' + warning + '</a></li>';
+ });
+ msg += ' </ul>';
+ msg += '</li>';
+ msg += '</ul>';
}
+ $(document.getElementById(this.id_from_key('status', key_value))).html(msg);
+ $('[data-toggle="tooltip"]').tooltip({'placement': 'bottom'});
+
+ },
+
+ set_bgcolor: function(key_value, class_name)
+ {
+ var elt = $(document.getElementById(this.id_from_key(this.canonical_key, key_value)))
+ if (class_name == BGCOLOR_RESET)
+ elt.removeClass('added removed');
+ else
+ elt.addClass((class_name == BGCOLOR_ADDED ? 'added' : 'removed'));
+ },
+
+ do_filter: function()
+ {
+ // Let's clear the table and only add lines that are visible
+ var self = this;
+ this.clear_table();
+
+ // XXX Here we have lost checkboxes
+ // set checkbox from record.
+ // only the current plugin known that we have an element in a set
- var checkbox_id = this.flat_id(this.id('checkbox', key_value));
- // function escape_id(myid) is defined in portal/static/js/common.functions.js
- checkbox_id = escape_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);
+ lines = Array();
+ var record_keys = [];
+ manifold.query_store.iter_visible_records(this.options.query_uuid, function (record_key, record) {
+ lines.push(self.new_record(record));
+ record_keys.push(record_key);
+ });
+ this.table.fnAddData(lines);
+ $.each(record_keys, function(i, record_key) {
+ var state = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_SET);
+ var warnings = manifold.query_store.get_record_state(self.options.query_uuid, record_key, STATE_WARNINGS);
+ switch(state) {
+ // XXX The row and checkbox still does not exists !!!!
+ case STATE_SET_IN:
+ case STATE_SET_IN_SUCCESS:
+ case STATE_SET_OUT_FAILURE:
+ self.set_checkbox_from_record_key(record_key, true);
+ break;
+ case STATE_SET_OUT:
+ case STATE_SET_OUT_SUCCESS:
+ case STATE_SET_IN_FAILURE:
+ //self.set_checkbox_from_record_key(record_key, false);
+ break;
+ case STATE_SET_IN_PENDING:
+ self.set_checkbox_from_record_key(record_key, true);
+ self.set_bgcolor(record_key, BGCOLOR_ADDED);
+ break;
+ case STATE_SET_OUT_PENDING:
+ //self.set_checkbox_from_record_key(record_key, false);
+ self.set_bgcolor(record_key, BGCOLOR_REMOVED);
+ break;
+ }
+ self.change_status(record_key, warnings); // XXX will retrieve status again
+ });
},
/*************************** QUERY HANDLER ****************************/
on_filter_added: function(filter)
{
+ this.do_filter();
+
+ /*
this.filters.push(filter);
this.redraw_table();
+ */
},
on_filter_removed: function(filter)
{
+ this.do_filter();
+ /*
// Remove corresponding filters
this.filters = $.grep(this.filters, function(x) {
- return x != filter;
+ return x == filter;
});
this.redraw_table();
+ */
},
on_filter_clear: function()
{
- // XXX
- this.redraw_table();
+ this.do_filter();
},
on_field_added: function(field)
on_all_filter_added: function(filter)
{
- // XXX
- this.redraw_table();
+ this.do_filter();
},
on_all_filter_removed: function(filter)
{
- // XXX
- this.redraw_table();
+ this.do_filter();
},
on_all_filter_clear: function()
{
- // XXX
- this.redraw_table();
+ this.do_filter();
},
on_all_field_added: function(field)
on_new_record: function(record)
{
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]);
+ // if the 'all' query has been dealt with already we may turn on the checkbox
+ this.set_checkbox_from_record(record, true);
+ } else {
this.buffered_records_to_check.push(record);
- }
+ }
},
on_clear_records: function()
on_query_done: function()
{
+ this.do_filter();
+/*
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_REQUEST_REMOVE:
- case FIELD_REQUEST_REMOVE_RESET:
- this.set_checkbox(data.value, false);
- break;
- default:
+ var state = manifold.query_store.get_record_state(this.options.query_uuid, data.value, data.status);
+ switch(data.status) {
+ case STATE_SET:
+ switch(state) {
+ case STATE_SET_IN:
+ case STATE_SET_IN_SUCCESS:
+ case STATE_SET_OUT_FAILURE:
+ this.set_checkbox_from_data(data.value, true);
+ this.set_bgcolor(data.value, BGCOLOR_RESET);
+ break;
+ case STATE_SET_OUT:
+ case STATE_SET_OUT_SUCCESS:
+ case STATE_SET_IN_FAILURE:
+ this.set_checkbox_from_data(data.value, false);
+ this.set_bgcolor(data.value, BGCOLOR_RESET);
+ break;
+ case STATE_SET_IN_PENDING:
+ this.set_checkbox_from_data(data.value, true);
+ this.set_bgcolor(data.value, BGCOLOR_ADDED);
+ break;
+ case STATE_SET_OUT_PENDING:
+ this.set_checkbox_from_data(data.value, false);
+ this.set_bgcolor(data.value, BGCOLOR_REMOVED);
+ break;
+ }
break;
- }
- },
- /* XXX TODO: make this generic a plugin has to subscribe to a set of Queries to avoid duplicated code ! */
- // all
- on_all_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_REQUEST_REMOVE:
- case FIELD_REQUEST_REMOVE_RESET:
- this.set_checkbox(data.value, false);
- break;
- default:
+ case STATE_WARNINGS:
+ this.change_status(data.value, state);
break;
}
},
- 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
-
- 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 = [];
-
- this.received_all_query = true;
- // unspin once we have received both
- if (this.received_all_query && this.received_query) this.unspin();
-
- }, // on_all_query_done
-
/************************** PRIVATE METHODS ***************************/
/**
if (op == '=' || op == '==') {
if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a")
ret = false;
+ }else if (op == 'included') {
+ $.each(value, function(i,x) {
+ if(x == col_value){
+ ret = true;
+ return false;
+ }else{
+ ret = false;
+ }
+ });
}else if (op == '!=') {
if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a")
ret = false;
e.stopPropagation();
var self = e.data;
+ var id=this.id;
- // XXX this.value = key of object to be added... what about multiple keys ?
- if (debug) messages.debug("querytable click handler checked=" + this.checked + " hrn=" + this.value);
- manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, this.value);
+ // this.id = key of object to be added... what about multiple keys ?
+ if (debug) messages.debug("querytable._check_click key="+this.canonical_key+"->"+id+" checked="+this.checked);
+ manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, id);
//return false; // prevent checkbox to be checked, waiting response from manifold plugin api
},
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';
- } );
- }
+ return $.map( oSettings.oApi._fnGetTrNodes(oSettings), function (tr, i) {
+ return result=$('td:eq('+iColumn+') input', tr).prop('checked') ? '1' : '0';
+ });
+ };
})(jQuery);