X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=manifold%2Fjs%2Fmanifold.js;h=c5779c1cacd3a5a88ccd67ae64bc86355e5500af;hb=401546ae932e7f2d120ec210c13e2db1ce754cc7;hp=6209085b39acc9171225510aab184cf860ced0bd;hpb=c8ac1863026e5736065065e931e20de310cb3b06;p=myslice.git diff --git a/manifold/js/manifold.js b/manifold/js/manifold.js index 6209085b..c5779c1c 100644 --- a/manifold/js/manifold.js +++ b/manifold/js/manifold.js @@ -2,37 +2,57 @@ function debug_dict_keys (msg, o) { var keys=[]; for (var k in o) keys.push(k); - console.log ("debug_dict_keys: " + msg + " keys= " + keys); + messages.debug ("debug_dict_keys: " + msg + " keys= " + keys); } function debug_dict (msg, o) { - for (var k in o) console.log ("debug_dict: " + msg + " [" + k + "]=" + o[k]); + for (var k in o) messages.debug ("debug_dict: " + msg + " [" + k + "]=" + o[k]); } function debug_value (msg, value) { - console.log ("debug_value: " + msg + " " + value); + messages.debug ("debug_value: " + msg + " " + value); } function debug_query (msg, query) { - if (query === undefined) console.log ("debug_query: " + msg + " -> undefined"); - else if (query == null) console.log ("debug_query: " + msg + " -> null"); - else if ('query_uuid' in query) console.log ("debug_query: " + msg + query.__repr()); - else console.log ("debug_query: " + msg + " query= " + query); + if (query === undefined) messages.debug ("debug_query: " + msg + " -> undefined"); + else if (query == null) messages.debug ("debug_query: " + msg + " -> null"); + else if ('query_uuid' in query) messages.debug ("debug_query: " + msg + query.__repr()); + else messages.debug ("debug_query: " + msg + " query= " + query); } /* ------------------------------------------------------------ */ -// this namespace holds functions for globally managing query objects + +/*! + * This namespace holds functions for globally managing query objects + * \Class Manifold + */ var manifold = { + /*! + * 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]; - }, - debug_all_queries : function (msg) { - for (var query_uuid in manifold.all_queries) { - $.publish("messages:debug","manifold.debug " + msg + " " + query_uuid + " -> " + manifold.all_queries[query_uuid]); - } + return manifold.all_queries[query_uuid]; }, // trigger a query asynchroneously @@ -42,55 +62,122 @@ var manifold = { // Executes all async. queries // input queries are specified as a list of {'query_uuid': , 'id': } - asynchroneous_exec : function (query_uuid_domids) { - // start spinners + asynchroneous_exec : function (query_publish_dom_tuples) { + // start spinners - if (manifold.asynchroneous_debug) - $.publish("messages.debug","Turning on spin with " + jQuery(".need-spin").length + " matches for .need-spin"); - jQuery('.need-spin').spin(spin_presets); + // 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, id) { - return function(data, textStatus) {manifold.asynchroneous_success(data, query, id);}}; - - // Loop through query array and use ajax to send back query_uuid_domids (to frontend) with json - jQuery.each(query_uuid_domids, function(index, tuple) { - var query=manifold.find_query(tuple.query_uuid); - var query_json=JSON.stringify (query); - if (manifold.asynchroneous_debug) { - $.publish("messages:debug","sending POST on " + manifold.proxy_url + " with 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, tuple.id)); - }) - }, - - asynchroneous_success : function (data, query, id) { - if (manifold.asynchroneous_debug) - $.publish("messages:debug","received manifold result with code " + data.code); - // 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) { - alert("Error received from manifold backend at " + MANIFOLD_URL + " [" + data.output + "]"); - return; - } - // once everything is checked we can use the 'value' part of the manifoldresult - data=data.value; - if (data) { - if (!!id) { - /* Directly inform the requestor */ - jQuery('#' + id).trigger('results', [data]); + // 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)); + }) + }, + + + /*! + * 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; + }, + + /*! + * 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) { + /* 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 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, domid) { + // xxx should have a nicer declaration of that enum in sync with the python code somehow + 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 (!!domid) { + /* Directly inform the requestor */ + if (manifold.asynchroneous_debug) messages.debug("directing result to " + domid); + jQuery('#' + domid).trigger('results', [result]); } else { - /* Publish an update announce */ - jQuery.publish("/results/" + query.query_uuid + "/changed", [data, query]); + /* 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); } - } + } }, }; // manifold object @@ -102,19 +189,19 @@ var manifold = { var o = $({}); - $.subscribe = function( types, selector, data, fn) { + $.subscribe = function( channel, selector, data, fn) { /* borrowed from jQuery */ if ( data == null && fn == null ) { - // ( types, fn ) + // ( channel, fn ) fn = selector; data = selector = undefined; } else if ( fn == null ) { if ( typeof selector === "string" ) { - // ( types, selector, fn ) + // ( channel, selector, fn ) fn = data; data = undefined; } else { - // ( types, data, fn ) + // ( channel, data, fn ) fn = data; data = selector; selector = undefined; @@ -129,9 +216,9 @@ var manifold = { * supported and editable, we might have the same issue with results but * the page load time will be severely affected... */ - o.on.apply(o, [types, selector, data, function() { + o.on.apply(o, [channel, selector, data, function() { for(i = 1; i < arguments.length; i++) { - if ( arguments[i].constructor.name == 'Query' ) + if ( arguments[i].constructor.name == 'ManifoldQuery' ) arguments[i] = arguments[i].clone(); } fn.apply(o, arguments);