X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=manifold%2Fjs%2Fmanifold.js;h=ef492f71ed5e9f17d6b9ab8dab57f5944ec16fee;hb=69651f9a5760ec0995dbe592cd5c01e174408808;hp=d24211ca9402cec8987537b10c954a7acae731ad;hpb=02b4adc22f4be31f0f846aea95a7e7ac4a806ae8;p=myslice.git diff --git a/manifold/js/manifold.js b/manifold/js/manifold.js index d24211ca..ef492f71 100644 --- a/manifold/js/manifold.js +++ b/manifold/js/manifold.js @@ -19,12 +19,115 @@ 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; + +/* Update requests from plugins */ +var SET_ADD = 201; +var SET_REMOVED = 202; + +/* Query status */ +var STATUS_NONE = 500; // Query has not been started yet +var STATUS_GET_IN_PROGRESS = 501; // Query has been sent, no result has been received +var STATUS_GET_RECEIVED = 502; // Success +var STATUS_GET_ERROR = 503; // Error +var STATUS_UPDATE_PENDING = 504; +var STATUS_UPDATE_IN_PROGRESS = 505; +var STATUS_UPDATE_RECEIVED = 506; +var STATUS_UPDATE_ERROR = 507; +// outdated ? + +// A structure for storing queries + + + +function QueryExt(query, parent_query, main_query) { + + /* Constructor */ + if (typeof query == "undefined") + throw "Must pass a query in QueryExt constructor"; + this.query = query + this.parent_query_ext = (typeof parent_query == "undefined") ? false : parent_query + this.main_query_ext = (typeof main_query == "undefined") ? false : main_query + + this.status = null; + this.results = null; + this.update_query = null; // null unless we are a main_query (aka parent_query == null); only main_query_fields can be updated... +} + +function QueryStore() { + + this.main_queries = {}; + this.analyzed_queries = {}; + + /* Insertion */ + + this.insert = function(query) + { + if (query.analyzed_query == null) { + query.analyze_subqueries(); + } + + query_ext = new QueryExt(query, null, null) + manifold.query_store.main_queries[query.query_uuid] = query_ext; + + // We also need to insert all queries and subqueries from the analyzed_query + // XXX We need the root of all subqueries + query.iter_subqueries(function(sq, data, parent_query) { + if (parent_query) + parent_query_ext = manifold.query_store.find_analyzed_query_ext(parent_query.query_uuid); + else + parent_query_ext = null; + // XXX parent_query_ext == false + // XXX main.subqueries = {} # Normal, we need analyzed_query + sq_ext = new QueryExt(sq, parent_query_ext, query_ext) + manifold.query_store.analyzed_queries[sq.query_uuid] = sq_ext; + }); + } + + /* Searching */ + + this.find_query_ext = function(query_uuid) + { + return this.main_queries[query_uuid]; + } + + this.find_query = function(query_uuid) + { + return this.find_query_ext(query_uuid).query; + } + + this.find_analyzed_query_ext = function(query_uuid) + { + return this.analyzed_queries[query_uuid]; + } + + this.find_analyzed_query = function(query_uuid) + { + return this.find_analyzed_query_ext(query_uuid).query; + } +} + /*! * This namespace holds functions for globally managing query objects * \Class Manifold */ var manifold = { + /************************************************************************** + * Helper functions + **************************************************************************/ + spin_presets: {}, spin: function(locator, active /*= true */) { @@ -33,11 +136,19 @@ 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); } }, + /************************************************************************** + * Query management + **************************************************************************/ + + query_store: new QueryStore(), + + // XXX Remaining functions are deprecated since they are replaced by the query store + /*! * Associative array storing the set of queries active on the page * \memberof Manifold @@ -52,6 +163,10 @@ var manifold = { * \param ManifoldQuery query Query to be added */ insert_query : function (query) { + // NEW API + manifold.query_store.insert(query); + + // FORMER API if (query.analyzed_query == null) { query.analyze_subqueries(); } @@ -68,6 +183,10 @@ var manifold = { return manifold.all_queries[query_uuid]; }, + /************************************************************************** + * Query execution + **************************************************************************/ + // trigger a query asynchroneously proxy_url : '/manifold/proxy/json/', @@ -77,10 +196,10 @@ var manifold = { * \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, domid) + success_closure: function(query, publish_uuid, callback /*domid*/) { return function(data, textStatus) { - manifold.asynchroneous_success(data, query, publish_uuid, domid); + manifold.asynchroneous_success(data, query, publish_uuid, callback /*domid*/); } }, @@ -90,11 +209,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,20 +226,27 @@ 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) { + 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.domid)); + 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, domid) { + 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, domid)); + $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, query.query_uuid, callback/*domid*/)); }, /*! @@ -145,9 +271,21 @@ var manifold = { * \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); + if (manifold.asynchroneous_debug) + messages.debug("publishing result on " + channel); jQuery.publish(channel, [result, query]); }, @@ -177,9 +315,14 @@ var manifold = { // 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) { + 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 + // We need to make sense of error codes here alert("Your session has expired, please log in again"); window.location="/logout/"; return; @@ -188,79 +331,216 @@ var manifold = { 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] ); + + $("#notifications").notify("create", "sticky", { + title: 'Warning', + text: data.description + },{ + expires: false, + speed: 1000 + }); + } // 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 { + //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); - } + //} } }, -}; // manifold object -/* ------------------------------------------------------------ */ + /************************************************************************** + * Plugin API helpers + **************************************************************************/ -// extend jQuery/$ with pubsub capabilities -/* https://gist.github.com/661855 */ -(function($) { + 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('*') ]; - 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; + 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); + }, + + + raise_event: function(query_uuid, event_type, value) + { + // Query uuid has been updated with the key of a new element + query_ext = manifold.query_store.find_analyzed_query_ext(query_uuid); + query = query_ext.query; + + switch(event_type) { + case SET_ADD: + // update is only possible is the query is not pending, etc + // CHECK status ! + + // XXX we can only update subqueries of the main query. Check ! + // assert query_ext.parent_query == query_ext.main_query + update_query = query_ext.parent_query_ext.update_query; - /* We use an indirection function that will clone the object passed in - * parameter to the subscribe callback + // NOTE: update might modify the fields in Get + // NOTE : we have to modify all child queries + // NOTE : parts of a query might not be started (eg slice.measurements, how to handle ?) + + // if everything is done right, update_query should not be null. It is updated when we received results from the get query + // object = the same as get + // filter = key : update a single object for now + // fields = the same as get + + break; + case SET_REMOVED: + // Query uuid has been updated with the key of a removed element + break; + case FILTER_ADDED: + break; + case FILTER_REMOVED: + break; + case FIELD_ADDED: + main_query = query_ext.main_query_ext.query; + main_update_query = query_ext.main_query_ext.update_query; + query.select(value); + + // Here we need the full path through all subqueries + path = "" + // XXX We might need the query name in the QueryExt structure + main_query.select(value); + + // XXX When is an update query associated ? + // XXX main_update_query.select(value); + + // We need to inform about changes in these queries to the respective plugins + // Note: query, main_query & update_query have the same UUID + manifold.raise_query_event(query_uuid, event_type, value); + // We are targeting the same object with get and update + // The notion of query is bad, we should have a notion of destination, and issue queries on the destination + // NOTE: Editing a subquery == editing a local view on the destination + break; + + case FIELD_REMOVED: + query = query_ext.query; + main_query = query_ext.main_query_ext.query; + main_update_query = query_ext.main_query_ext.update_query; + query.unselect(value); + main_query.unselect(value); + + // We need to inform about changes in these queries to the respective plugins + // Note: query & main_query have the same UUID + manifold.raise_query_event(query_uuid, event_type, value); + break; + } + // XXX We might need to run the new query again and manage the plugins in the meantime with spinners... + // For the time being, we will collect all columns during the first query + }, + + /* Publish/subscribe channels for internal use */ + get_query_channel: function(uuid) { return '/query/' + uuid }, + get_record_channel: function(uuid) { return '/record/' + uuid }, + +}; // manifold object +/* ------------------------------------------------------------ */ + +(function($) { + + /* 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)); /* ------------------------------------------------------------ */