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