manifold/static/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 // http://javascriptweblog.wordpress.com/2011/08/08/fixing-the-javascript-typeof-operator/
  21 Object.toType = (function toType(global) {
  22   return function(obj) {
  23     if (obj === global) {
  24       return "global";
  25     }
  26     return ({}).toString.call(obj).match(/\s([a-z|A-Z]+)/)[1].toLowerCase();
  27   }
  28 })(this);
  29
  30 /* ------------------------------------------------------------ */
  31
  32 // Constants that should be somehow moved to a plugin.js file
  33 var FILTER_ADDED   = 1;
  34 var FILTER_REMOVED = 2;
  35 var CLEAR_FILTERS  = 3;
  36 var FIELD_ADDED    = 4;
  37 var FIELD_REMOVED  = 5;
  38 var CLEAR_FIELDS   = 6;
  39 var NEW_RECORD     = 7;
  40 var CLEAR_RECORDS  = 8;
  41 var FIELD_STATE_CHANGED = 9;
  42
  43 var IN_PROGRESS    = 101;
  44 var DONE           = 102;
  45
  46 /* Update requests related to subqueries */
  47 var SET_ADD        = 201;
  48 var SET_REMOVED    = 202;
  49
  50 // request
  51 var FIELD_REQUEST_CHANGE  = 301;
  52 var FIELD_REQUEST_ADD     = 302;
  53 var FIELD_REQUEST_REMOVE  = 303;
  54 var FIELD_REQUEST_ADD_RESET = 304;
  55 var FIELD_REQUEST_REMOVE_RESET = 305;
  56 // status
  57 var FIELD_REQUEST_PENDING = 401;
  58 var FIELD_REQUEST_SUCCESS = 402;
  59 var FIELD_REQUEST_FAILURE = 403;
  60
  61 /* Query status */
  62 var STATUS_NONE               = 500; // Query has not been started yet
  63 var STATUS_GET_IN_PROGRESS    = 501; // Query has been sent, no result has been received
  64 var STATUS_GET_RECEIVED       = 502; // Success
  65 var STATUS_GET_ERROR          = 503; // Error
  66 var STATUS_UPDATE_PENDING     = 504;
  67 var STATUS_UPDATE_IN_PROGRESS = 505;
  68 var STATUS_UPDATE_RECEIVED    = 506;
  69 var STATUS_UPDATE_ERROR       = 507;
  70
  71 /* Requests for query cycle */
  72 var RUN_UPDATE     = 601;
  73
  74 /* MANIFOLD types */
  75 var TYPE_VALUE  = 1;
  76 var TYPE_RECORD = 2;
  77 var TYPE_LIST_OF_VALUES = 3;
  78 var TYPE_LIST_OF_RECORDS = 4;
  79
  80
  81 // A structure for storing queries
  82
  83 function QueryExt(query, parent_query_ext, main_query_ext, update_query_ext, disabled) {
  84
  85     /* Constructor */
  86     if (typeof query == "undefined")
  87         throw "Must pass a query in QueryExt constructor";
  88     this.query                 = query;
  89     this.parent_query_ext      = (typeof parent_query_ext      == "undefined") ? null  : parent_query_ext;
  90     this.main_query_ext        = (typeof main_query_ext        == "undefined") ? null  : main_query_ext;
  91     this.update_query_ext      = (typeof update_query_ext      == "undefined") ? null  : update_query_ext;
  92     this.update_query_orig_ext = (typeof update_query_orig_ext == "undefined") ? null  : update_query_orig_ext;
  93     this.disabled              = (typeof update_query_ext      == "undefined") ? false : disabled;
  94
  95     this.status       = null;
  96     this.results      = null;
  97     // update_query null unless we are a main_query (aka parent_query == null); only main_query_fields can be updated...
  98 }
  99
 100 function QueryStore() {
 101
 102     this.main_queries     = {};
 103     this.analyzed_queries = {};
 104
 105     /* Insertion */
 106
 107     this.insert = function(query) {
 108         // We expect only main_queries are inserted
 109
 110         /* If the query has not been analyzed, then we analyze it */
 111         if (query.analyzed_query == null) {
 112             query.analyze_subqueries();
 113         }
 114
 115         /* We prepare the update query corresponding to the main query and store both */
 116         /* Note: they have the same UUID */
 117
 118         // XXX query.change_action() should become deprecated
 119         update_query = query.clone();
 120         update_query.action = 'update';
 121         update_query.analyzed_query.action = 'update';
 122         update_query.params = {};
 123         update_query_ext = new QueryExt(update_query);
 124
 125         /* We remember the original query to be able to reset it */
 126         update_query_orig_ext = new QueryExt(update_query.clone());
 127
 128
 129         /* We store the main query */
 130         query_ext = new QueryExt(query, null, null, update_query_ext, update_query_orig_ext, false);
 131         manifold.query_store.main_queries[query.query_uuid] = query_ext;
 132         /* Note: the update query does not have an entry! */
 133
 134
 135         // The query is disabled; since it is incomplete until we know the content of the set of subqueries
 136         // XXX unless we have no subqueries ???
 137         // we will complete with params when records are received... this has to be done by the manager
 138         // SET_ADD, SET_REMOVE will change the status of the elements of the set
 139         // UPDATE will change also, etc.
 140         // XXX We need a proper structure to store this information...
 141
 142         // We also need to insert all queries and subqueries from the analyzed_query
 143         // XXX We need the root of all subqueries
 144         query.iter_subqueries(function(sq, data, parent_query) {
 145             if (parent_query)
 146                 parent_query_ext = manifold.query_store.find_analyzed_query_ext(parent_query.query_uuid);
 147             else
 148                 parent_query_ext = null;
 149             // XXX parent_query_ext == false
 150             // XXX main.subqueries = {} # Normal, we need analyzed_query
 151             sq_ext = new QueryExt(sq, parent_query_ext, query_ext)
 152             manifold.query_store.analyzed_queries[sq.query_uuid] = sq_ext;
 153         });
 154
 155         // XXX We have spurious update queries...
 156     }
 157
 158     /* Searching */
 159
 160     this.find_query_ext = function(query_uuid) {
 161         return this.main_queries[query_uuid];
 162     }
 163
 164     this.find_query = function(query_uuid) {
 165         return this.find_query_ext(query_uuid).query;
 166     }
 167
 168     this.find_analyzed_query_ext = function(query_uuid) {
 169         return this.analyzed_queries[query_uuid];
 170     }
 171
 172     this.find_analyzed_query = function(query_uuid) {
 173         return this.find_analyzed_query_ext(query_uuid).query;
 174     }
 175 }
 176
 177 /*!
 178  * This namespace holds functions for globally managing query objects
 179  * \Class Manifold
 180  */
 181 var manifold = {
 182
 183     /**************************************************************************
 184      * Helper functions
 185      **************************************************************************/
 186
 187     separator: '__',
 188
 189     get_type: function(variable) {
 190         switch(Object.toType(variable)) {
 191             case 'number':
 192             case 'string':
 193                 return TYPE_VALUE;
 194             case 'object':
 195                 return TYPE_RECORD;
 196             case 'array':
 197                 if ((variable.length > 0) && (Object.toType(variable[0]) === 'object'))
 198                     return TYPE_LIST_OF_RECORDS;
 199                 else
 200                     return TYPE_LIST_OF_VALUES;
 201         }
 202     },
 203
 204     /**************************************************************************
 205      * Metadata management
 206      **************************************************************************/
 207
 208      metadata: {
 209
 210         get_table: function(method) {
 211             var table = MANIFOLD_METADATA[method];
 212             return (typeof table === 'undefined') ? null : table;
 213         },
 214
 215         get_columns: function(method) {
 216             var table = this.get_table(method);
 217             if (!table) {
 218                 return null;
 219             }
 220
 221             return (typeof table.column === 'undefined') ? null : table.column;
 222         },
 223
 224         get_key: function(method) {
 225             var table = this.get_table(method);
 226             if (!table)
 227                 return null;
 228
 229             return (typeof table.key === 'undefined') ? null : table.key;
 230         },
 231
 232
 233         get_column: function(method, name) {
 234             var columns = this.get_columns(method);
 235             if (!columns)
 236                 return null;
 237
 238             $.each(columns, function(i, c) {
 239                 if (c.name == name)
 240                     return c
 241             });
 242             return null;
 243         },
 244
 245         get_type: function(method, name) {
 246             var table = this.get_table(method);
 247             if (!table)
 248                 return null;
 249
 250             return (typeof table.type === 'undefined') ? null : table.type;
 251         }
 252
 253      },
 254
 255     /**************************************************************************
 256      * Query management
 257      **************************************************************************/
 258
 259     query_store: new QueryStore(),
 260
 261     // XXX Remaining functions are deprecated since they are replaced by the query store
 262
 263     /*!
 264      * Associative array storing the set of queries active on the page
 265      * \memberof Manifold
 266      */
 267     all_queries: {},
 268
 269     /*!
 270      * Insert a query in the global hash table associating uuids to queries.
 271      * If the query has no been analyzed yet, let's do it.
 272      * \fn insert_query(query)
 273      * \memberof Manifold
 274      * \param ManifoldQuery query Query to be added
 275      */
 276     insert_query : function (query) {
 277         // NEW API
 278         manifold.query_store.insert(query);
 279
 280         // FORMER API
 281         if (query.analyzed_query == null) {
 282             query.analyze_subqueries();
 283         }
 284         manifold.all_queries[query.query_uuid]=query;
 285     },
 286
 287     /*!
 288      * Returns the query associated to a UUID
 289      * \fn find_query(query_uuid)
 290      * \memberof Manifold
 291      * \param string query_uuid The UUID of the query to be returned
 292      */
 293     find_query : function (query_uuid) {
 294         return manifold.all_queries[query_uuid];
 295     },
 296
 297     /**************************************************************************
 298      * Query execution
 299      **************************************************************************/
 300
 301     // trigger a query asynchroneously
 302     proxy_url : '/manifold/proxy/json/',
 303
 304     // reasonably low-noise, shows manifold requests coming in and out
 305     asynchroneous_debug : true,
 306     // print our more details on result publication and related callbacks
 307     pubsub_debug : false,
 308
 309     /**
 310      * \brief We use js function closure to be able to pass the query (array)
 311      * to the callback function used when data is received
 312      */
 313     success_closure: function(query, publish_uuid, callback) {
 314         return function(data, textStatus) {
 315             manifold.asynchroneous_success(data, query, publish_uuid, callback);
 316         }
 317     },
 318
 319     run_query: function(query, callback) {
 320         // default value for callback = null
 321         if (typeof callback === 'undefined')
 322             callback = null;
 323
 324         var query_json = JSON.stringify(query);
 325
 326         /* Nothing related to pubsub here... for the moment at least. */
 327         //query.iter_subqueries(function (sq) {
 328         //    manifold.raise_record_event(sq.query_uuid, IN_PROGRESS);
 329         //});
 330
 331         $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, null, callback));
 332     },
 333
 334     // Executes all async. queries - intended for the javascript header to initialize queries
 335     // input queries are specified as a list of {'query_uuid': <query_uuid> }
 336     // each plugin is responsible for managing its spinner through on_query_in_progress
 337     asynchroneous_exec : function (query_exec_tuples) {
 338
 339         // Loop through input array, and use publish_uuid to publish back results
 340         $.each(query_exec_tuples, function(index, tuple) {
 341             var query=manifold.find_query(tuple.query_uuid);
 342             var query_json=JSON.stringify (query);
 343             var publish_uuid=tuple.publish_uuid;
 344             // by default we publish using the same uuid of course
 345             if (publish_uuid==undefined) publish_uuid=query.query_uuid;
 346             if (manifold.pubsub_debug) {
 347                 messages.debug("sending POST on " + manifold.proxy_url + query.__repr());
 348             }
 349
 350             query.iter_subqueries(function (sq) {
 351                 manifold.raise_record_event(sq.query_uuid, IN_PROGRESS);
 352             });
 353
 354             // not quite sure what happens if we send a string directly, as POST data is named..
 355             // this gets reconstructed on the proxy side with ManifoldQuery.fill_from_POST
 356             $.post(manifold.proxy_url, {'json':query_json},
 357                    manifold.success_closure(query, publish_uuid, tuple.callback));
 358         })
 359     },
 360
 361     /**
 362      * \brief Forward a query to the manifold backend
 363      * \param query (dict) the query to be executed asynchronously
 364      * \param callback (function) the function to be called when the query terminates
 365      */
 366     forward: function(query, callback) {
 367         var query_json = JSON.stringify(query);
 368         $.post(manifold.proxy_url, {'json': query_json} ,
 369                manifold.success_closure(query, query.query_uuid, callback));
 370     },
 371
 372     /*!
 373      * Returns whether a query expects a unique results.
 374      * This is the case when the filters contain a key of the object
 375      * \fn query_expects_unique_result(query)
 376      * \memberof Manifold
 377      * \param ManifoldQuery query Query for which we are testing whether it expects a unique result
 378      */
 379     query_expects_unique_result: function(query) {
 380         /* XXX we need functions to query metadata */
 381         //var keys = MANIFOLD_METADATA[query.object]['keys']; /* array of array of field names */
 382         /* TODO requires keys in metadata */
 383         return true;
 384     },
 385
 386     /*!
 387      * Publish result
 388      * \fn publish_result(query, results)
 389      * \memberof Manifold
 390      * \param ManifoldQuery query Query which has received results
 391      * \param array results results corresponding to query
 392      */
 393     publish_result: function(query, result) {
 394         if (typeof result === 'undefined')
 395             result = [];
 396
 397         // NEW PLUGIN API
 398         manifold.raise_record_event(query.query_uuid, CLEAR_RECORDS);
 399         if (manifold.pubsub_debug)
 400             messages.debug(".. publish_result (1) ");
 401         var count=0;
 402         $.each(result, function(i, record) {
 403             manifold.raise_record_event(query.query_uuid, NEW_RECORD, record);
 404             count += 1;
 405         });
 406         if (manifold.pubsub_debug)
 407             messages.debug(".. publish_result (2) has used NEW API on " + count + " records");
 408         manifold.raise_record_event(query.query_uuid, DONE);
 409         if (manifold.pubsub_debug)
 410             messages.debug(".. publish_result (3) has used NEW API to say DONE");
 411
 412         // OLD PLUGIN API BELOW
 413         /* Publish an update announce */
 414         var channel="/results/" + query.query_uuid + "/changed";
 415         if (manifold.pubsub_debug)
 416             messages.debug(".. publish_result (4) OLD API on channel" + channel);
 417
 418         $.publish(channel, [result, query]);
 419
 420         if (manifold.pubsub_debug)
 421             messages.debug(".. publish_result (5) END q=" + query.__repr());
 422     },
 423
 424     /*!
 425      * Recursively publish result
 426      * \fn publish_result_rec(query, result)
 427      * \memberof Manifold
 428      * \param ManifoldQuery query Query which has received result
 429      * \param array result result corresponding to query
 430      *
 431      * Note: this function works on the analyzed query
 432      */
 433     publish_result_rec: function(query, result) {
 434         /* If the result is not unique, only publish the top query;
 435          * otherwise, publish the main object as well as subqueries
 436          * XXX how much recursive are we ?
 437          */
 438         if (manifold.pubsub_debug)
 439             messages.debug (">>>>> publish_result_rec " + query.object);
 440         if (manifold.query_expects_unique_result(query)) {
 441             /* Also publish subqueries */
 442             $.each(query.subqueries, function(object, subquery) {
 443                 manifold.publish_result_rec(subquery, result[0][object]);
 444                 /* TODO remove object from result */
 445             });
 446         }
 447         if (manifold.pubsub_debug)
 448             messages.debug ("===== publish_result_rec " + query.object);
 449
 450         manifold.publish_result(query, result);
 451
 452         if (manifold.pubsub_debug)
 453             messages.debug ("<<<<< publish_result_rec " + query.object);
 454     },
 455
 456     setup_update_query: function(query, records) {
 457         // We don't prepare an update query if the result has more than 1 entry
 458         if (records.length != 1)
 459             return;
 460         var query_ext = manifold.query_store.find_query_ext(query.query_uuid);
 461
 462         var record = records[0];
 463
 464         var update_query_ext = query_ext.update_query_ext;
 465         var update_query = update_query_ext.query;
 466         var update_query_ext = query_ext.update_query_ext;
 467         var update_query_orig = query_ext.update_query_orig_ext.query;
 468
 469         // Testing whether the result has subqueries (one level deep only)
 470         // iif the query has subqueries
 471         var count = 0;
 472         var obj = query.analyzed_query.subqueries;
 473         for (method in obj) {
 474             if (obj.hasOwnProperty(method)) {
 475                 var key = manifold.metadata.get_key(method);
 476                 if (!key)
 477                     continue;
 478                 if (key.length > 1)
 479                     continue;
 480                 key = key[0];
 481                 var sq_keys = [];
 482                 var subrecords = record[method];
 483                 if (!subrecords)
 484                     continue
 485                 $.each(subrecords, function (i, subrecord) {
 486                     sq_keys.push(subrecord[key]);
 487                 });
 488                 update_query.params[method] = sq_keys;
 489                 update_query_orig.params[method] = sq_keys.slice();
 490                 count++;
 491             }
 492         }
 493
 494         if (count > 0) {
 495             update_query_ext.disabled = false;
 496             update_query_orig_ext.disabled = false;
 497         }
 498     },
 499
 500     process_get_query_records: function(query, records) {
 501         this.setup_update_query(query, records);
 502
 503         /* Publish full results */
 504         var tmp_query = manifold.find_query(query.query_uuid);
 505         manifold.publish_result_rec(tmp_query.analyzed_query, records);
 506     },
 507
 508     /**
 509      *
 510      * What we need to do when receiving results from an update query:
 511      * - differences between what we had, what we requested, and what we obtained
 512      *    . what we had : update_query_orig (simple fields and set fields managed differently)
 513      *    . what we requested : update_query
 514      *    . what we received : records
 515      * - raise appropriate events
 516      *
 517      * The normal process is that results similar to Get will be pushed in the
 518      * pubsub mechanism, thus repopulating everything while we only need
 519      * diff's. This means we need to move the publish functionalities in the
 520      * previous 'process_get_query_records' function.
 521      */
 522     process_update_query_records: function(query, records) {
 523         // First issue: we request everything, and not only what we modify, so will will have to ignore some fields
 524         var query_uuid        = query.query_uuid;
 525         var query_ext         = manifold.query_store.find_analyzed_query_ext(query_uuid);
 526         var update_query      = query_ext.main_query_ext.update_query_ext.query;
 527         var update_query_orig = query_ext.main_query_ext.update_query_orig_ext.query;
 528
 529         // Since we update objects one at a time, we can get the first record
 530         var record = records[0];
 531
 532         // Let's iterate over the object properties
 533         for (var field in record) {
 534             switch (this.get_type(record[field])) {
 535                 case TYPE_VALUE:
 536                     // Did we ask for a change ?
 537                     var update_value = update_query[field];
 538                     if (!update_value)
 539                         // Not requested, if it has changed: OUT OF SYNC
 540                         // How we can know ?
 541                         // We assume it won't have changed
 542                         continue;
 543
 544                     var result_value = record[field];
 545                     if (!result_value)
 546                         throw "Internal error";
 547
 548                     data = {
 549                         request: FIELD_REQUEST_CHANGE,
 550                         key   : field,
 551                         value : update_value,
 552                         status: (update_value == result_value) ? FIELD_REQUEST_SUCCESS : FIELD_REQUEST_FAILURE,
 553                     }
 554                     manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
 555
 556                     break;
 557                 case TYPE_RECORD:
 558                     throw "Not implemented";
 559                     break;
 560
 561                 case TYPE_LIST_OF_VALUES:
 562                     // Same as list of records, but we don't have to extract keys
 563                     var result_keys  = record[field]
 564
 565                     // The rest of exactly the same (XXX factorize)
 566                     var update_keys  = update_query_orig.params[field];
 567                     var query_keys   = update_query.params[field];
 568                     var added_keys   = $.grep(query_keys, function (x) { return $.inArray(x, update_keys) == -1 });
 569                     var removed_keys = $.grep(update_keys, function (x) { return $.inArray(x, query_keys) == -1 });
 570
 571
 572                     $.each(added_keys, function(i, key) {
 573                         if ($.inArray(key, result_keys) == -1) {
 574                             data = {
 575                                 request: FIELD_REQUEST_ADD,
 576                                 key   : field,
 577                                 value : key,
 578                                 status: FIELD_REQUEST_FAILURE,
 579                             }
 580                         } else {
 581                             data = {
 582                                 request: FIELD_REQUEST_ADD,
 583                                 key   : field,
 584                                 value : key,
 585                                 status: FIELD_REQUEST_SUCCESS,
 586                             }
 587                         }
 588                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
 589                     });
 590                     $.each(removed_keys, function(i, key) {
 591                         if ($.inArray(key, result_keys) == -1) {
 592                             data = {
 593                                 request: FIELD_REQUEST_REMOVE,
 594                                 key   : field,
 595                                 value : key,
 596                                 status: FIELD_REQUEST_SUCCESS,
 597                             }
 598                         } else {
 599                             data = {
 600                                 request: FIELD_REQUEST_REMOVE,
 601                                 key   : field,
 602                                 value : key,
 603                                 status: FIELD_REQUEST_FAILURE,
 604                             }
 605                         }
 606                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
 607                     });
 608
 609
 610                     break;
 611                 case TYPE_LIST_OF_RECORDS:
 612                     // example: slice.resource
 613                     //  - update_query_orig.params.resource = resources in slice before update
 614                     //  - update_query.params.resource = resource requested in slice
 615                     //  - keys from field = resources obtained
 616                     var key = manifold.metadata.get_key(field);
 617                     if (!key)
 618                         continue;
 619                     if (key.length > 1) {
 620                         throw "Not implemented";
 621                         continue;
 622                     }
 623                     key = key[0];
 624
 625                     /* XXX should be modified for multiple keys */
 626                     var result_keys  = $.map(record[field], function(x) { return x[key]; });
 627
 628                     var update_keys  = update_query_orig.params[field];
 629                     var query_keys   = update_query.params[field];
 630                     var added_keys   = $.grep(query_keys, function (x) { return $.inArray(x, update_keys) == -1 });
 631                     var removed_keys = $.grep(update_keys, function (x) { return $.inArray(x, query_keys) == -1 });
 632
 633
 634                     $.each(added_keys, function(i, key) {
 635                         if ($.inArray(key, result_keys) == -1) {
 636                             data = {
 637                                 request: FIELD_REQUEST_ADD,
 638                                 key   : field,
 639                                 value : key,
 640                                 status: FIELD_REQUEST_FAILURE,
 641                             }
 642                         } else {
 643                             data = {
 644                                 request: FIELD_REQUEST_ADD,
 645                                 key   : field,
 646                                 value : key,
 647                                 status: FIELD_REQUEST_SUCCESS,
 648                             }
 649                         }
 650                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
 651                     });
 652                     $.each(removed_keys, function(i, key) {
 653                         if ($.inArray(key, result_keys) == -1) {
 654                             data = {
 655                                 request: FIELD_REQUEST_REMOVE,
 656                                 key   : field,
 657                                 value : key,
 658                                 status: FIELD_REQUEST_SUCCESS,
 659                             }
 660                         } else {
 661                             data = {
 662                                 request: FIELD_REQUEST_REMOVE,
 663                                 key   : field,
 664                                 value : key,
 665                                 status: FIELD_REQUEST_FAILURE,
 666                             }
 667                         }
 668                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
 669                     });
 670
 671
 672                     break;
 673             }
 674         }
 675
 676         // XXX Now we need to adapt 'update' and 'update_orig' queries as if we had done a get
 677         this.setup_update_query(query, records);
 678     },
 679
 680     process_query_records: function(query, records) {
 681         if (query.action == 'get') {
 682             this.process_get_query_records(query, records);
 683         } else if (query.action == 'update') {
 684             this.process_update_query_records(query, records);
 685         }
 686     },
 687
 688     // if set callback is provided it is called
 689     // most of the time publish_uuid will be query.query_uuid
 690     // however in some cases we wish to publish the result under a different uuid
 691     // e.g. an updater wants to publish its result as if from the original (get) query
 692     asynchroneous_success : function (data, query, publish_uuid, callback) {
 693         // xxx should have a nicer declaration of that enum in sync with the python code somehow
 694
 695         var start = new Date();
 696         if (manifold.asynchroneous_debug)
 697             messages.debug(">>>>>>>>>> asynchroneous_success query.object=" + query.object);
 698
 699         if (data.code == 2) { // ERROR
 700             // We need to make sense of error codes here
 701             alert("Your session has expired, please log in again");
 702             window.location="/logout/";
 703             if (manifold.asynchroneous_debug) {
 704                 duration=new Date()-start;
 705                 messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- error returned - logging out " + duration + " ms");
 706             }
 707             return;
 708         }
 709         if (data.code == 1) { // WARNING
 710             messages.error("Some errors have been received from the manifold backend at " + MANIFOLD_URL + " [" + data.description + "]");
 711             // publish error code and text message on a separate channel for whoever is interested
 712             if (publish_uuid)
 713                 $.publish("/results/" + publish_uuid + "/failed", [data.code, data.description] );
 714
 715         }
 716
 717         // If a callback has been specified, we redirect results to it
 718         if (!!callback) {
 719             callback(data);
 720             if (manifold.asynchroneous_debug) {
 721                 duration=new Date()-start;
 722                 messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- callback ended " + duration + " ms");
 723             }
 724             return;
 725         }
 726
 727         if (manifold.asynchroneous_debug)
 728             messages.debug ("========== asynchroneous_success " + query.object + " -- before process_query_records [" + query.query_uuid +"]");
 729
 730         // once everything is checked we can use the 'value' part of the manifoldresult
 731         var result=data.value;
 732         if (result) {
 733             /* Eventually update the content of related queries (update, etc) */
 734             this.process_query_records(query, result);
 735
 736             /* Publish results: disabled here, done in the previous call */
 737             //tmp_query = manifold.find_query(query.query_uuid);
 738             //manifold.publish_result_rec(tmp_query.analyzed_query, result);
 739         }
 740         if (manifold.asynchroneous_debug) {
 741             duration=new Date()-start;
 742             messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- done " + duration + " ms");
 743         }
 744
 745     },
 746
 747     /**************************************************************************
 748      * Plugin API helpers
 749      **************************************************************************/
 750
 751     raise_event_handler: function(type, query_uuid, event_type, value) {
 752         if (manifold.pubsub_debug)
 753             messages.debug("raise_event_handler, quuid="+query_uuid+" type="+type+" event_type="+event_type);
 754         if ((type != 'query') && (type != 'record'))
 755             throw 'Incorrect type for manifold.raise_event()';
 756         // xxx we observe quite a lot of incoming calls with an undefined query_uuid
 757         // this should be fixed upstream in manifold I expect
 758         if (query_uuid === undefined) {
 759             messages.warning("undefined query in raise_event_handler");
 760             return;
 761         }
 762
 763         // notify the change to objects that either listen to this channel specifically,
 764         // or to the wildcard channel
 765         var channels = [ manifold.get_channel(type, query_uuid), manifold.get_channel(type, '*') ];
 766
 767         $.each(channels, function(i, channel) {
 768             if (value === undefined) {
 769                 if (manifold.pubsub_debug) messages.debug("triggering [no value] on channel="+channel+" and event_type="+event_type);
 770                 $('.pubsub').trigger(channel, [event_type]);
 771             } else {
 772                 if (manifold.pubsub_debug) messages.debug("triggering [value="+value+"] on channel="+channel+" and event_type="+event_type);
 773                 $('.pubsub').trigger(channel, [event_type, value]);
 774             }
 775         });
 776     },
 777
 778     raise_query_event: function(query_uuid, event_type, value) {
 779         manifold.raise_event_handler('query', query_uuid, event_type, value);
 780     },
 781
 782     raise_record_event: function(query_uuid, event_type, value) {
 783         manifold.raise_event_handler('record', query_uuid, event_type, value);
 784     },
 785
 786
 787     raise_event: function(query_uuid, event_type, value) {
 788         // Query uuid has been updated with the key of a new element
 789         query_ext    = manifold.query_store.find_analyzed_query_ext(query_uuid);
 790         query = query_ext.query;
 791
 792         switch(event_type) {
 793             case FIELD_STATE_CHANGED:
 794                 // value is an object (request, key, value, status)
 795                 // update is only possible is the query is not pending, etc
 796                 // SET_ADD is on a subquery, FIELD_STATE_CHANGED on the query itself
 797                 // we should map SET_ADD on this...
 798
 799                 // 1. Update internal query store about the change in status
 800
 801                 // 2. Update the update query
 802                 update_query      = query_ext.main_query_ext.update_query_ext.query;
 803                 update_query_orig = query_ext.main_query_ext.update_query_orig_ext.query;
 804
 805                 switch(value.request) {
 806                     case FIELD_REQUEST_CHANGE:
 807                         if (update_query.params[value.key] === undefined)
 808                             update_query.params[value.key] = Array();
 809                         update_query.params[value.key] = value.value;
 810                         break;
 811                     case FIELD_REQUEST_ADD:
 812                         if ($.inArray(value.value, update_query_orig.params[value.key]) != -1)
 813                             value.request = FIELD_REQUEST_ADD_RESET;
 814                         if (update_query.params[value.key] === undefined)
 815                             update_query.params[value.key] = Array();
 816                         update_query.params[value.key].push(value.value);
 817                         break;
 818                     case FIELD_REQUEST_REMOVE:
 819                         if ($.inArray(value.value, update_query_orig.params[value.key]) == -1)
 820                             value.request = FIELD_REQUEST_REMOVE_RESET;
 821
 822                         var arr = update_query.params[value.key];
 823                         arr = $.grep(arr, function(x) { return x != value.value; });
 824                         if (update_query.params[value.key] === undefined)
 825                             update_query.params[value.key] = Array();
 826                         update_query.params[value.key] = arr;
 827
 828                         break;
 829                     case FIELD_REQUEST_ADD_RESET:
 830                     case FIELD_REQUEST_REMOVE_RESET:
 831                         // XXX We would need to keep track of the original query
 832                         throw "Not implemented";
 833                         break;
 834                 }
 835
 836                 // 3. Inform others about the change
 837                 // a) the main query...
 838                 manifold.raise_record_event(query_uuid, event_type, value);
 839
 840                 // b) subqueries eventually (dot in the key)
 841                 // Let's unfold
 842                 var path_array = value.key.split('.');
 843                 var value_key = value.key.split('.');
 844
 845                 var cur_query = query;
 846                 if (cur_query.analyzed_query)
 847                     cur_query = cur_query.analyzed_query;
 848                 $.each(path_array, function(i, method) {
 849                     cur_query = cur_query.subqueries[method];
 850                     value_key.shift(); // XXX check that method is indeed shifted
 851                 });
 852                 value.key = value_key;
 853
 854                 manifold.raise_record_event(cur_query.query_uuid, event_type, value);
 855
 856                 // XXX make this DOT a global variable... could be '/'
 857                 break;
 858
 859             case SET_ADD:
 860             case SET_REMOVED:
 861
 862                 // update is only possible is the query is not pending, etc
 863                 // CHECK status !
 864
 865                 // XXX we can only update subqueries of the main query. Check !
 866                 // assert query_ext.parent_query == query_ext.main_query
 867                 // old // update_query = query_ext.main_query_ext.update_query_ext.query;
 868
 869                 // This SET_ADD is called on a subquery, so we have to
 870                 // recontruct the path of the key in the main_query
 871                 // We then call FIELD_STATE_CHANGED which is the equivalent for the main query
 872
 873                 var path = "";
 874                 var sq = query_ext;
 875                 while (sq.parent_query_ext) {
 876                     if (path != "")
 877                         path = '.' + path;
 878                     path = sq.query.object + path;
 879                     sq = sq.parent_query_ext;
 880                 }
 881
 882                 main_query = query_ext.main_query_ext.query;
 883                 data = {
 884                     request: (event_type == SET_ADD) ? FIELD_REQUEST_ADD : FIELD_REQUEST_REMOVE,
 885                     key   : path,
 886                     value : value,
 887                     status: FIELD_REQUEST_PENDING,
 888                 };
 889                 this.raise_event(main_query.query_uuid, FIELD_STATE_CHANGED, data);
 890
 891                 // old //update_query.params[path].push(value);
 892                 // old // console.log('Updated query params', update_query);
 893                 // NOTE: update might modify the fields in Get
 894                 // NOTE : we have to modify all child queries
 895                 // NOTE : parts of a query might not be started (eg slice.measurements, how to handle ?)
 896
 897                 // if everything is done right, update_query should not be null.
 898                 // It is updated when we received results from the get query
 899                 // object = the same as get
 900                 // filter = key : update a single object for now
 901                 // fields = the same as get
 902                 manifold.raise_query_event(query_uuid, event_type, value);
 903
 904                 break;
 905
 906             case RUN_UPDATE:
 907                 manifold.run_query(query_ext.main_query_ext.update_query_ext.query);
 908                 break;
 909
 910             case FILTER_ADDED:
 911 // Thierry - this is probably wrong but intended as a hotfix
 912 // http://trac.myslice.info/ticket/32
 913 //                manifold.raise_query_event(query_uuid, event_type, value);
 914                 break;
 915             case FILTER_REMOVED:
 916                 manifold.raise_query_event(query_uuid, event_type, value);
 917                 break;
 918             case FIELD_ADDED:
 919                 main_query = query_ext.main_query_ext.query;
 920                 main_update_query = query_ext.main_query_ext.update_query;
 921                 query.select(value);
 922
 923                 // Here we need the full path through all subqueries
 924                 path = ""
 925                 // XXX We might need the query name in the QueryExt structure
 926                 main_query.select(value);
 927
 928                 // XXX When is an update query associated ?
 929                 // XXX main_update_query.select(value);
 930
 931                 manifold.raise_query_event(query_uuid, event_type, value);
 932                 break;
 933
 934             case FIELD_REMOVED:
 935                 query = query_ext.query;
 936                 main_query = query_ext.main_query_ext.query;
 937                 main_update_query = query_ext.main_query_ext.update_query;
 938                 query.unselect(value);
 939                 main_query.unselect(value);
 940
 941                 // We need to inform about changes in these queries to the respective plugins
 942                 // Note: query & main_query have the same UUID
 943                 manifold.raise_query_event(query_uuid, event_type, value);
 944                 break;
 945         }
 946         // We need to inform about changes in these queries to the respective plugins
 947         // Note: query, main_query & update_query have the same UUID
 948         manifold.raise_query_event(query_uuid, event_type, value);
 949         // We are targeting the same object with get and update
 950         // The notion of query is bad, we should have a notion of destination, and issue queries on the destination
 951         // NOTE: Editing a subquery == editing a local view on the destination
 952
 953         // XXX We might need to run the new query again and manage the plugins in the meantime with spinners...
 954         // For the time being, we will collect all columns during the first query
 955     },
 956
 957     /* Publish/subscribe channels for internal use */
 958     get_channel: function(type, query_uuid) {
 959         if ((type !== 'query') && (type != 'record'))
 960             return null;
 961         return '/' + type + '/' + query_uuid;
 962     },
 963
 964 }; // manifold object
 965 /* ------------------------------------------------------------ */
 966
 967 (function($) {
 968
 969     // OLD PLUGIN API: extend jQuery/$ with pubsub capabilities
 970     // https://gist.github.com/661855
 971     var o = $({});
 972     $.subscribe = function( channel, selector, data, fn) {
 973       /* borrowed from jQuery */
 974       if ( data == null && fn == null ) {
 975           // ( channel, fn )
 976           fn = selector;
 977           data = selector = undefined;
 978       } else if ( fn == null ) {
 979           if ( typeof selector === "string" ) {
 980               // ( channel, selector, fn )
 981               fn = data;
 982               data = undefined;
 983           } else {
 984               // ( channel, data, fn )
 985               fn = data;
 986               data = selector;
 987               selector = undefined;
 988           }
 989       }
 990       /* </ugly> */
 991
 992       /* We use an indirection function that will clone the object passed in
 993        * parameter to the subscribe callback
 994        *
 995        * FIXME currently we only clone query objects which are the only ones
 996        * supported and editable, we might have the same issue with results but
 997        * the page load time will be severely affected...
 998        */
 999       o.on.apply(o, [channel, selector, data, function() {
1000           for(i = 1; i < arguments.length; i++) {
1001               if ( arguments[i].constructor.name == 'ManifoldQuery' )
1002                   arguments[i] = arguments[i].clone();
1003           }
1004           fn.apply(o, arguments);
1005       }]);
1006     };
1007
1008     $.unsubscribe = function() {
1009       o.off.apply(o, arguments);
1010     };
1011
1012     $.publish = function() {
1013       o.trigger.apply(o, arguments);
1014     };
1015
1016 }(jQuery));
1017
1018 /* ------------------------------------------------------------ */
1019
1020 //http://stackoverflow.com/questions/5100539/django-csrf-check-failing-with-an-ajax-post-request
1021 //make sure to expose csrf in our outcoming ajax/post requests
1022 $.ajaxSetup({
1023      beforeSend: function(xhr, settings) {
1024          function getCookie(name) {
1025              var cookieValue = null;
1026              if (document.cookie && document.cookie != '') {
1027                  var cookies = document.cookie.split(';');
1028                  for (var i = 0; i < cookies.length; i++) {
1029                      var cookie = jQuery.trim(cookies[i]);
1030                      // Does this cookie string begin with the name we want?
1031                  if (cookie.substring(0, name.length + 1) == (name + '=')) {
1032                      cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
1033                      break;
1034                  }
1035              }
1036          }
1037          return cookieValue;
1038          }
1039          if (!(/^http:.*/.test(settings.url) || /^https:.*/.test(settings.url))) {
1040              // Only send the token to relative URLs i.e. locally.
1041              xhr.setRequestHeader("X-CSRFToken", getCookie('csrftoken'));
1042          }
1043      }
1044 });