/usr/share/gjs-1.0/dbus.js is in libgjs0c 1.32.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 | // Copyright 2008 litl, LLC.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
const Lang = imports.lang;
// Parameters for acquire_name, keep in sync with
// enum in util/dbus.h
const SINGLE_INSTANCE = 0;
const MANY_INSTANCES = 1;
const CALL_FLAG_START = 1;
// Merge stuff defined in native code
Lang.copyProperties(imports.dbusNative, this);
var Introspectable = {
name: 'org.freedesktop.DBus.Introspectable',
methods: [
// Introspectable: return an XML description of the object.
// Out Args:
// xml_data: XML description of the object.
{ name: 'Introspect', inSignature: '', outSignature: 's' }
],
signals: [],
properties: []
};
var Properties = {
name: 'org.freedesktop.DBus.Properties',
methods: [
{ name: 'Get', inSignature: 'ss', outSignature: 'v' },
{ name: 'Set', inSignature: 'ssv', outSignature: '' },
{ name: 'GetAll', inSignature: 's', outSignature: 'a{sv}' }
],
signals: [],
properties: []
};
function _proxyInvoker(obj, ifaceName, methodName, outSignature, inSignature, timeout, arg_array) {
let replyFunc;
let flags = 0;
/* Note: "this" in here is the module, "obj" is the proxy object
*/
if (ifaceName == null)
ifaceName = obj._dbusInterface;
/* Convert arg_array to a *real* array */
arg_array = Array.prototype.slice.call(arg_array);
/* The default replyFunc only logs the responses */
replyFunc = _logReply;
let signatureLength = this.signatureLength(inSignature);
let minNumberArgs = signatureLength;
let maxNumberArgs = signatureLength + 2;
if (arg_array.length < minNumberArgs) {
throw new Error("Not enough arguments passed for method: " + methodName +
". Expected " + minNumberArgs + ", got " + arg_array.length);
} else if (arg_array.length > maxNumberArgs) {
throw new Error("Too many arguments passed for method: " + methodName +
". Maximum is " + maxNumberArgs +
" + one callback and/or flags");
}
while (arg_array.length > signatureLength) {
let argNum = arg_array.length - 1;
let arg = arg_array.pop();
if (typeof(arg) == "function") {
replyFunc = arg;
} else if (typeof(arg) == "number") {
flags = arg;
} else {
throw new Error("Argument " + argNum + " of method " + methodName +
" is " + typeof(arg) + ". It should be a callback or flags");
}
}
let auto_start = false;
if (flags & CALL_FLAG_START) {
auto_start = true;
}
/* Auto-start on method calls is too unpredictable; in particular if
* something crashes we want to cleanly restart it, not have it
* come back next time someone tries to use it.
*/
obj._dbusBus.call_async(obj._dbusBusName,
obj._dbusPath,
ifaceName,
methodName,
outSignature,
inSignature,
auto_start,
timeout,
arg_array,
replyFunc);
}
function _logReply(result, exc) {
if (result != null) {
log("Ignored reply to dbus method: " + result.toSource());
}
if (exc != null) {
log("Ignored exception from dbus method: " + exc.toString());
}
}
function _makeProxyMethod(member) {
return function() {
/* JSON methods are the default */
if (!("outSignature" in member))
member.outSignature = "a{sv}";
if (!("inSignature" in member))
member.inSignature = "a{sv}";
if (!("timeout" in member))
member.timeout = -1;
_proxyInvoker(this, null, member.name,
member.outSignature, member.inSignature,
member.timeout, arguments);
};
}
// stub we insert in all proxy prototypes
function _getBusName() {
return this._dbusBusName;
}
// stub we insert in all proxy prototypes
function _getPath() {
return this._dbusPath;
}
// stub we insert in all proxy prototypes
function _getBus() {
return this._dbusBus;
}
// stub we insert in all proxy prototypes
function _getInterface() {
return this._dbusInterface;
}
function _invokeSignalWatchCallback(callback, emitter, argsFromDBus) {
let argArray = [emitter];
let length = argsFromDBus.length;
for (let i = 0; i < length; ++i) {
argArray.push(argsFromDBus[i]);
}
callback.apply(null, argArray);
}
function _connect(signalName, callback) {
if (!this._signalNames || !(signalName in this._signalNames))
throw new Error("Signal " + signalName + " not defined in this object");
let me = this;
return this._dbusBus.watch_signal(this._dbusBusName,
this._dbusPath,
this._dbusInterface,
signalName,
function() {
_invokeSignalWatchCallback(callback,
me,
arguments);
});
}
function _disconnectByID(ID) {
this._dbusBus.unwatch_signal_by_id(ID);
}
function _getRemote(propName) {
// convert arguments to regular array
let argArray = [].splice.call(arguments, 0);
// prepend iface the property is on
argArray.splice(0, 0, this._dbusInterface);
_proxyInvoker(this, "org.freedesktop.DBus.Properties",
"Get",
"v",
"ss",
-1,
argArray);
}
function _setRemote(propName, value) {
// convert arguments to regular array
let argArray = [].splice.call(arguments, 0);
// prepend iface the property is on
argArray.splice(0, 0, this._dbusInterface);
_proxyInvoker(this, "org.freedesktop.DBus.Properties",
"Set",
"",
"ssv",
-1,
argArray);
}
function _getAllRemote() {
// convert arguments to regular array
let argArray = [].splice.call(arguments, 0);
// prepend iface the properties are on
argArray.splice(0, 0, this._dbusInterface);
_proxyInvoker(this, "org.freedesktop.DBus.Properties",
"GetAll",
"a{sv}",
"s",
-1,
argArray);
}
// adds remote members to a prototype. The instances using
// the prototype must be proxified with proxifyObject, too.
// Note that the bus (system vs. session) is per-instance not
// per-prototype so the bus should not be involved in this
// function.
// The "iface" arg is a special object that might have properties
// for 'name', 'methods', and 'signals'
function proxifyPrototype(proto, iface) {
if ('name' in iface)
proto._dbusInterface = iface.name;
else
proto._dbusInterface = null;
if ('methods' in iface) {
let methods = iface.methods;
for (let i = 0; i < methods.length; ++i) {
let method = methods[i];
if (!('name' in method))
throw new Error("Method definition must have a name");
/* To ease transition let's create two methods: Foo and FooRemote.
* Foo will just log a warning so we can catch people using the
* old naming system. FooRemote is the actual proxy method.
*/
let methodName = method.name + "Remote";
proto[methodName] = _makeProxyMethod(method);
proto[method.name] = function() {
log("PROXY-ERROR: " + method.name + " called, you should be using " +
methodName + " instead");
};
}
}
if ('signals' in iface) {
let signals = iface.signals;
let signalNames = {};
for (let i = 0; i < signals.length; i++) {
let signal = signals[i];
if (!('name' in signal))
throw new Error("Signal definition must have a name");
let name = signal.name;
/* This is a bit silly, but we might want to add more information
* later and it still beats an Array in checking if the object has
* a given signal
*/
signalNames[name] = name;
}
proto['_signalNames'] = signalNames;
proto['connect'] = _connect;
proto['disconnect'] = _disconnectByID;
}
// properties just adds GetRemote, SetRemote, and GetAllRemote
// methods; using attributes would force synchronous API.
if ('properties' in iface &&
iface.properties.length > 0) {
proto['GetRemote'] = _getRemote;
proto['SetRemote'] = _setRemote;
proto['GetAllRemote'] = _getAllRemote;
}
proto['getBusName'] = _getBusName;
proto['getPath'] = _getPath;
proto['getBus'] = _getBus;
proto['getInterface'] = _getInterface;
}
// methods common to both session and system buses.
// add them to the common prototype of this.session and this.system.
// convert any object to a dbus proxy ... assumes its prototype is
// also proxified
this._busProto.proxifyObject = function(obj, busName, path) {
if (!busName) {
throw new Error('missing bus name proxifying object');
}
if (!path) {
throw new Error('missing path proxifying object');
}
if (path[0] != '/')
throw new Error("Path doesn't look like a path: " + path);
obj._dbusBus = this;
obj._dbusBusName = busName;
obj._dbusPath = path;
};
// add 'object' to the exports object at the given path
let _addExports = function(node, path, object) {
if (path == '') {
if ('-impl-' in node)
throw new Error("Object already registered for path.");
node['-impl-'] = object;
} else {
let idx = path.indexOf('/');
let head = (idx >= 0) ? path.slice(0, idx) : path;
let tail = (idx >= 0) ? path.slice(idx+1) : '';
if (!(head in node))
node[head] = {};
_addExports(node[head], tail, object);
}
};
// remove any implementation from exports at the given path.
let _removeExportsPath = function(node, path) {
if (path == '') {
delete node['-impl-'];
} else {
let idx = path.indexOf('/');
let head = (idx >= 0) ? path.slice(0, idx) : path;
let tail = (idx >= 0) ? path.slice(idx+1) : '';
// recursively delete next component
_removeExportsPath(node[head], tail);
// are we empty now? if so, clean us up.
if ([x for (x in node[head])].length == 0) {
delete node[head];
}
}
};
// export the object at the specified object path
this._busProto.exportObject = function(path, object) {
if (path.slice(0,1) != '/')
throw new Error("Bad path! Must start with /");
// keep session and system paths separate, just in case we register on both
let pathProp = '_dbusPaths' + this._dbusBusType;
// optimize for the common one-path case by using a colon-delimited
// string rather than an array.
if (!(pathProp in object)) {
object[pathProp] = path;
} else {
object[pathProp] += ':' + path;
}
_addExports(this.exports, path.slice(1), object);
};
// unregister this object from all its paths
this._busProto.unexportObject = function(object) {
// keep session and system paths separate, just in case we register on both
let pathProp = '_dbusPaths' + this._dbusBusType;
if (!(pathProp in object))
return; // already or never registered.
let dbusPaths = object[pathProp].split(':');
for (let i = 0; i < dbusPaths.length; ++i) {
let path = dbusPaths[i];
_removeExportsPath(this.exports, path.slice(1));
}
delete object[pathProp];
};
// given a "this" with _dbusInterfaces, return a dict from property
// names to property signatures. Used as value of _dbus_signatures
// when passing around a dict of properties.
function _getPropertySignatures(ifaceName) {
let iface = this._dbusInterfaces[ifaceName];
if (!iface)
throw new Error("Object has no interface " + ifaceName);
if (!('_dbusPropertySignaturesCache' in iface)) {
let signatures = {};
if ('properties' in iface) {
let properties = iface.properties;
for (let i = 0; i < properties.length; ++i) {
signatures[properties[i].name] =
properties[i].signature;
}
}
iface._dbusPropertySignaturesCache = signatures;
}
return iface._dbusPropertySignaturesCache;
}
// split a "single complete type" (SCT) from the rest of a dbus signature.
// Returns the tail, and the head is added to acc.
function _eatSCT(acc, s) {
// eat the first character
let c = s.charAt(0);
s = s.slice(1);
acc.push(c);
// if this is a compound type, loop eating until we reach the close paren
if (c=='(') {
while (s.charAt(0) != ')') {
s = _eatSCT(acc, s);
}
s = _eatSCT(acc, s); // the close paren
} else if (c=='{') {
s = _eatSCT(acc, s);
s = _eatSCT(acc, s);
if (s.charAt(0) != '}')
throw new Error("Bad DICT_ENTRY signature!");
s = _eatSCT(acc, s); // the close brace
} else if (c=='a') {
s = _eatSCT(acc, s); // element type
}
return s;
}
// parse signature string, generating a list of "single complete types"
function _parseDBusSigs(sig) {
while (sig.length > 0) {
let one = [];
sig = _eatSCT(one, sig);
yield one.join('');
}
}
// given a "this" with _dbusInterfaces, returns DBus Introspection
// format XML giving interfaces and methods implemented.
function _getInterfaceXML() {
let result = '';
// iterate through defined interfaces
let ifaces = ('_dbusInterfaces' in this) ? this._dbusInterfaces : {};
ifaces = [i for each (i in ifaces)]; // convert to array
// add introspectable and properties
ifaces.push(Introspectable);
ifaces.push(Properties);
for (let i = 0; i < ifaces.length; i++) {
let iface = ifaces[i];
result += ' <interface name="' + iface.name + '">\n';
// describe methods.
let methods = ('methods' in iface) ? iface.methods : [];
for (let j = 0; j < methods.length; j++) {
let method = methods[j];
result += ' <method name="' + method.name + '">\n';
for each (let sig in _parseDBusSigs(method.inSignature)) {
result += ' <arg type="' + sig + '" direction="in"/>\n';
}
for each (let sig in _parseDBusSigs(method.outSignature)) {
result += ' <arg type="' + sig + '" direction="out"/>\n';
}
result += ' </method>\n';
}
// describe signals
let signals = ('signals' in iface) ? iface.signals : [];
for (let j = 0; j < signals.length; j++) {
let signal = signals[j];
result += ' <signal name="' + signal.name + '">\n';
for each (let sig in _parseDBusSigs(signal.inSignature)) {
result += ' <arg type="' + sig + '"/>\n';
}
result += ' </signal>\n';
}
// describe properties
let properties = ('properties' in iface) ? iface.properties : [];
for (let j = 0; j < properties.length; j++) {
let property = properties[j];
result += ' <property name="' + property.name + '" type="'
+ property.signature + '" access="'
+ property.access + '"/>\n';
}
// close <interface> tag
result += ' </interface>\n';
}
return result;
}
// Verifies that a given object conforms to a given interface,
// and stores meta-info from the interface in the object as
// required.
// Note that an object can be exported on multiple buses, so conformExport()
// should not be specific to the bus (session vs. system)
function conformExport(object, iface) {
if (!('_dbusInterfaces' in object)) {
object._dbusInterfaces = {};
} else if (iface.name in object._dbusInterfaces) {
return;
}
object._dbusInterfaces[iface.name] = iface;
object.getDBusPropertySignatures =
_getPropertySignatures;
if (!('getDBusInterfaceXML' in object))
object.getDBusInterfaceXML = _getInterfaceXML;
if ('methods' in iface) {
let methods = iface.methods;
for (let i = 0; i < methods.length; ++i) {
let method = methods[i];
if (!('name' in method))
throw new Error("Method definition must have a name");
if (!('outSignature' in method))
method.outSignature = "a{sv}";
let name = method.name;
let asyncName = name +"Async";
let missing = [];
if (!(name in object) &&
!(asyncName in object)) {
missing.push(name);
} else {
if (asyncName in object)
object[asyncName].outSignature = method.outSignature;
else
object[name].outSignature = method.outSignature;
}
if (missing.length > 0) {
throw new Error("Exported object missing members " + missing.toSource());
}
}
}
if ('properties' in iface) {
let properties = iface.properties;
let missing = [];
for (let i = 0; i < properties.length; ++i) {
if (!(properties[i].name in object)) {
missing.push(properties[i]);
}
}
if (missing.length > 0) {
throw new Error("Exported object missing properties " + missing.toSource());
}
}
// sanity-check signals
if ('signals' in iface) {
let signals = iface.signals;
for (let i = 0; i < signals.length; ++i) {
let signal = signals[i];
if (signal.name.indexOf('-') >= 0)
throw new Error("dbus signals cannot have a hyphen in them, use camelCase");
}
}
}
// DBusError object
// Used to return dbus error with given name and mesage from
// remote methods
function DBusError(dbusErrorName, errorMessage) {
this.dbusErrorName = dbusErrorName;
this.errorMessage = errorMessage;
}
DBusError.prototype = {
toString: function() {
return this.errorMessage;
}
};
// Creates a proxy class for a given interface
function makeProxyClass(iface) {
let constructor = function() { this._init.apply(this, arguments); };
constructor.prototype._init = function(bus, name, path) {
bus.proxifyObject(this, name, path);
};
proxifyPrototype(constructor.prototype, iface);
return constructor;
}
var IntrospectableProxy = makeProxyClass(Introspectable);
|