2 function debug_dict_keys (msg, o) {
4 for (var k in o) keys.push(k);
5 messages.debug ("debug_dict_keys: " + msg + " keys= " + keys);
7 function debug_dict (msg, o) {
8 for (var k in o) messages.debug ("debug_dict: " + msg + " [" + k + "]=" + o[k]);
10 function debug_value (msg, value) {
11 messages.debug ("debug_value: " + msg + " " + value);
13 function debug_query (msg, query) {
14 if (query === undefined) messages.debug ("debug_query: " + msg + " -> undefined");
15 else if (query == null) messages.debug ("debug_query: " + msg + " -> null");
16 else if ('query_uuid' in query) messages.debug ("debug_query: " + msg + query.__repr());
17 else messages.debug ("debug_query: " + msg + " query= " + query);
20 /* ------------------------------------------------------------ */
22 // Constants that should be somehow moved to a plugin.js file
24 var FILTER_REMOVED = 2;
25 var CLEAR_FILTERS = 3;
27 var FIELD_REMOVED = 5;
30 var CLEAR_RECORDS = 8;
32 var IN_PROGRESS = 101;
36 * This namespace holds functions for globally managing query objects
43 spin: function(locator, active /*= true */) {
44 active = typeof active !== 'undefined' ? active : true;
47 $(locator).spin(manifold.spin_presets);
49 $(locator).spin(false);
51 } catch (err) { messages.debug("Cannot turn spins on/off " + err); }
55 * Associative array storing the set of queries active on the page
61 * Insert a query in the global hash table associating uuids to queries.
62 * If the query has no been analyzed yet, let's do it.
63 * \fn insert_query(query)
65 * \param ManifoldQuery query Query to be added
67 insert_query : function (query) {
68 if (query.analyzed_query == null) {
69 query.analyze_subqueries();
71 manifold.all_queries[query.query_uuid]=query;
75 * Returns the query associated to a UUID
76 * \fn find_query(query_uuid)
78 * \param string query_uuid The UUID of the query to be returned
80 find_query : function (query_uuid) {
81 return manifold.all_queries[query_uuid];
84 // trigger a query asynchroneously
85 proxy_url : '/manifold/proxy/json/',
87 asynchroneous_debug : true,
90 * \brief We use js function closure to be able to pass the query (array)
91 * to the callback function used when data is received
93 success_closure: function(query, publish_uuid, callback /*domid*/)
95 return function(data, textStatus) {
96 manifold.asynchroneous_success(data, query, publish_uuid, callback /*domid*/);
100 // Executes all async. queries
101 // input queries are specified as a list of {'query_uuid': <query_uuid>, 'id': <possibly null>}
102 asynchroneous_exec : function (query_publish_dom_tuples) {
105 // in case the spin stuff was not loaded, let's make sure we proceed to the exit
107 // if (manifold.asynchroneous_debug)
108 // messages.debug("Turning on spin with " + jQuery(".need-spin").length + " matches for .need-spin");
109 // jQuery('.need-spin').spin(manifold.spin_presets);
110 //} catch (err) { messages.debug("Cannot turn on spins " + err); }
112 // Loop through input array, and use publish_uuid to publish back results
113 jQuery.each(query_publish_dom_tuples, function(index, tuple) {
114 var query=manifold.find_query(tuple.query_uuid);
115 var query_json=JSON.stringify (query);
116 var publish_uuid=tuple.publish_uuid;
117 // by default we publish using the same uuid of course
118 if (publish_uuid==undefined) publish_uuid=query.query_uuid;
119 if (manifold.asynchroneous_debug) {
120 messages.debug("sending POST on " + manifold.proxy_url + " to be published on " + publish_uuid);
121 messages.debug("... ctd... with actual query= " + query.__repr());
124 query.iter_subqueries(function (sq) {
125 $('.plugin').trigger(manifold.get_record_channel(sq.query_uuid), [IN_PROGRESS]);
128 // not quite sure what happens if we send a string directly, as POST data is named..
129 // this gets reconstructed on the proxy side with ManifoldQuery.fill_from_POST
130 jQuery.post(manifold.proxy_url, {'json':query_json} , manifold.success_closure(query, publish_uuid, tuple.callback /*domid*/));
135 * \brief Forward a query to the manifold backend
136 * \param query (dict) the query to be executed asynchronously
137 * \param callback (function) the function to be called when the query terminates
139 * \param domid (string) the domid to be notified about the results (null for using the pub/sub system
141 forward: function(query, callback /*domid*/) {
142 var query_json = JSON.stringify(query);
143 $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, query.query_uuid, callback/*domid*/));
147 * Returns whether a query expects a unique results.
148 * This is the case when the filters contain a key of the object
149 * \fn query_expects_unique_result(query)
151 * \param ManifoldQuery query Query for which we are testing whether it expects a unique result
153 query_expects_unique_result: function(query) {
154 /* XXX we need functions to query metadata */
155 //var keys = MANIFOLD_METADATA[query.object]['keys']; /* array of array of field names */
156 /* TODO requires keys in metadata */
162 * \fn publish_result(query, results)
164 * \param ManifoldQuery query Query which has received results
165 * \param array results results corresponding to query
167 publish_result: function(query, result) {
168 if (typeof result === 'undefined')
172 var channel = manifold.get_record_channel(query.query_uuid);
173 $('.plugin').trigger(channel, [CLEAR_RECORDS]);
174 $.each(result, function(i, record) {
175 $('.plugin').trigger(channel, [NEW_RECORD, record]);
177 $('.plugin').trigger(channel, [DONE]);
179 // OLD PLUGIN API BELOW
180 /* Publish an update announce */
181 var channel="/results/" + query.query_uuid + "/changed";
182 if (manifold.asynchroneous_debug)
183 messages.debug("publishing result on " + channel);
184 jQuery.publish(channel, [result, query]);
188 * Recursively publish result
189 * \fn publish_result_rec(query, result)
191 * \param ManifoldQuery query Query which has received result
192 * \param array result result corresponding to query
194 publish_result_rec: function(query, result) {
195 /* If the result is not unique, only publish the top query;
196 * otherwise, publish the main object as well as subqueries
197 * XXX how much recursive are we ?
199 if (manifold.query_expects_unique_result(query)) {
200 /* Also publish subqueries */
201 jQuery.each(query.subqueries, function(object, subquery) {
202 manifold.publish_result_rec(subquery, result[0][object]);
203 /* TODO remove object from result */
206 manifold.publish_result(query, result);
209 // if set domid allows the result to be directed to just one plugin
210 // most of the time publish_uuid will be query.query_uuid
211 // however in some cases we wish to publish the result under a different uuid
212 // e.g. an updater wants to publish its result as if from the original (get) query
213 asynchroneous_success : function (data, query, publish_uuid, callback /*domid*/) {
214 // xxx should have a nicer declaration of that enum in sync with the python code somehow
216 /* If a callback has been specified, we redirect results to it */
217 if (!!callback) { callback(data); return; }
219 if (data.code == 2) { // ERROR
220 alert("Your session has expired, please log in again");
221 window.location="/logout/";
224 if (data.code == 1) { // WARNING
225 messages.error("Some errors have been received from the manifold backend at " + MANIFOLD_URL + " [" + data.description + "]");
226 // publish error code and text message on a separate channel for whoever is interested
227 jQuery.publish("/results/" + publish_uuid + "/failed", [data.code, data.description] );
229 // once everything is checked we can use the 'value' part of the manifoldresult
230 var result=data.value;
232 //if (!!callback /* domid */) {
233 // /* Directly inform the requestor */
234 // if (manifold.asynchroneous_debug) messages.debug("directing result to callback");
236 // //if (manifold.asynchroneous_debug) messages.debug("directing result to " + domid);
237 // //jQuery('#' + domid).trigger('results', [result]);
239 /* XXX Jordan XXX I don't need publish_uuid here... What is it used for ? */
240 /* query is the query we sent to the backend; we need to find the
241 * corresponding analyezd_query in manifold.all_queries
243 tmp_query = manifold.find_query(query.query_uuid);
244 manifold.publish_result_rec(tmp_query.analyzed_query, result);
250 /* Publish/subscribe channels for internal use */
251 get_query_channel: function(uuid) { return '/query/' + uuid },
252 get_record_channel: function(uuid) { return '/record/' + uuid },
254 }; // manifold object
255 /* ------------------------------------------------------------ */
261 * NOTE: Since we don't have a plugin class, we are extending all jQuery
266 * \brief Associates a query handler to the current plugin
267 * \param uuid (string) query uuid
268 * \param handler (function) handler callback
270 $.fn.set_query_handler = function(uuid, handler)
272 this.on(manifold.get_query_channel(uuid), handler);
275 $.fn.set_record_handler = function(uuid, handler)
277 this.on(manifold.get_record_channel(uuid), handler);
280 // OLD PLUGIN API: extend jQuery/$ with pubsub capabilities
281 // https://gist.github.com/661855
283 $.subscribe = function( channel, selector, data, fn) {
284 /* borrowed from jQuery */
285 if ( data == null && fn == null ) {
288 data = selector = undefined;
289 } else if ( fn == null ) {
290 if ( typeof selector === "string" ) {
291 // ( channel, selector, fn )
295 // ( channel, data, fn )
298 selector = undefined;
303 /* We use an indirection function that will clone the object passed in
304 * parameter to the subscribe callback
306 * FIXME currently we only clone query objects which are the only ones
307 * supported and editable, we might have the same issue with results but
308 * the page load time will be severely affected...
310 o.on.apply(o, [channel, selector, data, function() {
311 for(i = 1; i < arguments.length; i++) {
312 if ( arguments[i].constructor.name == 'ManifoldQuery' )
313 arguments[i] = arguments[i].clone();
315 fn.apply(o, arguments);
319 $.unsubscribe = function() {
320 o.off.apply(o, arguments);
323 $.publish = function() {
324 o.trigger.apply(o, arguments);
329 /* ------------------------------------------------------------ */
331 //http://stackoverflow.com/questions/5100539/django-csrf-check-failing-with-an-ajax-post-request
332 //make sure to expose csrf in our outcoming ajax/post requests
334 beforeSend: function(xhr, settings) {
335 function getCookie(name) {
336 var cookieValue = null;
337 if (document.cookie && document.cookie != '') {
338 var cookies = document.cookie.split(';');
339 for (var i = 0; i < cookies.length; i++) {
340 var cookie = jQuery.trim(cookies[i]);
341 // Does this cookie string begin with the name we want?
342 if (cookie.substring(0, name.length + 1) == (name + '=')) {
343 cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
350 if (!(/^http:.*/.test(settings.url) || /^https:.*/.test(settings.url))) {
351 // Only send the token to relative URLs i.e. locally.
352 xhr.setRequestHeader("X-CSRFToken", getCookie('csrftoken'));