This repository has been archived by the owner on Feb 26, 2022. It is now read-only.
/
context-menu.js
1099 lines (902 loc) · 31 KB
/
context-menu.js
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
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
module.metadata = {
"stability": "stable"
};
const { Class, mix } = require("./core/heritage");
const { addCollectionProperty } = require("./util/collection");
const { ns } = require("./core/namespace");
const { validateOptions, getTypeOf } = require("./deprecated/api-utils");
const { URL } = require("./url");
const { WindowTracker, browserWindowIterator } = require("./deprecated/window-utils");
const { isBrowser } = require("./window/utils");
const { Ci } = require("chrome");
const { MatchPattern } = require("./page-mod/match-pattern");
const { Worker } = require("./content/worker");
const { EventTarget } = require("./event/target");
const { emit } = require('./event/core');
const { when } = require('./system/unload');
// All user items we add have this class.
const ITEM_CLASS = "addon-context-menu-item";
// Items in the top-level context menu also have this class.
const TOPLEVEL_ITEM_CLASS = "addon-context-menu-item-toplevel";
// Items in the overflow submenu also have this class.
const OVERFLOW_ITEM_CLASS = "addon-context-menu-item-overflow";
// The class of the menu separator that separates standard context menu items
// from our user items.
const SEPARATOR_CLASS = "addon-context-menu-separator";
// If more than this number of items are added to the context menu, all items
// overflow into a "Jetpack" submenu.
const OVERFLOW_THRESH_DEFAULT = 10;
const OVERFLOW_THRESH_PREF =
"extensions.addon-sdk.context-menu.overflowThreshold";
// The label of the overflow sub-xul:menu.
//
// TODO: Localize this.
const OVERFLOW_MENU_LABEL = "Add-ons";
// The class of the overflow sub-xul:menu.
const OVERFLOW_MENU_CLASS = "addon-content-menu-overflow-menu";
// The class of the overflow submenu's xul:menupopup.
const OVERFLOW_POPUP_CLASS = "addon-content-menu-overflow-popup";
//These are used by PageContext.isCurrent below. If the popupNode or any of
//its ancestors is one of these, Firefox uses a tailored context menu, and so
//the page context doesn't apply.
const NON_PAGE_CONTEXT_ELTS = [
Ci.nsIDOMHTMLAnchorElement,
Ci.nsIDOMHTMLAppletElement,
Ci.nsIDOMHTMLAreaElement,
Ci.nsIDOMHTMLButtonElement,
Ci.nsIDOMHTMLCanvasElement,
Ci.nsIDOMHTMLEmbedElement,
Ci.nsIDOMHTMLImageElement,
Ci.nsIDOMHTMLInputElement,
Ci.nsIDOMHTMLMapElement,
Ci.nsIDOMHTMLMediaElement,
Ci.nsIDOMHTMLMenuElement,
Ci.nsIDOMHTMLObjectElement,
Ci.nsIDOMHTMLOptionElement,
Ci.nsIDOMHTMLSelectElement,
Ci.nsIDOMHTMLTextAreaElement,
];
// Holds private properties for API objects
let internal = ns();
function getScheme(spec) {
try {
return URL(spec).scheme;
}
catch(e) {
return null;
}
}
let Context = Class({
// Returns the node that made this context current
adjustPopupNode: function adjustPopupNode(popupNode) {
return popupNode;
},
// Returns whether this context is current for the current node
isCurrent: function isCurrent(popupNode) {
return false;
}
});
// Matches when the context-clicked node doesn't have any of
// NON_PAGE_CONTEXT_ELTS in its ancestors
let PageContext = Class({
extends: Context,
isCurrent: function isCurrent(popupNode) {
// If there is a selection in the window then this context does not match
if (!popupNode.ownerDocument.defaultView.getSelection().isCollapsed)
return false;
// If the clicked node or any of its ancestors is one of the blacklisted
// NON_PAGE_CONTEXT_ELTS then this context does not match
while (!(popupNode instanceof Ci.nsIDOMDocument)) {
if (NON_PAGE_CONTEXT_ELTS.some(function(type) popupNode instanceof type))
return false;
popupNode = popupNode.parentNode;
}
return true;
}
});
exports.PageContext = PageContext;
// Matches when there is an active selection in the window
let SelectionContext = Class({
extends: Context,
isCurrent: function isCurrent(popupNode) {
if (!popupNode.ownerDocument.defaultView.getSelection().isCollapsed)
return true;
try {
// The node may be a text box which has selectionStart and selectionEnd
// properties. If not this will throw.
let { selectionStart, selectionEnd } = popupNode;
return !isNaN(selectionStart) && !isNaN(selectionEnd) &&
selectionStart !== selectionEnd;
}
catch (e) {
return false;
}
}
});
exports.SelectionContext = SelectionContext;
// Matches when the context-clicked node or any of its ancestors matches the
// selector given
let SelectorContext = Class({
extends: Context,
initialize: function initialize(selector) {
let options = validateOptions({ selector: selector }, {
selector: {
is: ["string"],
msg: "selector must be a string."
}
});
internal(this).selector = options.selector;
},
adjustPopupNode: function adjustPopupNode(popupNode) {
let selector = internal(this).selector;
while (!(popupNode instanceof Ci.nsIDOMDocument)) {
if (popupNode.mozMatchesSelector(selector))
return popupNode;
popupNode = popupNode.parentNode;
}
return null;
},
isCurrent: function isCurrent(popupNode) {
return !!this.adjustPopupNode(popupNode);
}
});
exports.SelectorContext = SelectorContext;
// Matches when the page url matches any of the patterns given
let URLContext = Class({
extends: Context,
initialize: function initialize(patterns) {
patterns = Array.isArray(patterns) ? patterns : [patterns];
try {
internal(this).patterns = patterns.map(function (p) new MatchPattern(p));
}
catch (err) {
throw new Error("Patterns must be a string, regexp or an array of " +
"strings or regexps: " + err);
}
},
isCurrent: function isCurrent(popupNode) {
let url = popupNode.ownerDocument.URL;
return internal(this).patterns.some(function (p) p.test(url));
}
});
exports.URLContext = URLContext;
function removeItemFromArray(array, item) {
return array.filter(function(i) i !== item);
}
// Shared option validation rules for Item and Menu
let baseItemRules = {
parentMenu: {
is: ["object", "undefined"],
ok: function (v) {
if (!v)
return true;
return (v instanceof ItemContainer) || (v instanceof Menu);
},
msg: "parentMenu must be a Menu or not specified."
},
context: {
is: ["undefined", "object", "array"],
ok: function (v) {
if (!v)
return true;
let arr = Array.isArray(v) ? v : [v];
return arr.every(function (o) o instanceof Context);
},
msg: "The 'context' option must be a Context object or an array of " +
"Context objects."
},
contentScript: {
is: ["string", "array", "undefined"],
ok: function (v) {
return !Array.isArray(v) ||
v.every(function (s) typeof(s) === "string");
}
},
contentScriptFile: {
is: ["string", "array", "undefined"],
ok: function (v) {
if (!v)
return true;
let arr = Array.isArray(v) ? v : [v];
return arr.every(function (s) {
return getTypeOf(s) === "string" &&
getScheme(s) === 'resource';
});
},
msg: "The 'contentScriptFile' option must be a local file URL or " +
"an array of local file URLs."
},
onMessage: {
is: ["function", "undefined"]
}
};
let labelledItemRules = mix(baseItemRules, {
label: {
map: String,
is: ["string"],
ok: function (v) !!v,
msg: "The item must have a non-empty string label."
},
image: {
map: String,
is: ["string", "undefined", "null"]
}
});
// Additional validation rules for Item
let itemRules = mix(labelledItemRules, {
data: {
map: String,
is: ["string", "undefined"]
}
});
// Additional validation rules for Menu
let menuRules = mix(labelledItemRules, {
items: {
is: ["array", "undefined"],
ok: function (v) {
if (!v)
return true;
return v.every(function (item) {
return item instanceof BaseItem;
});
},
msg: "items must be an array, and each element in the array must be an " +
"Item, Menu, or Separator."
}
});
let ContextWorker = Worker.compose({
//Returns true if any context listeners are defined in the worker's port.
anyContextListeners: function anyContextListeners() {
return this._contentWorker.hasListenerFor("context");
},
// Calls the context workers context listeners and returns the first result
// that is either a string or a value that evaluates to true. If all of the
// listeners returned false then returns false. If there are no listeners
// then returns null.
getMatchedContext: function getCurrentContexts(popupNode) {
let results = this._contentWorker.emitSync("context", popupNode);
return results.reduce(function(val, result) val || result, null);
},
// Emits a click event in the worker's port. popupNode is the node that was
// context-clicked, and clickedItemData is the data of the item that was
// clicked.
fireClick: function fireClick(popupNode, clickedItemData) {
this._contentWorker.emitSync("click", popupNode, clickedItemData);
}
});
// Returns true if any contexts match. If there are no contexts then a
// PageContext is tested instead
function hasMatchingContext(contexts, popupNode) {
for (let context in contexts) {
if (!context.isCurrent(popupNode))
return false;
}
return true;
}
// Gets the matched context from any worker for this item. If there is no worker
// or no matched context then returns null.
function getCurrentWorkerContext(item, popupNode) {
let worker = getItemWorkerForWindow(item, popupNode.ownerDocument.defaultView);
if (!worker)
return null;
return worker.getMatchedContext(popupNode);
}
// Tests whether an item should be visible or not based on its contexts and
// content scripts
function isItemVisible(item, popupNode, defaultVisibility) {
if (!item.context.length) {
let worker = getItemWorkerForWindow(item, popupNode.ownerDocument.defaultView);
if (!worker || !worker.anyContextListeners())
return defaultVisibility;
}
if (!hasMatchingContext(item.context, popupNode))
return false;
let context = getCurrentWorkerContext(item, popupNode);
if (typeof(context) === "string")
item.label = context;
return context !== false;
}
// Destroys any item's content scripts workers associated with the given window
function destroyItemWorkerForWindow(item, window) {
let worker = internal(item).workerMap.get(window);
if (worker)
worker.destroy();
internal(item).workerMap.delete(window);
}
// Gets the item's content script worker for a window, creating one if necessary
// Once created it will be automatically destroyed when the window unloads.
// If there is not content scripts for the item then null will be returned.
function getItemWorkerForWindow(item, window) {
if (!item.contentScript && !item.contentScriptFile)
return null;
let worker = internal(item).workerMap.get(window);
if (worker)
return worker;
worker = ContextWorker({
window: window,
contentScript: item.contentScript,
contentScriptFile: item.contentScriptFile,
onMessage: function(msg) {
emit(item, "message", msg);
},
onDetach: function() {
destroyItemWorkerForWindow(item, window);
}
});
internal(item).workerMap.set(window, worker);
return worker;
}
// Called when an item is clicked to send out click events to the content
// scripts
function itemClicked(item, clickedItem, popupNode) {
let worker = getItemWorkerForWindow(item, popupNode.ownerDocument.defaultView);
if (worker) {
let adjustedNode = popupNode;
for (let context in item.context)
adjustedNode = context.adjustPopupNode(adjustedNode);
worker.fireClick(adjustedNode, clickedItem.data);
}
if (item.parentMenu)
itemClicked(item.parentMenu, clickedItem, popupNode);
}
// All things that appear in the context menu extend this
let BaseItem = Class({
initialize: function initialize() {
addCollectionProperty(this, "context");
// Used to cache content script workers and the windows they have been
// created for
internal(this).workerMap = new Map();
if ("context" in internal(this).options && internal(this).options.context) {
let contexts = internal(this).options.context;
if (Array.isArray(contexts)) {
for (let context of contexts)
this.context.add(context);
}
else {
this.context.add(contexts);
}
}
let parentMenu = internal(this).options.parentMenu;
if (!parentMenu)
parentMenu = contentContextMenu;
parentMenu.addItem(this);
Object.defineProperty(this, "contentScript", {
enumerable: true,
value: internal(this).options.contentScript
});
Object.defineProperty(this, "contentScriptFile", {
enumerable: true,
value: internal(this).options.contentScriptFile
});
},
destroy: function destroy() {
if (this.parentMenu)
this.parentMenu.removeItem(this);
},
get parentMenu() {
return internal(this).parentMenu;
},
});
// All things that have a label on the context menu extend this
let LabelledItem = Class({
extends: BaseItem,
implements: [ EventTarget ],
initialize: function initialize(options) {
BaseItem.prototype.initialize.call(this);
EventTarget.prototype.initialize.call(this, options);
},
destroy: function destroy() {
for (let [window] of internal(this).workerMap)
destroyItemWorkerForWindow(this, window);
BaseItem.prototype.destroy.call(this);
},
get label() {
return internal(this).options.label;
},
set label(val) {
internal(this).options.label = val;
MenuManager.updateItem(this);
},
get image() {
return internal(this).options.image;
},
set image(val) {
internal(this).options.image = val;
MenuManager.updateItem(this);
},
get data() {
return internal(this).options.data;
},
set data(val) {
internal(this).options.data = val;
}
});
let Item = Class({
extends: LabelledItem,
initialize: function initialize(options) {
internal(this).options = validateOptions(options, itemRules);
LabelledItem.prototype.initialize.call(this, options);
},
toString: function toString() {
return "[object Item \"" + this.label + "\"]";
},
get data() {
return internal(this).options.data;
},
set data(val) {
internal(this).options.data = val;
MenuManager.updateItem(this);
},
});
exports.Item = Item;
let ItemContainer = Class({
initialize: function initialize() {
internal(this).children = [];
},
destroy: function destroy() {
// Destroys the entire hierarchy
for (let item of internal(this).children)
item.destroy();
},
addItem: function addItem(item) {
let oldParent = item.parentMenu;
// Don't just call removeItem here as that would remove the corresponding
// UI element which is more costly than just moving it to the right place
if (oldParent)
internal(oldParent).children = removeItemFromArray(internal(oldParent).children, item);
let after = null;
let children = internal(this).children;
if (children.length > 0)
after = children[children.length - 1];
children.push(item);
internal(item).parentMenu = this;
// If there was an old parent then we just have to move the item, otherwise
// it needs to be created
if (oldParent)
MenuManager.moveItem(item, after);
else
MenuManager.createItem(item, after);
},
removeItem: function removeItem(item) {
// If the item isn't a child of this menu then ignore this call
if (item.parentMenu !== this)
return;
MenuManager.removeItem(item);
internal(this).children = removeItemFromArray(internal(this).children, item);
internal(item).parentMenu = null;
},
get items() {
return internal(this).children.slice(0);
},
set items(val) {
// Validate the arguments before making any changes
if (!Array.isArray(val))
throw new Error(menuOptionRules.items.msg);
for (let item of val) {
if (!(item instanceof BaseItem))
throw new Error(menuOptionRules.items.msg);
}
// Remove the old items and add the new ones
for (let item of internal(this).children)
this.removeItem(item);
for (let item of val)
this.addItem(item);
},
});
let Menu = Class({
extends: LabelledItem,
implements: [ItemContainer],
initialize: function initialize(options) {
internal(this).options = validateOptions(options, menuRules);
LabelledItem.prototype.initialize.call(this, options);
ItemContainer.prototype.initialize.call(this);
if (internal(this).options.items) {
for (let item of internal(this).options.items)
this.addItem(item);
}
},
destroy: function destroy() {
ItemContainer.prototype.destroy.call(this);
LabelledItem.prototype.destroy.call(this);
},
toString: function toString() {
return "[object Menu \"" + this.label + "\"]";
},
});
exports.Menu = Menu;
let Separator = Class({
extends: BaseItem,
initialize: function initialize(options) {
internal(this).options = validateOptions(options, baseItemRules);
BaseItem.prototype.initialize.call(this);
},
toString: function toString() {
return "[object Separator]";
}
});
exports.Separator = Separator;
// Holds items for the content area context menu
let contentContextMenu = ItemContainer();
exports.contentContextMenu = contentContextMenu;
when(function() {
contentContextMenu.destroy();
});
// App specific UI code lives here, it should handle populating the context
// menu and passing clicks etc. through to the items.
let MenuWrapper = Class({
initialize: function initialize(winWrapper, items, contextMenu) {
this.winWrapper = winWrapper;
this.window = winWrapper.window;
this.items = items;
this.contextMenu = contextMenu;
this.populated = false;
this.menuMap = new Map();
this.contextMenu.addEventListener("popupshowing", this, false);
},
destroy: function destroy() {
this.contextMenu.removeEventListener("popupshowing", this, false);
if (!this.populated)
return;
// If we're getting unloaded at runtime then we must remove all the
// generated XUL nodes
let oldParent = null;
for (let item of internal(this.items).children) {
let xulNode = this.getXULNodeForItem(item);
oldParent = xulNode.parentNode;
oldParent.removeChild(xulNode);
}
if (oldParent)
this.onXULRemoved(oldParent);
},
get separator() {
return this.contextMenu.querySelector("." + SEPARATOR_CLASS);
},
get overflowMenu() {
return this.contextMenu.querySelector("." + OVERFLOW_MENU_CLASS);
},
get overflowPopup() {
return this.contextMenu.querySelector("." + OVERFLOW_POPUP_CLASS);
},
get topLevelItems() {
return this.contextMenu.querySelectorAll("." + TOPLEVEL_ITEM_CLASS);
},
get overflowItems() {
return this.contextMenu.querySelectorAll("." + OVERFLOW_ITEM_CLASS + " > ." + ITEM_CLASS);
},
getXULNodeForItem: function getXULNodeForItem(item) {
return this.menuMap.get(item);
},
// Recurses through the item hierarchy creating XUL nodes for everything
populate: function populate(menu) {
for (let i = 0; i < internal(menu).children.length; i++) {
let item = internal(menu).children[i];
let after = i === 0 ? null : internal(menu).children[i - 1];
this.createItem(item, after);
if (item instanceof Menu)
this.populate(item);
}
},
// Recurses through the menu setting the visibility of items. Returns true
// if any of the items in this menu were visible
setVisibility: function setVisibility(menu, popupNode, defaultVisibility) {
let anyVisible = false;
for (let item of internal(menu).children) {
let visible = isItemVisible(item, popupNode, defaultVisibility);
// Recurse through Menus, if none of the sub-items were visible then the
// menu is hidden too.
if (visible && (item instanceof Menu))
visible = this.setVisibility(item, popupNode, true);
let xulNode = this.getXULNodeForItem(item);
xulNode.hidden = !visible;
anyVisible = anyVisible || visible;
}
return anyVisible;
},
// Works out where to insert a XUL node for an item in a browser window
insertIntoXUL: function insertIntoXUL(item, node, after) {
let menupopup = null;
let before = null;
let menu = item.parentMenu;
if (menu === this.items) {
menupopup = this.overflowPopup;
// If there isn't already an overflow menu then check if we need to
// create one, otherwise use the main context menu
if (!menupopup) {
menupopup = this.contextMenu;
let toplevel = this.topLevelItems;
if (toplevel.length >= MenuManager.overflowThreshold) {
// Create the overflow menu and move everything there
let overflowMenu = this.window.document.createElement("menu");
overflowMenu.setAttribute("class", OVERFLOW_MENU_CLASS);
overflowMenu.setAttribute("label", OVERFLOW_MENU_LABEL);
this.contextMenu.insertBefore(overflowMenu, this.separator.nextSibling);
menupopup = this.window.document.createElement("menupopup");
menupopup.setAttribute("class", OVERFLOW_POPUP_CLASS);
overflowMenu.appendChild(menupopup);
for (let xulNode of toplevel) {
menupopup.appendChild(xulNode);
this.updateXULClass(xulNode);
}
}
}
}
else {
let xulNode = this.getXULNodeForItem(menu);
menupopup = xulNode.firstChild;
}
if (after) {
let afterNode = this.getXULNodeForItem(after);
before = afterNode.nextSibling;
}
else if (menupopup === this.contextMenu) {
let topLevel = this.topLevelItems;
if (topLevel.length > 0)
before = topLevel[topLevel.length - 1].nextSibling;
else
before = this.separator.nextSibling;
}
menupopup.insertBefore(node, before);
},
// Sets the right class for XUL nodes
updateXULClass: function updateXULClass(xulNode) {
if (xulNode.parentNode == this.contextMenu)
xulNode.classList.add(TOPLEVEL_ITEM_CLASS);
else
xulNode.classList.remove(TOPLEVEL_ITEM_CLASS);
if (xulNode.parentNode == this.overflowPopup)
xulNode.classList.add(OVERFLOW_ITEM_CLASS);
else
xulNode.classList.remove(OVERFLOW_ITEM_CLASS);
},
// Creates a XUL node for an item
createItem: function createItem(item, after) {
if (!this.populated)
return;
// Create the separator if it doesn't already exist
if (!this.separator) {
let separator = this.window.document.createElement("menuseparator");
separator.setAttribute("class", SEPARATOR_CLASS);
this.contextMenu.appendChild(separator);
}
let type = "menuitem";
if (item instanceof Menu)
type = "menu";
else if (item instanceof Separator)
type = "menuseparator";
let xulNode = this.window.document.createElement(type);
xulNode.setAttribute("class", ITEM_CLASS);
if (item instanceof LabelledItem) {
xulNode.setAttribute("label", item.label);
if (item.image) {
xulNode.setAttribute("image", item.image);
if (item instanceof Menu)
xulNode.classList.add("menu-iconic");
else
xulNode.classList.add("menuitem-iconic");
}
if (item.data)
xulNode.setAttribute("value", item.data);
let self = this;
xulNode.addEventListener("click", function(event) {
// Only care about clicks directly on this item
if (event.target !== xulNode)
return;
itemClicked(item, item, self.contextMenu.triggerNode);
}, false);
}
this.insertIntoXUL(item, xulNode, after);
this.updateXULClass(xulNode);
xulNode.data = item.data;
if (item instanceof Menu) {
let menupopup = this.window.document.createElement("menupopup");
xulNode.appendChild(menupopup);
}
this.menuMap.set(item, xulNode);
},
// Updates the XUL node for an item in this window
updateItem: function updateItem(item) {
if (!this.populated)
return;
let xulNode = this.getXULNodeForItem(item);
// TODO figure out why this requires setAttribute
xulNode.setAttribute("label", item.label);
if (item.image) {
xulNode.setAttribute("image", item.image);
if (item instanceof Menu)
xulNode.classList.add("menu-iconic");
else
xulNode.classList.add("menuitem-iconic");
}
else {
xulNode.removeAttribute("image");
xulNode.classList.remove("menu-iconic");
xulNode.classList.remove("menuitem-iconic");
}
if (item.data)
xulNode.setAttribute("value", item.data);
else
xulNode.removeAttribute("value");
},
// Moves the XUL node for an item in this window to its new place in the
// hierarchy
moveItem: function moveItem(item, after) {
if (!this.populated)
return;
let xulNode = this.getXULNodeForItem(item);
let oldParent = xulNode.parentNode;
this.insertIntoXUL(item, xulNode, after);
this.updateXULClass(xulNode);
this.onXULRemoved(oldParent);
},
// Removes the XUL nodes for an item in every window we've ever populated.
removeItem: function removeItem(item) {
if (!this.populated)
return;
let xulItem = this.getXULNodeForItem(item);
let oldParent = xulItem.parentNode;
oldParent.removeChild(xulItem);
this.menuMap.delete(item);
this.onXULRemoved(oldParent);
},
// Called when any XUL nodes have been removed from a menupopup. This handles
// making sure the separator and overflow are correct
onXULRemoved: function onXULRemoved(parent) {
if (parent == this.contextMenu) {
let toplevel = this.topLevelItems;
// If there are no more items then remove the separator
if (toplevel.length == 0) {
let separator = this.separator;
if (separator)
separator.parentNode.removeChild(separator);
}
}
else if (parent == this.overflowPopup) {
if (parent.childNodes.length == 0) {
// It's possible that this add-on had all the items in the overflow
// menu and they're now all gone, so remove the separator and overflow
// menu directly
let separator = this.separator;
separator.parentNode.removeChild(separator);
this.contextMenu.removeChild(parent.parentNode);
}
else if (parent.childNodes.length <= MenuManager.overflowThreshold) {
// Otherwise if the overflow menu is empty enough move everything in
// the overflow menu back to top level and remove the overflow menu
while (parent.firstChild) {
let node = parent.firstChild;
this.contextMenu.insertBefore(node, parent.parentNode);
this.updateXULClass(node);
}
this.contextMenu.removeChild(parent.parentNode);
}
}
},
handleEvent: function handleEvent(event) {
try {
if (event.type != "popupshowing")
return;
if (event.target != this.contextMenu)
return;
if (internal(this.items).children.length == 0)
return;
if (!this.populated) {
this.populated = true;
this.populate(this.items);
}
let separator = this.separator;
let popup = this.overflowMenu;
let popupNode = event.target.triggerNode;
if (this.setVisibility(this.items, popupNode, PageContext().isCurrent(popupNode))) {
// Some of this instance's items are visible so make sure the separator
// and if necessary the overflow popup are visible
separator.hidden = false;
if (popup)
popup.hidden = false;
}
else {
// We need to test whether any other instance has visible items.
// Get all the highest level items and see if any are visible.
let anyVisible = (Array.some(this.topLevelItems, function(item) !item.hidden)) ||
(Array.some(this.overflowItems, function(item) !item.hidden));
// If any were visible make sure the separator and if necessary the
// overflow popup are visible, otherwise hide them
separator.hidden = !anyVisible;
if (popup)
popup.hidden = !anyVisible;
}
}
catch (e) {
console.exception(e);
}
}
});
// This wraps every window that we've seen
let WindowWrapper = Class({
initialize: function initialize(window) {
this.window = window;