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);
254 for (var idx in self.agents) {
255 if (self.agents[idx]) {
256 self.removeAgent(self.agents[idx]);
264 // call dbusSend with bus type, destination, object, message and arguments
265 self.wampSession.call("serviceRelease", arglist).then(ServiceRemovedSuccessCB, ServiceRemovedErrorCB);
272 cloudeebus.Service.prototype._searchMethod = function(ifName, method, objectJS) {
274 var funcToCall = null;
276 // Check if 'objectJS' has a member 'interfaceProxies' with an interface named 'ifName'
277 // and a method named 'method'
278 if (objectJS.interfaceProxies && objectJS.interfaceProxies[ifName] &&
279 objectJS.interfaceProxies[ifName][method]) {
280 funcToCall = objectJS.interfaceProxies[ifName][method];
282 // retrieve the method directly from 'root' of objectJs
283 funcToCall = objectJS[method];
290 cloudeebus.Service.prototype._addMethod = function(ifName, method, agent) {
293 var methodId = this.name + "#" + agent.objectPath + "#" + ifName + "#" + method;
294 var funcToCall = this._searchMethod(ifName, method, agent.jsHdl);
296 if (funcToCall == null)
297 cloudeebus.log("Method " + method + " doesn't exist in Javascript object");
299 agent.jsHdl.wrapperFunc[method] = function() {
301 var methodId = arguments[0];
303 // affectation of callDict in eval, otherwise dictionary(='{}') interpreted as block of code by eval
304 eval("callDict = " + arguments[1]);
306 result = funcToCall.apply(agent.jsHdl, callDict.args);
307 service._returnMethod(methodId, callDict.callIndex, true, result);
310 var errorStr = cloudeebus.getError(e);
311 cloudeebus.log("Method " + ifName + "." + method + " call on " + agent.objectPath + " exception: " + errorStr);
312 service._returnMethod(methodId, callDict.callIndex, false, errorStr);
315 agent.jsHdl.methodId[agent.objectPath].push(methodId);
316 this.wampSession.subscribe(methodId, agent.jsHdl.wrapperFunc[method]);
321 cloudeebus.Service.prototype._addSignal = function(ifName, signal, agent) {
323 var methodExist = false;
325 if (agent.jsHdl.interfaceProxies && agent.jsHdl.interfaceProxies[ifName])
326 if (agent.jsHdl.interfaceProxies[ifName][signal]) {
329 agent.jsHdl.interfaceProxies[ifName][signal] = function() {
330 service._emitSignal(agent.objectPath, signal, arguments[0]);
335 if ((agent.jsHdl[signal] == undefined || agent.jsHdl[signal] == null) && !methodExist)
336 agent.jsHdl[signal] = function() {
337 service._emitSignal(agent.objectPath, signal, arguments[0]);
340 cloudeebus.log("Can not create new method to emit signal '" + signal + "' in object JS this method already exist!");
344 cloudeebus.Service.prototype._createWrapper = function(agent) {
346 var parser = new DOMParser();
347 var xmlDoc = parser.parseFromString(agent.xml, "text/xml");
348 var ifXml = xmlDoc.getElementsByTagName("interface");
349 agent.jsHdl.wrapperFunc = {};
350 agent.jsHdl.methodId = {};
351 agent.jsHdl.methodId[agent.objectPath] = [];
352 for (var i=0; i < ifXml.length; i++) {
353 var ifName = ifXml[i].attributes.getNamedItem("name").value;
354 var ifChild = ifXml[i].firstChild;
356 if (ifChild.nodeName == "method") {
357 var metName = ifChild.attributes.getNamedItem("name").value;
358 self._addMethod(ifName, metName, agent);
360 if (ifChild.nodeName == "signal") {
361 var metName = ifChild.attributes.getNamedItem("name").value;
362 self._addSignal(ifName, metName, agent);
364 ifChild = ifChild.nextSibling;
370 cloudeebus.Service.prototype.addAgent = function(agent) {
373 var promise = new cloudeebus.Promise(function (resolver) {
374 function ServiceAddAgentSuccessCB(objPath) {
375 try { // calling dbus hook object function for un-translated types
376 self.agents.push(agent);
377 resolver.fulfill(objPath, true);
380 var errorStr = cloudeebus.getError(e);
381 cloudeebus.log("Method callback exception: " + errorStr);
382 resolver.reject(errorStr, true);
386 function ServiceAddAgenterrorCB(error) {
387 var errorStr = cloudeebus.getError(error);
388 cloudeebus.log("Error adding agent : " + agent.objectPath + ", error: " + errorStr);
389 self.promise.resolver.reject(errorStr, true);
393 self._createWrapper(agent);
396 var errorStr = cloudeebus.getError(e);
397 cloudeebus.log("Exception creating agent wrapper " + agent.objectPath + " : " + errorStr);
398 resolver.reject(errorStr, true);
407 // call dbusSend with bus type, destination, object, message and arguments
408 self.wampSession.call("serviceAddAgent", arglist).then(ServiceAddAgentSuccessCB, ServiceAddAgenterrorCB);
415 cloudeebus.Service.prototype._deleteWrapper = function(agent) {
416 var objJs = agent.jsHdl;
417 if (objJs.methodId[agent.objectPath]) {
418 while (objJs.methodId[agent.objectPath].length) {
420 this.wampSession.unsubscribe( objJs.methodId[agent.objectPath].pop() );
423 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));
426 objJs.methodId[agent.objectPath] = null;
431 cloudeebus.Service.prototype.removeAgent = function(rmAgent) {
434 var promise = new cloudeebus.Promise(function (resolver) {
435 function ServiceRemoveAgentSuccessCB(objectPath) {
436 // Searching agent in list
437 for (var idx in self.agents)
438 if (self.agents[idx].objectPath == objectPath) {
439 agent = self.agents[idx];
443 try { // calling dbus hook object function for un-translated types
444 self.agents.splice(idx, 1);
445 self._deleteWrapper(agent);
446 resolver.fulfill(agent, true);
449 var errorStr = cloudeebus.getError(e);
450 cloudeebus.log("Method callback exception: " + errorStr);
451 resolver.reject(errorStr, true);
455 function ServiceRemoveAgentErrorCB(error) {
456 var errorStr = cloudeebus.getError(error);
457 cloudeebus.log("Error removing agent : " + rmAgent.objectPath + ", error: " + errorStr);
458 resolver.reject(errorStr, true);
465 // call dbusSend with bus type, destination, object, message and arguments
466 self.wampSession.call("serviceDelAgent", arglist).then(ServiceRemoveAgentSuccessCB, ServiceRemoveAgentErrorCB);
473 cloudeebus.Service.prototype._returnMethod = function(methodId, callIndex, success, result, successCB, errorCB) {
481 this.wampSession.call("returnMethod", arglist).then(successCB, errorCB);
485 cloudeebus.Service.prototype._emitSignal = function(objectPath, signalName, result, successCB, errorCB) {
492 this.wampSession.call("emitSignal", arglist).then(successCB, errorCB);
497 /*****************************************************************************/
499 function _processWrappers(wrappers, value) {
500 for (var i=0; i<wrappers.length; i++)
505 function _processWrappersAsync(wrappers, value) {
507 function processAsyncOnce() {
508 _processWrappers(wrappers, value);
509 clearInterval(taskid);
511 taskid = setInterval(processAsyncOnce, 200);
516 /*****************************************************************************/
518 cloudeebus.PromiseResolver = function(promise) {
519 this.promise = promise;
520 this.resolved = null;
525 cloudeebus.PromiseResolver.prototype.resolve = function(value, sync) {
529 var then = (value && value.then && value.then.apply) ? value.then : null;
532 var fulfillCallback = function(arg) {
533 self.resolve(arg, true);
535 var rejectCallback = function(arg) {
536 self.reject(arg, true);
539 then.apply(value, [fulfillCallback, rejectCallback]);
542 this.reject(cloudeebus.getError(e), true);
546 this.fulfill(value, sync);
550 cloudeebus.PromiseResolver.prototype.fulfill = function(value, sync) {
554 var promise = this.promise;
555 promise.state = "fulfilled";
556 promise.result = value;
558 this.resolved = true;
560 _processWrappers(promise._fulfillWrappers, value);
562 _processWrappersAsync(promise._fulfillWrappers, value);
566 cloudeebus.PromiseResolver.prototype.reject = function(value, sync) {
570 var promise = this.promise;
571 promise.state = "rejected";
572 promise.result = value;
574 this.resolved = true;
576 _processWrappers(promise._rejectWrappers, value);
578 _processWrappersAsync(promise._rejectWrappers, value);
583 /*****************************************************************************/
585 cloudeebus.Promise = function(init) {
586 this.state = "pending";
588 this._fulfillWrappers = [];
589 this._rejectWrappers = [];
590 this.resolver = new cloudeebus.PromiseResolver(this);
593 init.apply(this, [this.resolver]);
596 this.resolver.reject(cloudeebus.getError(e), true);
603 cloudeebus.Promise.prototype.appendWrappers = function(fulfillWrapper, rejectWrapper) {
605 this._fulfillWrappers.push(fulfillWrapper);
607 this._rejectWrappers.push(rejectWrapper);
608 if (this.state == "fulfilled")
609 _processWrappersAsync(this._fulfillWrappers, this.result);
610 if (this.state == "rejected")
611 _processWrappersAsync(this._rejectWrappers, this.result);
615 cloudeebus.Promise.prototype.then = function(fulfillCB, rejectCB) {
616 var promise = new cloudeebus.Promise();
617 var resolver = promise.resolver;
618 var fulfillWrapper, rejectWrapper;
621 fulfillWrapper = function(arg) {
623 var value = fulfillCB.apply(promise, [arg]);
624 resolver.resolve(value, true);
627 resolver.reject(cloudeebus.getError(e), true);
631 fulfillWrapper = function(arg) {
632 resolver.fulfill(arg, true);
636 rejectWrapper = function(arg) {
638 var value = rejectCB.apply(promise, [arg]);
639 resolver.resolve(value, true);
642 resolver.reject(cloudeebus.getError(e), true);
646 rejectWrapper = function(arg) {
647 resolver.reject(arg, true);
650 this.appendWrappers(fulfillWrapper,rejectWrapper);
655 cloudeebus.Promise.prototype["catch"] = function(rejectCB) {
656 return this.then(undefined,rejectCB);
660 cloudeebus.Promise.prototype.done = function(fulfillCB, rejectCB) {
661 this.appendWrappers(fulfillCB,rejectCB);
665 cloudeebus.Promise.resolve = function(value) {
666 var promise = new cloudeebus.Promise();
667 promise.resolver.resolve(value);
672 cloudeebus.Promise.fulfill = function(value) {
673 var promise = new cloudeebus.Promise();
674 promise.resolver.fulfill(value);
679 cloudeebus.Promise.reject = function(value) {
680 var promise = new cloudeebus.Promise();
681 promise.resolver.reject(value);
686 cloudeebus.Promise.any = function() {
687 var promise = new cloudeebus.Promise();
688 var resolver = promise.resolver;
689 var fulfillCallback = function(arg) {
690 resolver.resolve(arg, true);
692 var rejectCallback = function(arg) {
693 resolver.reject(arg, true);
695 if (arguments.length == 0)
696 resolver.resolve(undefined, true);
699 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
704 cloudeebus.Promise.every = function() {
705 var promise = new cloudeebus.Promise();
706 var resolver = promise.resolver;
708 var countdown = arguments.length;
709 var args = new Array(countdown);
710 var rejectCallback = function(arg) {
711 resolver.reject(arg, true);
713 if (arguments.length == 0)
714 resolver.resolve(undefined, true);
716 for (i in arguments) {
717 var fulfillCallback = function(arg) {
721 resolver.resolve(args, true);
724 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
731 cloudeebus.Promise.some = function() {
732 var promise = new cloudeebus.Promise();
733 var resolver = promise.resolver;
735 var countdown = arguments.length;
736 var args = new Array(countdown);
737 var fulfillCallback = function(arg) {
738 resolver.resolve(arg, true);
740 if (arguments.length == 0)
741 resolver.resolve(undefined, true);
743 for (i in arguments) {
744 var rejectCallback = function(arg) {
748 resolver.reject(args, true);
751 cloudeebus.Promise.resolve(arguments[i]).appendWrappers(fulfillCallback,rejectCallback);
759 /*****************************************************************************/
761 cloudeebus.ProxyObject = function(session, busConnection, busName, objectPath) {
762 this.wampSession = session;
763 this.busConnection = busConnection;
764 this.busName = busName;
765 this.objectPath = objectPath;
766 this.interfaceProxies = {};
771 cloudeebus.ProxyObject.prototype.getInterface = function(ifName) {
772 return this.interfaceProxies[ifName];
776 cloudeebus.ProxyObject.prototype._introspect = function(successCB, errorCB) {
780 function getAllPropertiesSuccessCB(props) {
781 var ifProxy = self.interfaceProxies[self.propInterfaces[self.propInterfaces.length-1]];
782 for (var prop in props)
783 ifProxy[prop] = self[prop] = props[prop];
784 getAllPropertiesNextInterfaceCB();
787 function getAllPropertiesNextInterfaceCB() {
788 self.propInterfaces.pop();
789 if (self.propInterfaces.length > 0)
790 self.callMethod("org.freedesktop.DBus.Properties",
792 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
793 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
795 self.propInterfaces = null;
801 function introspectSuccessCB(str) {
802 var parser = new DOMParser();
803 var xmlDoc = parser.parseFromString(str, "text/xml");
804 var interfaces = xmlDoc.getElementsByTagName("interface");
805 self.propInterfaces = [];
806 var supportDBusProperties = false;
807 for (var i=0; i < interfaces.length; i++) {
808 var ifName = interfaces[i].attributes.getNamedItem("name").value;
809 self.interfaceProxies[ifName] = new cloudeebus.ProxyObject(self.wampSession, self.busConnection, self.busName, self.objectPath);
810 if (ifName == "org.freedesktop.DBus.Properties")
811 supportDBusProperties = true;
812 var hasProperties = false;
813 var ifChild = interfaces[i].firstChild;
815 if (ifChild.nodeName == "method") {
818 var metChild = ifChild.firstChild;
820 if (metChild.nodeName == "arg" &&
821 metChild.attributes.getNamedItem("direction").value == "in") {
822 signature += metChild.attributes.getNamedItem("type").value;
825 metChild = metChild.nextSibling;
827 var metName = ifChild.attributes.getNamedItem("name").value;
829 self._addMethod(ifName, metName, nArgs, signature);
830 self.interfaceProxies[ifName]._addMethod(ifName, metName, nArgs, signature);
832 else if (ifChild.nodeName == "property") {
834 self.propInterfaces.push(ifName);
835 hasProperties = true;
837 ifChild = ifChild.nextSibling;
840 if (supportDBusProperties && self.propInterfaces.length > 0) {
841 self.callMethod("org.freedesktop.DBus.Properties",
843 [self.propInterfaces[self.propInterfaces.length-1]]).then(getAllPropertiesSuccessCB,
844 errorCB ? errorCB : getAllPropertiesNextInterfaceCB);
847 self.propInterfaces = null;
853 // call Introspect on self
854 self.callMethod("org.freedesktop.DBus.Introspectable", "Introspect", []).then(introspectSuccessCB, errorCB);
858 cloudeebus.ProxyObject.prototype._addMethod = function(ifName, method, nArgs, signature) {
862 self[method] = function() {
864 for (var i=0; i < nArgs; i++ )
865 args.push(arguments[i]);
866 return self.callMethod(ifName, method, args, signature);
871 cloudeebus.ProxyObject.prototype.callMethod = function(ifName, method, args, signature) {
875 var promise = new cloudeebus.Promise(function (resolver) {
876 function callMethodSuccessCB(str) {
877 try { // calling dbus hook object function for un-translated types
878 var result = eval(str);
879 resolver.fulfill(result[0], true);
882 var errorStr = cloudeebus.getError(e);
883 cloudeebus.log("Method callback exception: " + errorStr);
884 resolver.reject(errorStr, true);
888 function callMethodErrorCB(error) {
889 var errorStr = cloudeebus.getError(error);
890 cloudeebus.log("Error calling method: " + method + " on object: " + self.objectPath + " : " + errorStr);
891 resolver.reject(errorStr, true);
895 self.busConnection.name,
903 // call dbusSend with bus type, destination, object, message and arguments
904 self.wampSession.call("dbusSend", arglist).then(callMethodSuccessCB, callMethodErrorCB);
911 cloudeebus.ProxyObject.prototype.connectToSignal = function(ifName, signal, handlerCB, errorCB) {
915 function signalHandler(id, data) {
917 try { // calling dbus hook object function for un-translated types
918 handlerCB.apply(self, eval(data));
921 var errorStr = cloudeebus.getError(e);
922 cloudeebus.log("Signal handler exception: " + errorStr);
929 function connectToSignalSuccessCB(str) {
931 self.wampSession.subscribe(str, signalHandler);
934 cloudeebus.log("Subscribe error: " + cloudeebus.getError(e));
938 function connectToSignalErrorCB(error) {
939 var errorStr = cloudeebus.getError(error);
940 cloudeebus.log("Error connecting to signal: " + signal + " on object: " + self.objectPath + " : " + errorStr);
946 self.busConnection.name,
953 // call dbusSend with bus type, destination, object, message and arguments
954 self.wampSession.call("dbusRegister", arglist).then(connectToSignalSuccessCB, connectToSignalErrorCB);
958 cloudeebus.ProxyObject.prototype.disconnectSignal = function(ifName, signal) {
960 this.wampSession.unsubscribe(this.busConnection.name + "#" + this.busName + "#" + this.objectPath + "#" + ifName + "#" + signal);
963 cloudeebus.log("Unsubscribe error: " + cloudeebus.getError(e));