manifold/js/manifold.js

   1 // utilities
   2 function debug_dict_keys (msg, o) {
   3     var keys=[];
   4     for (var k in o) keys.push(k);
   5     messages.debug ("debug_dict_keys: " + msg + " keys= " + keys);
   6 }
   7 function debug_dict (msg, o) {
   8     for (var k in o) messages.debug ("debug_dict: " + msg + " [" + k + "]=" + o[k]);
   9 }
  10 function debug_value (msg, value) {
  11     messages.debug ("debug_value: " + msg + " " + value);
  12 }
  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);
  18 }
  19
  20 /* ------------------------------------------------------------ */
  21
  22 /*!
  23  * This namespace holds functions for globally managing query objects
  24  * \Class Manifold
  25  */
  26 var manifold = {
  27
  28     spin_presets: {},
  29
  30     spin: function(locator, active /*= true */) {
  31         active = typeof active !== 'undefined' ? active : true;
  32         try {
  33             if (active) {
  34                 $(locator).spin(manifold.spin_presets);
  35             } else {
  36                 $locator.spin(false);
  37             }
  38         } catch (err) { messages.debug("Cannot turn spins on/off " + err); }
  39     },
  40
  41     /*!
  42      * Associative array storing the set of queries active on the page
  43      * \memberof Manifold
  44      */
  45     all_queries: {},
  46
  47     /*!
  48      * Insert a query in the global hash table associating uuids to queries.
  49      * If the query has no been analyzed yet, let's do it.
  50      * \fn insert_query(query)
  51      * \memberof Manifold
  52      * \param ManifoldQuery query Query to be added
  53      */
  54     insert_query : function (query) {
  55         if (query.analyzed_query == null) {
  56             query.analyze_subqueries();
  57         }
  58         manifold.all_queries[query.query_uuid]=query;
  59     },
  60
  61     /*!
  62      * Returns the query associated to a UUID
  63      * \fn find_query(query_uuid)
  64      * \memberof Manifold
  65      * \param string query_uuid The UUID of the query to be returned
  66      */
  67     find_query : function (query_uuid) {
  68         return manifold.all_queries[query_uuid];
  69     },
  70
  71     // trigger a query asynchroneously
  72     proxy_url : '/manifold/proxy/json/',
  73
  74     asynchroneous_debug : true,
  75
  76     /**
  77      * \brief We use js function closure to be able to pass the query (array)
  78      * to the callback function used when data is received
  79      */
  80     success_closure: function(query, publish_uuid, callback /*domid*/)
  81     {
  82         return function(data, textStatus) {
  83             manifold.asynchroneous_success(data, query, publish_uuid, callback /*domid*/);
  84         }
  85     },
  86
  87     // Executes all async. queries
  88     // input queries are specified as a list of {'query_uuid': <query_uuid>, 'id': <possibly null>}
  89     asynchroneous_exec : function (query_publish_dom_tuples) {
  90         // start spinners
  91
  92         // in case the spin stuff was not loaded, let's make sure we proceed to the exit
  93         try {
  94             if (manifold.asynchroneous_debug)
  95             messages.debug("Turning on spin with " + jQuery(".need-spin").length + " matches for .need-spin");
  96             jQuery('.need-spin').spin(manifold.spin_presets);
  97         } catch (err) { messages.debug("Cannot turn on spins " + err); }
  98
  99         // Loop through input array, and use publish_uuid to publish back results
 100         jQuery.each(query_publish_dom_tuples, function(index, tuple) {
 101             var query=manifold.find_query(tuple.query_uuid);
 102             var query_json=JSON.stringify (query);
 103             var publish_uuid=tuple.publish_uuid;
 104             // by default we publish using the same uuid of course
 105             if (publish_uuid==undefined) publish_uuid=query.query_uuid;
 106             if (manifold.asynchroneous_debug) {
 107                 messages.debug("sending POST on " + manifold.proxy_url + " to be published on " + publish_uuid);
 108                 messages.debug("... ctd... with actual query= " + query.__repr());
 109             }
 110             // not quite sure what happens if we send a string directly, as POST data is named..
 111             // this gets reconstructed on the proxy side with ManifoldQuery.fill_from_POST
 112                 jQuery.post(manifold.proxy_url, {'json':query_json} , manifold.success_closure(query, publish_uuid, tuple.callback /*domid*/));
 113         })
 114     },
 115
 116     /**
 117      * \brief Forward a query to the manifold backend
 118      * \param query (dict) the query to be executed asynchronously
 119      * \param callback (function) the function to be called when the query terminates
 120      * Deprecated:
 121      * \param domid (string) the domid to be notified about the results (null for using the pub/sub system
 122      */
 123     forward: function(query, callback /*domid*/) {
 124         var query_json = JSON.stringify(query);
 125         $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, query.query_uuid, callback/*domid*/));
 126     },
 127
 128     /*!
 129      * Returns whether a query expects a unique results.
 130      * This is the case when the filters contain a key of the object
 131      * \fn query_expects_unique_result(query)
 132      * \memberof Manifold
 133      * \param ManifoldQuery query Query for which we are testing whether it expects a unique result
 134      */
 135     query_expects_unique_result: function(query) {
 136         /* XXX we need functions to query metadata */
 137         //var keys = MANIFOLD_METADATA[query.object]['keys']; /* array of array of field names */
 138         /* TODO requires keys in metadata */
 139         return true;
 140     },
 141
 142     /*!
 143      * Publish result
 144      * \fn publish_result(query, results)
 145      * \memberof Manifold
 146      * \param ManifoldQuery query Query which has received results
 147      * \param array results results corresponding to query
 148      */
 149     publish_result: function(query, result) {
 150         /* Publish an update announce */
 151         var channel="/results/" + query.query_uuid + "/changed";
 152         if (manifold.asynchroneous_debug)
 153             messages.debug("publishing result on " + channel);
 154         if (typeof result === 'undefined')
 155             result = [];
 156         jQuery.publish(channel, [result, query]);
 157     },
 158
 159     /*!
 160      * Recursively publish result
 161      * \fn publish_result_rec(query, result)
 162      * \memberof Manifold
 163      * \param ManifoldQuery query Query which has received result
 164      * \param array result result corresponding to query
 165      */
 166     publish_result_rec: function(query, result) {
 167         /* If the result is not unique, only publish the top query;
 168          * otherwise, publish the main object as well as subqueries
 169          * XXX how much recursive are we ?
 170          */
 171         if (manifold.query_expects_unique_result(query)) {
 172             /* Also publish subqueries */
 173             jQuery.each(query.subqueries, function(object, subquery) {
 174                 manifold.publish_result_rec(subquery, result[0][object]);
 175                 /* TODO remove object from result */
 176             });
 177         }
 178         manifold.publish_result(query, result);
 179     },
 180
 181     // if set domid allows the result to be directed to just one plugin
 182     // most of the time publish_uuid will be query.query_uuid
 183     // however in some cases we wish to publish the result under a different uuid
 184     // e.g. an updater wants to publish its result as if from the original (get) query
 185     asynchroneous_success : function (data, query, publish_uuid, callback /*domid*/) {
 186         // xxx should have a nicer declaration of that enum in sync with the python code somehow
 187
 188         /* If a callback has been specified, we redirect results to it */
 189         if (!!callback) { callback(data); return; }
 190
 191         if (data.code == 2) { // ERROR
 192             alert("Your session has expired, please log in again");
 193             window.location="/logout/";
 194             return;
 195         }
 196         if (data.code == 1) { // WARNING
 197             messages.error("Some errors have been received from the manifold backend at " + MANIFOLD_URL + " [" + data.description + "]");
 198             // publish error code and text message on a separate channel for whoever is interested
 199             jQuery.publish("/results/" + publish_uuid + "/failed", [data.code, data.description] );
 200         }
 201         // once everything is checked we can use the 'value' part of the manifoldresult
 202         var result=data.value;
 203         if (result) {
 204             //if (!!callback /* domid */) {
 205             //    /* Directly inform the requestor */
 206             //    if (manifold.asynchroneous_debug) messages.debug("directing result to callback");
 207             //    callback(result);
 208             //    //if (manifold.asynchroneous_debug) messages.debug("directing result to " + domid);
 209             //    //jQuery('#' + domid).trigger('results', [result]);
 210             //} else {
 211                 /* XXX Jordan XXX I don't need publish_uuid here... What is it used for ? */
 212                 /* query is the query we sent to the backend; we need to find the
 213                  * corresponding analyezd_query in manifold.all_queries
 214                  */
 215                 tmp_query = manifold.find_query(query.query_uuid);
 216                 manifold.publish_result_rec(tmp_query.analyzed_query, result);
 217             //}
 218
 219         }
 220     },
 221
 222 }; // manifold object
 223 /* ------------------------------------------------------------ */
 224
 225 // extend jQuery/$ with pubsub capabilities
 226 /* https://gist.github.com/661855 */
 227 (function($) {
 228
 229   var o = $({});
 230
 231   $.subscribe = function( channel, selector, data, fn) {
 232     /* borrowed from jQuery */
 233     if ( data == null && fn == null ) {
 234         // ( channel, fn )
 235         fn = selector;
 236         data = selector = undefined;
 237     } else if ( fn == null ) {
 238         if ( typeof selector === "string" ) {
 239             // ( channel, selector, fn )
 240             fn = data;
 241             data = undefined;
 242         } else {
 243             // ( channel, data, fn )
 244             fn = data;
 245             data = selector;
 246             selector = undefined;
 247         }
 248     }
 249     /* </ugly> */
 250
 251     /* We use an indirection function that will clone the object passed in
 252      * parameter to the subscribe callback
 253      *
 254      * FIXME currently we only clone query objects which are the only ones
 255      * supported and editable, we might have the same issue with results but
 256      * the page load time will be severely affected...
 257      */
 258     o.on.apply(o, [channel, selector, data, function() {
 259         for(i = 1; i < arguments.length; i++) {
 260             if ( arguments[i].constructor.name == 'ManifoldQuery' )
 261                 arguments[i] = arguments[i].clone();
 262         }
 263         fn.apply(o, arguments);
 264     }]);
 265   };
 266
 267   $.unsubscribe = function() {
 268     o.off.apply(o, arguments);
 269   };
 270
 271   $.publish = function() {
 272     o.trigger.apply(o, arguments);
 273   };
 274
 275 }(jQuery));
 276
 277 /* ------------------------------------------------------------ */
 278
 279 //http://stackoverflow.com/questions/5100539/django-csrf-check-failing-with-an-ajax-post-request
 280 //make sure to expose csrf in our outcoming ajax/post requests
 281 $.ajaxSetup({
 282      beforeSend: function(xhr, settings) {
 283          function getCookie(name) {
 284              var cookieValue = null;
 285              if (document.cookie && document.cookie != '') {
 286                  var cookies = document.cookie.split(';');
 287                  for (var i = 0; i < cookies.length; i++) {
 288                      var cookie = jQuery.trim(cookies[i]);
 289                      // Does this cookie string begin with the name we want?
 290                  if (cookie.substring(0, name.length + 1) == (name + '=')) {
 291                      cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
 292                      break;
 293                  }
 294              }
 295          }
 296          return cookieValue;
 297          }
 298          if (!(/^http:.*/.test(settings.url) || /^https:.*/.test(settings.url))) {
 299              // Only send the token to relative URLs i.e. locally.
 300              xhr.setRequestHeader("X-CSRFToken", getCookie('csrftoken'));
 301          }
 302      }
 303 });
 304