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