[html] Add Ehsun to authors of dbus.js
[browser-dbus-bridge.git] / html / dbus.js
1 /*
2  * DBus.js, a JS wrapper for the Browser D-Bus Bridge
3  * Copyright (c) 2008-2009  Movial Creative Technologies Inc
4  *
5  * Contact: Movial Creative Technologies Inc, <info@movial.com>
6  * Authors: Lauri Mylläri, <lauri.myllari@movial.fi>
7  *          Kalle Vahlman, <kalle.vahlman@movial.com>
8  *          Ehsun Amanolahi, <ehsun.amanolahi@movial.com>
9  *
10  * Permission is hereby granted, free of charge, to any person
11  * obtaining a copy of this software and associated documentation
12  * files (the "Software"), to deal in the Software without
13  * restriction, including without limitation the rights to use,
14  * copy, modify, merge, publish, distribute, sublicense, and/or sell
15  * copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following
17  * conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
24  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
26  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
27  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
29  * OTHER DEALINGS IN THE SOFTWARE.
30  */
31
32 if (!window.DBus)
33 {
34     /* This is the Gecko wrapping for the Browser D-Bus Bridge API
35      * You can use the XPCOM API directly, but the Bridge API
36      *  - is easier to use
37      *  - has few utility features over the "raw" API (like introspection)
38      *  - generally feels a bit more JavaScriptish (hopefully)
39      */
40
41     /* For readability */
42     var ep = netscape.security.PrivilegeManager.enablePrivilege;
43     ep("UniversalXPConnect");
44     var cc = Components.classes;
45     var ci = Components.interfaces;
46
47     /* Utility function that creates a wrapper function which handles signature
48      * conversion from wrapper(argarray) to method(arg1, ..., argN) and sets
49      * 'this' to point to the user-specified object. This is mainly used to
50      * convert the variant arrays from the XPCOM service to callback arguments.
51      */
52     var unWrap = function(method, user_data) {
53         return function() {
54             if (method){
55                 method.apply(user_data, arguments[0]);
56             }
57         };
58     };
59
60     var makeVariantMaker = function(variant_type) {
61         return function(val) {
62             ep("UniversalXPConnect");
63             var variant = cc["@mozilla.org/variant;1"].createInstance(ci.nsIWritableVariant);
64             variant['setAs' + variant_type](val);
65             return variant;
66         };
67         return ret;
68     };
69
70     // Bridge API: The DBus singleton class
71     window.DBus = function() {
72
73         ep("UniversalXPConnect");
74         this.dbus = cc["@movial.fi/dbus/service;1"].getService();
75         this.dbus = this.dbus.QueryInterface(Components.interfaces.IDBusService);
76
77         // Mirror static properties
78         this.SYSTEM = this.dbus.SYSTEM;
79         this.SESSION = this.dbus.SESSION;
80
81         // Bridge API: DBus.[some type]()
82         // These are types we can wrap to variants directly for the
83         // DBus.Int32() etc conversion methods
84         var types = {
85             Int32:  "Int32",
86             UInt32: "Uint32",
87             Int16:  "Int16",
88             UInt16: "Uint16",
89             Int64:  "Int64",
90             UInt64: "Uint64",
91             Double: "Double",
92             Byte:   "Int8"
93         };
94
95         for (var type in types) {
96             if(type !== null ){
97                 this[type] = makeVariantMaker(types[type]);
98             }
99         }
100
101         /* TODO: These need their own XPCOM types/handling:
102        - ObjectPath
103        - Signature
104        - Variant?
105        - Struct?
106          */
107
108     };
109
110     // Bridge API: dbus.getMethod()
111     window.DBus.prototype.getMethod = function(bustype,
112                                                destination,
113                                                object_path,
114                                                method_name,
115                                                interface,
116                                                signature,
117                                                user_data) {
118
119         /* A wrapper function for method calls
120          * Executes the actual call through the XPCOM interface
121          */
122         var method = function() {
123             ep("UniversalXPConnect");
124             // FIXME: Is the copy really necessary? Why?
125             method.dbusmethod.doCall(Array.prototype.slice.call(arguments),
126             arguments.length);
127
128         };
129
130         // Store the user specified "this" object
131         method.user_data = user_data;
132
133         // Create the XPCOM method object
134         ep("UniversalXPConnect");
135         method.dbusmethod = this.dbus.getMethod(bustype,
136                                                 destination,
137                                                 object_path,
138                                                 method_name,
139                                                 interface,
140                                                 signature);
141
142         /* XXX: Hmm? onreply and onerror are undefined here, no? */
143         method.dbusmethod.onReply = unWrap(method.onreply, method.user_data);
144         method.dbusmethod.onError = unWrap(method.onerror, method.user_data);
145
146         // Watch the onreply property and assign the callback through our
147         // wrapper
148         method.watch("onreply", function(id, oldval, newval) {
149             ep("UniversalXPConnect");
150             method.dbusmethod.onReply = unWrap(newval, method.user_data);
151         });
152
153         // Ditto for onerror
154         method.watch("onerror", function(id, oldval, newval) {
155             ep("UniversalXPConnect");
156             method.dbusmethod.onError = unWrap(newval, method.user_data);
157         });
158
159         // Mirror the async property
160         method.async = true;
161         method.watch("async", function(id, oldval, newval) {
162             ep("UniversalXPConnect");
163             method.dbusmethod.async = newval;
164         });
165
166         return method;
167     };
168
169     // Bridge API: dbus.getSignal()
170     window.DBus.prototype.getSignal = function(bustype,
171                                         interface,
172                                         signal_name,
173                                         sender,
174                                         object_path,
175                                         user_data) {
176         var signal = {};
177
178         // Create the XPCOM signal object
179         ep("UniversalXPConnect");
180         signal.dbussignal = this.dbus.getSignal(bustype,
181                                                 interface,
182                                                 signal_name,
183                                                 sender,
184                                                 object_path);
185
186         // Store user-specified "this" for callbacks
187         signal.user_data = user_data;
188
189         // XXX: ummm.... onemit == undefined?
190         signal.dbussignal.onEmit = unWrap(signal.onemit, signal.user_data);
191
192         // Watch the onemit property for wrapping
193         signal.watch("onemit", function(id, oldval, newval) {
194             ep("UniversalXPConnect");
195             signal.dbussignal.onEmit = unWrap(newval, signal.user_data);
196         });
197
198         // Watch the enabled property for wrapping
199         signal.enabled = false;
200         signal.watch("enabled", function(id, oldval, newval) {
201             ep("UniversalXPConnect");
202             signal.dbussignal.enabled = newval;
203         });
204
205         return signal;
206     };
207
208     // Bridge API: dbus.emitSignal()
209     window.DBus.prototype.emitSignal = function() {
210         var args = arguments.splice(5);
211         ep("UniversalXPConnect");
212         this.dbus.emitSignal(arguments[0], arguments[1],
213                              arguments[2], arguments[3],
214                              arguments[4], args, args.length);
215     };
216
217 }
218
219 // Instantiate the Bridge API singleton
220 try {
221   window.dbus = new window.DBus();
222 } catch (e) {
223   window.dbus = null;
224 }
225
226 /**
227  *  @private
228  */
229
230 DBus.prototype.parseInterface = function(doc, dest, path, inter){
231     var ret = {};
232     var temp = doc.getElementsByTagName("interface");
233     //interesting interface is last
234     for( var i = temp.length - 1; i >=0; i--){
235         if( temp[i].getAttribute("name") != inter ) { continue; }
236         //method name
237         var methods = temp[i].getElementsByTagName("method");
238         for ( var j = 0, jl = methods.length; j < jl; j ++){
239             var name = methods[j].getAttribute("name");
240             //params
241             var args = methods[j].getElementsByTagName("arg");
242             var type = [];
243
244             for( var z = 0, zl = args.length; z < zl; z ++){
245
246                 if(  args[z].getAttribute("direction") == "in"){
247                     type.push(args[z].getAttribute("type") );
248                 }
249
250             }
251             ret[name] = dbus.getMethod(window.DBus.SESSION, dest, path,
252                                        name, inter, type.join(""), ret );
253         }
254
255         //signals
256         var signals = temp[i].getElementsByTagName("signal");
257         for ( var j = 0, jl = signals.length; j < jl; j ++){
258             name = signals[j].getAttribute("name");
259             ret[name] = dbus.getSignal(window.DBus.SESSION,
260                                        inter, name, null,
261                                        this.object_path, ret);
262             ret[name].enabled = false;
263             ret[name].onemit = null;
264         }
265         ret.xml = (new XMLSerializer()).serializeToString(doc);
266         return ret;
267         // break; //interface found
268     }
269 };
270
271 /**
272     *  @constructor
273     *  @class This method uses the <code>Introspect</code> method on the standard
274     *  <code>org.freedesktop.DBus.Introspectable</code> interface to map a given
275     *  D-Bus interface to a JavaScript object. The produced object works as
276     *  <code>this</code> in all its methods.<br/> Note that introspecting is
277     *  not done asynchronously so the function call will block until the service
278     *  responds.
279     *  <br/>
280     *  for example:<br/>
281     *  <code>
282     *  var myinterface = DBus.getInterface( mydest, mypath, myinterface);<br/>
283     *  var myname = "";<br/>
284     *  myinterface.getName.onreply = function(name){<br/>
285     *  &nbsp;&nbsp;myname = name;<br/>
286     *  };<br/>
287     *  myinterface.getName.onerror = function(message){<br/>
288     *  &nbsp;&nbsp;alert('name getting failed:'+message );<br/>
289     *  };<br/>
290     *  myinterface.getName( me );<br/>
291     *  </code>
292     *  @param dest {String} destination
293     *  @param path {String} object path
294     *  @param inter {String} interface
295     */
296 DBus.prototype.getInterface = function(dest, path, inter){
297     var doc = null;
298     var introspect = dbus.getMethod(dbus.SESSION, dest, path,
299                                     "Introspect",
300                                     "org.freedesktop.DBus.Introspectable" );
301     introspect.onreply = function(s){
302         doc = s.replace(/^\s*|\s*$/g,"");
303     };
304     introspect.onerror = function(s){
305         doc = null;
306     };
307     introspect.async = false;
308     introspect();
309
310     if (doc === null) {
311         return null;
312     }
313
314     doc = (new DOMParser()).parseFromString(doc, "text/xml");
315
316     return this.parseInterface(doc, dest, path, inter);
317 };