1 /******************************************************************************
2 * Copyright 2012 Intel Corporation.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *****************************************************************************/
19 /*****************************************************************************/
21 var dbus = { // hook object for dbus types not translated by python-json
22 Double: function(value, level) {
29 /*****************************************************************************/
31 var cloudeebus = window.cloudeebus = {
36 cloudeebus.reset = function() {
37 cloudeebus.sessionBus = null;
38 cloudeebus.systemBus = null;
39 cloudeebus.wampSession = null;
40 cloudeebus.uri = null;
44 cloudeebus.log = function(msg) {
47 cloudeebus.getError = function(error) {
48 if (error.desc && error.uri)
49 return error.desc + " : " + error.uri; // Python exception (cloudeebus.py)
54 if (error.name && error.message)
55 return error.name + " : " + error.message; // Javascript exception
60 return error; // Autobahn error
63 cloudeebus.versionCheck = function(version) {
64 var ver = version.split(".");
65 var min = cloudeebus.minVersion.split(".");
66 for (var i=0; i<ver.length; i++) {
67 if (Number(ver[i]) > Number(min[i]))
69 if (Number(ver[i]) < Number(min[i]))
76 cloudeebus.connect = function(uri, manifest, successCB, errorCB) {
80 function onCloudeebusVersionCheckCB(version) {
81 if (cloudeebus.versionCheck(version)) {
82 cloudeebus.log("Connected to " + cloudeebus.uri);
86 var errorMsg = "Cloudeebus server version " + version + " unsupported, need version " + cloudeebus.minVersion + " or superior";
87 cloudeebus.log(errorMsg);
93 function onWAMPSessionAuthErrorCB(error) {
94 var errorStr = cloudeebus.getError(error);
95 cloudeebus.log("Authentication error: " + errorStr);
100 function onWAMPSessionAuthenticatedCB(permissions) {
101 cloudeebus.sessionBus = new cloudeebus.BusConnection("session", cloudeebus.wampSession);
102 cloudeebus.systemBus = new cloudeebus.BusConnection("system", cloudeebus.wampSession);
103 cloudeebus.wampSession.call("getVersion").then(onCloudeebusVersionCheckCB, errorCB);
106 function onWAMPSessionChallengedCB(challenge) {
107 var signature = cloudeebus.wampSession.authsign(challenge, manifest.key);
108 cloudeebus.wampSession.auth(signature).then(onWAMPSessionAuthenticatedCB, onWAMPSessionAuthErrorCB);
111 function onWAMPSessionConnectedCB(session) {
112 cloudeebus.wampSession = session;
114 cloudeebus.wampSession.authreq(
116 {permissions: manifest.permissions,
117 services: manifest.services}
118 ).then(onWAMPSessionChallengedCB, onWAMPSessionAuthErrorCB);
120 cloudeebus.wampSession.authreq().then(function() {
121 cloudeebus.wampSession.auth().then(onWAMPSessionAuthenticatedCB, onWAMPSessionAuthErrorCB);
122 }, onWAMPSessionAuthErrorCB);
125 function onWAMPSessionErrorCB(code, reason) {
126 if (code == ab.CONNECTION_UNSUPPORTED) {
127 cloudeebus.log("Browser is not supported");
130 cloudeebus.log("Failed to open session, code = " + code + ", reason = " + reason);
136 return ab.connect(cloudeebus.uri, onWAMPSessionConnectedCB, onWAMPSessionErrorCB);
140 cloudeebus.SessionBus = function() {
141 return cloudeebus.sessionBus;
145 cloudeebus.SystemBus = function() {
146 return cloudeebus.systemBus;
151 /*****************************************************************************/
153 cloudeebus.BusConnection = function(name, session) {
155 this.wampSession = session;
160 cloudeebus.BusConnection.prototype.getObject = function(busName, objectPath, introspectCB, errorCB) {
161 var proxy = new cloudeebus.ProxyObject(this.wampSession, this, busName, objectPath);
163 proxy._introspect(introspectCB, errorCB);
168 cloudeebus.BusConnection.prototype.addService = function(serviceName) {
174 var promise = new cloudeebus.Promise(function (resolver) {
175 var cloudeebusService = new cloudeebus.Service(self.wampSession, self, serviceName);
177 function ServiceAddedSuccessCB(serviceName) {
178 cloudeebusService.isCreated = true;
179 resolver.fulfill(cloudeebusService, true);
182 function ServiceAddedErrorCB(error) {
183 var errorStr = cloudeebus.getError(error);
184 cloudeebus.log("Error adding service method: " + self.name + ", error: " + errorStr);
185 resolver.reject(errorStr, true);
193 // call dbusSend with bus type, destination, object, message and arguments
194 self.wampSession.call("serviceAdd", arglist).then(ServiceAddedSuccessCB, ServiceAddedErrorCB);
202 /*****************************************************************************/
203 //Generic definition for an agent. An agent needs :
204 //objPath : a DBus path to access it
205 //jsHdl : a Javascript handler to process methods,
206 //xml : the xml which describe interface/methods/signals...
207 cloudeebus.Agent = function(objPath, jsHdl, xml) {
209 this.objectPath = objPath;
215 cloudeebus.Service = function(session, busConnection, name) {
216 this.wampSession = session;
217 this.busConnection = busConnection;
220 this.isCreated = false;
225 cloudeebus.Service.prototype.remove = function() {
228 var promise = new cloudeebus.Promise(function (resolver) {
229 function ServiceRemovedSuccessCB(serviceName) {
230 resolver.fulfill(serviceName, true);
233 function ServiceRemovedErrorCB(error) {
234 var errorStr = cloudeebus.getError(error);
235 resolver.reject(errorStr, true);
242 // call dbusSend with bus type, destination, object, message and arguments
243 self.wampSession.call("serviceRelease", arglist).then(ServiceRemovedSuccessCB, ServiceRemovedErrorCB);
250 cloudeebus.Service.prototype._searchMethod = function(ifName, method, objectJS) {
252 var funcToCall = null;
254 // Check if 'objectJS' has a member 'interfaceProxies' with an interface named 'ifName'
255 // and a method named 'method'
256 if (objectJS.interfaceProxies && objectJS.interfaceProxies[ifName] &&
257 objectJS.interfaceProxies[ifName][method]) {
258 funcToCall = objectJS.interfaceProxies[ifName][method];
260 // retrieve the method directly from 'root' of objectJs
261 funcToCall = objectJS[method];
268 cloudeebus.Service.prototype._addMethod = function(ifName, method, agent) {
271 var methodId = this.name + "#" + agent.objectPath + "#" + ifName + "#" + method;
272 var funcToCall = this._searchMethod(ifName, method, agent.jsHdl);
274 if (funcToCall == null)
275 cloudeebus.log("Method " + method + " doesn't exist in Javascript object");
277 agent.jsHdl.wrapperFunc[method] = function() {
279 var methodId = arguments[0];
281 // affectation of callDict in eval, otherwise dictionary(='{}') interpreted as block of code by eval
282 eval("callDict = " + arguments[1]);
284 result = funcToCall.apply(agent.jsHdl, callDict.args);
285 service._returnMethod(methodId, callDict.callIndex, true, result);
288 var errorStr = cloudeebus.getError(e);
289 cloudeebus.log("Method " + ifName + "." + method + " call on " + agent.objectPath + " exception: " + errorStr);
290 service._returnMethod(methodId, callDict.callIndex, false, errorStr);
293 agent.jsHdl.methodId[agent.objectPath].push(methodId);
294 this.wampSession.subscribe(methodId, agent.jsHdl.wrapperFunc[method]);
299 cloudeebus.Service.prototype._addSignal = function(ifName, signal, agent) {
301 var methodExist = false;
303 if (agent.jsHdl.interfaceProxies && agent.jsHdl.interfaceProxies[ifName])
304 if (agent.jsHdl.interfaceProxies[ifName][signal]) {
307 agent.jsHdl.interfaceProxies[ifName][signal] = function() {
309 for (var i=0; i < arguments.length; i++ )
310 args.push(arguments[i]);
311 service._emitSignal(agent.objectPath, signal, args);
316 if ((agent.jsHdl[signal] == undefined || agent.jsHdl[signal] == null) && !methodExist)
317 agent.jsHdl[signal] = function() {
319 for (var i=0; i < arguments.length; i++ )
320 args.push(arguments[i]);
321 service._emitSignal(agent.objectPath, signal, args);
324 cloudeebus.log("Can not create new method to emit signal '" + signal + "' in object JS this method already exist!");
328 cloudeebus.Service.prototype._createWrapper = function(agent) {
330 var parser = new DOMParser();
331 var xmlDoc = parser.parseFromString(agent.xml, "text/xml");
332 var ifXml = xmlDoc.getElementsByTagName("interface");
333 agent.jsHdl.wrapperFunc = {};
334 agent.jsHdl.methodId = {};
335 agent.jsHdl.methodId[agent.objectPath] = [];
336 for (var i=0; i < ifXml.length; i++) {
337 var ifName = ifXml[i].attributes.getNamedItem("name").value;
338 var ifChild = ifXml[i].firstChild;
340 if (ifChild.nodeName == "method") {
341 var metName = ifChild.attributes.getNamedItem("name").value;
342 self._addMethod(ifName, metName, agent);
344 if (ifChild.nodeName == "signal") {
345 var metName = ifChild.attributes.getNamedItem("name").value;
346 self._addSignal(ifName, metName, agent);
348 ifChild = ifChild.nextSibling;
354 cloudeebus.Service.prototype.addAgent = function(agent) {
357 var promise = new cloudeebus.Promise(function (resolver) {
358 function ServiceAddAgentSuccessCB(objPath) {
359 self.agents.push(agent);
361 self._createWrapper(agent);
364 var errorStr = cloudeebus.getError(e);
365 cloudeebus.log("Exception creating agent wrapper " + agent.objectPath + " : " + errorStr);
366 resolver.reject(errorStr, true);
369 resolver.fulfill(objPath, true);
372 function ServiceAddAgenterrorCB(error) {
373 var errorStr = cloudeebus.getError(error);
374 cloudeebus.log("Error adding agent : " + agent.objectPath + ", error: " + errorStr);
375 self.promise.resolver.reject(errorStr, true);
384 // call dbusSend with bus type, destination, object, message and arguments
385 self.wampSession.call("serviceAddAgent", arglist).then(ServiceAddAgentSuccessCB, ServiceAddAgenterrorCB);
392 cloudeebus.Service.prototype._deleteWrapper = function(agent) {
393 var objJs = agent.jsHdl;
394 if (objJs.methodId[agent.objectPath]) {
395 while (objJs.methodId[agent.objectPath].length) {
397 this.wampSession.unsubscribe( objJs.methodId[agent.objectPath].pop() );
400 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));
403 objJs.methodId[agent.objectPath] = null;
408 cloudeebus.Service.prototype.removeAgent = function(rmAgent) {
411 var promise = new cloudeebus.Promise(function (resolver) {
412 function ServiceRemoveAgentSuccessCB(objectPath) {
413 // Searching agent in list
414 for (var idx in self.agents)
415 if (self.agents[idx].objectPath == objectPath) {
416 agent = self.agents[idx];
420 self.agents.splice(idx, 1);
421 self._deleteWrapper(agent);
422 resolver.fulfill(agent, true);
425 function ServiceRemoveAgentErrorCB(error) {
426 var errorStr = cloudeebus.getError(error);
427 cloudeebus.log("Error removing agent : " + rmAgent.objectPath + ", error: " + errorStr);
428 resolver.reject(errorStr, true);
435 // call dbusSend with bus type, destination, object, message and arguments
436 self.wampSession.call("serviceDelAgent", arglist).then(ServiceRemoveAgentSuccessCB, ServiceRemoveAgentErrorCB);
443 cloudeebus.Service.prototype._returnMethod = function(methodId, callIndex, success, result, successCB, errorCB) {
451 this.wampSession.call("returnMethod", arglist).then(successCB, errorCB);
455 cloudeebus.Service.prototype._emitSignal = function(objectPath, signalName, args, successCB, errorCB) {
462 this.wampSession.call("emitSignal", arglist).then(successCB, errorCB);
467 /*****************************************************************************/
469 function _processWrappers(wrappers, value) {
470 for (var i=0; i<wrappers.length; i++)
475 function _processWrappersAsync(wrappers, value) {
477 function processAsyncOnce() {
478 _processWrappers(wrappers, value);
479 clearInterval(taskid);
481 taskid = setInterval(processAsyncOnce, 200);
486 /*****************************************************************************/
488 cloudeebus.PromiseResolver = function(promise) {
489 this.promise = promise;
490 this.resolved = null;
495 cloudeebus.PromiseResolver.prototype.resolve = function(value, sync) {
499 var then = (value && value.then && value.then.apply) ? value.then : null;
502 var fulfillCallback = function(arg) {
503 self.resolve(arg, true);
505 var rejectCallback = function(arg) {
506 self.reject(arg, true);
509 then.apply(value, [fulfillCallback, rejectCallback]);
512 this.reject(cloudeebus.getError(e), true);
516 this.fulfill(value, sync);
520 cloudeebus.PromiseResolver.prototype.fulfill = function(value, sync) {
524 var promise = this.promise;
525 promise.state = "fulfilled";
526 promise.result = value;
528 this.resolved = true;
530 _processWrappers(promise._fulfillWrappers, value);
532 _processWrappersAsync(promise._fulfillWrappers, value);
536 cloudeebus.PromiseResolver.prototype.reject = function(value, sync) {
540 var promise = this.promise;
541 promise.state = "rejected";
542 promise.result = value;
544 this.resolved = true;
546 _processWrappers(promise._rejectWrappers, value);
548 _processWrappersAsync(promise._rejectWrappers, value);
553 /*****************************************************************************/
555 cloudeebus.Promise = function(init) {
556 this.state = "pending";
558 this._fulfillWrappers = [];
559 this._rejectWrappers = [];
560 this.resolver = new cloudeebus.PromiseResolver(this);
563 init.apply(this, [this.resolver]);
566 this.resolver.reject(cloudeebus.getError(e), true);
573 cloudeebus.Promise.prototype.appendWrappers = function(fulfillWrapper, rejectWrapper) {
575 this._fulfillWrappers.push(fulfillWrapper);
577 this._rejectWrappers.push(rejectWrapper);
578 if (this.state == "fulfilled")
579 _processWrappersAsync(this._fulfillWrappers, this.result);
580 if (this.state == "rejected")
581 _processWrappersAsync(this._rejectWrappers, this.result);
585 cloudeebus.Promise.prototype.then = function(fulfillCB, rejectCB) {
586 var promise = new cloudeebus.Promise();
587 var resolver = promise.resolver;
588 var fulfillWrapper, rejectWrapper;
591 fulfillWrapper = function(arg) {
593 var value = fulfillCB.apply(promise, [arg]);
594 resolver.resolve(value, true);
597 resolver.reject(cloudeebus.getError(e), true);
601 fulfillWrapper = function(arg) {
602 resolver.fulfill(arg, true);
606 rejectWrapper = function(arg) {
608 var value = rejectCB.apply(promise, [arg]);
609 resolver.resolve(value, true);
612 resolver.reject(cloudeebus.getError(e), true);
616 rejectWrapper = function(arg) {
617 resolver.reject(arg, true);
620 this.appendWrappers(fulfillWrapper,rejectWrapper);
625 cloudeebus.Promise.prototype["catch"] = function(rejectCB) {
626 return this.then(undefined,rejectCB);
630 cloudeebus.Promise.prototype.done = function(fulfillCB, rejectCB) {
631 this.appendWrappers(fulfillCB,rejectCB);
635 cloudeebus.Promise.resolve = function(value) {
636 var promise = new cloudeebus.Promise();
637 promise.resolver.resolve(value);
642 cloudeebus.Promise.fulfill = function(value) {
643 var promise = new cloudeebus.Promise();
644 promise.resolver.fulfill(value);
649 cloudeebus.Promise.reject = function(value) {
650 var promise = new cloudeebus.Promise();
651 promise.resolver.reject(value);
656 cloudeebus.Promise.any = function() {
657 var promise = new cloudeebus.Promise();
658 var resolver = promise.resolver;
659 var fulfillCallback = function(arg) {
660 resolver.resolve(arg, true);
662 var rejectCallback = function(arg) {
663 resolver.reject(arg, true);
665 if (arguments.length == 0)
666 resolver.resolve(undefined, true);
669 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
674 cloudeebus.Promise.every = function() {
675 var promise = new cloudeebus.Promise();
676 var resolver = promise.resolver;
678 var countdown = arguments.length;
679 var args = new Array(countdown);
680 var rejectCallback = function(arg) {
681 resolver.reject(arg, true);
683 if (arguments.length == 0)
684 resolver.resolve(undefined, true);
686 for (i in arguments) {
687 var fulfillCallback = function(arg) {
691 resolver.resolve(args, true);
694 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
701 cloudeebus.Promise.some = function() {
702 var promise = new cloudeebus.Promise();
703 var resolver = promise.resolver;
705 var countdown = arguments.length;
706 var args = new Array(countdown);
707 var fulfillCallback = function(arg) {
708 resolver.resolve(arg, true);
710 if (arguments.length == 0)
711 resolver.resolve(undefined, true);
713 for (i in arguments) {
714 var rejectCallback = function(arg) {
718 resolver.reject(args, true);
721 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
729 /*****************************************************************************/
731 cloudeebus.ProxyObject = function(session, busConnection, busName, objectPath) {
732 this.wampSession = session;
733 this.busConnection = busConnection;
734 this.busName = busName;
735 this.objectPath = objectPath;
736 this.interfaceProxies = {};
741 cloudeebus.ProxyObject.prototype.getInterface = function(ifName) {
742 return this.interfaceProxies[ifName];
746 cloudeebus.ProxyObject.prototype._introspect = function(successCB, errorCB) {
750 function getAllPropertiesSuccessCB(props) {
751 var ifProxy = self.interfaceProxies[self.propInterfaces[self.propInterfaces.length-1]];
752 for (var prop in props)
753 ifProxy[prop] = self[prop] = props[prop];
754 getAllPropertiesNextInterfaceCB();
757 function getAllPropertiesNextInterfaceCB() {
758 self.propInterfaces.pop();
759 if (self.propInterfaces.length > 0)
760 self.callMethod("org.freedesktop.DBus.Properties",
762 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
763 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
765 self.propInterfaces = null;
771 function introspectSuccessCB(str) {
772 var parser = new DOMParser();
773 var xmlDoc = parser.parseFromString(str, "text/xml");
774 var nodes = xmlDoc.getElementsByTagName("node");
775 self.childNodeNames = [];
776 var l = nodes.length;
777 //there will always be 1 node, the parent/head node
778 for(var i = 1; i < l; i++){
779 self.childNodeNames.push(nodes[i].getAttribute("name"));
781 var interfaces = xmlDoc.getElementsByTagName("interface");
782 self.propInterfaces = [];
783 var supportDBusProperties = false;
784 for (var i=0; i < interfaces.length; i++) {
785 var ifName = interfaces[i].attributes.getNamedItem("name").value;
786 self.interfaceProxies[ifName] = new cloudeebus.ProxyObject(self.wampSession, self.busConnection, self.busName, self.objectPath);
787 if (ifName == "org.freedesktop.DBus.Properties")
788 supportDBusProperties = true;
789 var hasProperties = false;
790 var ifChild = interfaces[i].firstChild;
792 if (ifChild.nodeName == "method") {
795 var metChild = ifChild.firstChild;
797 if (metChild.nodeName == "arg" &&
798 metChild.attributes.getNamedItem("direction").value == "in") {
799 signature += metChild.attributes.getNamedItem("type").value;
802 metChild = metChild.nextSibling;
804 var metName = ifChild.attributes.getNamedItem("name").value;
806 self._addMethod(ifName, metName, nArgs, signature);
807 self.interfaceProxies[ifName]._addMethod(ifName, metName, nArgs, signature);
809 else if (ifChild.nodeName == "property") {
811 self.propInterfaces.push(ifName);
812 hasProperties = true;
814 ifChild = ifChild.nextSibling;
817 if (supportDBusProperties && self.propInterfaces.length > 0) {
818 self.callMethod("org.freedesktop.DBus.Properties",
820 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
821 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
824 self.propInterfaces = null;
830 // call Introspect on self
831 self.callMethod("org.freedesktop.DBus.Introspectable", "Introspect", []).then(introspectSuccessCB, errorCB);
835 cloudeebus.ProxyObject.prototype._addMethod = function(ifName, method, nArgs, signature) {
839 self[method] = function() {
841 for (var i=0; i < nArgs; i++ )
842 args.push(arguments[i]);
843 return self.callMethod(ifName, method, args, signature);
848 cloudeebus.ProxyObject.prototype.callMethod = function(ifName, method, args, signature) {
852 var promise = new cloudeebus.Promise(function (resolver) {
853 function callMethodSuccessCB(str) {
854 try { // calling dbus hook object function for un-translated types
855 var result = eval(str);
856 resolver.fulfill(result[0], true);
859 var errorStr = cloudeebus.getError(e);
860 cloudeebus.log("Method callback exception: " + errorStr);
861 resolver.reject(errorStr, true);
865 function callMethodErrorCB(error) {
866 var errorStr = cloudeebus.getError(error);
867 cloudeebus.log("Error calling method: " + method + " on object: " + self.objectPath + " : " + errorStr);
868 resolver.reject(errorStr, true);
872 self.busConnection.name,
880 // call dbusSend with bus type, destination, object, message and arguments
881 self.wampSession.call("dbusSend", arglist).then(callMethodSuccessCB, callMethodErrorCB);
888 cloudeebus.ProxyObject.prototype.connectToSignal = function(ifName, signal, handlerCB, errorCB) {
892 function signalHandler(id, data) {
894 try { // calling dbus hook object function for un-translated types
895 handlerCB.apply(self, eval(data));
898 var errorStr = cloudeebus.getError(e);
899 cloudeebus.log("Signal handler exception: " + errorStr);
906 function connectToSignalSuccessCB(str) {
908 self.wampSession.subscribe(str, signalHandler);
911 cloudeebus.log("Subscribe error: " + cloudeebus.getError(e));
915 function connectToSignalErrorCB(error) {
916 var errorStr = cloudeebus.getError(error);
917 cloudeebus.log("Error connecting to signal: " + signal + " on object: " + self.objectPath + " : " + errorStr);
923 self.busConnection.name,
930 // call dbusSend with bus type, destination, object, message and arguments
931 self.wampSession.call("dbusRegister", arglist).then(connectToSignalSuccessCB, connectToSignalErrorCB);
935 cloudeebus.ProxyObject.prototype.disconnectSignal = function(ifName, signal) {
937 this.wampSession.unsubscribe(this.busConnection.name + "#" + this.busName + "#" + this.objectPath + "#" + ifName + "#" + signal);
940 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));