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