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) {
179 cloudeebusService.isCreated = true;
180 resolver.fulfill(cloudeebusService, true);
183 var errorStr = cloudeebus.getError(e);
184 cloudeebus.log("Method callback exception: " + errorStr);
185 resolver.reject(errorStr, true);
189 function ServiceAddedErrorCB(error) {
190 var errorStr = cloudeebus.getError(error);
191 cloudeebus.log("Error adding service method: " + self.name + ", error: " + errorStr);
192 resolver.reject(errorStr, true);
200 // call dbusSend with bus type, destination, object, message and arguments
201 self.wampSession.call("serviceAdd", arglist).then(ServiceAddedSuccessCB, ServiceAddedErrorCB);
209 /*****************************************************************************/
210 //Generic definition for an agent. An agent needs :
211 //srvDbusName : the DBus parent service
212 //objPath : a DBus path to access it
213 //jsHdl : a Javascript handler to process methods,
214 //xml : the xml which describe interface/methods/signals...
215 cloudeebus.Agent = function(srvDbusName, objPath, jsHdl, xml) {
216 this.srvName = srvDbusName;
218 this.objectPath = objPath;
224 cloudeebus.Service = function(session, busConnection, name) {
225 this.wampSession = session;
226 this.busConnection = busConnection;
229 this.isCreated = false;
234 cloudeebus.Service.prototype.remove = function() {
237 var promise = new cloudeebus.Promise(function (resolver) {
238 function ServiceRemovedSuccessCB(serviceName) {
240 resolver.fulfill(serviceName, true);
243 var errorStr = cloudeebus.getError(e);
244 cloudeebus.log("Method callback exception: " + errorStr);
245 resolver.reject(errorStr, true);
249 function ServiceRemovedErrorCB(error) {
250 var errorStr = cloudeebus.getError(error);
251 resolver.reject(errorStr, true);
258 // call dbusSend with bus type, destination, object, message and arguments
259 self.wampSession.call("serviceRelease", arglist).then(ServiceRemovedSuccessCB, ServiceRemovedErrorCB);
266 cloudeebus.Service.prototype._searchMethod = function(ifName, method, objectJS) {
268 var funcToCall = null;
270 // Check if 'objectJS' has a member 'interfaceProxies' with an interface named 'ifName'
271 // and a method named 'method'
272 if (objectJS.interfaceProxies && objectJS.interfaceProxies[ifName] &&
273 objectJS.interfaceProxies[ifName][method]) {
274 funcToCall = objectJS.interfaceProxies[ifName][method];
276 // retrieve the method directly from 'root' of objectJs
277 funcToCall = objectJS[method];
284 cloudeebus.Service.prototype._addMethod = function(ifName, method, agent) {
287 var methodId = this.name + "#" + agent.objectPath + "#" + ifName + "#" + method;
288 var funcToCall = this._searchMethod(ifName, method, agent.jsHdl);
290 if (funcToCall == null)
291 cloudeebus.log("Method " + method + " doesn't exist in Javascript object");
293 agent.jsHdl.wrapperFunc[method] = function() {
295 var methodId = arguments[0];
297 // affectation of callDict in eval, otherwise dictionary(='{}') interpreted as block of code by eval
298 eval("callDict = " + arguments[1]);
300 result = funcToCall.apply(agent.jsHdl, callDict.args);
301 service._returnMethod(methodId, callDict.callIndex, true, result);
304 var errorStr = cloudeebus.getError(e);
305 cloudeebus.log("Method " + ifName + "." + method + " call on " + agent.objectPath + " exception: " + errorStr);
306 service._returnMethod(methodId, callDict.callIndex, false, errorStr);
309 agent.jsHdl.methodId[agent.objectPath].push(methodId);
310 this.wampSession.subscribe(methodId, agent.jsHdl.wrapperFunc[method]);
315 cloudeebus.Service.prototype._addSignal = function(ifName, signal, agent) {
317 var methodExist = false;
319 if (agent.jsHdl.interfaceProxies && agent.jsHdl.interfaceProxies[ifName])
320 if (agent.jsHdl.interfaceProxies[ifName][signal]) {
323 agent.jsHdl.interfaceProxies[ifName][signal] = function() {
324 service._emitSignal(agent.objectPath, signal, arguments[0]);
329 if ((agent.jsHdl[signal] == undefined || agent.jsHdl[signal] == null) && !methodExist)
330 agent.jsHdl[signal] = function() {
331 service._emitSignal(agent.objectPath, signal, arguments[0]);
334 cloudeebus.log("Can not create new method to emit signal '" + signal + "' in object JS this method already exist!");
338 cloudeebus.Service.prototype._createWrapper = function(agent) {
340 var parser = new DOMParser();
341 var xmlDoc = parser.parseFromString(agent.xml, "text/xml");
342 var ifXml = xmlDoc.getElementsByTagName("interface");
343 agent.jsHdl.wrapperFunc = {};
344 agent.jsHdl.methodId = {};
345 agent.jsHdl.methodId[agent.objectPath] = [];
346 for (var i=0; i < ifXml.length; i++) {
347 var ifName = ifXml[i].attributes.getNamedItem("name").value;
348 var ifChild = ifXml[i].firstChild;
350 if (ifChild.nodeName == "method") {
351 var metName = ifChild.attributes.getNamedItem("name").value;
352 self._addMethod(ifName, metName, agent);
354 if (ifChild.nodeName == "signal") {
355 var metName = ifChild.attributes.getNamedItem("name").value;
356 self._addSignal(ifName, metName, agent);
358 ifChild = ifChild.nextSibling;
364 cloudeebus.Service.prototype.addAgent = function(agent) {
367 var promise = new cloudeebus.Promise(function (resolver) {
368 function ServiceAddAgentSuccessCB(objPath) {
370 self.agents.push(agent);
371 resolver.fulfill(objPath, true);
374 var errorStr = cloudeebus.getError(e);
375 cloudeebus.log("Method callback exception: " + errorStr);
376 resolver.reject(errorStr, true);
380 function ServiceAddAgenterrorCB(error) {
381 var errorStr = cloudeebus.getError(error);
382 cloudeebus.log("Error adding agent : " + agent.objectPath + ", error: " + errorStr);
383 self.promise.resolver.reject(errorStr, true);
387 self._createWrapper(agent);
390 var errorStr = cloudeebus.getError(e);
391 cloudeebus.log("Exception creating agent wrapper " + agent.objectPath + " : " + errorStr);
392 resolver.reject(errorStr, true);
401 // call dbusSend with bus type, destination, object, message and arguments
402 self.wampSession.call("serviceAddAgent", arglist).then(ServiceAddAgentSuccessCB, ServiceAddAgenterrorCB);
409 cloudeebus.Service.prototype._deleteWrapper = function(agent) {
410 var objJs = agent.jsHdl;
411 if (objJs.methodId[agent.objectPath]) {
412 while (objJs.methodId[agent.objectPath].length) {
414 this.wampSession.unsubscribe( objJs.methodId[agent.objectPath].pop() );
417 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));
420 objJs.methodId[agent.objectPath] = null;
425 cloudeebus.Service.prototype.removeAgent = function(rmAgent) {
428 var promise = new cloudeebus.Promise(function (resolver) {
429 function ServiceRemoveAgentSuccessCB(objectPath) {
430 // Searching agent in list
431 for (var idx in self.agents)
432 if (self.agents[idx].objectPath == objectPath) {
433 agent = self.agents[idx];
438 self.agents.splice(idx, 1);
439 self._deleteWrapper(agent);
440 resolver.fulfill(agent, true);
443 var errorStr = cloudeebus.getError(e);
444 cloudeebus.log("Method callback exception: " + errorStr);
445 resolver.reject(errorStr, true);
449 function ServiceRemoveAgentErrorCB(error) {
450 var errorStr = cloudeebus.getError(error);
451 cloudeebus.log("Error removing agent : " + rmAgent.objectPath + ", error: " + errorStr);
452 resolver.reject(errorStr, true);
459 // call dbusSend with bus type, destination, object, message and arguments
460 self.wampSession.call("serviceDelAgent", arglist).then(ServiceRemoveAgentSuccessCB, ServiceRemoveAgentErrorCB);
467 cloudeebus.Service.prototype._returnMethod = function(methodId, callIndex, success, result, successCB, errorCB) {
475 this.wampSession.call("returnMethod", arglist).then(successCB, errorCB);
479 cloudeebus.Service.prototype._emitSignal = function(objectPath, signalName, result, successCB, errorCB) {
486 this.wampSession.call("emitSignal", arglist).then(successCB, errorCB);
491 /*****************************************************************************/
493 function _processWrappers(wrappers, value) {
494 for (var i=0; i<wrappers.length; i++)
499 function _processWrappersAsync(wrappers, value) {
501 function processAsyncOnce() {
502 _processWrappers(wrappers, value);
503 clearInterval(taskid);
505 taskid = setInterval(processAsyncOnce, 200);
510 /*****************************************************************************/
512 cloudeebus.PromiseResolver = function(promise) {
513 this.promise = promise;
514 this.resolved = null;
519 cloudeebus.PromiseResolver.prototype.resolve = function(value, sync) {
523 var then = (value && value.then && value.then.apply) ? value.then : null;
526 var fulfillCallback = function(arg) {
527 self.resolve(arg, true);
529 var rejectCallback = function(arg) {
530 self.reject(arg, true);
533 then.apply(value, [fulfillCallback, rejectCallback]);
536 this.reject(cloudeebus.getError(e), true);
540 this.fulfill(value, sync);
544 cloudeebus.PromiseResolver.prototype.fulfill = function(value, sync) {
548 var promise = this.promise;
549 promise.state = "fulfilled";
550 promise.result = value;
552 this.resolved = true;
554 _processWrappers(promise._fulfillWrappers, value);
556 _processWrappersAsync(promise._fulfillWrappers, value);
560 cloudeebus.PromiseResolver.prototype.reject = function(value, sync) {
564 var promise = this.promise;
565 promise.state = "rejected";
566 promise.result = value;
568 this.resolved = true;
570 _processWrappers(promise._rejectWrappers, value);
572 _processWrappersAsync(promise._rejectWrappers, value);
577 /*****************************************************************************/
579 cloudeebus.Promise = function(init) {
580 this.state = "pending";
582 this._fulfillWrappers = [];
583 this._rejectWrappers = [];
584 this.resolver = new cloudeebus.PromiseResolver(this);
587 init.apply(this, [this.resolver]);
590 this.resolver.reject(cloudeebus.getError(e), true);
597 cloudeebus.Promise.prototype.appendWrappers = function(fulfillWrapper, rejectWrapper) {
599 this._fulfillWrappers.push(fulfillWrapper);
601 this._rejectWrappers.push(rejectWrapper);
602 if (this.state == "fulfilled")
603 _processWrappersAsync(this._fulfillWrappers, this.result);
604 if (this.state == "rejected")
605 _processWrappersAsync(this._rejectWrappers, this.result);
609 cloudeebus.Promise.prototype.then = function(fulfillCB, rejectCB) {
610 var promise = new cloudeebus.Promise();
611 var resolver = promise.resolver;
612 var fulfillWrapper, rejectWrapper;
615 fulfillWrapper = function(arg) {
617 var value = fulfillCB.apply(promise, [arg]);
618 resolver.resolve(value, true);
621 resolver.reject(cloudeebus.getError(e), true);
625 fulfillWrapper = function(arg) {
626 resolver.fulfill(arg, true);
630 rejectWrapper = function(arg) {
632 var value = rejectCB.apply(promise, [arg]);
633 resolver.resolve(value, true);
636 resolver.reject(cloudeebus.getError(e), true);
640 rejectWrapper = function(arg) {
641 resolver.reject(arg, true);
644 this.appendWrappers(fulfillWrapper,rejectWrapper);
649 cloudeebus.Promise.prototype["catch"] = function(rejectCB) {
650 return this.then(undefined,rejectCB);
654 cloudeebus.Promise.prototype.done = function(fulfillCB, rejectCB) {
655 this.appendWrappers(fulfillCB,rejectCB);
659 cloudeebus.Promise.resolve = function(value) {
660 var promise = new cloudeebus.Promise();
661 promise.resolver.resolve(value);
666 cloudeebus.Promise.fulfill = function(value) {
667 var promise = new cloudeebus.Promise();
668 promise.resolver.fulfill(value);
673 cloudeebus.Promise.reject = function(value) {
674 var promise = new cloudeebus.Promise();
675 promise.resolver.reject(value);
680 cloudeebus.Promise.any = function() {
681 var promise = new cloudeebus.Promise();
682 var resolver = promise.resolver;
683 var fulfillCallback = function(arg) {
684 resolver.resolve(arg, true);
686 var rejectCallback = function(arg) {
687 resolver.reject(arg, true);
689 if (arguments.length == 0)
690 resolver.resolve(undefined, true);
693 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
698 cloudeebus.Promise.every = function() {
699 var promise = new cloudeebus.Promise();
700 var resolver = promise.resolver;
702 var countdown = arguments.length;
703 var args = new Array(countdown);
704 var rejectCallback = function(arg) {
705 resolver.reject(arg, true);
707 if (arguments.length == 0)
708 resolver.resolve(undefined, true);
710 for (i in arguments) {
711 var fulfillCallback = function(arg) {
715 resolver.resolve(args, true);
718 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
725 cloudeebus.Promise.some = function() {
726 var promise = new cloudeebus.Promise();
727 var resolver = promise.resolver;
729 var countdown = arguments.length;
730 var args = new Array(countdown);
731 var fulfillCallback = function(arg) {
732 resolver.resolve(arg, true);
734 if (arguments.length == 0)
735 resolver.resolve(undefined, true);
737 for (i in arguments) {
738 var rejectCallback = function(arg) {
742 resolver.reject(args, true);
745 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
753 /*****************************************************************************/
755 cloudeebus.ProxyObject = function(session, busConnection, busName, objectPath) {
756 this.wampSession = session;
757 this.busConnection = busConnection;
758 this.busName = busName;
759 this.objectPath = objectPath;
760 this.interfaceProxies = {};
765 cloudeebus.ProxyObject.prototype.getInterface = function(ifName) {
766 return this.interfaceProxies[ifName];
770 cloudeebus.ProxyObject.prototype._introspect = function(successCB, errorCB) {
774 function getAllPropertiesSuccessCB(props) {
775 var ifProxy = self.interfaceProxies[self.propInterfaces[self.propInterfaces.length-1]];
776 for (var prop in props)
777 ifProxy[prop] = self[prop] = props[prop];
778 getAllPropertiesNextInterfaceCB();
781 function getAllPropertiesNextInterfaceCB() {
782 self.propInterfaces.pop();
783 if (self.propInterfaces.length > 0)
784 self.callMethod("org.freedesktop.DBus.Properties",
786 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
787 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
789 self.propInterfaces = null;
795 function introspectSuccessCB(str) {
796 var parser = new DOMParser();
797 var xmlDoc = parser.parseFromString(str, "text/xml");
798 var interfaces = xmlDoc.getElementsByTagName("interface");
799 self.propInterfaces = [];
800 var supportDBusProperties = false;
801 for (var i=0; i < interfaces.length; i++) {
802 var ifName = interfaces[i].attributes.getNamedItem("name").value;
803 self.interfaceProxies[ifName] = new cloudeebus.ProxyObject(self.wampSession, self.busConnection, self.busName, self.objectPath);
804 if (ifName == "org.freedesktop.DBus.Properties")
805 supportDBusProperties = true;
806 var hasProperties = false;
807 var ifChild = interfaces[i].firstChild;
809 if (ifChild.nodeName == "method") {
812 var metChild = ifChild.firstChild;
814 if (metChild.nodeName == "arg" &&
815 metChild.attributes.getNamedItem("direction").value == "in") {
816 signature += metChild.attributes.getNamedItem("type").value;
819 metChild = metChild.nextSibling;
821 var metName = ifChild.attributes.getNamedItem("name").value;
823 self._addMethod(ifName, metName, nArgs, signature);
824 self.interfaceProxies[ifName]._addMethod(ifName, metName, nArgs, signature);
826 else if (ifChild.nodeName == "property") {
828 self.propInterfaces.push(ifName);
829 hasProperties = true;
831 ifChild = ifChild.nextSibling;
834 if (supportDBusProperties && self.propInterfaces.length > 0) {
835 self.callMethod("org.freedesktop.DBus.Properties",
837 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
838 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
841 self.propInterfaces = null;
847 // call Introspect on self
848 self.callMethod("org.freedesktop.DBus.Introspectable", "Introspect", []).then(introspectSuccessCB, errorCB);
852 cloudeebus.ProxyObject.prototype._addMethod = function(ifName, method, nArgs, signature) {
856 self[method] = function() {
858 for (var i=0; i < nArgs; i++ )
859 args.push(arguments[i]);
860 return self.callMethod(ifName, method, args, signature);
865 cloudeebus.ProxyObject.prototype.callMethod = function(ifName, method, args, signature) {
869 var promise = new cloudeebus.Promise(function (resolver) {
870 function callMethodSuccessCB(str) {
871 try { // calling dbus hook object function for un-translated types
872 var result = eval(str);
873 resolver.fulfill(result[0], true);
876 var errorStr = cloudeebus.getError(e);
877 cloudeebus.log("Method callback exception: " + errorStr);
878 resolver.reject(errorStr, true);
882 function callMethodErrorCB(error) {
883 var errorStr = cloudeebus.getError(error);
884 cloudeebus.log("Error calling method: " + method + " on object: " + self.objectPath + " : " + errorStr);
885 resolver.reject(errorStr, true);
889 self.busConnection.name,
897 // call dbusSend with bus type, destination, object, message and arguments
898 self.wampSession.call("dbusSend", arglist).then(callMethodSuccessCB, callMethodErrorCB);
905 cloudeebus.ProxyObject.prototype.connectToSignal = function(ifName, signal, handlerCB, errorCB) {
909 function signalHandler(id, data) {
911 try { // calling dbus hook object function for un-translated types
912 handlerCB.apply(self, eval(data));
915 var errorStr = cloudeebus.getError(e);
916 cloudeebus.log("Signal handler exception: " + errorStr);
923 function connectToSignalSuccessCB(str) {
925 self.wampSession.subscribe(str, signalHandler);
928 cloudeebus.log("Subscribe error: " + cloudeebus.getError(e));
932 function connectToSignalErrorCB(error) {
933 var errorStr = cloudeebus.getError(error);
934 cloudeebus.log("Error connecting to signal: " + signal + " on object: " + self.objectPath + " : " + errorStr);
940 self.busConnection.name,
947 // call dbusSend with bus type, destination, object, message and arguments
948 self.wampSession.call("dbusRegister", arglist).then(connectToSignalSuccessCB, connectToSignalErrorCB);
952 cloudeebus.ProxyObject.prototype.disconnectSignal = function(ifName, signal) {
954 this.wampSession.unsubscribe(this.busConnection.name + "#" + this.busName + "#" + this.objectPath + "#" + ifName + "#" + signal);
957 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));