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