plugins: migrated hazelnut and googlemaps to the new plugin class, updated plugin...
[myslice.git] / manifold / js / manifold.js
index c3aac9f..f7c098a 100644 (file)
@@ -32,15 +32,104 @@ var CLEAR_RECORDS  = 8;
 var IN_PROGRESS    = 101;
 var DONE           = 102;
 
+/* Update requests from plugins */
 var SET_ADD        = 201;
 var SET_REMOVED    = 202;
 
+/* Query status */
+var STATUS_NONE               = 500; // Query has not been started yet
+var STATUS_GET_IN_PROGRESS    = 501; // Query has been sent, no result has been received
+var STATUS_GET_RECEIVED       = 502; // Success
+var STATUS_GET_ERROR          = 503; // Error
+var STATUS_UPDATE_PENDING     = 504;
+var STATUS_UPDATE_IN_PROGRESS = 505;
+var STATUS_UPDATE_RECEIVED    = 506;
+var STATUS_UPDATE_ERROR       = 507;
+// outdated ?
+
+// A structure for storing queries
+
+
+
+function QueryExt(query, parent_query, main_query) {
+
+    /* Constructor */
+    if (typeof query == "undefined")
+        throw "Must pass a query in QueryExt constructor";
+    this.query            = query
+    this.parent_query_ext = (typeof parent_query == "undefined") ? false : parent_query
+    this.main_query_ext   = (typeof main_query   == "undefined") ? false : main_query
+    
+    this.status       = null;
+    this.results      = null;
+    this.update_query = null; // null unless we are a main_query (aka parent_query == null); only main_query_fields can be updated...
+}
+
+function QueryStore() {
+
+    this.main_queries     = {};
+    this.analyzed_queries = {};
+
+    /* Insertion */
+
+    this.insert = function(query)
+    {
+        if (query.analyzed_query == null) {
+            query.analyze_subqueries();
+        }
+
+        query_ext = new QueryExt(query, null, null)
+        manifold.query_store.main_queries[query.query_uuid] = query_ext;
+
+        // We also need to insert all queries and subqueries from the analyzed_query
+        // XXX We need the root of all subqueries
+        query.iter_subqueries(function(sq, data, parent_query) {
+            if (parent_query)
+                parent_query_ext = manifold.query_store.find_analyzed_query_ext(parent_query.query_uuid);
+            else
+                parent_query_ext = null;
+            // XXX parent_query_ext == false
+            // XXX main.subqueries = {} # Normal, we need analyzed_query
+            sq_ext = new QueryExt(sq, parent_query_ext, query_ext)
+            manifold.query_store.analyzed_queries[sq.query_uuid] = sq_ext;
+        });
+    }
+
+    /* Searching */
+
+    this.find_query_ext = function(query_uuid)
+    {
+        return this.main_queries[query_uuid];
+    }
+
+    this.find_query = function(query_uuid)
+    {
+        return this.find_query_ext(query_uuid).query;
+    }
+
+    this.find_analyzed_query_ext = function(query_uuid)
+    {
+        return this.analyzed_queries[query_uuid];
+    }
+
+    this.find_analyzed_query = function(query_uuid)
+    {
+        return this.find_analyzed_query_ext(query_uuid).query;
+    }
+}
+
 /*!
  * This namespace holds functions for globally managing query objects
  * \Class Manifold
  */
 var manifold = {
 
+    /************************************************************************** 
+     * Helper functions
+     **************************************************************************/ 
+
+    separator: '__',
+
     spin_presets: {},
 
     spin: function(locator, active /*= true */) {
@@ -54,6 +143,14 @@ var manifold = {
         } catch (err) { messages.debug("Cannot turn spins on/off " + err); }
     },
 
+    /************************************************************************** 
+     * Query management
+     **************************************************************************/ 
+
+    query_store: new QueryStore(),
+
+    // XXX Remaining functions are deprecated since they are replaced by the query store
+
     /*!
      * Associative array storing the set of queries active on the page
      * \memberof Manifold
@@ -68,6 +165,10 @@ var manifold = {
      * \param ManifoldQuery query Query to be added
      */
     insert_query : function (query) { 
+        // NEW API
+        manifold.query_store.insert(query);
+
+        // FORMER API
         if (query.analyzed_query == null) {
             query.analyze_subqueries();
         }
@@ -84,6 +185,10 @@ var manifold = {
         return manifold.all_queries[query_uuid];
     },
 
+    /************************************************************************** 
+     * Query execution
+     **************************************************************************/ 
+
     // trigger a query asynchroneously
     proxy_url : '/manifold/proxy/json/',
 
@@ -160,34 +265,6 @@ var manifold = {
         return true;
     },
 
-    raise_event_handler: function(type, query_uuid, event_type, value)
-    {
-        if (type == 'query') {
-            var channels = [ manifold.get_query_channel(query_uuid), manifold.get_query_channel('*') ];
-        } else if (type == 'record') {
-            var channels = [ manifold.get_record_channel(query_uuid), manifold.get_record_channel('*') ];
-
-        } else {
-            throw 'Incorrect type for manifold.raise_event()';
-        }
-        $.each(channels, function(i, channel) {
-            if (value === undefined)
-                $('.plugin').trigger(channel, [event_type]);
-            else
-                $('.plugin').trigger(channel, [event_type, value]);
-        });
-    },
-
-    raise_query_event: function(query_uuid, event_type, value)
-    {
-        manifold.raise_event_handler('query', query_uuid, event_type, value);
-    },
-
-    raise_record_event: function(query_uuid, event_type, value)
-    {
-        manifold.raise_event_handler('record', query_uuid, event_type, value);
-    },
-
     /*!
      * Publish result
      * \fn publish_result(query, results)
@@ -247,6 +324,7 @@ var manifold = {
         if (!!callback) { callback(data); return; }
 
         if (data.code == 2) { // ERROR
+            // We need to make sense of error codes here
             alert("Your session has expired, please log in again");
             window.location="/logout/";
             return;
@@ -255,6 +333,15 @@ var manifold = {
             messages.error("Some errors have been received from the manifold backend at " + MANIFOLD_URL + " [" + data.description + "]");
             // publish error code and text message on a separate channel for whoever is interested
             jQuery.publish("/results/" + publish_uuid + "/failed", [data.code, data.description] );
+
+            $("#notifications").notify("create", "sticky", {
+              title: 'Warning',
+              text: data.description
+            },{
+              expires: false,
+              speed: 1000
+            });
+            
         }
         // once everything is checked we can use the 'value' part of the manifoldresult
         var result=data.value;
@@ -277,48 +364,119 @@ var manifold = {
         }
     },
 
-    raise_event: function(uuid, event_type, value)
+    /************************************************************************** 
+     * Plugin API helpers
+     **************************************************************************/ 
+
+    raise_event_handler: function(type, query_uuid, event_type, value)
+    {
+        if ((type != 'query') && (type != 'record'))
+            throw 'Incorrect type for manifold.raise_event()';
+
+        var channels = [ manifold.get_channel(type, query_uuid), manifold.get_channel(type, '*') ];
+
+        $.each(channels, function(i, channel) {
+            if (value === undefined)
+                $('.plugin').trigger(channel, [event_type]);
+            else
+                $('.plugin').trigger(channel, [event_type, value]);
+        });
+    },
+
+    raise_query_event: function(query_uuid, event_type, value)
+    {
+        manifold.raise_event_handler('query', query_uuid, event_type, value);
+    },
+
+    raise_record_event: function(query_uuid, event_type, value)
+    {
+        manifold.raise_event_handler('record', query_uuid, event_type, value);
+    },
+
+
+    raise_event: function(query_uuid, event_type, value)
     {
+        // Query uuid has been updated with the key of a new element
+        query_ext    = manifold.query_store.find_analyzed_query_ext(query_uuid);
+        query = query_ext.query;
+
         switch(event_type) {
             case SET_ADD:
-                // Query uuid has been updated with the key of a new element
+                // update is only possible is the query is not pending, etc
+                // CHECK status !
+
+                // XXX we can only update subqueries of the main query. Check !
+                // assert query_ext.parent_query == query_ext.main_query
+                update_query = query_ext.parent_query_ext.update_query;
+
+                // NOTE: update might modify the fields in Get
+                // NOTE : we have to modify all child queries
+                // NOTE : parts of a query might not be started (eg slice.measurements, how to handle ?)
+
+                // if everything is done right, update_query should not be null. It is updated when we received results from the get query
+                // object = the same as get
+                // filter = key : update a single object for now
+                // fields = the same as get
+
                 break;
             case SET_REMOVED:
                 // Query uuid has been updated with the key of a removed element
                 break;
+            case FILTER_ADDED:
+                break;
+            case FILTER_REMOVED:
+                break;
+            case FIELD_ADDED:
+                main_query = query_ext.main_query_ext.query;
+                main_update_query = query_ext.main_query_ext.update_query;
+                query.select(value);
+
+                // Here we need the full path through all subqueries
+                path = ""
+                // XXX We might need the query name in the QueryExt structure
+                main_query.select(value);
+
+                // XXX When is an update query associated ?
+                // XXX main_update_query.select(value);
+
+                break;
+
+            case FIELD_REMOVED:
+                query = query_ext.query;
+                main_query = query_ext.main_query_ext.query;
+                main_update_query = query_ext.main_query_ext.update_query;
+                query.unselect(value);
+                main_query.unselect(value);
+
+                // We need to inform about changes in these queries to the respective plugins
+                // Note: query & main_query have the same UUID
+                manifold.raise_query_event(query_uuid, event_type, value);
+                break;
         }
+        // We need to inform about changes in these queries to the respective plugins
+        // Note: query, main_query & update_query have the same UUID
+        manifold.raise_query_event(query_uuid, event_type, value);
+        // We are targeting the same object with get and update
+        // The notion of query is bad, we should have a notion of destination, and issue queries on the destination
+        // NOTE: Editing a subquery == editing a local view on the destination
+
+        // XXX We might need to run the new query again and manage the plugins in the meantime with spinners...
+        // For the time being, we will collect all columns during the first query
     },
 
     /* Publish/subscribe channels for internal use */
-    get_query_channel:  function(uuid) { return '/query/'  + uuid },
-    get_record_channel: function(uuid) { return '/record/' + uuid },
+    get_channel: function(type, query_uuid) 
+    {
+        if ((type !== 'query') && (type != 'record'))
+            return null;
+        return '/' + type + '/' + query_uuid;
+    },
 
 }; // manifold object
 /* ------------------------------------------------------------ */
 
 (function($) {
 
-    /* NEW PLUGIN API
-     * 
-     * NOTE: Since we don't have a plugin class, we are extending all jQuery
-     * plugins...
-     */
-
-    /*!
-     * \brief Associates a query handler to the current plugin
-     * \param uuid (string) query uuid
-     * \param handler (function) handler callback
-     */
-    $.fn.set_query_handler = function(uuid, handler)
-    {
-        this.on(manifold.get_query_channel(uuid), handler);
-    }
-
-    $.fn.set_record_handler = function(uuid, handler)
-    {
-        this.on(manifold.get_record_channel(uuid), handler);
-    }
-
     // OLD PLUGIN API: extend jQuery/$ with pubsub capabilities
     // https://gist.github.com/661855
     var o = $({});