X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=manifold%2Fjs%2Fmanifold.js;h=c3aac9fbdf997c26f5b44755078df0408f213259;hb=07411e389a9d39ddccfd93cd53ac895393a8ae3a;hp=9f24bac353e7395e3b5d4429744731603f4aee3a;hpb=69867d5296684463d3aad4f6db867d24005102aa;p=myslice.git diff --git a/manifold/js/manifold.js b/manifold/js/manifold.js index 9f24bac3..c3aac9fb 100644 --- a/manifold/js/manifold.js +++ b/manifold/js/manifold.js @@ -18,16 +18,70 @@ function debug_query (msg, query) { } /* ------------------------------------------------------------ */ -// this namespace holds functions for globally managing query objects + +// 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; + +var SET_ADD = 201; +var SET_REMOVED = 202; + +/*! + * This namespace holds functions for globally managing query objects + * \Class Manifold + */ var manifold = { + spin_presets: {}, + + spin: function(locator, active /*= true */) { + active = typeof active !== 'undefined' ? active : true; + try { + if (active) { + $(locator).spin(manifold.spin_presets); + } else { + $(locator).spin(false); + } + } catch (err) { messages.debug("Cannot turn spins on/off " + err); } + }, + + /*! + * Associative array storing the set of queries active on the page + * \memberof Manifold + */ all_queries: {}, + /*! + * Insert a query in the global hash table associating uuids to queries. + * If the query has no been analyzed yet, let's do it. + * \fn insert_query(query) + * \memberof Manifold + * \param ManifoldQuery query Query to be added + */ insert_query : function (query) { - manifold.all_queries[query.query_uuid]=query; + if (query.analyzed_query == null) { + query.analyze_subqueries(); + } + manifold.all_queries[query.query_uuid]=query; }, + + /*! + * Returns the query associated to a UUID + * \fn find_query(query_uuid) + * \memberof Manifold + * \param string query_uuid The UUID of the query to be returned + */ find_query : function (query_uuid) { - return manifold.all_queries[query_uuid]; + return manifold.all_queries[query_uuid]; }, // trigger a query asynchroneously @@ -35,127 +89,283 @@ var manifold = { asynchroneous_debug : true, + /** + * \brief We use js function closure to be able to pass the query (array) + * to the callback function used when data is received + */ + success_closure: function(query, publish_uuid, callback /*domid*/) + { + return function(data, textStatus) { + manifold.asynchroneous_success(data, query, publish_uuid, callback /*domid*/); + } + }, + // Executes all async. queries // input queries are specified as a list of {'query_uuid': , 'id': } asynchroneous_exec : function (query_publish_dom_tuples) { - // 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(spin_presets); - } catch (err) { messages.debug("Cannot turn on spins " + err); } - - // We use js function closure to be able to pass the query (array) to the - // callback function used when data is received - var success_closure = function(query, publish_uuid, domid) { - return function(data, textStatus) {manifold.asynchroneous_success(data, query, publish_uuid, domid);}}; - - // Loop through input array, and use publish_uuid to publish back results - jQuery.each(query_publish_dom_tuples, function(index, tuple) { - var query=manifold.find_query(tuple.query_uuid); - var query_json=JSON.stringify (query); - var publish_uuid=tuple.publish_uuid; - // by default we publish using the same uuid of course - if (publish_uuid==undefined) publish_uuid=query.query_uuid; - if (manifold.asynchroneous_debug) { - messages.debug("sending POST on " + manifold.proxy_url + " to be published on " + publish_uuid); - messages.debug("... ctd... with actual query= " + query.__repr()); - } - // 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} , success_closure(query, publish_uuid, tuple.domid)); - }) - }, + // 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); } + + // Loop through input array, and use publish_uuid to publish back results + jQuery.each(query_publish_dom_tuples, function(index, tuple) { + var query=manifold.find_query(tuple.query_uuid); + var query_json=JSON.stringify (query); + var publish_uuid=tuple.publish_uuid; + // by default we publish using the same uuid of course + if (publish_uuid==undefined) publish_uuid=query.query_uuid; + if (manifold.asynchroneous_debug) { + 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) { + manifold.raise_record_event(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*/)); + }) + }, + + /** + * \brief Forward a query to the manifold backend + * \param query (dict) the query to be executed asynchronously + * \param callback (function) the function to be called when the query terminates + * Deprecated: + * \param domid (string) the domid to be notified about the results (null for using the pub/sub system + */ + forward: function(query, callback /*domid*/) { + var query_json = JSON.stringify(query); + $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, query.query_uuid, callback/*domid*/)); + }, + + /*! + * Returns whether a query expects a unique results. + * This is the case when the filters contain a key of the object + * \fn query_expects_unique_result(query) + * \memberof Manifold + * \param ManifoldQuery query Query for which we are testing whether it expects a unique result + */ + query_expects_unique_result: function(query) { + /* XXX we need functions to query metadata */ + //var keys = MANIFOLD_METADATA[query.object]['keys']; /* array of array of field names */ + /* TODO requires keys in metadata */ + return true; + }, + + raise_event_handler: function(type, query_uuid, event_type, value) + { + if (type == 'query') { + var channels = [ manifold.get_query_channel(query_uuid), manifold.get_query_channel('*') ]; + } else if (type == 'record') { + var channels = [ manifold.get_record_channel(query_uuid), manifold.get_record_channel('*') ]; + + } else { + throw 'Incorrect type for manifold.raise_event()'; + } + $.each(channels, function(i, channel) { + if (value === undefined) + $('.plugin').trigger(channel, [event_type]); + else + $('.plugin').trigger(channel, [event_type, value]); + }); + }, + + raise_query_event: function(query_uuid, event_type, value) + { + manifold.raise_event_handler('query', query_uuid, event_type, value); + }, + + raise_record_event: function(query_uuid, event_type, value) + { + manifold.raise_event_handler('record', query_uuid, event_type, value); + }, + + /*! + * Publish result + * \fn publish_result(query, results) + * \memberof Manifold + * \param ManifoldQuery query Query which has received results + * \param array results results corresponding to query + */ + publish_result: function(query, result) { + if (typeof result === 'undefined') + result = []; + + // NEW PLUGIN API + manifold.raise_record_event(query.query_uuid, CLEAR_RECORDS); + $.each(result, function(i, record) { + manifold.raise_record_event(query.query_uuid, NEW_RECORD, record); + }); + manifold.raise_record_event(query.query_uuid, 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); + jQuery.publish(channel, [result, query]); + }, + + /*! + * Recursively publish result + * \fn publish_result_rec(query, result) + * \memberof Manifold + * \param ManifoldQuery query Query which has received result + * \param array result result corresponding to query + */ + publish_result_rec: function(query, result) { + /* If the result is not unique, only publish the top query; + * otherwise, publish the main object as well as subqueries + * XXX how much recursive are we ? + */ + if (manifold.query_expects_unique_result(query)) { + /* Also publish subqueries */ + jQuery.each(query.subqueries, function(object, subquery) { + manifold.publish_result_rec(subquery, result[0][object]); + /* TODO remove object from result */ + }); + } + manifold.publish_result(query, result); + }, // if set domid allows the result to be directed to just one plugin // most of the time publish_uuid will be query.query_uuid - // however in some cases we wish to publish the results under a different uuid - // e.g. an updater wants to publish its results as if from the original (get) query - asynchroneous_success : function (data, query, publish_uuid, domid) { - if (manifold.asynchroneous_debug) - messages.debug("received manifold result with code " + data.code + " for publish on " + publish_uuid); - // xxx should have a nicer declaration of that enum in sync with the python code somehow - if (data.code == 1) { - alert("Your session has expired, please log in again"); - window.location="/logout/"; - return; - } else if (data.code != 0) { - messages.error("Error received from manifold backend at " + MANIFOLD_URL + " [" + data.output + "]"); - // publish error code and text message on a separate channel for whoever is interested - jQuery.publish("/results/" + publish_uuid + "/failed", [data.code, data.output] ); - return; - } - // once everything is checked we can use the 'value' part of the manifoldresult - var value=data.value; - if (value) { - if (!!domid) { - /* Directly inform the requestor */ - if (manifold.asynchroneous_debug) messages.debug("directing results to " + domid); - jQuery('#' + domid).trigger('results', [value]); - } else { - /* Publish an update announce */ - if (manifold.asynchroneous_debug) messages.debug("publishing results on " + publish_uuid); - jQuery.publish("/results/" + publish_uuid + "/changed", [value, query]); - } + // however in some cases we wish to publish the result under a different uuid + // e.g. an updater wants to publish its result as if from the original (get) query + asynchroneous_success : function (data, query, publish_uuid, callback /*domid*/) { + // xxx should have a nicer declaration of that enum in sync with the python code somehow + + /* If a callback has been specified, we redirect results to it */ + if (!!callback) { callback(data); return; } - } + if (data.code == 2) { // ERROR + alert("Your session has expired, please log in again"); + window.location="/logout/"; + return; + } + if (data.code == 1) { // WARNING + messages.error("Some errors have been received from the manifold backend at " + MANIFOLD_URL + " [" + data.description + "]"); + // publish error code and text message on a separate channel for whoever is interested + jQuery.publish("/results/" + publish_uuid + "/failed", [data.code, data.description] ); + } + // once everything is checked we can use the 'value' part of the manifoldresult + var result=data.value; + if (result) { + //if (!!callback /* domid */) { + // /* Directly inform the requestor */ + // if (manifold.asynchroneous_debug) messages.debug("directing result to callback"); + // callback(result); + // //if (manifold.asynchroneous_debug) messages.debug("directing result to " + domid); + // //jQuery('#' + domid).trigger('results', [result]); + //} else { + /* XXX Jordan XXX I don't need publish_uuid here... What is it used for ? */ + /* query is the query we sent to the backend; we need to find the + * corresponding analyezd_query in manifold.all_queries + */ + tmp_query = manifold.find_query(query.query_uuid); + manifold.publish_result_rec(tmp_query.analyzed_query, result); + //} + + } }, + raise_event: function(uuid, event_type, value) + { + switch(event_type) { + case SET_ADD: + // Query uuid has been updated with the key of a new element + break; + case SET_REMOVED: + // Query uuid has been updated with the key of a removed element + break; + } + }, + + /* 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( types, selector, data, fn) { - /* borrowed from jQuery */ - if ( data == null && fn == null ) { - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - // ( types, 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, [types, selector, data, function() { - for(i = 1; i < arguments.length; i++) { - if ( arguments[i].constructor.name == 'Query' ) - 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)); /* ------------------------------------------------------------ */