manifoldapi/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://stackoverflow.com/questions/7837456/comparing-two-arrays-in-javascript
  21 // attach the .equals method to Array's prototype to call it on any array
  22 Array.prototype.equals = function (array) {
  23     // if the other array is a falsy value, return
  24     if (!array)
  25         return false;
  26
  27     // compare lengths - can save a lot of time
  28     if (this.length != array.length)
  29         return false;
  30
  31     for (var i = 0, l=this.length; i < l; i++) {
  32         // Check if we have nested arrays
  33         if (this[i] instanceof Array && array[i] instanceof Array) {
  34             // recurse into the nested arrays
  35             if (!this[i].equals(array[i]))
  36                 return false;
  37         }
  38         else if (this[i] != array[i]) {
  39             // Warning - two different object instances will never be equal: {x:20} != {x:20}
  40             return false;
  41         }
  42     }
  43     return true;
  44 }
  45
  46 // http://javascriptweblog.wordpress.com/2011/08/08/fixing-the-javascript-typeof-operator/
  47 Object.toType = (function toType(global) {
  48   return function(obj) {
  49     if (obj === global) {
  50       return "global";
  51     }
  52     return ({}).toString.call(obj).match(/\s([a-z|A-Z]+)/)[1].toLowerCase();
  53   }
  54 })(this);
  55
  56 /* ------------------------------------------------------------ */
  57
  58 // Constants that should be somehow moved to a plugin.js file
  59 var FILTER_ADDED   = 1;
  60 var FILTER_REMOVED = 2;
  61 var CLEAR_FILTERS  = 3;
  62 var FIELD_ADDED    = 4;
  63 var FIELD_REMOVED  = 5;
  64 var CLEAR_FIELDS   = 6;
  65 var NEW_RECORD     = 7;
  66 var CLEAR_RECORDS  = 8;
  67
  68 /**
  69  * event: FIELD_STATE_CHANGED
  70  *
  71  * Parameters:
  72  *   dict :
  73  *      .state      : ???? used to be FIELD_REQUEST_ADD / FIELD_REQUEST_REMOVE
  74  *      .key        : ??? the key fields of the record
  75  *      .op         : the key of the record who has received an update
  76  *      .value      : the new state of the record
  77  */
  78 var FIELD_STATE_CHANGED = 9;
  79
  80 var IN_PROGRESS    = 101;
  81 var DONE           = 102; //XXX Should be harmonized with query state
  82
  83 /* Update requests related to subqueries */
  84
  85 /*
  86 var SET_ADD        = 201;
  87 var SET_REMOVED    = 202;
  88 */
  89
  90 // request
  91 /*
  92 var FIELD_REQUEST_CHANGE  = 301;
  93 var FIELD_REQUEST_ADD     = 302;
  94 var FIELD_REQUEST_REMOVE  = 303;
  95 var FIELD_REQUEST_ADD_RESET = 304;
  96 var FIELD_REQUEST_REMOVE_RESET = 305;
  97 */
  98 // status (XXX Should be deprecated)
  99 var FIELD_REQUEST_PENDING = 401;
 100 var FIELD_REQUEST_SUCCESS = 402;
 101 var FIELD_REQUEST_FAILURE = 403;
 102 var STATUS_OKAY           = 404;
 103 var STATUS_SET_WARNING    = 405;
 104 var STATUS_ADD_WARNING    = 406;
 105 var STATUS_REMOVE_WARNING = 407;
 106 var STATUS_RESET          = 408;
 107
 108 /* Requests for query cycle */
 109 var RUN_UPDATE     = 601;
 110
 111 /* MANIFOLD types */
 112 var TYPE_VALUE  = 1;
 113 var TYPE_RECORD = 2;
 114 var TYPE_LIST_OF_VALUES = 3;
 115 var TYPE_LIST_OF_RECORDS = 4;
 116
 117 /******************************************************************************
 118  * QUERY STATUS (for manifold events)
 119  ******************************************************************************/
 120
 121 var STATUS_NONE               = 500; // Query has not been started yet
 122 var STATUS_GET_IN_PROGRESS    = 501; // Query has been sent, no result has been received
 123 var STATUS_GET_RECEIVED       = 502; // Success
 124 var STATUS_GET_ERROR          = 503; // Error
 125 var STATUS_UPDATE_PENDING     = 504;
 126 var STATUS_UPDATE_IN_PROGRESS = 505;
 127 var STATUS_UPDATE_RECEIVED    = 506;
 128 var STATUS_UPDATE_ERROR       = 507;
 129
 130 /******************************************************************************
 131  * QUERY STATE (for query_store)
 132  ******************************************************************************/
 133
 134 // XXX Rendundant with query status ?
 135
 136 var QUERY_STATE_INIT        = 0;
 137 var QUERY_STATE_INPROGRESS  = 1;
 138 var QUERY_STATE_DONE        = 2;
 139
 140 /******************************************************************************
 141  * RECORD STATES (for query_store)
 142  ******************************************************************************/
 143
 144 var STATE_SET       = 0;
 145 var STATE_VALUE     = 1;
 146 var STATE_WARNINGS  = 2;
 147 var STATE_VISIBLE   = 3;
 148
 149 // ACTIONS
 150 var STATE_SET_CHANGE = 0;
 151 var STATE_SET_ADD    = 1;
 152 var STATE_SET_REMOVE = 2;
 153 var STATE_SET_CLEAR  = 3;
 154
 155 // STATE_SET : enum
 156 var STATE_SET_IN            = 0;
 157 var STATE_SET_OUT           = 1;
 158 var STATE_SET_IN_PENDING    = 2;
 159 var STATE_SET_OUT_PENDING   = 3;
 160 var STATE_SET_IN_SUCCESS    = 4;
 161 var STATE_SET_OUT_SUCCESS   = 5;
 162 var STATE_SET_IN_FAILURE    = 6;
 163 var STATE_SET_OUT_FAILURE   = 7;
 164 var STATE_VALUE_CHANGE_PENDING    = 8;
 165 var STATE_VALUE_CHANGE_SUCCESS    = 9;
 166 var STATE_VALUE_CHANGE_FAILURE    = 10;
 167
 168 // STATE_WARNINGS : dict
 169
 170 // STATE_VISIBLE : boolean
 171
 172 /******************************************************************************
 173  * CONSTRAINTS
 174  ******************************************************************************/
 175
 176 var CONSTRAINT_RESERVABLE_LEASE     = 0;
 177
 178 var CONSTRAINT_RESERVABLE_LEASE_MSG = "Configuration required: this resource needs to be scheduled";
 179
 180 // A structure for storing queries
 181
 182 function QueryExt(query, parent_query_ext, main_query_ext, update_query_ext, disabled, domain_query_ext) {
 183
 184     /* Constructor */
 185     if (typeof query == "undefined")
 186         throw "Must pass a query in QueryExt constructor";
 187     this.query                 = query;
 188     this.parent_query_ext      = (typeof parent_query_ext      == "undefined") ? null  : parent_query_ext;
 189     this.main_query_ext        = (typeof main_query_ext        == "undefined") ? null  : main_query_ext;
 190     this.update_query_ext      = (typeof update_query_ext      == "undefined") ? null  : update_query_ext;
 191     this.update_query_orig_ext = (typeof update_query_orig_ext == "undefined") ? null  : update_query_orig_ext;
 192     this.disabled              = (typeof disabled              == "undefined") ? false : disabled;
 193
 194     // A domain query is a query that is issued to retrieve all possible values for a set
 195     // eg. all resources that can be attached to a slice
 196     // It is null unless we are a subquery for which a domain query has been issued
 197     this.domain_query_ext      = (typeof domain_query_ext      == "undefined") ? null  : domain_query_ext;
 198
 199     // Set members to buffer until the domain query is completed
 200     // A list of keys
 201     this.set_members = [];
 202
 203     // The set query is the query for which the domain query has been issued.
 204     // It is null unless the query is a domain query
 205     this.set_query_ext         = (typeof set_query_ext         == "undefined") ? null  : domain_query_ext;
 206
 207     this.query_state = QUERY_STATE_INIT;
 208
 209     // Results from a query consists in a dict that maps keys to records
 210     this.records = new Hashtable();
 211
 212     // Status is a dict that maps keys to record status
 213     this.state = new Hashtable();
 214
 215     // Filters that impact visibility in the local interface
 216     this.filters = [];
 217
 218     // XXX Until we find a better solution
 219     this.num_pending = 0;
 220     this.num_unconfigured = 0;
 221
 222     // update_query null unless we are a main_query (aka parent_query == null); only main_query_fields can be updated...
 223 }
 224
 225 function QueryStore() {
 226
 227     this.main_queries     = {};
 228     this.analyzed_queries = {};
 229
 230     /* Insertion */
 231
 232     this.insert = function(query) {
 233         // We expect only main_queries are inserted
 234
 235         /* If the query has not been analyzed, then we analyze it */
 236         if (query.analyzed_query == null) {
 237             query.analyze_subqueries();
 238         }
 239
 240         /* We prepare the update query corresponding to the main query and store both */
 241         /* Note: they have the same UUID */
 242
 243         // XXX query.change_action() should become deprecated
 244         update_query = query.clone();
 245         update_query.action = 'update';
 246         update_query.analyzed_query.action = 'update';
 247         update_query.params = {};
 248         update_query_ext = new QueryExt(update_query);
 249
 250         /* We remember the original query to be able to reset it */
 251         update_query_orig_ext = new QueryExt(update_query.clone());
 252
 253
 254         /* We store the main query */
 255         query_ext = new QueryExt(query, null, null, update_query_ext, update_query_orig_ext, false);
 256         manifold.query_store.main_queries[query.query_uuid] = query_ext;
 257         /* Note: the update query does not have an entry! */
 258
 259
 260         // The query is disabled; since it is incomplete until we know the content of the set of subqueries
 261         // XXX unless we have no subqueries ???
 262         // we will complete with params when records are received... this has to be done by the manager
 263         // SET_ADD, SET_REMOVE will change the status of the elements of the set
 264         // UPDATE will change also, etc.
 265         // XXX We need a proper structure to store this information...
 266
 267         // We also need to insert all queries and subqueries from the analyzed_query
 268         // XXX We need the root of all subqueries
 269         query.iter_subqueries(function(sq, data, parent_query) {
 270             var parent_query_ext;
 271             if (parent_query) {
 272                 parent_query_ext = manifold.query_store.find_analyzed_query_ext(parent_query.query_uuid);
 273             } else {
 274                 parent_query_ext = null;
 275             }
 276             // XXX parent_query_ext == false
 277             // XXX main.subqueries = {} # Normal, we need analyzed_query
 278             sq_ext = new QueryExt(sq, parent_query_ext, query_ext)
 279
 280             if (parent_query) {
 281                 /* Let's issue a query for the subquery domain. This query will not need any update etc.
 282                    eg. for resources in a slice, we also query all resources */
 283                 var all_fields = manifold.metadata.get_field_names(sq.object);
 284                 var domain_query = new ManifoldQuery('get', sq.object, 'now', [], {}, all_fields);
 285                 //var domain_query = new ManifoldQuery('get', sq.object);
 286
 287                 console.log("Created domain query", domain_query);
 288                 var domain_query_ext = new QueryExt(domain_query);
 289
 290                 domain_query_ext.set_query_ext = sq_ext;
 291                 sq_ext.domain_query_ext = domain_query_ext;
 292
 293                 // One of these two is useless ?
 294                 manifold.query_store.main_queries[domain_query.query_uuid] = domain_query_ext;
 295                 manifold.query_store.analyzed_queries[domain_query.query_uuid] = domain_query_ext;
 296
 297                 // XXX This query is run before the plugins are initialized and listening
 298                 manifold.run_query(domain_query);
 299             }
 300
 301             manifold.query_store.analyzed_queries[sq.query_uuid] = sq_ext;
 302         });
 303
 304         // XXX We have spurious update queries...
 305     }
 306
 307     /* Searching */
 308
 309     this.find_query_ext = function(query_uuid)
 310     {
 311         return this.main_queries[query_uuid];
 312     }
 313
 314     this.find_query = function(query_uuid)
 315     {
 316         return this.find_query_ext(query_uuid).query;
 317     }
 318
 319     this.find_analyzed_query_ext = function(query_uuid)
 320     {
 321         return this.analyzed_queries[query_uuid];
 322     }
 323
 324     this.find_analyzed_query = function(query_uuid)
 325     {
 326         return this.find_analyzed_query_ext(query_uuid).query;
 327     }
 328
 329     this.state_dict_create = function(default_set)
 330     {
 331         default_set = (default_set === undefined) ? STATE_SET_OUT : default_set;
 332         var state_dict = {};
 333         // We cannot use constants in literal definition, so...
 334         state_dict[STATE_WARNINGS] = {};
 335         state_dict[STATE_SET] = default_set;
 336         state_dict[STATE_VISIBLE] = true;
 337         return state_dict;
 338     }
 339
 340     // RECORDS
 341
 342     this.set_records = function(query_uuid, records, default_set)
 343     {
 344         default_set = (default_set === undefined) ? STATE_SET_OUT : default_set;
 345
 346         var self = this;
 347         var query_ext = this.find_analyzed_query_ext(query_uuid);
 348         var record_key = manifold.metadata.get_key(query_ext.query.object);
 349         $.each(records, function(i, record) {
 350             var key = manifold.metadata.get_key(query_ext.query.object);
 351             // ["start_time", "resource", "end_time"]
 352             // ["urn"]
 353
 354             var record_key_value = manifold.record_get_value(record, record_key);
 355             query_ext.records.put(record_key_value, record);
 356
 357             if (!(query_ext.state.get(record_key_value)))
 358                 query_ext.state.put(record_key_value, self.state_dict_create(default_set));
 359         });
 360     }
 361
 362     this.get_records = function(query_uuid)
 363     {
 364         var query_ext = this.find_analyzed_query_ext(query_uuid);
 365         return query_ext.records.values();
 366     }
 367
 368     this.get_record = function(query_uuid, record_key)
 369     {
 370         var query_ext = this.find_analyzed_query_ext(query_uuid);
 371         return query_ext.records.get(record_key);
 372     }
 373
 374     this.del_record = function(query_uuid, record_key)
 375     {
 376         var query_ext = this.find_analyzed_query_ext(query_uuid);
 377         return query_ext.records.remove(record_key);
 378     }
 379
 380     this.del_state = function(query_uuid, record_key)
 381     {
 382         var query_ext = this.find_analyzed_query_ext(query_uuid);
 383         return query_ext.state.remove(record_key);
 384     }
 385
 386     this.add_record = function(query_uuid, record, new_state)
 387     {
 388         var query_ext, key, record_key;
 389         query_ext = this.find_analyzed_query_ext(query_uuid);
 390
 391         if (typeof(record) == 'object') {
 392             key = manifold.metadata.get_key(query_ext.query.object);
 393             record_key = manifold.record_get_value(record, key);
 394         } else {
 395             record_key = record;
 396         }
 397
 398         var record_entry = query_ext.records.get(record_key);
 399         if (!record_entry)
 400             query_ext.records.put(record_key, record);
 401
 402         manifold.query_store.set_record_state(query_uuid, record_key, STATE_SET, new_state);
 403     }
 404
 405     this.remove_record = function(query_uuid, record, new_state)
 406     {
 407         var query_ext, key, record_key;
 408         query_ext = this.find_analyzed_query_ext(query_uuid);
 409
 410         if (typeof(record) == 'object') {
 411             key = manifold.metadata.get_key(query_ext.query.object);
 412             record_key = manifold.record_get_value(record, key);
 413         } else {
 414             record_key = record;
 415         }
 416
 417         if ((query_ext.query.object == 'lease') && (new_state == STATE_SET_OUT)) {
 418             // Leases that are marked out are in fact leases from other slices
 419             // We need to _remove_ leases that we mark as OUT
 420             manifold.query_store.del_record(query_uuid, record_key);
 421             manifold.query_store.del_state(query_uuid, record_key);
 422         } else {
 423             manifold.query_store.set_record_state(query_uuid, record_key, STATE_SET, new_state);
 424         }
 425     }
 426
 427     this.iter_records = function(query_uuid, callback)
 428     {
 429         var query_ext = this.find_analyzed_query_ext(query_uuid);
 430         query_ext.records.each(callback);
 431         //callback = function(record_key, record)
 432     }
 433
 434     this.iter_visible_records = function(query_uuid, callback)
 435     {
 436         var query_ext = this.find_analyzed_query_ext(query_uuid);
 437         query_ext.records.each(function(record_key, record) {
 438             if (query_ext.state.get(record_key)[STATE_VISIBLE]) // .STATE_VISIBLE would be for the string key
 439                 callback(record_key, record);
 440         });
 441         //callback = function(record_key, record)
 442
 443     }
 444
 445     // STATE
 446
 447     this.set_record_state = function(query_uuid, result_key, state, value)
 448     {
 449         var query_ext = this.find_analyzed_query_ext(query_uuid);
 450         var state_dict = query_ext.state.get(result_key);
 451         if (!state_dict)
 452             state_dict = this.state_dict_create();
 453
 454         state_dict[state] = value;
 455
 456         query_ext.state.put(result_key, state_dict);
 457     }
 458
 459     this.get_record_state = function(query_uuid, result_key, state)
 460     {
 461         var query_ext = this.find_analyzed_query_ext(query_uuid);
 462         var state_dict = query_ext.state.get(result_key);
 463         if (!state_dict)
 464             return null;
 465         return state_dict[state];
 466     }
 467
 468     // FILTERS
 469
 470     this.add_filter = function(query_uuid, filter)
 471     {
 472         var query_ext = this.find_analyzed_query_ext(query_uuid);
 473         // XXX When we update a filter
 474         query_ext.filters.push(filter);
 475
 476         this.apply_filters(query_uuid);
 477
 478     }
 479
 480     this.update_filter = function(query_uuid, filter)
 481     {
 482         // XXX
 483
 484         this.apply_filters(query_uuid);
 485     }
 486
 487     this.remove_filter = function(query_uuid, filter)
 488     {
 489         var query_ext = this.find_analyzed_query_ext(query_uuid);
 490         query_ext.filters = $.grep(query_ext.filters, function(x) {
 491             return !(x.equals(filter));
 492         });
 493
 494         this.apply_filters(query_uuid);
 495     }
 496
 497     this.get_filters = function(query_uuid)
 498     {
 499         var query_ext = this.find_analyzed_query_ext(query_uuid);
 500         return query_ext.filters;
 501     }
 502
 503     this.recount = function(query_uuid)
 504     {
 505         var query_ext;
 506         var is_reserved, is_pending, in_set,  is_unconfigured;
 507
 508         query_ext = manifold.query_store.find_analyzed_query_ext(query_uuid);
 509         query_ext.num_pending = 0;
 510         query_ext.num_unconfigured = 0;
 511
 512         this.iter_records(query_uuid, function(record_key, record) {
 513             var record_state = manifold.query_store.get_record_state(query_uuid, record_key, STATE_SET);
 514             var record_warnings = manifold.query_store.get_record_state(query_uuid, record_key, STATE_WARNINGS);
 515
 516             is_reserved = (record_state == STATE_SET_IN)
 517                        || (record_state == STATE_SET_OUT_PENDING)
 518                        || (record_state == STATE_SET_IN_SUCCESS)
 519                        || (record_state == STATE_SET_OUT_FAILURE);
 520
 521             is_pending = (record_state == STATE_SET_IN_PENDING)
 522                       || (record_state == STATE_SET_OUT_PENDING);
 523
 524             in_set = (record_state == STATE_SET_IN) // should not have warnings
 525                   || (record_state == STATE_SET_IN_PENDING)
 526                   || (record_state == STATE_SET_IN_SUCCESS)
 527                   || (record_state == STATE_SET_OUT_FAILURE); // should not have warnings
 528
 529             is_unconfigured = (in_set && !$.isEmptyObject(record_warnings));
 530
 531             /* Let's update num_pending and num_unconfigured at this stage */
 532             if (is_pending)
 533                 query_ext.num_pending++;
 534             if (is_unconfigured)
 535                 query_ext.num_unconfigured++;
 536         });
 537
 538     }
 539
 540     this.apply_filters = function(query_uuid)
 541     {
 542         var start = new Date().getTime();
 543
 544         // Toggle visibility of records according to the different filters.
 545
 546         var self = this;
 547         var filters = this.get_filters(query_uuid);
 548         var col_value;
 549         /* Let's update num_pending and num_unconfigured at this stage */
 550
 551         // Adapted from querytable._querytable_filter()
 552
 553         this.iter_records(query_uuid, function(record_key, record) {
 554             var is_reserved, is_pending, in_set,  is_unconfigured;
 555             var visible = true;
 556
 557             var record_state = manifold.query_store.get_record_state(query_uuid, record_key, STATE_SET);
 558             var record_warnings = manifold.query_store.get_record_state(query_uuid, record_key, STATE_WARNINGS);
 559
 560             is_reserved = (record_state == STATE_SET_IN)
 561                        || (record_state == STATE_SET_OUT_PENDING)
 562                        || (record_state == STATE_SET_IN_SUCCESS)
 563                        || (record_state == STATE_SET_OUT_FAILURE);
 564
 565             is_pending = (record_state == STATE_SET_IN_PENDING)
 566                       || (record_state == STATE_SET_OUT_PENDING);
 567
 568             in_set = (record_state == STATE_SET_IN) // should not have warnings
 569                   || (record_state == STATE_SET_IN_PENDING)
 570                   || (record_state == STATE_SET_IN_SUCCESS)
 571                   || (record_state == STATE_SET_OUT_FAILURE); // should not have warnings
 572
 573             is_unconfigured = (in_set && !$.isEmptyObject(record_warnings));
 574
 575             // We go through each filter and decide whether it affects the visibility of the record
 576             $.each(filters, function(index, filter) {
 577                 var key = filter[0];
 578                 var op = filter[1];
 579                 var value = filter[2];
 580
 581
 582                 /* We do some special handling for the manifold:status filter
 583                  * predicates. */
 584
 585                 if (key == 'manifold:status') {
 586                     if (op != '=' && op != '==') {
 587                         // Unsupported filter, let's ignore it
 588                         console.log("Unsupported filter on manifold:status. Should be EQUAL only.");
 589                         return true; // ~ continue
 590                     }
 591
 592                     switch (value) {
 593                         case 'reserved':
 594                             // true  => ~ continue
 595                             // false => ~ break
 596                             visible = is_reserved;
 597                             return visible;
 598                         case 'unconfigured':
 599                             visible = is_unconfigured;
 600                             return visible;
 601                         case 'pending':
 602                             visible = is_pending;
 603                             return visible;
 604                     }
 605                     return false; // ~ break
 606                 }
 607
 608                 /* Normal filtering behaviour (according to the record content) follows... */
 609                 col_value = manifold.record_get_value(record, key);
 610
 611                 // When the filter does not match, we hide the column by default
 612                 if (col_value === 'undefined') {
 613                     visible = false;
 614                     return false; // ~ break
 615                 }
 616
 617                 // XXX This should accept pluggable filtering functions.
 618
 619
 620                 /* Test whether current filter is compatible with the column */
 621                 if (op == '=' || op == '==') {
 622                     if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a")
 623                         visible = false;
 624                 }else if (op == 'included') {
 625                     $.each(value, function(i,x) {
 626                       if(x == col_value){
 627                           visible = true;
 628                           return false; // ~ break
 629                       }else{
 630                           visible = false;
 631                       }
 632                     });
 633                 }else if (op == '!=') {
 634                     if ( col_value == value || col_value==null || col_value=="" || col_value=="n/a")
 635                         visible = false;
 636                 } else if(op=='<') {
 637                     if ( parseFloat(col_value) >= value || col_value==null || col_value=="" || col_value=="n/a")
 638                         visible = false;
 639                 } else if(op=='>') {
 640                     if ( parseFloat(col_value) <= value || col_value==null || col_value=="" || col_value=="n/a")
 641                         visible = false;
 642                 } else if(op=='<=' || op=='≤') {
 643                     if ( parseFloat(col_value) > value || col_value==null || col_value=="" || col_value=="n/a")
 644                         visible = false;
 645                 } else if(op=='>=' || op=='≥') {
 646                     if ( parseFloat(col_value) < value || col_value==null || col_value=="" || col_value=="n/a")
 647                         visible = false;
 648                 }else{
 649                     // How to break out of a loop ?
 650                     alert("filter not supported");
 651                     return false; // break
 652                 }
 653
 654             });
 655
 656             // Set the visibility status in the query store
 657             self.set_record_state(query_uuid, record_key, STATE_VISIBLE, visible);
 658         });
 659
 660         var end = new Date().getTime();
 661         console.log("APPLY FILTERS took", end - start, "ms");
 662
 663     }
 664
 665 }
 666
 667 /*!
 668  * This namespace holds functions for globally managing query objects
 669  * \Class Manifold
 670  */
 671 var manifold = {
 672
 673     /**************************************************************************
 674      * Helper functions
 675      **************************************************************************/
 676
 677     separator: '__',
 678
 679     get_type: function(variable) {
 680         switch(Object.toType(variable)) {
 681             case 'number':
 682             case 'string':
 683                 return TYPE_VALUE;
 684             case 'object':
 685                 return TYPE_RECORD;
 686             case 'array':
 687                 if ((variable.length > 0) && (Object.toType(variable[0]) === 'object'))
 688                     return TYPE_LIST_OF_RECORDS;
 689                 else
 690                     return TYPE_LIST_OF_VALUES;
 691         }
 692     },
 693
 694     /**
 695      *  Args:
 696      *      fields: A String instance (field name), or a set of String instances
 697      *          (field names) # XXX tuple !!
 698      *  Returns:
 699      *      If fields is a String,  return the corresponding value.
 700      *      If fields is a set, return a tuple of corresponding value.
 701      *
 702      *  Raises:
 703      *      KeyError if at least one of the fields is not found
 704      */
 705     record_get_value: function(record, fields)
 706     {
 707         if (typeof(fields) === 'string') {
 708             if (fields.indexOf('.') != -1) {
 709                 key_subkey = key.split('.', 2);
 710                 key     = key_subkey[0];
 711                 subkey  = key_subkey[1];
 712
 713                 if (record.indexOf(key) == -1) {
 714                     return null;
 715                 }
 716                 // Tests if the following is an array (typeof would give object)
 717                 if (Object.prototype.toString.call(record[key]) === '[object Array]') {
 718                     // Records
 719                     return $.map(record[key], function(subrecord) { return manifold.record_get_value(subrecord, subkey) });
 720                 } else if (typeof(record) == 'object') {
 721                     // Record
 722                     return manifold.record_get_value(record[key], subkey);
 723                 } else {
 724                     console.log('Unknown field');
 725                 }
 726             } else {
 727                 return record[fields];
 728             }
 729         } else {
 730             // see. get_map_entries
 731             if (fields.length == 1)
 732                 return manifold.record_get_value(record, fields[0])
 733
 734             // Build a new record
 735             var ret = {};
 736             $.each(fields, function(i, field) {
 737                 ret[field] = manifold.record_get_value(record, field);
 738             });
 739             ret.hashCode = record.hashCode;
 740             ret.equals = record.equals;
 741             return ret;
 742             // this was an array, we want a dictionary
 743             //return $.map(fields, function(x) { manifold.record_get_value(record, x) });
 744
 745         }
 746     },
 747
 748     record_hashcode: function(key_fields)
 749     {
 750         return function() {
 751             ret = "";
 752             for (var i=0; i < key_fields.length; i++)
 753                 ret += "@@" + this[key_fields[i]];
 754             return ret;
 755         };
 756     },
 757
 758     _record_equals: function(self, other, key_fields)
 759     {
 760         for (var i=0; i < key_fields.length; i++) {
 761             var this_value  = self[key_fields[i]];
 762             var other_value = other[key_fields[i]];
 763
 764             var this_type = manifold.get_type(this_value);
 765             var other_type = manifold.get_type(other_value);
 766             if (this_type != other_type)
 767                 return false;
 768
 769             switch (this_type) {
 770                 case TYPE_VALUE:
 771                 case TYPE_LIST_OF_VALUES:
 772                     if (this_value != other_value)
 773                         return false;
 774                     break;
 775                 case TYPE_RECORD:
 776                     if (!(_record_equals(this_value, other_value, key_fields)))
 777                         return false;
 778                     break;
 779                 case TYPE_LIST_OF_RECORDS:
 780                     if (this_value.length != other_value.length)
 781                         return false;
 782                     for (var j = 0; j < this_value.length; j++)
 783                         if (!(_record_equals(this_value[j], other_value[j], key_fields)))
 784                             return false;
 785                     break;
 786             }
 787         }
 788         return true;
 789     },
 790
 791     record_equals: function(key_fields)
 792     {
 793         return function(other) {
 794             return manifold._record_equals(this, other, key_fields);
 795         };
 796     },
 797
 798     _in_array: function(element, array, key_fields)
 799     {
 800         if (key_fields.length > 1) {
 801             for (var i = 0; i < array.length; i++) {
 802                 if (manifold._record_equals(element, array[i], key_fields))
 803                     return true;
 804             }
 805             return false;
 806         } else {
 807             // XXX TODO If we have a dict, extract the key first
 808             return ($.inArray(element, array) != -1);
 809         }
 810     },
 811
 812     /**************************************************************************
 813      * Metadata management
 814      **************************************************************************/
 815
 816      metadata: {
 817
 818         get_table: function(method) {
 819             var table = MANIFOLD_METADATA[method];
 820             return (typeof table === 'undefined') ? null : table;
 821         },
 822
 823         get_columns: function(method) {
 824             var table = this.get_table(method);
 825             if (!table) {
 826                 return null;
 827             }
 828
 829             return (typeof table.column === 'undefined') ? null : table.column;
 830         },
 831
 832         get_field_names: function(method)
 833         {
 834             var columns = this.get_columns(method);
 835             if (!columns)
 836                 return null;
 837             return $.map(columns, function (x) { return x.name });
 838         },
 839
 840         get_key: function(method) {
 841             var table = this.get_table(method);
 842             if (!table)
 843                 return null;
 844
 845             return (typeof table.key === 'undefined') ? null : table.key;
 846         },
 847
 848
 849         get_column: function(method, name) {
 850             var columns = this.get_columns(method);
 851             if (!columns)
 852                 return null;
 853
 854             $.each(columns, function(i, c) {
 855                 if (c.name == name)
 856                     return c
 857             });
 858             return null;
 859         },
 860
 861         get_type: function(method, name) {
 862             var table = this.get_table(method);
 863             if (!table)
 864                 return null;
 865
 866             var match = $.grep(table.column, function(x) { return x.name == name });
 867             if (match.length == 0) {
 868                 return undefined;
 869             } else {
 870                 return match[0].type;
 871             }
 872             return (typeof table.type === 'undefined') ? null : table.type;
 873         }
 874
 875      },
 876
 877     /**************************************************************************
 878      * Query management
 879      **************************************************************************/
 880
 881     query_store: new QueryStore(),
 882
 883     // XXX Remaining functions are deprecated since they are replaced by the query store
 884
 885     /*!
 886      * Associative array storing the set of queries active on the page
 887      * \memberof Manifold
 888      */
 889     all_queries: {},
 890
 891     /*!
 892      * Insert a query in the global hash table associating uuids to queries.
 893      * If the query has no been analyzed yet, let's do it.
 894      * \fn insert_query(query)
 895      * \memberof Manifold
 896      * \param ManifoldQuery query Query to be added
 897      */
 898     insert_query : function (query) {
 899         // NEW API
 900         manifold.query_store.insert(query);
 901
 902         // Run
 903         $(document).ready(function() {
 904         manifold.run_query(query);
 905         });
 906
 907         // FORMER API
 908         if (query.analyzed_query == null) {
 909             query.analyze_subqueries();
 910         }
 911         manifold.all_queries[query.query_uuid]=query;
 912     },
 913
 914     /*!
 915      * Returns the query associated to a UUID
 916      * \fn find_query(query_uuid)
 917      * \memberof Manifold
 918      * \param string query_uuid The UUID of the query to be returned
 919      */
 920     find_query : function (query_uuid) {
 921         return manifold.all_queries[query_uuid];
 922     },
 923
 924     /**************************************************************************
 925      * Query execution
 926      **************************************************************************/
 927
 928     // trigger a query asynchroneously
 929     proxy_url : '/manifold/proxy/json/',
 930
 931     // reasonably low-noise, shows manifold requests coming in and out
 932     asynchroneous_debug : true,
 933     // print our more details on result publication and related callbacks
 934     pubsub_debug : false,
 935
 936     /**
 937      * \brief We use js function closure to be able to pass the query (array)
 938      * to the callback function used when data is received
 939      */
 940     success_closure: function(query, publish_uuid, callback) {
 941         return function(data, textStatus) {
 942             manifold.asynchroneous_success(data, query, publish_uuid, callback);
 943         }
 944     },
 945
 946     run_query: function(query, callback)
 947         {
 948         // default value for callback = null
 949         if (typeof callback === 'undefined')
 950             callback = null;
 951
 952         var query_ext = manifold.query_store.find_query_ext(query.query_uuid);
 953         query_ext.query_state = QUERY_STATE_INPROGRESS;
 954
 955         var query_json = JSON.stringify(query);
 956
 957         // Inform plugins about the progress
 958         query.iter_subqueries(function (sq) {
 959             var sq_query_ext = manifold.query_store.find_analyzed_query_ext(sq.query_uuid);
 960             sq_query_ext.query_state = QUERY_STATE_INPROGRESS;
 961
 962             manifold.raise_record_event(sq.query_uuid, IN_PROGRESS);
 963         });
 964
 965
 966         $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, null, callback));
 967     },
 968
 969     // XXX DEPRECATED
 970     // Executes all async. queries - intended for the javascript header to initialize queries
 971     // input queries are specified as a list of {'query_uuid': <query_uuid> }
 972     // each plugin is responsible for managing its spinner through on_query_in_progress
 973     asynchroneous_exec : function (query_exec_tuples) {
 974
 975         // Loop through input array, and use publish_uuid to publish back results
 976         $.each(query_exec_tuples, function(index, tuple) {
 977             var query=manifold.find_query(tuple.query_uuid);
 978             var query_json=JSON.stringify (query);
 979             var publish_uuid=tuple.publish_uuid;
 980             // by default we publish using the same uuid of course
 981             if (publish_uuid==undefined) publish_uuid=query.query_uuid;
 982             if (manifold.pubsub_debug) {
 983                 messages.debug("sending POST on " + manifold.proxy_url + query.__repr());
 984             }
 985
 986             query.iter_subqueries(function (sq) {
 987                 manifold.raise_record_event(sq.query_uuid, IN_PROGRESS);
 988             });
 989
 990             // not quite sure what happens if we send a string directly, as POST data is named..
 991             // this gets reconstructed on the proxy side with ManifoldQuery.fill_from_POST
 992             $.post(manifold.proxy_url, {'json':query_json},
 993                    manifold.success_closure(query, publish_uuid, tuple.callback));
 994         })
 995     },
 996
 997     /**
 998      * \brief Forward a query to the manifold backend
 999      * \param query (dict) the query to be executed asynchronously
1000      * \param callback (function) the function to be called when the query terminates
1001      */
1002     forward: function(query, callback) {
1003         var query_json = JSON.stringify(query);
1004         $.post(manifold.proxy_url, {'json': query_json} ,
1005                manifold.success_closure(query, query.query_uuid, callback));
1006     },
1007
1008     /*!
1009      * Returns whether a query expects a unique results.
1010      * This is the case when the filters contain a key of the object
1011      * \fn query_expects_unique_result(query)
1012      * \memberof Manifold
1013      * \param ManifoldQuery query Query for which we are testing whether it expects a unique result
1014      */
1015     query_expects_unique_result: function(query) {
1016         /* XXX we need functions to query metadata */
1017         //var keys = MANIFOLD_METADATA[query.object]['keys']; /* array of array of field names */
1018         /* TODO requires keys in metadata */
1019         return true;
1020     },
1021
1022     /*!
1023      * Publish result
1024      * \fn publish_result(query, results)
1025      * \memberof Manifold
1026      * \param ManifoldQuery query Query which has received results
1027      * \param array results results corresponding to query
1028      */
1029     publish_result: function(query, result) {
1030         if (typeof result === 'undefined')
1031             result = [];
1032
1033         // NEW PLUGIN API
1034         manifold.raise_record_event(query.query_uuid, CLEAR_RECORDS);
1035         if (manifold.pubsub_debug)
1036             messages.debug(".. publish_result (1) ");
1037         var count=0;
1038         $.each(result, function(i, record) {
1039             manifold.raise_record_event(query.query_uuid, NEW_RECORD, record);
1040             count += 1;
1041         });
1042         if (manifold.pubsub_debug)
1043             messages.debug(".. publish_result (2) has used NEW API on " + count + " records");
1044         manifold.raise_record_event(query.query_uuid, DONE);
1045         if (manifold.pubsub_debug)
1046             messages.debug(".. publish_result (3) has used NEW API to say DONE");
1047
1048         // OLD PLUGIN API BELOW
1049         /* Publish an update announce */
1050         var channel="/results/" + query.query_uuid + "/changed";
1051         if (manifold.pubsub_debug)
1052             messages.debug(".. publish_result (4) OLD API on channel" + channel);
1053
1054         $.publish(channel, [result, query]);
1055
1056         if (manifold.pubsub_debug)
1057             messages.debug(".. publish_result (5) END q=" + query.__repr());
1058     },
1059
1060     store_records: function(query, records) {
1061         // Store records
1062         var query_ext = manifold.query_store.find_analyzed_query_ext(query.query_uuid);
1063         if (query_ext.set_query_ext) {
1064             // We have a domain query
1065             // The results are stored in the corresponding set_query
1066             manifold.query_store.set_records(query_ext.set_query_ext.query.query_uuid, records);
1067
1068         } else if (query_ext.domain_query_ext) {
1069             // We have a set query, it is only used to determine which objects are in the set, we should only retrieve the key
1070             // Has it a domain query, and has it completed ?
1071             $.each(records, function(i, record) {
1072                 var key = manifold.metadata.get_key(query.object);
1073                 var record_key = manifold.record_get_value(record, key);
1074                 manifold.query_store.set_record_state(query.query_uuid, record_key, STATE_SET, STATE_SET_IN);
1075             });
1076
1077         } else {
1078             // We have a normal query
1079             manifold.query_store.set_records(query.query_uuid, records, STATE_SET_IN);
1080         }
1081     },
1082
1083     /*!
1084      * Recursively publish result
1085      * \fn publish_result_rec(query, result)
1086      * \memberof Manifold
1087      * \param ManifoldQuery query Query which has received result
1088      * \param array result result corresponding to query
1089      *
1090      * Note: this function works on the analyzed query
1091      */
1092     publish_result_rec: function(query, records) {
1093         /* If the result is not unique, only publish the top query;
1094          * otherwise, publish the main object as well as subqueries
1095          * XXX how much recursive are we ?
1096          */
1097         if (manifold.pubsub_debug)
1098              messages.debug (">>>>> publish_result_rec " + query.object);
1099         if (manifold.query_expects_unique_result(query)) {
1100             /* Also publish subqueries */
1101             $.each(query.subqueries, function(object, subquery) {
1102                 manifold.publish_result_rec(subquery, records[0][object]);
1103                 /* TODO remove object from result */
1104             });
1105         }
1106         if (manifold.pubsub_debug)
1107             messages.debug ("===== publish_result_rec " + query.object);
1108
1109         var query_ext = manifold.query_store.find_analyzed_query_ext(query.query_uuid);
1110         query_ext.query_state = QUERY_STATE_DONE;
1111
1112         this.store_records(query, records);
1113
1114         var pub_query;
1115
1116         if (query_ext.set_query_ext) {
1117             if (query_ext.set_query_ext.query_state != QUERY_STATE_DONE)
1118                 return;
1119             pub_query = query_ext.set_query_ext.query;
1120         } else if (query_ext.domain_query_ext) {
1121             if (query_ext.domain_query_ext.query_state != QUERY_STATE_DONE)
1122                 return;
1123             pub_query = query;
1124         } else {
1125             pub_query = query;
1126         }
1127         // We can only publish results if the query (and its related domain query) is complete
1128         manifold.publish_result(pub_query, records);
1129
1130         if (manifold.pubsub_debug)
1131             messages.debug ("<<<<< publish_result_rec " + query.object);
1132     },
1133
1134     setup_update_query: function(query, records)
1135     {
1136         // We don't prepare an update query if the result has more than 1 entry
1137         if (records.length != 1)
1138             return;
1139         var query_ext = manifold.query_store.find_query_ext(query.query_uuid);
1140
1141         var record = records[0];
1142
1143         var update_query_ext = query_ext.update_query_ext;
1144
1145         if (!update_query_ext)
1146             return;
1147
1148         var update_query = update_query_ext.query;
1149         var update_query_ext = query_ext.update_query_ext;
1150         var update_query_orig = query_ext.update_query_orig_ext.query;
1151
1152         // Testing whether the result has subqueries (one level deep only)
1153         // iif the query has subqueries
1154         var count = 0;
1155         var obj = query.analyzed_query.subqueries;
1156         for (method in obj) {
1157             if (obj.hasOwnProperty(method)) {
1158                 var key = manifold.metadata.get_key(method);
1159                 if (!key)
1160                     continue;
1161                 var sq_keys = [];
1162                 var subrecords = record[method];
1163                 if (!subrecords)
1164                     continue
1165                 $.each(subrecords, function (i, subrecord) {
1166                     sq_keys.push(manifold.record_get_value(subrecord, key));
1167                 });
1168                 update_query.params[method] = sq_keys;
1169                 update_query_orig.params[method] = sq_keys.slice();
1170                 count++;
1171             }
1172         }
1173
1174         if (count > 0) {
1175             update_query_ext.disabled = false;
1176             update_query_orig_ext.disabled = false;
1177         }
1178     },
1179
1180     process_get_query_records: function(query, records) {
1181         this.setup_update_query(query, records);
1182
1183         var query_ext = manifold.query_store.find_query_ext(query.query_uuid);
1184         query_ext.query_state = QUERY_STATE_DONE;
1185
1186         /* Publish full results */
1187         var tmp_query = manifold.query_store.find_analyzed_query(query.query_uuid);
1188         manifold.publish_result_rec(tmp_query, records);
1189     },
1190
1191     make_records: function(object, records)
1192     {
1193         $.each(records, function(i, record) {
1194             manifold.make_record(object, record);
1195         });
1196     },
1197
1198     make_record: function(object, record)
1199     {
1200         // To make an object a record, we just add the hash function
1201         var key = manifold.metadata.get_key(object);
1202         record.hashCode = manifold.record_hashcode(key.sort());
1203         record.equals   = manifold.record_equals(key);
1204
1205         // Looking after subrecords
1206         for (var field in record) {
1207             var result_value = record[field];
1208
1209             switch (this.get_type(result_value)) {
1210                 case TYPE_RECORD:
1211                     var subobject = manifold.metadata.get_type(object, field);
1212                     // if (subobject) XXX Bugs with fields declared string while they are not : network.version is a dict in fact
1213                     if (subobject && subobject != 'string')
1214                         manifold.make_record(subobject, result_value);
1215                     break;
1216                 case TYPE_LIST_OF_RECORDS:
1217                     var subobject = manifold.metadata.get_type(object, field);
1218                     if (subobject)
1219                         manifold.make_records(subobject, result_value);
1220                     break;
1221             }
1222         }
1223     },
1224
1225     /**
1226      *
1227      * What we need to do when receiving results from an update query:
1228      * - differences between what we had, what we requested, and what we obtained
1229      *    . what we had : update_query_orig (simple fields and set fields managed differently)
1230      *    . what we requested : update_query
1231      *    . what we received : records
1232      * - raise appropriate events
1233      *
1234      * The normal process is that results similar to Get will be pushed in the
1235      * pubsub mechanism, thus repopulating everything while we only need
1236      * diff's. This means we need to move the publish functionalities in the
1237      * previous 'process_get_query_records' function.
1238      */
1239     process_update_query_records: function(query, records) {
1240         // First issue: we request everything, and not only what we modify, so will will have to ignore some fields
1241         var query_uuid        = query.query_uuid;
1242         var query_ext         = manifold.query_store.find_analyzed_query_ext(query_uuid);
1243         var update_query      = query_ext.main_query_ext.update_query_ext.query;
1244         var update_query_orig = query_ext.main_query_ext.update_query_orig_ext.query;
1245
1246         // Since we update objects one at a time, we can get the first record
1247         var record = records[0];
1248
1249         // Let's iterate over the object properties
1250         for (var field in record) {
1251             var result_value = record[field];
1252             switch (this.get_type(result_value)) {
1253                 case TYPE_VALUE:
1254                     // Did we ask for a change ?
1255                     var update_value = update_query[field];
1256                     if (!update_value)
1257                         // Not requested, if it has changed: OUT OF SYNC
1258                         // How we can know ?
1259                         // We assume it won't have changed
1260                         continue;
1261
1262                     if (!result_value)
1263                         throw "Internal error";
1264
1265                     data = {
1266                         state : STATE_SET,
1267                         key   : field,
1268                         op    : update_value,
1269                         value : (update_value == result_value) ? STATE_VALUE_CHANGE_SUCCESS : STATE_VALUE_CHANGE_FAILURE,
1270                     }
1271                     manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
1272
1273                     break;
1274                 case TYPE_RECORD:
1275                     throw "Not implemented";
1276                     break;
1277
1278                 /*
1279 case TYPE_LIST_OF_VALUES:
1280                     // Same as list of records, but we don't have to extract keys
1281
1282                     // The rest of exactly the same (XXX factorize)
1283                     var update_keys  = update_query_orig.params[field];
1284                     var query_keys   = update_query.params[field];
1285                     var added_keys   = $.grep(query_keys, function (x) { return $.inArray(x, update_keys) == -1 });
1286                     var removed_keys = $.grep(update_keys, function (x) { return $.inArray(x, query_keys) == -1 });
1287
1288
1289                     $.each(added_keys, function(i, key) {
1290                         if ($.inArray(key, result_value) == -1) {
1291                             data = {
1292                                 request: FIELD_REQUEST_ADD,
1293                                 key   : field,
1294                                 value : key,
1295                                 status: FIELD_REQUEST_FAILURE,
1296                             }
1297                         } else {
1298                             data = {
1299                                 request: FIELD_REQUEST_ADD,
1300                                 key   : field,
1301                                 value : key,
1302                                 status: FIELD_REQUEST_SUCCESS,
1303                             }
1304                         }
1305                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
1306                     });
1307                     $.each(removed_keys, function(i, key) {
1308                         if ($.inArray(key, result_keys) == -1) {
1309                             data = {
1310                                 request: FIELD_REQUEST_REMOVE,
1311                                 key   : field,
1312                                 value : key,
1313                                 status: FIELD_REQUEST_SUCCESS,
1314                             }
1315                         } else {
1316                             data = {
1317                                 request: FIELD_REQUEST_REMOVE,
1318                                 key   : field,
1319                                 value : key,
1320                                 status: FIELD_REQUEST_FAILURE,
1321                             }
1322                         }
1323                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
1324                     });
1325
1326
1327                     break;
1328                 */
1329                 case TYPE_LIST_OF_VALUES: // XXX Until fixed
1330                 case TYPE_LIST_OF_RECORDS:
1331                     var key, new_state, cur_query_uuid;
1332
1333                     cur_query_uuid = query.analyzed_query.subqueries[field].query_uuid;
1334
1335                     // example: slice.resource
1336                     //  - update_query_orig.params.resource = resources in slice before update
1337                     //  - update_query.params.resource = resource requested in slice
1338                     //  - keys from field = resources obtained
1339
1340                     if (field == 'lease') {
1341                          // lease_id has been added to be repeated when
1342                          // constructing request rspec. We don't want it for
1343                          // comparisons
1344                         key = ['start_time', 'end_time', 'resource'];
1345                     } else {
1346                         key = manifold.metadata.get_key(field);
1347                     }
1348                     if (!key)
1349                         continue;
1350                     /*
1351                     if (key.length > 1) {
1352                         throw "Not implemented";
1353                         continue;
1354                     }
1355                     key = key[0];
1356                     */
1357
1358                     /* XXX should be modified for multiple keys */
1359                     var result_keys  = $.map(record[field], function(x) { return manifold.record_get_value(x, key); });
1360
1361                     // XXX All this could be deduced from record state : STATE_IN_PENDING and STATE_OUT_PENDING
1362                     // what we had at the begining
1363                     var update_keys  = update_query_orig.params[field];
1364                     // what we asked
1365                     var query_keys   = update_query.params[field];
1366                     // what we added and removed
1367                     var added_keys   = $.grep(query_keys,  function (x) { return (!(manifold._in_array(x, update_keys, key))); });
1368                     var removed_keys = $.grep(update_keys, function (x) { return (!(manifold._in_array(x, query_keys,  key))); });
1369
1370                     // Send events related to parent query
1371                     $.each(added_keys, function(i, added_key) {
1372                         new_state = (manifold._in_array(added_key, result_keys, key)) ? STATE_SET_IN_SUCCESS : STATE_SET_IN_FAILURE;
1373
1374                         // Update record state for children queries
1375                         manifold.query_store.set_record_state(cur_query_uuid, added_key, STATE_SET, new_state);
1376
1377                         // XXX This could be optimized
1378                         manifold.query_store.recount(cur_query_uuid);
1379
1380                         data = { state: STATE_SET, key  : field, op   : new_state, value: added_key }
1381                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
1382
1383                         // Inform subquery also
1384                         data.key = '';
1385                         manifold.raise_record_event(cur_query_uuid, FIELD_STATE_CHANGED, data);
1386                         // XXX Passing no parameters so that they can redraw everything would
1387                         // be more efficient but is currently not supported
1388                         // XXX We could also need to inform plugins about nodes IN (not pending) that are no more, etc.
1389                         // XXX refactor all this when suppressing update_queries, and relying on state instead !
1390                     });
1391                     $.each(removed_keys, function(i, removed_key) {
1392                         new_state = (manifold._in_array(removed_key, result_keys, key)) ? STATE_SET_OUT_FAILURE : STATE_SET_OUT_SUCCESS;
1393
1394                         // Update record state for children queries
1395                         manifold.query_store.set_record_state(cur_query_uuid, removed_key, STATE_SET, new_state);
1396
1397                         // XXX This could be optimized
1398                         manifold.query_store.recount(cur_query_uuid);
1399
1400                         data = { state: STATE_SET, key  : field, op   : new_state, value: removed_key }
1401                         manifold.raise_record_event(query_uuid, FIELD_STATE_CHANGED, data);
1402
1403                         // Inform subquery also
1404                         data.key = '';
1405                         manifold.raise_record_event(cur_query_uuid, FIELD_STATE_CHANGED, data);
1406                     });
1407
1408                     break;
1409             }
1410         }
1411
1412         // XXX Now we need to adapt 'update' and 'update_orig' queries as if we had done a get
1413         this.setup_update_query(query, records);
1414
1415         var query_ext = manifold.query_store.find_query_ext(query.query_uuid);
1416         query_ext.query_state = QUERY_STATE_DONE;
1417
1418
1419         // Send DONE message to plugins
1420         query.iter_subqueries(function(sq, data, parent_query) {
1421             manifold.raise_record_event(sq.query_uuid, DONE);
1422         });
1423
1424     },
1425
1426     process_query_records: function(query, records) {
1427         if (query.action == 'get') {
1428             this.process_get_query_records(query, records);
1429         } else if (query.action == 'update') {
1430             this.process_update_query_records(query, records);
1431         }
1432     },
1433
1434     // if set callback is provided it is called
1435     // most of the time publish_uuid will be query.query_uuid
1436     // however in some cases we wish to publish the result under a different uuid
1437     // e.g. an updater wants to publish its result as if from the original (get) query
1438     asynchroneous_success : function (data, query, publish_uuid, callback) {
1439         // xxx should have a nicer declaration of that enum in sync with the python code somehow
1440
1441         var start = new Date();
1442         if (manifold.asynchroneous_debug)
1443             messages.debug(">>>>>>>>>> asynchroneous_success query.object=" + query.object);
1444
1445         if (data.code == 2) { // ERROR
1446             // We need to make sense of error codes here
1447             alert("Your session has expired, please log in again");
1448             localStorage.removeItem('user');
1449             window.location="/logout/";
1450             if (manifold.asynchroneous_debug) {
1451                 duration=new Date()-start;
1452                 messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- error returned - logging out " + duration + " ms");
1453             }
1454             return;
1455         }
1456         if (data.code == 1) { // WARNING
1457             messages.error("Some errors have been received from the manifold backend at " + MANIFOLD_URL + " [" + data.description + "]");
1458             // publish error code and text message on a separate channel for whoever is interested
1459             if (publish_uuid)
1460                 $.publish("/results/" + publish_uuid + "/failed", [data.code, data.description] );
1461
1462         }
1463
1464         // If a callback has been specified, we redirect results to it
1465         if (!!callback) {
1466             callback(data);
1467             if (manifold.asynchroneous_debug) {
1468                 duration=new Date()-start;
1469                 messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- callback ended " + duration + " ms");
1470             }
1471             return;
1472         }
1473
1474         if (manifold.asynchroneous_debug)
1475             messages.debug ("========== asynchroneous_success " + query.object + " -- before process_query_records [" + query.query_uuid +"]");
1476
1477         // once everything is checked we can use the 'value' part of the manifoldresult
1478         var result=data.value;
1479         if (result) {
1480             /* Eventually update the content of related queries (update, etc) */
1481             manifold.make_records(query.object, result);
1482             this.process_query_records(query, result);
1483
1484             /* Publish results: disabled here, done in the previous call */
1485             //tmp_query = manifold.find_query(query.query_uuid);
1486             //manifold.publish_result_rec(tmp_query.analyzed_query, result);
1487         }
1488         if (manifold.asynchroneous_debug) {
1489             duration=new Date()-start;
1490             messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- done " + duration + " ms");
1491         }
1492
1493     },
1494
1495     /**************************************************************************
1496      * Plugin API helpers
1497      **************************************************************************/
1498
1499     raise_event_handler: function(type, query_uuid, event_type, value) {
1500         if (manifold.pubsub_debug)
1501             messages.debug("raise_event_handler, quuid="+query_uuid+" type="+type+" event_type="+event_type);
1502         if ((type != 'query') && (type != 'record'))
1503             throw 'Incorrect type for manifold.raise_event()';
1504         // xxx we observe quite a lot of incoming calls with an undefined query_uuid
1505         // this should be fixed upstream in manifold I expect
1506         if (query_uuid === undefined) {
1507             messages.warning("undefined query in raise_event_handler");
1508             return;
1509         }
1510
1511         // notify the change to objects that either listen to this channel specifically,
1512         // or to the wildcard channel
1513         var channels = [ manifold.get_channel(type, query_uuid), manifold.get_channel(type, '*') ];
1514
1515         $.each(channels, function(i, channel) {
1516             if (value === undefined) {
1517                 if (manifold.pubsub_debug) messages.debug("triggering [no value] on channel="+channel+" and event_type="+event_type);
1518                 $('.pubsub').trigger(channel, [event_type]);
1519             } else {
1520                 if (manifold.pubsub_debug) messages.debug("triggering [value="+value+"] on channel="+channel+" and event_type="+event_type);
1521                 $('.pubsub').trigger(channel, [event_type, value]);
1522             }
1523         });
1524     },
1525
1526     raise_query_event: function(query_uuid, event_type, value) {
1527         manifold.raise_event_handler('query', query_uuid, event_type, value);
1528     },
1529
1530     raise_record_event: function(query_uuid, event_type, value) {
1531         manifold.raise_event_handler('record', query_uuid, event_type, value);
1532     },
1533
1534     /**
1535      * Event handler helpers
1536      */
1537     _get_next_state_add: function(prev_state)
1538     {
1539         switch (prev_state) {
1540             case STATE_SET_OUT:
1541             case STATE_SET_OUT_SUCCESS:
1542             case STATE_SET_IN_FAILURE:
1543                 new_state = STATE_SET_IN_PENDING;
1544                 break;
1545
1546             case STATE_SET_OUT_PENDING:
1547                 new_state = STATE_SET_IN;
1548                 break;
1549
1550             case STATE_SET_IN:
1551             case STATE_SET_IN_PENDING:
1552             case STATE_SET_IN_SUCCESS:
1553             case STATE_SET_OUT_FAILURE:
1554                 console.log("Inconsistent state: already in");
1555                 return;
1556         }
1557         return new_state;
1558     },
1559
1560     _get_next_state_remove: function(prev_state)
1561     {
1562         switch (prev_state) {
1563             case STATE_SET_IN:
1564             case STATE_SET_IN_SUCCESS:
1565             case STATE_SET_OUT_FAILURE:
1566                 new_state = STATE_SET_OUT_PENDING;
1567                 break;
1568
1569             case STATE_SET_IN_PENDING:
1570                 new_state = STATE_SET_OUT;
1571                 break;
1572
1573             case STATE_SET_OUT:
1574             case STATE_SET_OUT_PENDING:
1575             case STATE_SET_OUT_SUCCESS:
1576             case STATE_SET_IN_FAILURE:
1577                 console.log("Inconsistent state: already out");
1578                 return;
1579         }
1580         return new_state;
1581     },
1582
1583     _grep_active_lease_callback: function(lease_query, resource_key) {
1584         return function(lease_key_lease) {
1585             var state, lease_key, lease;
1586
1587             lease_key = lease_key_lease[0];
1588             lease = lease_key_lease[1];
1589
1590             if (lease['resource'] != resource_key)
1591                 return false;
1592
1593             state = manifold.query_store.get_record_state(lease_query.query_uuid, lease_key, STATE_SET);;
1594             switch(state) {
1595                 case STATE_SET_IN:
1596                 case STATE_SET_IN_PENDING:
1597                 case STATE_SET_IN_SUCCESS:
1598                 case STATE_SET_OUT_FAILURE:
1599                     return true;
1600                 case STATE_SET_OUT:
1601                 case STATE_SET_OUT_PENDING:
1602                 case STATE_SET_OUT_SUCCESS:
1603                 case STATE_SET_IN_FAILURE:
1604                     return false;
1605             }
1606         }
1607     },
1608
1609     _enforce_constraints: function(query_ext, record, record_key, event_type)
1610     {
1611         var query, data;
1612
1613         query = query_ext.query;
1614
1615         switch(query.object) {
1616
1617             case 'resource':
1618                 // CONSTRAINT_RESERVABLE_LEASE
1619                 //
1620                 // +) If a reservable node is added to the slice, then it should have a corresponding lease
1621                 // XXX Not always a resource
1622                 var is_reservable = (record.exclusive == true);
1623                 if (is_reservable) {
1624                     var warnings = manifold.query_store.get_record_state(query.query_uuid, record_key, STATE_WARNINGS);
1625
1626                     if (event_type == STATE_SET_ADD) {
1627                         // We should have a lease_query associated
1628                         var lease_query = query_ext.parent_query_ext.query.subqueries['lease']; // in  options
1629                         var lease_query_ext = manifold.query_store.find_analyzed_query_ext(lease_query.query_uuid);
1630                         // Do we have lease records (in) with this resource
1631                         var lease_records = $.grep(lease_query_ext.records.entries(), this._grep_active_lease_callback(lease_query, record_key));
1632                         if (lease_records.length == 0) {
1633                             // Sets a warning
1634                             // XXX Need for a better function to manage warnings
1635                             var warn = CONSTRAINT_RESERVABLE_LEASE_MSG;
1636                             warnings[CONSTRAINT_RESERVABLE_LEASE] = warn;
1637                         } else {
1638                             // Lease are defined, delete the warning in case it was set previously
1639                             delete warnings[CONSTRAINT_RESERVABLE_LEASE];
1640                         }
1641                     } else {
1642                         // Remove warnings attached to this resource
1643                         delete warnings[CONSTRAINT_RESERVABLE_LEASE];
1644                     }
1645
1646                     manifold.query_store.set_record_state(query.query_uuid, record_key, STATE_WARNINGS, warnings);
1647                 }
1648
1649                 /* This was redundant */
1650                 // manifold.query_store.recount(query.query_uuid);
1651
1652                 // Signal the change to plugins (even if the constraint does not apply, so that the plugin can display a checkmark)
1653                 data = {
1654                     state:  STATE_WARNINGS,
1655                     key   : record_key,
1656                     op    : null,
1657                     value : warnings
1658                 }
1659                 manifold.raise_record_event(query.query_uuid, FIELD_STATE_CHANGED, data);
1660                 break;
1661
1662             case 'lease':
1663                 var resource_key = record_key.resource;
1664                 var resource_query = query_ext.parent_query_ext.query.subqueries['resource'];
1665                 var warnings = manifold.query_store.get_record_state(resource_query.query_uuid, resource_key, STATE_WARNINGS);
1666
1667                 if (event_type == STATE_SET_ADD) {
1668                      // A lease is added, it removes the constraint
1669                     delete warnings[CONSTRAINT_RESERVABLE_LEASE];
1670                 } else {
1671                     // A lease is removed, it might trigger the warning
1672                     var lease_records = $.grep(query_ext.records.entries(), this._grep_active_lease_callback(query, resource_key));
1673                     if (lease_records.length == 0) { // XXX redundant cases
1674                         // Sets a warning
1675                         // XXX Need for a better function to manage warnings
1676                         var warn = CONSTRAINT_RESERVABLE_LEASE_MSG;
1677                         warnings[CONSTRAINT_RESERVABLE_LEASE] = warn;
1678                     } else {
1679                         // Lease are defined, delete the warning in case it was set previously
1680                         delete warnings[CONSTRAINT_RESERVABLE_LEASE];
1681                     }
1682
1683                 }
1684
1685                 manifold.query_store.recount(resource_query.query_uuid);
1686
1687                 // Signal the change to plugins (even if the constraint does not apply, so that the plugin can display a checkmark)
1688                 data = {
1689                     state:  STATE_WARNINGS,
1690                     key   : resource_key,
1691                     op    : null,
1692                     value : warnings
1693                 }
1694                 manifold.raise_record_event(resource_query.query_uuid, FIELD_STATE_CHANGED, data);
1695                 break;
1696         }
1697
1698         // -) When a lease is added, it might remove the warning associated to a reservable node
1699
1700         // If a NITOS node is reserved, then at least a NITOS channel should be reserved
1701         // - When a NITOS channel is added, it might remove a warning associated to all NITOS nodes
1702
1703         // If a NITOS channel is reserved, then at least a NITOS node should be reserved
1704         // - When a NITOS node is added, it might remove a warning associated to all NITOS channels
1705
1706         // A lease is present while the resource has been removed => Require warnings on nodes not in set !
1707
1708     },
1709
1710     _get_query_path: function(query_ext) {
1711         var path = "";
1712         var sq = query_ext;
1713         while (sq.parent_query_ext) {
1714             if (path != "")
1715                 path = '.' + path;
1716             path = sq.query.object + path;
1717             sq = sq.parent_query_ext;
1718         }
1719         return path;
1720     },
1721
1722
1723     /**
1724      * Handling events raised by plugins
1725      */
1726     raise_event: function(query_uuid, event_type, data)
1727     {
1728         var query, query_ext;
1729
1730         // Query uuid has been updated with the key of a new element
1731         query_ext    = manifold.query_store.find_analyzed_query_ext(query_uuid);
1732         query = query_ext.query;
1733
1734         switch(event_type) {
1735
1736             // XXX At some point, should be renamed to RECORD_STATE_CHANGED
1737             case FIELD_STATE_CHANGED:
1738
1739                 // value is an object (request, key, value, status)
1740                 // update is only possible is the query is not pending, etc
1741                 // SET_ADD is on a subquery, FIELD_STATE_CHANGED on the query itself
1742                 // we should map SET_ADD on this...
1743
1744                 // 1. Update internal query store about the change in status
1745
1746                 // 2. Update the update query
1747                 update_query      = query_ext.main_query_ext.update_query_ext.query;
1748                 update_query_orig = query_ext.main_query_ext.update_query_orig_ext.query;
1749
1750                 switch(data.state) {
1751
1752                     case STATE_VALUE:
1753                         switch(data.op) {
1754                             case STATE_CHANGE:
1755                                 /* Set parameter data.key in the update_query to VALUE */
1756                                 if (update_query.params[data.key] === undefined)
1757                                     update_query.params[data.key] = Array();
1758                                 update_query.params[data.key] = value.value;
1759                                 break;
1760
1761                         }
1762                         break;
1763
1764                     case STATE_SET:
1765                         var prev_state, new_state;
1766                         var main_query, record, new_data, path;
1767
1768                         // We only track state in the analyzed query
1769                         prev_state = manifold.query_store.get_record_state(query_uuid, data.value, STATE_SET);
1770                         if (prev_state === null)
1771                             prev_state = STATE_SET_OUT;
1772
1773                         switch(data.op) {
1774                             case STATE_SET_ADD:
1775                                 new_state = this._get_next_state_add(prev_state);
1776
1777                                 /* data.value containts the resource key */
1778                                 manifold.query_store.add_record(query_uuid, data.value, new_state);
1779                                 record = manifold.query_store.get_record(query_uuid, data.value);
1780                                 this._enforce_constraints(query_ext, record, data.value, STATE_SET_ADD);
1781
1782                                 /* Process update query in parent */
1783                                 path =  this._get_query_path(query_ext);
1784                                 if (update_query.params[path] === undefined)
1785                                     update_query.params[path] = Array();
1786                                 update_query.params[path].push(data.value);
1787
1788                                 break;
1789
1790                             case STATE_SET_REMOVE:
1791                                 new_state = this._get_next_state_remove(prev_state);
1792
1793                                 /* data.value contains the resource key */
1794                                 manifold.query_store.remove_record(query_uuid, data.value, new_state);
1795                                 record = manifold.query_store.get_record(query_uuid, data.value);
1796                                 this._enforce_constraints(query_ext, record, data.value, STATE_SET_REMOVE);
1797
1798                                 /* Process update query in parent */
1799                                 path =  this._get_query_path(query_ext);
1800                                 arr = update_query.params[path];
1801
1802                                 var key = manifold.metadata.get_key(query.object);
1803                                 arr = $.grep(arr, function(x) { return (!(manifold._record_equals(x, data.value, key))); });
1804                                 if (update_query.params[path] === undefined)
1805                                     update_query.params[path] = Array();
1806                                 update_query.params[path] = arr;
1807                                 break;
1808                         }
1809
1810                         /* Inform the parent query: important for update */
1811                         new_data = {
1812                             state : STATE_SET,
1813                             key   : path,
1814                             op    : new_state,
1815                             value : data.value,
1816                         };
1817                         main_query = query_ext.main_query_ext.query;
1818                         manifold.raise_record_event(main_query.query_uuid, event_type, new_data);
1819                         /* Propagate the event to other plugins subscribed to the query */
1820                         manifold.query_store.recount(query_uuid);
1821                         new_data.key = ''
1822                         manifold.raise_record_event(query_uuid, event_type, new_data);
1823
1824                         break;
1825                 }
1826 /*
1827                 // 3. Inform others about the change
1828                 // a) the main query...
1829                 manifold.raise_record_event(query_uuid, event_type, data);
1830
1831                 // b) subqueries eventually (dot in the key)
1832                 // Let's unfold
1833
1834                 var cur_query = query;
1835                 if (cur_query.analyzed_query)
1836                     cur_query = cur_query.analyzed_query;
1837
1838                 if (data.key) {
1839                     var path_array = data.key.split('.');
1840                     var value_key = data.key.split('.');
1841                     $.each(path_array, function(i, method) {
1842                         cur_query = cur_query.subqueries[method];
1843                         value_key.shift(); // XXX check that method is indeed shifted
1844                     });
1845                     data.key = value_key;
1846                 }
1847                 manifold.raise_record_event(cur_query.query_uuid, event_type, data);
1848 */
1849
1850                 break;
1851
1852             case RUN_UPDATE:
1853                 manifold.run_query(query_ext.main_query_ext.update_query_ext.query);
1854                 break;
1855
1856             /* QUERY STATE CHANGED */
1857
1858             // FILTERS
1859
1860             case FILTER_ADDED:
1861                 console.log("FILTER ADDED", data);
1862                 /* Update internal record state */
1863                 manifold.query_store.add_filter(query_uuid, data);
1864
1865                 /* Propagate the message to plugins */
1866                 manifold.raise_query_event(query_uuid, event_type, data);
1867
1868                 break;
1869
1870             case FILTER_REMOVED:
1871                 console.log("FILTER REMOVED", data);
1872                 /* Update internal record state */
1873                 manifold.query_store.remove_filter(query_uuid, data);
1874
1875                 /* Propagate the message to plugins */
1876                 manifold.raise_query_event(query_uuid, event_type, data);
1877
1878                 break;
1879
1880             case FIELD_ADDED:
1881                 main_query = query_ext.main_query_ext.query;
1882                 main_update_query = query_ext.main_query_ext.update_query;
1883                 query.select(data);
1884
1885                 // Here we need the full path through all subqueries
1886                 path = ""
1887                 // XXX We might need the query name in the QueryExt structure
1888                 main_query.select(data);
1889
1890                 // XXX When is an update query associated ?
1891                 // XXX main_update_query.select(value);
1892
1893                 manifold.raise_query_event(query_uuid, event_type, data);
1894                 break;
1895
1896             case FIELD_REMOVED:
1897                 query = query_ext.query;
1898                 main_query = query_ext.main_query_ext.query;
1899                 main_update_query = query_ext.main_query_ext.update_query;
1900                 query.unselect(data);
1901                 main_query.unselect(data);
1902
1903                 // We need to inform about changes in these queries to the respective plugins
1904                 // Note: query & main_query have the same UUID
1905                 manifold.raise_query_event(query_uuid, event_type, data);
1906                 break;
1907         }
1908         // We need to inform about changes in these queries to the respective plugins
1909         // Note: query, main_query & update_query have the same UUID
1910
1911         // http://trac.myslice.info/ticket/32
1912         // Avoid multiple calls to the same event
1913         //manifold.raise_query_event(query_uuid, event_type, value);
1914
1915         // We are targeting the same object with get and update
1916         // The notion of query is bad, we should have a notion of destination, and issue queries on the destination
1917         // NOTE: Editing a subquery == editing a local view on the destination
1918
1919         // XXX We might need to run the new query again and manage the plugins in the meantime with spinners...
1920         // For the time being, we will collect all columns during the first query
1921     },
1922
1923     /* Publish/subscribe channels for internal use */
1924     get_channel: function(type, query_uuid) {
1925         if ((type !== 'query') && (type != 'record'))
1926             return null;
1927         return '/' + type + '/' + query_uuid;
1928     },
1929
1930 }; // manifold object
1931 /* ------------------------------------------------------------ */
1932
1933 (function($) {
1934
1935     // OLD PLUGIN API: extend jQuery/$ with pubsub capabilities
1936     // https://gist.github.com/661855
1937     var o = $({});
1938     $.subscribe = function( channel, selector, data, fn) {
1939       /* borrowed from jQuery */
1940       if ( data == null && fn == null ) {
1941           // ( channel, fn )
1942           fn = selector;
1943           data = selector = undefined;
1944       } else if ( fn == null ) {
1945           if ( typeof selector === "string" ) {
1946               // ( channel, selector, fn )
1947               fn = data;
1948               data = undefined;
1949           } else {
1950               // ( channel, data, fn )
1951               fn = data;
1952               data = selector;
1953               selector = undefined;
1954           }
1955       }
1956       /* </ugly> */
1957
1958       /* We use an indirection function that will clone the object passed in
1959        * parameter to the subscribe callback
1960        *
1961        * FIXME currently we only clone query objects which are the only ones
1962        * supported and editable, we might have the same issue with results but
1963        * the page load time will be severely affected...
1964        */
1965       o.on.apply(o, [channel, selector, data, function() {
1966           for(i = 1; i < arguments.length; i++) {
1967               if ( arguments[i].constructor.name == 'ManifoldQuery' )
1968                   arguments[i] = arguments[i].clone();
1969           }
1970           fn.apply(o, arguments);
1971       }]);
1972     };
1973
1974     $.unsubscribe = function() {
1975       o.off.apply(o, arguments);
1976     };
1977
1978     $.publish = function() {
1979       o.trigger.apply(o, arguments);
1980     };
1981
1982 }(jQuery));
1983
1984 /* ------------------------------------------------------------ */
1985
1986 //http://stackoverflow.com/questions/5100539/django-csrf-check-failing-with-an-ajax-post-request
1987 //make sure to expose csrf in our outcoming ajax/post requests
1988 $.ajaxSetup({
1989      beforeSend: function(xhr, settings) {
1990          function getCookie(name) {
1991              var cookieValue = null;
1992              if (document.cookie && document.cookie != '') {
1993                  var cookies = document.cookie.split(';');
1994                  for (var i = 0; i < cookies.length; i++) {
1995                      var cookie = jQuery.trim(cookies[i]);
1996                      // Does this cookie string begin with the name we want?
1997                  if (cookie.substring(0, name.length + 1) == (name + '=')) {
1998                      cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
1999                      break;
2000                  }
2001              }
2002          }
2003          return cookieValue;
2004          }
2005          if (!(/^http:.*/.test(settings.url) || /^https:.*/.test(settings.url))) {
2006              // Only send the token to relative URLs i.e. locally.
2007              xhr.setRequestHeader("X-CSRFToken", getCookie('csrftoken'));
2008          }
2009      }
2010 });