From 4b9ed7eeaae673d0bf30a4d494fa052bcbc41fdb Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jordan=20Aug=C3=A9?= Date: Mon, 8 Jul 2013 13:49:26 +0200 Subject: [PATCH] Attempts for a simpler plugin API: both coexist, tests with hazelnut plugin --- manifold/js/manifold-query.js | 20 ++- manifold/js/manifold.js | 154 ++++++++++++++-------- manifold/manifoldresult.py | 1 + plugins/hazelnut/hazelnut.js | 238 ++++++++++++++++++++++++++-------- 4 files changed, 303 insertions(+), 110 deletions(-) diff --git a/manifold/js/manifold-query.js b/manifold/js/manifold-query.js index 7c5de925..c6ebaabf 100644 --- a/manifold/js/manifold-query.js +++ b/manifold/js/manifold-query.js @@ -74,7 +74,7 @@ INSERT INTO object VALUES(field=value) } // FIXME These functions computing diff's between queries are meant to be shared - this.diff_fields = function (otherQuery) { + this.diff_fields = function(otherQuery) { var f1 = this.fields; var f2 = otherQuery.fields; @@ -87,7 +87,7 @@ INSERT INTO object VALUES(field=value) } // FIXME Modify filter to filters - this.diff_filter = function (otherQuery) { + this.diff_filter = function(otherQuery) { var f1 = this.filters; var f2 = otherQuery.filters; @@ -98,6 +98,22 @@ INSERT INTO object VALUES(field=value) return {'added':added, 'removed':removed}; } + + this.iter_subqueries = function(callback, data) + { + rec = function(query, callback, data) { + jQuery.each(query.subqueries, function(object, subquery) { + rec(subquery, callback); + }); + callback(query, data); + }; + if (this.analyzed_query !== undefined) + query = this.analyzed_query; + else + query = this + rec(query, callback, data); + } + // we send queries as a json string now // this.as_POST = function() { // return {'action': this.action, 'object': this.object, 'timestamp': this.timestamp, diff --git a/manifold/js/manifold.js b/manifold/js/manifold.js index bae00c7c..221986df 100644 --- a/manifold/js/manifold.js +++ b/manifold/js/manifold.js @@ -19,6 +19,19 @@ function debug_query (msg, query) { /* ------------------------------------------------------------ */ +// Constants that should be somehow moved to a plugin.js file +var FILTER_ADDED = 1; +var FILTER_REMOVED = 2; +var CLEAR_FILTERS = 3; +var FIELD_ADDED = 4; +var FIELD_REMOVED = 5; +var CLEAR_FIELDS = 6; +var NEW_RECORD = 7; +var CLEAR_RECORDS = 8; + +var IN_PROGRESS = 101; +var DONE = 102; + /*! * This namespace holds functions for globally managing query objects * \Class Manifold @@ -33,7 +46,7 @@ var manifold = { if (active) { $(locator).spin(manifold.spin_presets); } else { - $locator.spin(false); + $(locator).spin(false); } } catch (err) { messages.debug("Cannot turn spins on/off " + err); } }, @@ -90,11 +103,11 @@ var manifold = { // start spinners // in case the spin stuff was not loaded, let's make sure we proceed to the exit - try { - if (manifold.asynchroneous_debug) - messages.debug("Turning on spin with " + jQuery(".need-spin").length + " matches for .need-spin"); - jQuery('.need-spin').spin(manifold.spin_presets); - } catch (err) { messages.debug("Cannot turn on spins " + err); } + //try { + // if (manifold.asynchroneous_debug) + // messages.debug("Turning on spin with " + jQuery(".need-spin").length + " matches for .need-spin"); + // jQuery('.need-spin').spin(manifold.spin_presets); + //} catch (err) { messages.debug("Cannot turn on spins " + err); } // Loop through input array, and use publish_uuid to publish back results jQuery.each(query_publish_dom_tuples, function(index, tuple) { @@ -107,6 +120,11 @@ var manifold = { messages.debug("sending POST on " + manifold.proxy_url + " to be published on " + publish_uuid); messages.debug("... ctd... with actual query= " + query.__repr()); } + + query.iter_subqueries(function (sq) { + $('.plugin').trigger(manifold.get_record_channel(sq.query_uuid), [IN_PROGRESS]); + }); + // not quite sure what happens if we send a string directly, as POST data is named.. // this gets reconstructed on the proxy side with ManifoldQuery.fill_from_POST jQuery.post(manifold.proxy_url, {'json':query_json} , manifold.success_closure(query, publish_uuid, tuple.callback /*domid*/)); @@ -147,12 +165,22 @@ var manifold = { * \param array results results corresponding to query */ publish_result: function(query, result) { + if (typeof result === 'undefined') + result = []; + + // NEW PLUGIN API + var channel = manifold.get_record_channel(query.query_uuid); + $('.plugin').trigger(channel, [CLEAR_RECORDS]); + $.each(result, function(i, record) { + $('.plugin').trigger(channel, [NEW_RECORD, record]); + }); + $('.plugin').trigger(channel, [DONE]); + + // OLD PLUGIN API BELOW /* Publish an update announce */ var channel="/results/" + query.query_uuid + "/changed"; if (manifold.asynchroneous_debug) messages.debug("publishing result on " + channel); - if (typeof result === 'undefined') - result = []; jQuery.publish(channel, [result, query]); }, @@ -219,59 +247,83 @@ var manifold = { } }, + /* Publish/subscribe channels for internal use */ + get_query_channel: function(uuid) { return '/query/' + uuid }, + get_record_channel: function(uuid) { return '/record/' + uuid }, + }; // manifold object /* ------------------------------------------------------------ */ -// extend jQuery/$ with pubsub capabilities -/* https://gist.github.com/661855 */ (function($) { - var o = $({}); - - $.subscribe = function( channel, selector, data, fn) { - /* borrowed from jQuery */ - if ( data == null && fn == null ) { - // ( channel, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - // ( channel, selector, fn ) - fn = data; - data = undefined; - } else { - // ( channel, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - /* */ - - /* We use an indirection function that will clone the object passed in - * parameter to the subscribe callback + /* NEW PLUGIN API * - * FIXME currently we only clone query objects which are the only ones - * supported and editable, we might have the same issue with results but - * the page load time will be severely affected... + * NOTE: Since we don't have a plugin class, we are extending all jQuery + * plugins... */ - o.on.apply(o, [channel, selector, data, function() { - for(i = 1; i < arguments.length; i++) { - if ( arguments[i].constructor.name == 'ManifoldQuery' ) - arguments[i] = arguments[i].clone(); - } - fn.apply(o, arguments); - }]); - }; - $.unsubscribe = function() { - o.off.apply(o, arguments); - }; + /*! + * \brief Associates a query handler to the current plugin + * \param uuid (string) query uuid + * \param handler (function) handler callback + */ + $.fn.set_query_handler = function(uuid, handler) + { + this.on(manifold.get_query_channel(uuid), handler); + } - $.publish = function() { - o.trigger.apply(o, arguments); - }; + $.fn.set_record_handler = function(uuid, handler) + { + this.on(manifold.get_record_channel(uuid), handler); + } + // OLD PLUGIN API: extend jQuery/$ with pubsub capabilities + // https://gist.github.com/661855 + var o = $({}); + $.subscribe = function( channel, selector, data, fn) { + /* borrowed from jQuery */ + if ( data == null && fn == null ) { + // ( channel, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + // ( channel, selector, fn ) + fn = data; + data = undefined; + } else { + // ( channel, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + /* */ + + /* We use an indirection function that will clone the object passed in + * parameter to the subscribe callback + * + * FIXME currently we only clone query objects which are the only ones + * supported and editable, we might have the same issue with results but + * the page load time will be severely affected... + */ + o.on.apply(o, [channel, selector, data, function() { + for(i = 1; i < arguments.length; i++) { + if ( arguments[i].constructor.name == 'ManifoldQuery' ) + arguments[i] = arguments[i].clone(); + } + fn.apply(o, arguments); + }]); + }; + + $.unsubscribe = function() { + o.off.apply(o, arguments); + }; + + $.publish = function() { + o.trigger.apply(o, arguments); + }; + }(jQuery)); /* ------------------------------------------------------------ */ diff --git a/manifold/manifoldresult.py b/manifold/manifoldresult.py index 483fd914..a20c5b03 100644 --- a/manifold/manifoldresult.py +++ b/manifold/manifoldresult.py @@ -15,6 +15,7 @@ class ManifoldResult (dict): self['code']=code self['value']=value self['output']=output + self['description'] = '' # Jordan: needed by javascript code def from_json (self, json_string): d=json.dumps(json_string) diff --git a/plugins/hazelnut/hazelnut.js b/plugins/hazelnut/hazelnut.js index 5f1c27a0..e63baccd 100644 --- a/plugins/hazelnut/hazelnut.js +++ b/plugins/hazelnut/hazelnut.js @@ -48,24 +48,30 @@ var $this = $(this); - /* Events */ - $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 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); + + /* 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, hazelnut.query_handler); + $this.set_record_handler(options.query_uuid, hazelnut.record_handler); + +// /* 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 @@ -281,53 +287,58 @@ } 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); + // 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 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; + 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"); + // 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; } - /* - * fill the dataTables object - * we cannot set html content directly here, need to use fnAddData - */ + /* + * 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 + // 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 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 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 */ + /* fill in stuff depending on the column name */ for (var j = 0; j < nb_col; j++) { if (typeof colnames[j] == 'undefined') { line.push('...'); @@ -345,10 +356,10 @@ } } - /* catch up with the last column if checkboxes were requested */ + /* 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 + // 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['urn']); @@ -361,27 +372,140 @@ }); - this.table.fnClearTable(); - if (debug) messages.debug("hazelnut.update_plugin: total of " + lines.length + " rows"); + 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) + { + var result=""; + // Prefix id with plugin_uuid + result += " is present */ + checked = 'checked '; + hazelnut.current_resources.push(record['urn']); + } + // Use a key instead of hostname (hard coded...) + line.push(object.checkbox(options.plugin_uuid, record['urn'], record['type'], checked, false)); + } + // XXX Is adding an array of lines more efficient ? + this.table.fnAddData(line); + }; - this.checkbox = function (plugin_uuid, header, field, selected_str, disabled_str) { - var result=""; - // Preafix id with plugin_uuid - result += "