X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=manifold%2Fjs%2Fmanifold.js;h=68625232465c362192eb830ee69f73032855ea38;hb=b4be700065b4341db22d1ce46133bf1edef36340;hp=abbd6e6d6b1b06d6d79d5fb91d3c0f39179f1280;hpb=6abb2ca187f04e30071da29386552f3ce670b5dc;p=myslice.git diff --git a/manifold/js/manifold.js b/manifold/js/manifold.js index abbd6e6d..68625232 100644 --- a/manifold/js/manifold.js +++ b/manifold/js/manifold.js @@ -17,6 +17,16 @@ function debug_query (msg, query) { else messages.debug ("debug_query: " + msg + " query= " + query); } +// http://javascriptweblog.wordpress.com/2011/08/08/fixing-the-javascript-typeof-operator/ +Object.toType = (function toType(global) { + return function(obj) { + if (obj === global) { + return "global"; + } + return ({}).toString.call(obj).match(/\s([a-z|A-Z]+)/)[1].toLowerCase(); + } +})(this); + /* ------------------------------------------------------------ */ // Constants that should be somehow moved to a plugin.js file @@ -28,14 +38,24 @@ var FIELD_REMOVED = 5; var CLEAR_FIELDS = 6; var NEW_RECORD = 7; var CLEAR_RECORDS = 8; +var FIELD_STATE_CHANGED = 9; var IN_PROGRESS = 101; var DONE = 102; -/* Update requests from plugins */ +/* Update requests related to subqueries */ var SET_ADD = 201; var SET_REMOVED = 202; -var RUN_UPDATE = 203; + +// request +var FIELD_REQUEST_CHANGE = 301; +var FIELD_REQUEST_ADD = 302; +var FIELD_REQUEST_REMOVE = 303; +var FIELD_REQUEST_RESET = 304; +// status +var FIELD_REQUEST_PENDING = 401; +var FIELD_REQUEST_SUCCESS = 402; +var FIELD_REQUEST_FAILURE = 403; /* Query status */ var STATUS_NONE = 500; // Query has not been started yet @@ -46,22 +66,30 @@ 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 +/* Requests for query cycle */ +var RUN_UPDATE = 601; + +/* MANIFOLD types */ +var TYPE_VALUE = 1; +var TYPE_RECORD = 2; +var TYPE_LIST_OF_VALUES = 3; +var TYPE_LIST_OF_RECORDS = 4; +// A structure for storing queries function QueryExt(query, parent_query_ext, main_query_ext, update_query_ext, disabled) { /* Constructor */ if (typeof query == "undefined") throw "Must pass a query in QueryExt constructor"; - this.query = query - this.parent_query_ext = (typeof parent_query_ext == "undefined") ? null : parent_query_ext - this.main_query_ext = (typeof main_query_ext == "undefined") ? null : main_query_ext - this.update_query_ext = (typeof update_query_ext == "undefined") ? null : update_query_ext - this.disabled = (typeof update_query_ext == "undefined") ? false : disabled + this.query = query; + this.parent_query_ext = (typeof parent_query_ext == "undefined") ? null : parent_query_ext; + this.main_query_ext = (typeof main_query_ext == "undefined") ? null : main_query_ext; + this.update_query_ext = (typeof update_query_ext == "undefined") ? null : update_query_ext; + this.update_query_orig_ext = (typeof update_query_orig_ext == "undefined") ? null : update_query_orig_ext; + this.disabled = (typeof update_query_ext == "undefined") ? false : disabled; this.status = null; this.results = null; @@ -93,10 +121,13 @@ function QueryStore() { update_query.analyzed_query.action = 'update'; update_query.params = {}; update_query_ext = new QueryExt(update_query); - console.log("Update query created from Get query", update_query); + + /* We remember the original query to be able to reset it */ + update_query_orig_ext = new QueryExt(update_query.clone()); + /* We store the main query */ - query_ext = new QueryExt(query, null, null, update_query_ext, false); + query_ext = new QueryExt(query, null, null, update_query_ext, update_query_orig_ext, false); manifold.query_store.main_queries[query.query_uuid] = query_ext; /* Note: the update query does not have an entry! */ @@ -172,6 +203,22 @@ var manifold = { } catch (err) { messages.debug("Cannot turn spins on/off " + err); } }, + get_type: function(variable) + { + switch(Object.toType(variable)) { + case 'number': + case 'string': + return TYPE_VALUE; + case 'object': + return TYPE_RECORD; + case 'array': + if ((variable.length > 0) && (Object.toType(variable[0]) === 'object')) + return TYPE_LIST_OF_RECORDS; + else + return TYPE_LIST_OF_VALUES; + } + }, + /************************************************************************** * Metadata management **************************************************************************/ @@ -290,6 +337,22 @@ var manifold = { } }, + run_query: function(query, callback) + { + // default value for callback = null + if (typeof callback === 'undefined') + callback = null; + + var query_json = JSON.stringify(query); + + /* Nothing related to pubsub here... for the moment at least. */ + //query.iter_subqueries(function (sq) { + // manifold.raise_record_event(sq.query_uuid, IN_PROGRESS); + //}); + + $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, null, callback /*domid*/)); + }, + // Executes all async. queries // input queries are specified as a list of {'query_uuid': , 'id': } asynchroneous_exec : function (query_publish_dom_tuples) { @@ -398,6 +461,237 @@ var manifold = { manifold.publish_result(query, result); }, + process_get_query_records: function(query, records) + { + /* This consists in managing the update query */ + + // We don't prepare an update query if the result has more than 1 entry + if (records.length == 1) { + var query_ext = manifold.query_store.find_query_ext(query.query_uuid); + + var record = records[0]; + + var update_query_ext = query_ext.update_query_ext; + var update_query = update_query_ext.query; + var update_query_ext = query_ext.update_query_ext; + var update_query_orig = query_ext.update_query_orig_ext.query; + + // Testing whether the result has subqueries (one level deep only) + // iif the query has subqueries + var count = 0; + var obj = query.analyzed_query.subqueries; + for (method in obj) { + if (obj.hasOwnProperty(method)) { + var key = manifold.metadata.get_key(method); + if (!key) + continue; + if (key.length > 1) + continue; + key = key[0]; + var sq_keys = []; + var subrecords = record[method]; + if (!subrecords) + continue + $.each(subrecords, function (i, subrecord) { + sq_keys.push(subrecord[key]); + }); + update_query.params[method] = sq_keys; + update_query_orig.params[method] = sq_keys.slice(); + count++; + } + } + + if (count > 0) { + update_query_ext.disabled = false; + update_query_orig_ext.disabled = false; + } + } + + /* Publish results */ + // NOTE: this is redundant only for Get queries + tmp_query = manifold.find_query(query.query_uuid); + manifold.publish_result_rec(tmp_query.analyzed_query, records); + }, + + /** + * + * What we need to do when receiving results from an update query: + * - differences between what we had, what we requested, and what we obtained + * . what we had : update_query_orig (simple fields and set fields managed differently) + * . what we requested : update_query + * . what we received : records + * - raise appropriate events + * + * The normal process is that results similar to Get will be pushed in the + * pubsub mechanism, thus repopulating everything while we only need + * diff's. This means we need to move the publish functionalities in the + * previous 'process_get_query_records' function. + */ + process_update_query_records: function(query, records) + { + // First issue: we request everything, and not only what we modify, so will will have to ignore some fields + var query_uuid = query.query_uuid; + var query_ext = manifold.query_store.find_analyzed_query_ext(query_uuid); + var update_query = query_ext.main_query_ext.update_query_ext.query; + var update_query_orig = query_ext.main_query_ext.update_query_orig_ext.query; + + // Since we update objects one at a time, we can get the first record + var record = records[0]; + + // Let's iterate over the object properties + for (var field in record) { + switch (this.get_type(record[field])) { + case TYPE_VALUE: + // Did we ask for a change ? + var update_value = update_query[field]; + if (!update_value) + // Not requested, if it has changed: OUT OF SYNC + // How we can know ? + // We assume it won't have changed + continue; + + var result_value = record[field]; + if (!result_value) + throw "Internal error"; + + data = { + request: FIELD_REQUEST_CHANGE, + key : field, + value : update_value, + status: (update_value == result_value) ? FIELD_REQUEST_SUCCESS : FIELD_REQUEST_FAILURE, + } + manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data); + + break; + case TYPE_RECORD: + throw "Not implemented"; + break; + + case TYPE_LIST_OF_VALUES: + // Same as list of records, but we don't have to extract keys + var result_keys = record[field] + + // The rest of exactly the same (XXX factorize) + var update_keys = update_query_orig.params[field]; + var query_keys = update_query.params[field]; + var added_keys = $.grep(query_keys, function (x) { return $.inArray(x, update_keys) == -1 }); + var removed_keys = $.grep(update_keys, function (x) { return $.inArray(x, query_keys) == -1 }); + + + $.each(added_keys, function(i, key) { + if ($.inArray(key, result_keys) == -1) { + data = { + request: FIELD_REQUEST_ADD, + key : field, + value : key, + status: FIELD_REQUEST_FAILURE, + } + } else { + data = { + request: FIELD_REQUEST_ADD, + key : field, + value : key, + status: FIELD_REQUEST_SUCCESS, + } + } + manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data); + }); + $.each(removed_keys, function(i, key) { + if ($.inArray(key, result_keys) == -1) { + data = { + request: FIELD_REQUEST_REMOVE, + key : field, + value : key, + status: FIELD_REQUEST_SUCCESS, + } + } else { + data = { + request: FIELD_REQUEST_REMOVE, + key : field, + value : key, + status: FIELD_REQUEST_FAILURE, + } + } + manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data); + }); + + + break; + case TYPE_LIST_OF_RECORDS: + // example: slice.resource + // - update_query_orig.params.resource = resources in slice before update + // - update_query.params.resource = resource requested in slice + // - keys from field = resources obtained + var key = manifold.metadata.get_key(field); + if (!key) + continue; + if (key.length > 1) { + throw "Not implemented"; + continue; + } + key = key[0]; + + /* XXX should be modified for multiple keys */ + var result_keys = $.map(record[field], function(x) { return x[key]; }); + + var update_keys = update_query_orig.params[field]; + var query_keys = update_query.params[field]; + var added_keys = $.grep(query_keys, function (x) { return $.inArray(x, update_keys) == -1 }); + var removed_keys = $.grep(update_keys, function (x) { return $.inArray(x, query_keys) == -1 }); + + + $.each(added_keys, function(i, key) { + if ($.inArray(key, result_keys) == -1) { + data = { + request: FIELD_REQUEST_ADD, + key : field, + value : key, + status: FIELD_REQUEST_FAILURE, + } + } else { + data = { + request: FIELD_REQUEST_ADD, + key : field, + value : key, + status: FIELD_REQUEST_SUCCESS, + } + } + manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data); + }); + $.each(removed_keys, function(i, key) { + if ($.inArray(key, result_keys) == -1) { + data = { + request: FIELD_REQUEST_REMOVE, + key : field, + value : key, + status: FIELD_REQUEST_SUCCESS, + } + } else { + data = { + request: FIELD_REQUEST_REMOVE, + key : field, + value : key, + status: FIELD_REQUEST_FAILURE, + } + } + manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data); + }); + + + break; + } + } + }, + + process_query_records: function(query, records) + { + if (query.action == 'get') { + this.process_get_query_records(query, records); + } else if (query.action == 'update') { + this.process_update_query_records(query, records); + } + }, + // 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 @@ -417,7 +711,8 @@ var manifold = { 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] ); + if (publish_uuid) + $.publish("/results/" + publish_uuid + "/failed", [data.code, data.description] ); $("#notifications").notify("create", "sticky", { title: 'Warning', @@ -431,74 +726,12 @@ var manifold = { // 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 - */ - - // XXX We might need to update the corresponding update_query here - query_ext = manifold.query_store.find_query_ext(query.query_uuid); - query = query_ext.query; - - // We don't prepare an update query if the result has more than 1 entry - if (result.length == 1) { - var res = result[0]; - - console.log("Locating update query for updating params", update_query); - update_query_ext = query_ext.update_query_ext; - update_query = update_query_ext.query; - - // Testing whether the result has subqueries (one level deep only) - // iif the query has subqueries - var count = 0; - var obj = query.analyzed_query.subqueries; - for (method in obj) { - if (obj.hasOwnProperty(method)) { - var key = manifold.metadata.get_key(method); - if (!key) - continue; - if (key.length > 1) - continue; - key = key[0]; - var sq_keys = []; - var records = res[method]; - if (!records) - continue - $.each(records, function (i, obj) { - sq_keys.push(obj[key]); - }); - update_query.params[method] = sq_keys; - count++; - } - } - - if (count > 0) { - update_query_ext.disabled = false; - } - - } - - - - // We have results from the main query - // inspect subqueries and get the key for each - - // XXX note that we might need the name for each relation, but - // this might be for SET_ADD, since we need to recursively find - // the path from the main query - - - tmp_query = manifold.find_query(query.query_uuid); - manifold.publish_result_rec(tmp_query.analyzed_query, result); - //} + /* Eventually update the content of related queries (update, etc) */ + this.process_query_records(query, result); + /* Publish results: disabled here, done in the previous call */ + //tmp_query = manifold.find_query(query.query_uuid); + //manifold.publish_result_rec(tmp_query.analyzed_query, result); } }, @@ -539,13 +772,63 @@ var manifold = { query = query_ext.query; switch(event_type) { + case FIELD_STATE_CHANGED: + // value is an object (request, key, value, status) + // update is only possible is the query is not pending, etc + // SET_ADD is on a subquery, FIELD_STATE_CHANGED on the query itself + // we should map SET_ADD on this... + + // 1. Update internal query store about the change in status + + // 2. Update the update query + update_query = query_ext.main_query_ext.update_query_ext.query; + update_query_orig = query_ext.main_query_ext.update_query_orig_ext.query; + + switch(value.request) { + case FIELD_REQUEST_CHANGE: + update_query.params[value.key] = value.value; + break; + case FIELD_REQUEST_ADD: + if ($.inArray(value.value, update_query_orig.params[value.key]) != -1) + value.request = FIELD_REQUEST_RESET; + update_query.params[value.key].push(value.value); + break; + case FIELD_REQUEST_REMOVE: + if ($.inArray(value.value, update_query_orig.params[value.key]) == -1) + value.request = FIELD_REQUEST_RESET; + + var arr = update_query.params[value.key]; + arr = $.grep(arr, function(x) { return x != value.value; }); + update_query.params[value.key] = arr; + + break; + case FIELD_REQUEST_RESET: + // XXX We would need to keep track of the original query + throw "Not implemented"; + break; + } + + // 3. Inform others about the change + // a) the main query... + manifold.raise_record_event(query_uuid, event_type, value); + + // b) subqueries eventually (dot in the key) + // XXX make this DOT a global variable... could be '/' + break; + case SET_ADD: + case SET_REMOVED: + // 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.main_query_ext.update_query_ext.query; + // old // update_query = query_ext.main_query_ext.update_query_ext.query; + + // This SET_ADD is called on a subquery, so we have to + // recontruct the path of the key in the main_query + // We then call FIELD_STATE_CHANGED which is the equivalent for the main query var path = ""; var sq = query_ext; @@ -556,8 +839,17 @@ var manifold = { sq = sq.parent_query_ext; } - update_query.params[path].push(value); - console.log('Updated query params', update_query); + main_query = query_ext.main_query_ext.query; + data = { + request: (event_type == SET_ADD) ? FIELD_REQUEST_ADD : FIELD_REQUEST_REMOVE, + key : path, + value : value, + status: FIELD_REQUEST_PENDING, + }; + this.raise_event(main_query.query_uuid, FIELD_STATE_CHANGED, data); + + // old //update_query.params[path].push(value); + // old // console.log('Updated query params', update_query); // 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 ?) @@ -566,21 +858,19 @@ var manifold = { // object = the same as get // filter = key : update a single object for now // fields = the same as get + manifold.raise_query_event(query_uuid, event_type, value); break; - case SET_REMOVED: - // Query uuid has been updated with the key of a removed element - break; case RUN_UPDATE: - update_query = query_ext.main_query_ext.update_query_ext.query; - - manifold.asynchroneous_exec ( [ {'query_uuid': update_query.query_uuid, 'publish_uuid' : query_uuid} ], false); + manifold.run_query(query_ext.main_query_ext.update_query_ext.query); break; case FILTER_ADDED: + manifold.raise_query_event(query_uuid, event_type, value); break; case FILTER_REMOVED: + manifold.raise_query_event(query_uuid, event_type, value); break; case FIELD_ADDED: main_query = query_ext.main_query_ext.query; @@ -595,6 +885,7 @@ var manifold = { // XXX When is an update query associated ? // XXX main_update_query.select(value); + manifold.raise_query_event(query_uuid, event_type, value); break; case FIELD_REMOVED: