rename Agent attributes, to be documented
[contrib/cloudeebus.git] / cloudeebus / cloudeebus.js
index 5f1d40b..6f81a31 100644 (file)
@@ -29,8 +29,8 @@ var dbus = { // hook object for dbus types not translated by python-json
 /*****************************************************************************/
 
 var cloudeebus = window.cloudeebus = {
-               version: "0.5.99",
-               minVersion: "0.3.2"
+               version: "0.5.100",
+               minVersion: "0.5.100"
 };
 
 cloudeebus.reset = function() {
@@ -46,16 +46,18 @@ cloudeebus.log = function(msg) {
 
 cloudeebus.getError = function(error) {
        if (error.desc && error.uri)
-               return error.desc + " : " + error.uri;
+               return error.desc + " : " + error.uri; // Python exception (cloudeebus.py)
        if (error.desc)
                return error.desc;
        if (error.uri)
                return error.uri;
        if (error.name && error.message)
-               return error.name + " : " + error.message;
+               return error.name + " : " + error.message; // Javascript exception
        if (error.message)
                return error.message;
-       return error;
+       if (error.name)
+               return error.name;
+       return error; // Autobahn error
 };
 
 cloudeebus.versionCheck = function(version) {
@@ -111,7 +113,8 @@ cloudeebus.connect = function(uri, manifest, successCB, errorCB) {
                if (manifest)
                        cloudeebus.wampSession.authreq(
                                        manifest.name, 
-                                       {permissions: manifest.permissions}
+                                       {permissions: manifest.permissions, 
+                                                services: manifest.services}
                                ).then(onWAMPSessionChallengedCB, onWAMPSessionAuthErrorCB);
                else
                        cloudeebus.wampSession.authreq().then(function() {
@@ -164,61 +167,47 @@ cloudeebus.BusConnection.prototype.getObject = function(busName, objectPath, int
 
 cloudeebus.BusConnection.prototype.addService = function(serviceName) {
        var self = this;
+
+       if (!serviceName)
+               serviceName = "";
        
        var promise = new cloudeebus.Promise(function (resolver) {
-         cloudeebusService = new cloudeebus.Service(self.wampSession, self, serviceName);
-       
-         function busServiceAddedSuccessCB(service) {
-                 try {
-                         service.isCreated = true;
-                         var result = [cloudeebusService];
-                         resolver.fulfill(result[0], true);
-                 }
-                 catch (e) {
-                         var errorStr = cloudeebus.getError(e);
-                         cloudeebus.log("Method callback exception: " + errorStr);
-                         resolver.reject(errorStr, true);
-                 }             
-         }
-       
-         function busServiceErrorSuccessCB(error) {
-                 resolver.reject(cloudeebus.getError(error), true);
-         }
-       
-         cloudeebusService.add(this).then(busServiceAddedSuccessCB, busServiceErrorSuccessCB);
+               var cloudeebusService = new cloudeebus.Service(self.wampSession, self, serviceName);
+       
+               function ServiceAddedSuccessCB(serviceName) {
+                       cloudeebusService.isCreated = true;
+                       resolver.fulfill(cloudeebusService, true);
+               }
+               
+               function ServiceAddedErrorCB(error) {
+                       var errorStr = cloudeebus.getError(error);
+                       cloudeebus.log("Error adding service method: " + self.name + ", error: " + errorStr);
+                       resolver.reject(errorStr, true);
+               }
+
+               var arglist = [
+                   self.name,
+                   serviceName
+                   ];
+
+               // call dbusSend with bus type, destination, object, message and arguments
+               self.wampSession.call("serviceAdd", arglist).then(ServiceAddedSuccessCB, ServiceAddedErrorCB);
        });
        
        return promise;
 };
 
-cloudeebus.BusConnection.prototype.removeService = function(serviceName, successCB, errorCB) {
-       var self = this;
-       
-       function busServiceRemovedSuccessCB(serviceName) {
-               // Be sure we are removing the service requested...
-               if (serviceName == self.service.name) {
-                       self.service = null;
-                       if (successCB)
-                               successCB(serviceName);
-               }
-       }
-       
-       cloudeebusService.remove(busServiceRemovedSuccessCB, errorCB);
-};
 
 
 /*****************************************************************************/
-//Generic definition for an agent. An agent need :
-//srvDbusName : the DBus parent service
+//Generic definition for an agent. An agent needs :
 //objPath : a DBus path to access it
-//jsHdl : a Javascript handler to process methods, 
+//handler : a Javascript handler to process methods, 
 //xml : the xml which describe interface/methods/signals...
-cloudeebus.Agent = function(srvDbusName, objPath, jsHdl, xml) {
-       this.srvName = srvDbusName;
-       this.registered = false;
+cloudeebus.Agent = function(objPath, handler, xml) {
        this.xml = xml;
        this.objectPath = objPath;
-       this.jsHdl = jsHdl;
+       this.handler = handler;
        return this;
 };
 
@@ -227,62 +216,36 @@ cloudeebus.Service = function(session, busConnection, name) {
        this.wampSession = session;
        this.busConnection = busConnection; 
        this.name = name;
+       this.agents = [];
        this.isCreated = false;
        return this;
 };
 
-cloudeebus.Service.prototype.add = function(promise) {
+
+cloudeebus.Service.prototype.remove = function() {
        var self = this;
-       self.promise = promise;
-       var resolver = self.promise.resolver;
        
-       function ServiceAddedSuccessCB(serviceName) {
-               try { // calling dbus hook object function for un-translated types
-                       var result = [self];
-                       resolver.fulfill(result[0], true);
+       var promise = new cloudeebus.Promise(function (resolver) {
+               function ServiceRemovedSuccessCB(serviceName) {
+                       resolver.fulfill(serviceName, true);
                }
-               catch (e) {
-                       var errorStr = cloudeebus.getError(e);
-                       cloudeebus.log("Method callback exception: " + errorStr);
+               
+               function ServiceRemovedErrorCB(error) {
+                       var errorStr = cloudeebus.getError(error);
                        resolver.reject(errorStr, true);
-               }               
-       }
+               }
+               
+               var arglist = [
+                   self.name
+                   ];
+       
+               // call dbusSend with bus type, destination, object, message and arguments
+               self.wampSession.call("serviceRelease", arglist).then(ServiceRemovedSuccessCB, ServiceRemovedErrorCB);
+       });
        
-       function ServiceAddedErrorCB(error) {
-               var errorStr = cloudeebus.getError(error);
-               cloudeebus.log("Error adding service method: " + self.name + ", error: " + errorStr);
-               self.promise.resolver.reject(errorStr, true);
-       }
-
-       var arglist = [
-           this.busConnection,
-           this.name
-           ];
-
-       // call dbusSend with bus type, destination, object, message and arguments
-       this.wampSession.call("serviceAdd", arglist).then(ServiceAddedSuccessCB, ServiceAddedErrorCB);
        return promise;
 };
 
-cloudeebus.Service.prototype.remove = function(successCB, errorCB) {
-       function ServiceRemovedSuccessCB(serviceName) {
-               if (successCB) {
-                       try {
-                               successCB(serviceName);
-                       }
-                       catch (e) {
-                               alert("Exception removing service " + serviceName + " : " + cloudeebus.getError(e));
-                       }
-               }
-       }
-       
-       var arglist = [
-           this.name
-           ];
-
-       // call dbusSend with bus type, destination, object, message and arguments
-       this.wampSession.call("serviceRelease", arglist).then(ServiceRemovedSuccessCB, errorCB);
-};
 
 cloudeebus.Service.prototype._searchMethod = function(ifName, method, objectJS) {
 
@@ -301,23 +264,24 @@ cloudeebus.Service.prototype._searchMethod = function(ifName, method, objectJS)
        return funcToCall;
 };
 
+
 cloudeebus.Service.prototype._addMethod = function(ifName, method, agent) {
 
        var service = this;
        var methodId = this.name + "#" + agent.objectPath + "#" + ifName + "#" + method;
-       var funcToCall = this._searchMethod(ifName, method, agent.jsHdl);
+       var funcToCall = this._searchMethod(ifName, method, agent.handler);
 
        if (funcToCall == null)
                cloudeebus.log("Method " + method + " doesn't exist in Javascript object");
        else {
-               agent.jsHdl.wrapperFunc[method] = function() {
+               agent.handler.wrapperFunc[method] = function() {
                        var result;
                        var methodId = arguments[0];
                        var callDict = {};
                        // affectation of callDict in eval, otherwise dictionary(='{}') interpreted as block of code by eval
                        eval("callDict = " + arguments[1]);
                        try {
-                               result = funcToCall.apply(agent.jsHdl, callDict.args);
+                               result = funcToCall.apply(agent.handler, callDict.args);
                                service._returnMethod(methodId, callDict.callIndex, true, result);
                        }
                        catch (e) {
@@ -326,42 +290,49 @@ cloudeebus.Service.prototype._addMethod = function(ifName, method, agent) {
                                service._returnMethod(methodId, callDict.callIndex, false, errorStr);
                        }
                };
-               agent.jsHdl.methodId[agent.objectPath].push(methodId);
-               cloudeebus.log("subscribe " + methodId);
-               this.wampSession.subscribe(methodId, agent.jsHdl.wrapperFunc[method]);
+               agent.handler.methodId[agent.objectPath].push(methodId);
+               this.wampSession.subscribe(methodId, agent.handler.wrapperFunc[method]);
        }
 };
 
+
 cloudeebus.Service.prototype._addSignal = function(ifName, signal, agent) {
        var service = this;
        var methodExist = false;
 
-       if (agent.jsHdl.interfaceProxies && agent.jsHdl.interfaceProxies[ifName])
-               if (agent.jsHdl.interfaceProxies[ifName][signal]) {
+       if (agent.handler.interfaceProxies && agent.handler.interfaceProxies[ifName])
+               if (agent.handler.interfaceProxies[ifName][signal]) {
                        methodExist = true;
                } else {
-                       agent.jsHdl.interfaceProxies[ifName][signal] = function() {
-                               service._emitSignal(agent.objectPath, signal, arguments[0]);
+                       agent.handler.interfaceProxies[ifName][signal] = function() {
+                               var args = [];
+                               for (var i=0; i < arguments.length; i++ )
+                                       args.push(arguments[i]);
+                               service._emitSignal(agent.objectPath, signal, args);
                        };
                return;
        }
-               
-       if ((agent.jsHdl[signal] == undefined || agent.jsHdl[signal] == null) && !methodExist) 
-               agent.jsHdl[signal] = function() {
-                       service._emitSignal(agent.objectPath, signal, arguments[0]);
+
+       if ((agent.handler[signal] == undefined || agent.handler[signal] == null) && !methodExist)
+               agent.handler[signal] = function() {
+                       var args = [];
+                       for (var i=0; i < arguments.length; i++ )
+                               args.push(arguments[i]);
+                       service._emitSignal(agent.objectPath, signal, args);
                };
        else
                cloudeebus.log("Can not create new method to emit signal '" + signal + "' in object JS this method already exist!");
 };
 
+
 cloudeebus.Service.prototype._createWrapper = function(agent) {
        var self = this;
        var parser = new DOMParser();
        var xmlDoc = parser.parseFromString(agent.xml, "text/xml");
        var ifXml = xmlDoc.getElementsByTagName("interface");
-       agent.jsHdl.wrapperFunc = [];
-       agent.jsHdl.methodId = [];
-       agent.jsHdl.methodId[agent.objectPath] = [];
+       agent.handler.wrapperFunc = {};
+       agent.handler.methodId = {};
+       agent.handler.methodId[agent.objectPath] = [];
        for (var i=0; i < ifXml.length; i++) {
                var ifName = ifXml[i].attributes.getNamedItem("name").value;
                var ifChild = ifXml[i].firstChild;
@@ -379,85 +350,96 @@ cloudeebus.Service.prototype._createWrapper = function(agent) {
        }
 };
 
-cloudeebus.Service.prototype.addAgent = function(agent, successCB, errorCB) {
-       function ServiceAddAgentSuccessCB(objPath) {
-               if (successCB) {
+
+cloudeebus.Service.prototype.addAgent = function(agent) {
+       var self = this;
+       
+       var promise = new cloudeebus.Promise(function (resolver) {
+               function ServiceAddAgentSuccessCB(objPath) {
+                       self.agents.push(agent);
                        try {
-                               successCB(objPath);
+                               self._createWrapper(agent);
                        }
                        catch (e) {
-                               alert("Exception adding agent " + agent.objectPath + " : " + cloudeebus.getError(e));
-                       }
+                               var errorStr = cloudeebus.getError(e);
+                               cloudeebus.log("Exception creating agent wrapper " + agent.objectPath + " : " + errorStr);
+                               resolver.reject(errorStr, true);
+                               return;
+                       }               
+                       resolver.fulfill(objPath, true);
                }
-       }
+               
+               function ServiceAddAgenterrorCB(error) {
+                       var errorStr = cloudeebus.getError(error);
+                       cloudeebus.log("Error adding agent : " + agent.objectPath + ", error: " + errorStr);
+                       self.promise.resolver.reject(errorStr, true);
+               }
+               
+               var arglist = [
+                   self.name,
+                   agent.objectPath,
+                   agent.xml
+                   ];
        
-       try {
-               this._createWrapper(agent);
-       }
-       catch (e) {
-               var errorStr = cloudeebus.getError(e);
-               alert("Exception creating agent wrapper " + agent.objectPath + " : " + errorStr);
-               errorCB(errorStr);
-               return;
-       }
+               // call dbusSend with bus type, destination, object, message and arguments
+               self.wampSession.call("serviceAddAgent", arglist).then(ServiceAddAgentSuccessCB, ServiceAddAgenterrorCB);
+       });
        
-       var arglist = [
-           agent.objectPath,
-           agent.xml
-           ];
-
-       // call dbusSend with bus type, destination, object, message and arguments
-       this.wampSession.call("serviceAddAgent", arglist).then(ServiceAddAgentSuccessCB, errorCB);
+       return promise;
 };
 
+
 cloudeebus.Service.prototype._deleteWrapper = function(agent) {
-       var objJs = agent.jsHdl;
+       var objJs = agent.handler;
        if (objJs.methodId[agent.objectPath]) {
-               for (var idx in objJs.methodId[agent.objectPath]) {
+               while (objJs.methodId[agent.objectPath].length) {
                        try {
-                               cloudeebus.log("unsubscribe " + objJs.methodId[agent.objectPath][idx]);
-                               this.wampSession.unsubscribe(objJs.methodId[agent.objectPath][idx]);
-                               objJs.methodId[agent.objectPath][idx] = null;
+                               this.wampSession.unsubscribe( objJs.methodId[agent.objectPath].pop() );
                        }
                        catch (e) {
                                cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));
                        }
                }
-               delete objJs.methodId[agent.objectPath];
+               objJs.methodId[agent.objectPath] = null;
        }
 };
 
-cloudeebus.Service.prototype.delAgent = function(rmAgent, successCB, errorCB) {
-       function ServiceDelAgentSuccessCB(agent) {
-               if (successCB) {
-                       try {
-                               successCB(agent);
-                       }
-                       catch (e) {
-                               var errorStr = cloudeebus.getError(e);
-                               alert("Exception deleting agent " + rmAgent.objectPath + " : " + errorStr);
-                               errorCB(errorStr);
-                       }
-               }
-       }
 
-       try {
-               this._deleteWrapper(rmAgent);
-       }
-       catch (e) {
-               var errorStr = cloudeebus.getError(e);
-               alert("Exception deleting agent wrapper " + rmAgent.objectPath + " : " + errorStr);
-               errorCB(errorStr);
-       }
+cloudeebus.Service.prototype.removeAgent = function(rmAgent) {
+       var self = this;
        
-       var arglist = [
-           rmAgent.objectPath
-           ];
+       var promise = new cloudeebus.Promise(function (resolver) {
+               function ServiceRemoveAgentSuccessCB(objectPath) {
+                       // Searching agent in list
+                       for (var idx in self.agents)
+                               if (self.agents[idx].objectPath == objectPath) {
+                                       agent = self.agents[idx];
+                                       break;
+                               }
+                                       
+                       self.agents.splice(idx, 1);
+                       self._deleteWrapper(agent);
+                       resolver.fulfill(agent, true);
+               }
 
-       // call dbusSend with bus type, destination, object, message and arguments
-       this.wampSession.call("serviceDelAgent", arglist).then(ServiceDelAgentSuccessCB, errorCB);
+               function ServiceRemoveAgentErrorCB(error) {
+                       var errorStr = cloudeebus.getError(error);
+                       cloudeebus.log("Error removing agent : " + rmAgent.objectPath + ", error: " + errorStr);
+                       resolver.reject(errorStr, true);
+               }
+
+               var arglist = [
+                   rmAgent.objectPath
+                   ];
+       
+               // call dbusSend with bus type, destination, object, message and arguments
+               self.wampSession.call("serviceDelAgent", arglist).then(ServiceRemoveAgentSuccessCB, ServiceRemoveAgentErrorCB);
+       });
+       
+       return promise;
 };
 
+
 cloudeebus.Service.prototype._returnMethod = function(methodId, callIndex, success, result, successCB, errorCB) {
        var arglist = [
            methodId,
@@ -469,11 +451,12 @@ cloudeebus.Service.prototype._returnMethod = function(methodId, callIndex, succe
        this.wampSession.call("returnMethod", arglist).then(successCB, errorCB);
 };
 
-cloudeebus.Service.prototype._emitSignal = function(objectPath, signalName, result, successCB, errorCB) {
+
+cloudeebus.Service.prototype._emitSignal = function(objectPath, signalName, args, successCB, errorCB) {
        var arglist = [
            objectPath,
            signalName,
-           result
+           JSON.stringify(args)
            ];
 
        this.wampSession.call("emitSignal", arglist).then(successCB, errorCB);
@@ -683,7 +666,7 @@ cloudeebus.Promise.any = function() {
                resolver.resolve(undefined, true);
        else
                for (i in arguments) 
-                       Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
+                       cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
        return promise;
 };
 
@@ -708,7 +691,7 @@ cloudeebus.Promise.every = function() {
                                        resolver.resolve(args, true);
                        };
                        index++;
-                       Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
+                       cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
                }
        
        return promise;
@@ -735,7 +718,7 @@ cloudeebus.Promise.some = function() {
                                        resolver.reject(args, true);
                        };
                        index++;
-                       Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
+                       cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
                }
        
        return promise;
@@ -751,6 +734,7 @@ cloudeebus.ProxyObject = function(session, busConnection, busName, objectPath) {
        this.busName = busName; 
        this.objectPath = objectPath; 
        this.interfaceProxies = {};
+       this.childNodeNames = [];
        return this;
 };
 
@@ -788,6 +772,10 @@ cloudeebus.ProxyObject.prototype._introspect = function(successCB, errorCB) {
        function introspectSuccessCB(str) {
                var parser = new DOMParser();
                var xmlDoc = parser.parseFromString(str, "text/xml");
+               var nodes = xmlDoc.getElementsByTagName("node");
+               // first node is the parent/head node
+               for(var i=1; i < nodes.length; i++)
+                       self.childNodeNames.push(nodes[i].getAttribute("name"));
                var interfaces = xmlDoc.getElementsByTagName("interface");
                self.propInterfaces = [];
                var supportDBusProperties = false;
@@ -926,7 +914,7 @@ cloudeebus.ProxyObject.prototype.connectToSignal = function(ifName, signal, hand
                var errorStr = cloudeebus.getError(error);
                cloudeebus.log("Error connecting to signal: " + signal + " on object: " + self.objectPath + " : " + errorStr);
                if (errorCB)
-                       errorCB(cloudeebus.getError(errorStr));
+                       errorCB(errorStr);
        }
 
        var arglist = [