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
|
/* -*- mode: js2; js2-basic-offset: 4; indent-tabs-mode: nil -*- */
// Copyright (C) 2011 Giovanni Campagna
// Copyright (C) 2013 Jonas Kuemmerlin <rgcjonas@gmail.com>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
const Lang = imports.lang;
const Mainloop = imports.mainloop;
const Gio = imports.gi.Gio;
const GLib = imports.gi.GLib;
const St = imports.gi.St;
const Signals = imports.signals;
const PopupMenu = imports.ui.popupMenu;
const Shell = imports.gi.Shell;
const Extension = imports.misc.extensionUtils.getCurrentExtension();
const Util = Extension.imports.util;
const Interfaces = Extension.imports.interfaces;
const DBusMenuProxy = Gio.DBusProxy.makeProxyWrapper(Interfaces.DBusMenu);
/**
* Menu:
* uses dbus to get a description of a menu
* and then builds an equivalent St one, using PopupMenu.
*
* Differently from Gtk version, does not support accelators,
* as PopupMenu has no API for these.
*
*/
const Menu = new Lang.Class({
Name: 'DbusMenu',
Extends: Util.Mixin,
_init: function(name, path) {
this.parent();
//bus settings
this._lateMixin.busName = name;
this._lateMixin.path = path;
},
_conserve: [
'open'
],
_mixinInit: function(callback) {
this._proxy = new DBusMenuProxy(Gio.DBus.session,this.busName, this.path, (function(result, error) {
// compact representation of a tree
this._children = [ ];
this._parents = { '0': null };
this._itemProperties = { '0': { } };
this._items = [ ];
this._proxy.connectSignal('ItemsPropertiesUpdated', Lang.bind(this, this._itemsPropertiesUpdated));
this._proxy.connectSignal('ItemUpdated', Lang.bind(this, this._itemUpdated));
this._proxy.connectSignal('LayoutUpdated', Lang.bind(this, this._layoutUpdated));
this._revision = 0;
this._readLayoutQueue = new Util.AsyncTaskQueue();
// AboutToShow should be called when the menu is opened. Because that would notably slow down displaying it,
// we'll fake the call here and read the layout afterwards, no matter if we needed to.
// FIXME: this is async, do we need a callback here?
this._proxy.AboutToShowRemote(0, (function(result, error) {
this._readLayout(0, callback);
}).bind(this));
}).bind(this));
},
_mixin: {
reset: function() {
this._readLayout(0);
},
_readLayout: function(subtree, callback) {
//HACK: readLayout calls can intefere with each other, therefore we need to make sure they're serialized.
this._readLayoutQueue.add(this._doReadLayout.bind(this, subtree), callback);
},
_doReadLayout: function(subtree, callback) {
this._proxy.GetLayoutRemote(subtree, -1, ['id'], (function(result, error) {
if (error) {
log(error);
log(error.stack);
}
var revision = result[0];
var root = result[1];
if (revision < this._revision) {
// this happens when skype sends LayoutUpdated events for non-existent menu items.
log("WARNING: trying to update layout with revision "+revision+" while we're at "+this._revision);
if (callback) callback();
return;
}
var toFinish = 1; //we need to keep track of finished recurse operations since they're all async
function recurse(element, finished) {
let id = element[0];
this._children[id] = [ ];
let child;
element[2].forEach(function(child) {
let childid = child.deep_unpack()[0];
this._children[id].push(childid);
this._parents[childid] = id;
if (!this._itemProperties[childid]) {
toFinish += 1;
this._readItem(childid, recurse.bind(this, child.deep_unpack(), finished));
} else {
toFinish += 1;
recurse.call(this, child.deep_unpack(), finished);
}
}, this);
if ((--toFinish) == 0) {
if (finished) finished();
}
}
var recurse_finish = (function() {
this._revision = revision;
if (this._items[subtree]) this._buildMenu(subtree);
this._GCItems();
if (callback) callback();
}).bind(this);
if (subtree == 0) {
recurse.call(this, root, recurse_finish);
} else {
this._readItem(subtree, recurse.bind(this, root, recurse_finish));
}
}).bind(this));
},
_readItem: function(id, callback) {
this._proxy.GetGroupPropertiesRemote([id], [], Lang.bind(this, function (result, error) {
if (error) {
log("While reading item "+id+" on "+this.busName+this.path+": ");
log(error);
error.stack.split("\n").forEach(function(e) { log(e); });
} else if (!result[0][0]) {
//FIXME: how the hell does nm-applet manage to get us here?
//it doesn't seem to have any negative effects, however
log("While reading item "+id+" on "+this.busName+this.path+": ");
log("Empty result set (?)");
log(result);
} else {
//the unpacking algorithm is very strange...
var props = result[0][0][1];
for (var i in props) {
if (i == 'icon-data') {
//HACK: newer gjs can transform byte arrays in GBytes automatically, but the versions
// commonly found bundled with GS 3.6 (Ubuntu 12.10, 13.04) don't do that :(
props[i] = Util.variantToGBytes(props[i]);
} else {
props[i] = props[i].deep_unpack();
}
}
this._itemProperties[id] = props;
if(id == 0)
this._updateRoot();
else
this._replaceItem(id, true);
}
if (callback) callback();
}));
},
_GCItems: function() {
// normally, a GC employs BFS, but this is a tree
// so DFS is easier and faster
this._items.forEach(function(item) {
item._collect = true;
});
function reach(id) {
if (this._items[id])
this._items[id]._collect = false;
this._children[id].forEach(function(child) {
reach.call(this, child);
}, this);
}
this._children[0].forEach(function(child) {
reach.call(this, child);
}, this);
this._items.forEach(function(item) {
if (item._collect) {
let id = item._dbusId;
item.destroy();
delete this._itemProperties[id];
delete this._children[id];
delete this._parents[id];
}
}, this);
},
_buildMenu: function(subtree) {
let menu;
if (subtree == 0)
menu = this;
else
menu = this._items[subtree].menu;
if (menu == null) {
// not a PopupMenu.PopupSubMenuMenuItem, or a destroyed one?
// then rebuild it
this._replaceItem(subtree);
menu = this._items[subtree].menu;
if (menu == null)
// the menu is inconsistent with itself, kill this submenu
return;
}
menu.removeAll();
for each (let child in this._children[subtree]) {
if (!this._itemProperties[child])
// we don't have the properties yet, skip...
continue;
this._items[child] = this._buildItem(child);
menu.addMenuItem(this._items[child]);
if (this._children[child].length > 0)
this._buildMenu(child);
}
},
_replaceItem: function(id, recurse) {
if (typeof(id) == "undefined") throw new Error("called _replaceItem with undefined id");
let position = 0;
let parent = this._parents[id];
if (typeof(parent) == "undefined") {
log("WARNING: _replaceItem: parent of "+id+" is undefined!");
return;
}
if (parent != 0 && (!this._items[parent] || !this._items[parent].menu)) {
// parent is not ready, rebuild it
this._replaceItem(parent);
}
let menu;
if (parent == 0)
menu = this;
else
menu = this._items[parent].menu;
let siblings = this._children[this._parents[id]];
for (let i = 0;i < siblings.length && siblings[i] != id;++i) {
if (this._items[siblings[i]])
position++;
}
let original = this._items[id];
// in the first implementation, this function stole
// the submenu from the controlling item
// I don't know how feasible it would be now that submenus
// are inlined
if (original)
original.destroy();
let item = this._items[id] = this._buildItem(id);
let has_children = this._itemProperties[id]['children-display'] == 'submenu';
if (has_children && recurse)
this._buildMenu(id);
menu.addMenuItem(item, position);
},
_buildItem: function(id) {
let properties = this._itemProperties[id];
let type = properties['type'];
// remove all underscores not followed by another underscore
let label = properties['label'] || '';
if (label)
label = label.replace(/_([^_])/, '$1');
let icon = properties['icon-name'];
let icon_data = properties['icon-data'];
let toggle_type = properties['toggle-type'];
let has_children = properties['children-display'] == 'submenu';
let stitem;
let activate = true;
let reactive = 'enabled' in properties ? properties['enabled'] : true;
let visible = 'visible' in properties ? properties['visible'] : true;
if (type == 'separator') {
// ignores label, sensitive, has_children, icon, toggle_type
activate = false;
stitem = new PopupMenu.PopupSeparatorMenuItem();
} else if (has_children) {
// ignores icon, toggle_type
activate = false;
stitem = new PopupMenu.PopupSubMenuMenuItem(label);
stitem._dbusOpeningId = stitem.menu.connect('opening', Lang.bind(this, function(menu) {
this._proxy.AboutToShowRemote(id, Lang.bind(this, function(needsRelayout) {
if (needsRelayout)
this._readLayout(id);
}));
}));
} else if (toggle_type) {
// ignores icon
let toggle_state = properties['toggle-state'];
if (toggle_type == 'checkmark')
stitem = new PopupMenu.PopupSwitchMenuItem(label, toggle_state, { reactive: reactive });
else if (toggle_type == 'radio') {
stitem = new PopupMenu.PopupMenuItem(label, { reactive: reactive });
if (stitem.setShowDot) { // GS 3.8
stitem.setShowDot(toggle_state);
} else { // GS 3.10
stitem.setOrnament(toggle_state ? PopupMenu.Ornament.DOT : PopupMenu.Ornament.NONE);
}
}
} else if (icon) {
stitem = new PopupMenu.PopupImageMenuItem(label, icon, { reactive: reactive });
} else if (icon_data) {
stitem = new PopupMenu.PopupMenuItem(label, { reactive: reactive });
let iconActor = Util.createActorFromMemoryImage(icon_data, 24);
iconActor.add_style_class_name('popup-menu-icon');
if (stitem.addActor) { // GS 3.8
stitem.addActor(iconActor, { align: St.Align.END });
} else { // 3.10
stitem.label.set_x_expand(true);
stitem.actor.add(iconActor, { align: St.Align.END });
}
}
else
stitem = new PopupMenu.PopupMenuItem(label, { reactive: reactive });
if (visible)
stitem.actor.show();
else
stitem.actor.hide();
if (activate) {
stitem._dbusActivateId = stitem.connect('activate', Lang.bind(this, this._itemActivate));
//stitem._dbusHoverId = stitem.connect('active-changed', Lang.bind(this, this._itemHovered));
}
stitem._dbusId = id;
stitem.connect('destroy', Lang.bind(this, this._itemDestroy));
return stitem;
},
_itemUpdated: function (proxy, id) {
log(this.busName + this.path + " updating item "+id);
log("WARNING: this method is not specified in libdbusmenu (!?)");
this._readItem(id);
},
_itemsPropertiesUpdated: function (proxy, bus, [changed, removed]) {
//FIXME: the array structure is weird
for (var i = 0; i < changed.length; i++) {
var id = changed[i][0];
var properties = changed[i][1];
for (var property in properties) {
this._itemPropertyUpdated(proxy, id, property, properties[property].deep_unpack())
}
}
removed.forEach(function([id, properties]) {
properties.forEach(function(i) {
this._itemPropertyUpdated(proxy, id, i /*, undefined */);
}, this);
}, this);
},
_itemPropertyUpdated: function (proxy, id, property, value) {
if (!this._itemProperties[id]) {
//we don't have any properties yet, this means we don't even deal with the item
//we couldn't use the property data anyway, so we bail out here
return;
}
if (id != 0 && !this._items[id]) {
//property is updated but the item isn't even present.
//we'll build the item now.
this._replaceItem(id, true);
return;
}
this._itemProperties[id][property] = value;
if (id == 0) {
this._updateRoot();
return;
}
if (property == 'label')
this._items[id].label.text = value.replace(/_([^_])/, '$1');
else if (property == 'visible') {
if (typeof(value) == "undefined") value = true; //in case the property was deleted
if (value)
this._items[id].actor.show();
else
this._items[id].actor.hide();
} else if (property == 'enabled') {
if (typeof(value) == "undefined") value = true; //in case the property was deleted, default = true
let item = this._items[id];
item.setSensitive(value);
if (value) {
if(!item._dbusActivateId)
item._dbusActivateId = item.connect('activate', Lang.bind(this, this._itemActivate));
//if(!item._dbusHoverId)
// item._dbusHoverId = item.connect('active-changed', Lang.bind(this, this._itemHovered));
} else {
if (item._dbusActivateId) {
item.disconnect(item._dbusActivateId);
item._dbusActivateId = 0;
}
//if (item._dbusHoverId) {
// item.disconnect(item._dbusHoverId);
// item._dbusHoverId = 0;
//}
}
} else if (property == 'toggle-state') {
if (this._items[id].setToggleState) {
this._items[id].setToggleState(value);
} else {
if (stitem.setShowDot) { // GS 3.8
stitem.setShowDot(toggle_state);
} else { // GS 3.10
stitem.setOrnament(toggle_state ? PopupMenu.Ornament.DOT : PopupMenu.Ornament.NONE);
}
}
} else if (property == 'icon-name' && this._items[id].setIcon)
this._items[id].setIcon(value);
else if (this._parents[id]) // element is already on a layout
this._replaceItem(this._parents[id], true);
},
_layoutUpdated: function(proxy, bus, [revision, subtree]) {
log("appindicator: layout updated for node "+subtree);
if (revision <= this._revision)
return;
this._readLayout(subtree);
},
_itemDestroy: function(item) {
delete this._items[item._dbusId];
if (item._dbusActivateId) {
item.disconnect(item._dbusActivateId);
item._dbusActivateId = 0;
}
if (item._dbusHoverId) {
item.disconnect(item._dbusHoverId);
item._dbusHoverId = 0;
}
if (item.menu && item._dbusOpeningId) {
item.menu.disconnect(item._dbusOpeningId);
item._dbusOpeningId = 0;
}
},
_itemActivate: function(item, event) {
// we emit clicked also for keyboard activation
// XXX: what is event specific data?
this._proxy.EventRemote(item._dbusId, 'clicked', GLib.Variant.new("s", ""), event.get_time());
},
/* FIXME: apparently this is not correct
_itemHovered: function(item, active) {
// we emit hovered also for keyboard selection
if (active) {
this._proxy.EventRemote(item._dbusId, 'hovered', '', 0);
}
},
*/
_updateRoot: function() {
let properties = this._itemProperties[0];
this.title = properties['label'];
this.active = properties['enabled'];
this.visible = properties['visible'];
this.emit('root-changed');
},
destroyDbusMenu: function() {
this._GCItems();
Signals._disconnectAll.apply(this._proxy);
delete this._proxy;
},
open: function() {
//HACK: We already opened the menu once and called AboutToShow, but Skype doesn't seem to be interested
// in exposing the whole menu at construction time, so we need to send AboutToShow again.
this._conserved.open.apply(this);
this._proxy.AboutToShowRemote(0, (function(result, error) {
if (result) this._readLayout(0);
}).bind(this));
}
}
});
|