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() {
308 service._emitSignal(agent.objectPath, signal, arguments[0]);
313 if ((agent.jsHdl[signal] == undefined || agent.jsHdl[signal] == null) && !methodExist)
314 agent.jsHdl[signal] = function() {
315 service._emitSignal(agent.objectPath, signal, arguments[0]);
318 cloudeebus.log("Can not create new method to emit signal '" + signal + "' in object JS this method already exist!");
322 cloudeebus.Service.prototype._createWrapper = function(agent) {
324 var parser = new DOMParser();
325 var xmlDoc = parser.parseFromString(agent.xml, "text/xml");
326 var ifXml = xmlDoc.getElementsByTagName("interface");
327 agent.jsHdl.wrapperFunc = {};
328 agent.jsHdl.methodId = {};
329 agent.jsHdl.methodId[agent.objectPath] = [];
330 for (var i=0; i < ifXml.length; i++) {
331 var ifName = ifXml[i].attributes.getNamedItem("name").value;
332 var ifChild = ifXml[i].firstChild;
334 if (ifChild.nodeName == "method") {
335 var metName = ifChild.attributes.getNamedItem("name").value;
336 self._addMethod(ifName, metName, agent);
338 if (ifChild.nodeName == "signal") {
339 var metName = ifChild.attributes.getNamedItem("name").value;
340 self._addSignal(ifName, metName, agent);
342 ifChild = ifChild.nextSibling;
348 cloudeebus.Service.prototype.addAgent = function(agent) {
351 var promise = new cloudeebus.Promise(function (resolver) {
352 function ServiceAddAgentSuccessCB(objPath) {
353 self.agents.push(agent);
355 self._createWrapper(agent);
358 var errorStr = cloudeebus.getError(e);
359 cloudeebus.log("Exception creating agent wrapper " + agent.objectPath + " : " + errorStr);
360 resolver.reject(errorStr, true);
363 resolver.fulfill(objPath, true);
366 function ServiceAddAgenterrorCB(error) {
367 var errorStr = cloudeebus.getError(error);
368 cloudeebus.log("Error adding agent : " + agent.objectPath + ", error: " + errorStr);
369 self.promise.resolver.reject(errorStr, true);
378 // call dbusSend with bus type, destination, object, message and arguments
379 self.wampSession.call("serviceAddAgent", arglist).then(ServiceAddAgentSuccessCB, ServiceAddAgenterrorCB);
386 cloudeebus.Service.prototype._deleteWrapper = function(agent) {
387 var objJs = agent.jsHdl;
388 if (objJs.methodId[agent.objectPath]) {
389 while (objJs.methodId[agent.objectPath].length) {
391 this.wampSession.unsubscribe( objJs.methodId[agent.objectPath].pop() );
394 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));
397 objJs.methodId[agent.objectPath] = null;
402 cloudeebus.Service.prototype.removeAgent = function(rmAgent) {
405 var promise = new cloudeebus.Promise(function (resolver) {
406 function ServiceRemoveAgentSuccessCB(objectPath) {
407 // Searching agent in list
408 for (var idx in self.agents)
409 if (self.agents[idx].objectPath == objectPath) {
410 agent = self.agents[idx];
414 self.agents.splice(idx, 1);
415 self._deleteWrapper(agent);
416 resolver.fulfill(agent, true);
419 function ServiceRemoveAgentErrorCB(error) {
420 var errorStr = cloudeebus.getError(error);
421 cloudeebus.log("Error removing agent : " + rmAgent.objectPath + ", error: " + errorStr);
422 resolver.reject(errorStr, true);
429 // call dbusSend with bus type, destination, object, message and arguments
430 self.wampSession.call("serviceDelAgent", arglist).then(ServiceRemoveAgentSuccessCB, ServiceRemoveAgentErrorCB);
437 cloudeebus.Service.prototype._returnMethod = function(methodId, callIndex, success, result, successCB, errorCB) {
445 this.wampSession.call("returnMethod", arglist).then(successCB, errorCB);
449 cloudeebus.Service.prototype._emitSignal = function(objectPath, signalName, result, successCB, errorCB) {
456 this.wampSession.call("emitSignal", arglist).then(successCB, errorCB);
461 /*****************************************************************************/
463 function _processWrappers(wrappers, value) {
464 for (var i=0; i<wrappers.length; i++)
469 function _processWrappersAsync(wrappers, value) {
471 function processAsyncOnce() {
472 _processWrappers(wrappers, value);
473 clearInterval(taskid);
475 taskid = setInterval(processAsyncOnce, 200);
480 /*****************************************************************************/
482 cloudeebus.PromiseResolver = function(promise) {
483 this.promise = promise;
484 this.resolved = null;
489 cloudeebus.PromiseResolver.prototype.resolve = function(value, sync) {
493 var then = (value && value.then && value.then.apply) ? value.then : null;
496 var fulfillCallback = function(arg) {
497 self.resolve(arg, true);
499 var rejectCallback = function(arg) {
500 self.reject(arg, true);
503 then.apply(value, [fulfillCallback, rejectCallback]);
506 this.reject(cloudeebus.getError(e), true);
510 this.fulfill(value, sync);
514 cloudeebus.PromiseResolver.prototype.fulfill = function(value, sync) {
518 var promise = this.promise;
519 promise.state = "fulfilled";
520 promise.result = value;
522 this.resolved = true;
524 _processWrappers(promise._fulfillWrappers, value);
526 _processWrappersAsync(promise._fulfillWrappers, value);
530 cloudeebus.PromiseResolver.prototype.reject = function(value, sync) {
534 var promise = this.promise;
535 promise.state = "rejected";
536 promise.result = value;
538 this.resolved = true;
540 _processWrappers(promise._rejectWrappers, value);
542 _processWrappersAsync(promise._rejectWrappers, value);
547 /*****************************************************************************/
549 cloudeebus.Promise = function(init) {
550 this.state = "pending";
552 this._fulfillWrappers = [];
553 this._rejectWrappers = [];
554 this.resolver = new cloudeebus.PromiseResolver(this);
557 init.apply(this, [this.resolver]);
560 this.resolver.reject(cloudeebus.getError(e), true);
567 cloudeebus.Promise.prototype.appendWrappers = function(fulfillWrapper, rejectWrapper) {
569 this._fulfillWrappers.push(fulfillWrapper);
571 this._rejectWrappers.push(rejectWrapper);
572 if (this.state == "fulfilled")
573 _processWrappersAsync(this._fulfillWrappers, this.result);
574 if (this.state == "rejected")
575 _processWrappersAsync(this._rejectWrappers, this.result);
579 cloudeebus.Promise.prototype.then = function(fulfillCB, rejectCB) {
580 var promise = new cloudeebus.Promise();
581 var resolver = promise.resolver;
582 var fulfillWrapper, rejectWrapper;
585 fulfillWrapper = function(arg) {
587 var value = fulfillCB.apply(promise, [arg]);
588 resolver.resolve(value, true);
591 resolver.reject(cloudeebus.getError(e), true);
595 fulfillWrapper = function(arg) {
596 resolver.fulfill(arg, true);
600 rejectWrapper = function(arg) {
602 var value = rejectCB.apply(promise, [arg]);
603 resolver.resolve(value, true);
606 resolver.reject(cloudeebus.getError(e), true);
610 rejectWrapper = function(arg) {
611 resolver.reject(arg, true);
614 this.appendWrappers(fulfillWrapper,rejectWrapper);
619 cloudeebus.Promise.prototype["catch"] = function(rejectCB) {
620 return this.then(undefined,rejectCB);
624 cloudeebus.Promise.prototype.done = function(fulfillCB, rejectCB) {
625 this.appendWrappers(fulfillCB,rejectCB);
629 cloudeebus.Promise.resolve = function(value) {
630 var promise = new cloudeebus.Promise();
631 promise.resolver.resolve(value);
636 cloudeebus.Promise.fulfill = function(value) {
637 var promise = new cloudeebus.Promise();
638 promise.resolver.fulfill(value);
643 cloudeebus.Promise.reject = function(value) {
644 var promise = new cloudeebus.Promise();
645 promise.resolver.reject(value);
650 cloudeebus.Promise.any = function() {
651 var promise = new cloudeebus.Promise();
652 var resolver = promise.resolver;
653 var fulfillCallback = function(arg) {
654 resolver.resolve(arg, true);
656 var rejectCallback = function(arg) {
657 resolver.reject(arg, true);
659 if (arguments.length == 0)
660 resolver.resolve(undefined, true);
663 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
668 cloudeebus.Promise.every = function() {
669 var promise = new cloudeebus.Promise();
670 var resolver = promise.resolver;
672 var countdown = arguments.length;
673 var args = new Array(countdown);
674 var rejectCallback = function(arg) {
675 resolver.reject(arg, true);
677 if (arguments.length == 0)
678 resolver.resolve(undefined, true);
680 for (i in arguments) {
681 var fulfillCallback = function(arg) {
685 resolver.resolve(args, true);
688 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
695 cloudeebus.Promise.some = function() {
696 var promise = new cloudeebus.Promise();
697 var resolver = promise.resolver;
699 var countdown = arguments.length;
700 var args = new Array(countdown);
701 var fulfillCallback = function(arg) {
702 resolver.resolve(arg, true);
704 if (arguments.length == 0)
705 resolver.resolve(undefined, true);
707 for (i in arguments) {
708 var rejectCallback = function(arg) {
712 resolver.reject(args, true);
715 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
723 /*****************************************************************************/
725 cloudeebus.ProxyObject = function(session, busConnection, busName, objectPath) {
726 this.wampSession = session;
727 this.busConnection = busConnection;
728 this.busName = busName;
729 this.objectPath = objectPath;
730 this.interfaceProxies = {};
735 cloudeebus.ProxyObject.prototype.getInterface = function(ifName) {
736 return this.interfaceProxies[ifName];
740 cloudeebus.ProxyObject.prototype._introspect = function(successCB, errorCB) {
744 function getAllPropertiesSuccessCB(props) {
745 var ifProxy = self.interfaceProxies[self.propInterfaces[self.propInterfaces.length-1]];
746 for (var prop in props)
747 ifProxy[prop] = self[prop] = props[prop];
748 getAllPropertiesNextInterfaceCB();
751 function getAllPropertiesNextInterfaceCB() {
752 self.propInterfaces.pop();
753 if (self.propInterfaces.length > 0)
754 self.callMethod("org.freedesktop.DBus.Properties",
756 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
757 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
759 self.propInterfaces = null;
765 function introspectSuccessCB(str) {
766 var parser = new DOMParser();
767 var xmlDoc = parser.parseFromString(str, "text/xml");
768 var nodes = xmlDoc.getElementsByTagName("node");
769 self.childNodeNames = [];
770 var l = nodes.length;
771 //there will always be 1 node, the parent/head node
772 for(var i = 1; i < l; i++){
773 self.childNodeNames.push(nodes[i].getAttribute("name"));
775 var interfaces = xmlDoc.getElementsByTagName("interface");
776 self.propInterfaces = [];
777 var supportDBusProperties = false;
778 for (var i=0; i < interfaces.length; i++) {
779 var ifName = interfaces[i].attributes.getNamedItem("name").value;
780 self.interfaceProxies[ifName] = new cloudeebus.ProxyObject(self.wampSession, self.busConnection, self.busName, self.objectPath);
781 if (ifName == "org.freedesktop.DBus.Properties")
782 supportDBusProperties = true;
783 var hasProperties = false;
784 var ifChild = interfaces[i].firstChild;
786 if (ifChild.nodeName == "method") {
789 var metChild = ifChild.firstChild;
791 if (metChild.nodeName == "arg" &&
792 metChild.attributes.getNamedItem("direction").value == "in") {
793 signature += metChild.attributes.getNamedItem("type").value;
796 metChild = metChild.nextSibling;
798 var metName = ifChild.attributes.getNamedItem("name").value;
800 self._addMethod(ifName, metName, nArgs, signature);
801 self.interfaceProxies[ifName]._addMethod(ifName, metName, nArgs, signature);
803 else if (ifChild.nodeName == "property") {
805 self.propInterfaces.push(ifName);
806 hasProperties = true;
808 ifChild = ifChild.nextSibling;
811 if (supportDBusProperties && self.propInterfaces.length > 0) {
812 self.callMethod("org.freedesktop.DBus.Properties",
814 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
815 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
818 self.propInterfaces = null;
824 // call Introspect on self
825 self.callMethod("org.freedesktop.DBus.Introspectable", "Introspect", []).then(introspectSuccessCB, errorCB);
829 cloudeebus.ProxyObject.prototype._addMethod = function(ifName, method, nArgs, signature) {
833 self[method] = function() {
835 for (var i=0; i < nArgs; i++ )
836 args.push(arguments[i]);
837 return self.callMethod(ifName, method, args, signature);
842 cloudeebus.ProxyObject.prototype.callMethod = function(ifName, method, args, signature) {
846 var promise = new cloudeebus.Promise(function (resolver) {
847 function callMethodSuccessCB(str) {
848 try { // calling dbus hook object function for un-translated types
849 var result = eval(str);
850 resolver.fulfill(result[0], true);
853 var errorStr = cloudeebus.getError(e);
854 cloudeebus.log("Method callback exception: " + errorStr);
855 resolver.reject(errorStr, true);
859 function callMethodErrorCB(error) {
860 var errorStr = cloudeebus.getError(error);
861 cloudeebus.log("Error calling method: " + method + " on object: " + self.objectPath + " : " + errorStr);
862 resolver.reject(errorStr, true);
866 self.busConnection.name,
874 // call dbusSend with bus type, destination, object, message and arguments
875 self.wampSession.call("dbusSend", arglist).then(callMethodSuccessCB, callMethodErrorCB);
882 cloudeebus.ProxyObject.prototype.connectToSignal = function(ifName, signal, handlerCB, errorCB) {
886 function signalHandler(id, data) {
888 try { // calling dbus hook object function for un-translated types
889 handlerCB.apply(self, eval(data));
892 var errorStr = cloudeebus.getError(e);
893 cloudeebus.log("Signal handler exception: " + errorStr);
900 function connectToSignalSuccessCB(str) {
902 self.wampSession.subscribe(str, signalHandler);
905 cloudeebus.log("Subscribe error: " + cloudeebus.getError(e));
909 function connectToSignalErrorCB(error) {
910 var errorStr = cloudeebus.getError(error);
911 cloudeebus.log("Error connecting to signal: " + signal + " on object: " + self.objectPath + " : " + errorStr);
917 self.busConnection.name,
924 // call dbusSend with bus type, destination, object, message and arguments
925 self.wampSession.call("dbusRegister", arglist).then(connectToSignalSuccessCB, connectToSignalErrorCB);
929 cloudeebus.ProxyObject.prototype.disconnectSignal = function(ifName, signal) {
931 this.wampSession.unsubscribe(this.busConnection.name + "#" + this.busName + "#" + this.objectPath + "#" + ifName + "#" + signal);
934 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));