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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
|
/* 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/. */
// This file is loaded into the browser window scope.
/* eslint-env mozilla/browser-window */
XPCOMUtils.defineLazyPreferenceGetter(
this,
"NEWTAB_ENABLED",
"browser.newtabpage.enabled",
false
);
XPCOMUtils.defineLazyPreferenceGetter(
this,
"SHOW_OTHER_BOOKMARKS",
"browser.toolbars.bookmarks.showOtherBookmarks",
true,
() => {
BookmarkingUI.maybeShowOtherBookmarksFolder().then(() => {
document
.getElementById("PlacesToolbar")
?._placesView?.updateNodesVisibility();
}, console.error);
}
);
ChromeUtils.defineESModuleGetters(this, {
PanelMultiView: "resource:///modules/PanelMultiView.sys.mjs",
RecentlyClosedTabsAndWindowsMenuUtils:
"resource:///modules/sessionstore/RecentlyClosedTabsAndWindowsMenuUtils.sys.mjs",
});
var StarUI = {
userHasTags: undefined,
_itemGuids: null,
_isNewBookmark: false,
_isComposing: false,
_autoCloseTimer: 0,
// The autoclose timer is diasbled if the user interacts with the
// popup, such as making a change through typing or clicking on
// the popup.
_autoCloseTimerEnabled: true,
// The autoclose timeout length. 3500ms matches the timeout that Pocket uses
// in browser/components/pocket/content/panels/js/saved.js.
_autoCloseTimeout: 3500,
_removeBookmarksOnPopupHidden: false,
_element(aID) {
return document.getElementById(aID);
},
// Edit-bookmark panel
get panel() {
delete this.panel;
this._createPanelIfNeeded();
var element = this._element("editBookmarkPanel");
// initially the panel is hidden
// to avoid impacting startup / new window performance
element.hidden = false;
element.addEventListener("keypress", this, { mozSystemGroup: true });
element.addEventListener("mousedown", this);
element.addEventListener("mouseout", this);
element.addEventListener("mousemove", this);
element.addEventListener("compositionstart", this);
element.addEventListener("compositionend", this);
element.addEventListener("input", this);
element.addEventListener("popuphidden", this);
element.addEventListener("popupshown", this);
return (this.panel = element);
},
// nsIDOMEventListener
handleEvent(aEvent) {
switch (aEvent.type) {
case "mousemove":
clearTimeout(this._autoCloseTimer);
// The autoclose timer is not disabled on generic mouseout
// because the user may not have actually interacted with the popup.
break;
case "popuphidden": {
clearTimeout(this._autoCloseTimer);
if (aEvent.originalTarget == this.panel) {
this._handlePopupHiddenEvent().catch(console.error);
}
break;
}
case "keypress":
clearTimeout(this._autoCloseTimer);
this._autoCloseTimerEnabled = false;
if (aEvent.defaultPrevented) {
// The event has already been consumed inside of the panel.
break;
}
switch (aEvent.keyCode) {
case KeyEvent.DOM_VK_ESCAPE:
if (this._isNewBookmark) {
this._removeBookmarksOnPopupHidden = true;
}
this.panel.hidePopup();
break;
case KeyEvent.DOM_VK_RETURN:
if (
aEvent.target.classList.contains("expander-up") ||
aEvent.target.classList.contains("expander-down") ||
aEvent.target.id == "editBMPanel_newFolderButton" ||
aEvent.target.id == "editBookmarkPanelRemoveButton"
) {
// XXX Why is this necessary? The defaultPrevented check should
// be enough.
break;
}
this.panel.hidePopup();
break;
// This case is for catching character-generating keypresses
case 0:
let accessKey = document.getElementById("key_close");
if (eventMatchesKey(aEvent, accessKey)) {
this.panel.hidePopup();
}
break;
}
break;
case "compositionend":
// After composition is committed, "mouseout" or something can set
// auto close timer.
this._isComposing = false;
break;
case "compositionstart":
if (aEvent.defaultPrevented) {
// If the composition was canceled, nothing to do here.
break;
}
this._isComposing = true;
// Explicit fall-through, during composition, panel shouldn't be hidden automatically.
case "input":
// Might have edited some text without keyboard events nor composition
// events. Fall-through to cancel auto close in such case.
case "mousedown":
clearTimeout(this._autoCloseTimer);
this._autoCloseTimerEnabled = false;
break;
case "mouseout":
if (!this._autoCloseTimerEnabled) {
// Don't autoclose the popup if the user has made a selection
// or keypress and then subsequently mouseout.
break;
}
// Explicit fall-through
case "popupshown":
// Don't handle events for descendent elements.
if (aEvent.target != aEvent.currentTarget) {
break;
}
// auto-close if new and not interacted with
if (this._isNewBookmark && !this._isComposing) {
let delay = this._autoCloseTimeout;
if (this._closePanelQuickForTesting) {
delay /= 10;
}
clearTimeout(this._autoCloseTimer);
this._autoCloseTimer = setTimeout(() => {
if (!this.panel.matches(":hover")) {
this.panel.hidePopup(true);
}
}, delay);
this._autoCloseTimerEnabled = true;
}
break;
}
},
/**
* Handle popup hidden event.
*/
async _handlePopupHiddenEvent() {
const { bookmarkState, didChangeFolder, selectedFolderGuid } =
gEditItemOverlay;
gEditItemOverlay.uninitPanel(true);
// Capture _removeBookmarksOnPopupHidden and _itemGuids values. Reset them
// before we handle the next popup.
const removeBookmarksOnPopupHidden = this._removeBookmarksOnPopupHidden;
this._removeBookmarksOnPopupHidden = false;
const guidsForRemoval = this._itemGuids;
this._itemGuids = null;
if (removeBookmarksOnPopupHidden && guidsForRemoval) {
if (!this._isNewBookmark) {
// Remove all bookmarks for the bookmark's url, this also removes
// the tags for the url.
await PlacesTransactions.Remove(guidsForRemoval).transact();
} else {
BookmarkingUI.star.removeAttribute("starred");
}
return;
}
await this._storeRecentlyUsedFolder(selectedFolderGuid, didChangeFolder);
await bookmarkState.save();
if (this._isNewBookmark) {
this.showConfirmation();
}
},
async showEditBookmarkPopup(aNode, aIsNewBookmark, aUrl) {
// Slow double-clicks (not true double-clicks) shouldn't
// cause the panel to flicker.
if (this.panel.state != "closed") {
return;
}
this._isNewBookmark = aIsNewBookmark;
this._itemGuids = null;
let titleL10nID = this._isNewBookmark
? "bookmarks-add-bookmark"
: "bookmarks-edit-bookmark";
document.l10n.setAttributes(
this._element("editBookmarkPanelTitle"),
titleL10nID
);
this._element("editBookmarkPanel_showForNewBookmarks").checked =
this.showForNewBookmarks;
this._itemGuids = [];
await PlacesUtils.bookmarks.fetch({ url: aUrl }, bookmark =>
this._itemGuids.push(bookmark.guid)
);
let removeButton = this._element("editBookmarkPanelRemoveButton");
if (this._isNewBookmark) {
document.l10n.setAttributes(removeButton, "bookmark-panel-cancel");
} else {
// The label of the remove button differs if the URI is bookmarked
// multiple times.
document.l10n.setAttributes(removeButton, "bookmark-panel-remove", {
count: this._itemGuids.length,
});
}
let onPanelReady = fn => {
let target = this.panel;
if (target.parentNode) {
// By targeting the panel's parent and using a capturing listener, we
// can have our listener called before others waiting for the panel to
// be shown (which probably expect the panel to be fully initialized)
target = target.parentNode;
}
target.addEventListener(
"popupshown",
function () {
fn();
},
{ capture: true, once: true }
);
};
let hiddenRows = ["location", "keyword"];
if (this.userHasTags === undefined) {
// Cache must be initialized
const fetchedTags = await PlacesUtils.bookmarks.fetchTags();
this.userHasTags = !!fetchedTags.length;
}
if (!this.userHasTags) {
// Hide tags ui because user has no tags defined
hiddenRows.push("tags");
}
await gEditItemOverlay.initPanel({
node: aNode,
onPanelReady,
hiddenRows,
focusedElement: "preferred",
isNewBookmark: this._isNewBookmark,
});
this.panel.openPopup(BookmarkingUI.anchor, "bottomright topright");
},
_createPanelIfNeeded() {
// Lazy load the editBookmarkPanel the first time we need to display it.
if (!this._element("editBookmarkPanel")) {
MozXULElement.insertFTLIfNeeded("browser/editBookmarkOverlay.ftl");
let template = this._element("editBookmarkPanelTemplate");
let clone = template.content.cloneNode(true);
template.replaceWith(clone);
}
},
removeBookmarkButtonCommand: function SU_removeBookmarkButtonCommand() {
this._removeBookmarksOnPopupHidden = true;
this.panel.hidePopup();
},
async _storeRecentlyUsedFolder(selectedFolderGuid, didChangeFolder) {
if (!selectedFolderGuid) {
return;
}
// If we're changing where a bookmark gets saved, persist that location.
if (didChangeFolder) {
Services.prefs.setCharPref(
"browser.bookmarks.defaultLocation",
selectedFolderGuid
);
}
// Don't store folders that are always displayed in "Recent Folders".
if (PlacesUtils.bookmarks.userContentRoots.includes(selectedFolderGuid)) {
return;
}
// List of recently used folders:
let lastUsedFolderGuids = await PlacesUtils.metadata.get(
PlacesUIUtils.LAST_USED_FOLDERS_META_KEY,
[]
);
let index = lastUsedFolderGuids.indexOf(selectedFolderGuid);
if (index > 1) {
// The guid is in the array but not the most recent.
lastUsedFolderGuids.splice(index, 1);
lastUsedFolderGuids.unshift(selectedFolderGuid);
} else if (index == -1) {
lastUsedFolderGuids.unshift(selectedFolderGuid);
}
while (lastUsedFolderGuids.length > PlacesUIUtils.maxRecentFolders) {
lastUsedFolderGuids.pop();
}
await PlacesUtils.metadata.set(
PlacesUIUtils.LAST_USED_FOLDERS_META_KEY,
lastUsedFolderGuids
);
},
onShowForNewBookmarksCheckboxCommand() {
Services.prefs.setBoolPref(
"browser.bookmarks.editDialog.showForNewBookmarks",
this._element("editBookmarkPanel_showForNewBookmarks").checked
);
},
showConfirmation() {
// Show the "Saved to bookmarks" hint for the first three times
const HINT_COUNT_PREF =
"browser.bookmarks.editDialog.confirmationHintShowCount";
const HINT_COUNT = Services.prefs.getIntPref(HINT_COUNT_PREF, 0);
if (HINT_COUNT >= 3) {
return;
}
Services.prefs.setIntPref(HINT_COUNT_PREF, HINT_COUNT + 1);
let anchor;
if (window.toolbar.visible) {
for (let id of ["library-button", "bookmarks-menu-button"]) {
let element = document.getElementById(id);
if (
element &&
element.getAttribute("cui-areatype") != "panel" &&
element.getAttribute("overflowedItem") != "true"
) {
anchor = element;
break;
}
}
}
if (!anchor) {
anchor = document.getElementById("PanelUI-menu-button");
}
ConfirmationHint.show(anchor, "confirmation-hint-page-bookmarked");
},
};
XPCOMUtils.defineLazyPreferenceGetter(
StarUI,
"showForNewBookmarks",
"browser.bookmarks.editDialog.showForNewBookmarks"
);
var PlacesCommandHook = {
/**
* Adds a bookmark to the page loaded in the current browser.
*/
async bookmarkPage() {
let browser = gBrowser.selectedBrowser;
let url = URL.fromURI(Services.io.createExposableURI(browser.currentURI));
let info = await PlacesUtils.bookmarks.fetch({ url });
let isNewBookmark = !info;
let showEditUI = !isNewBookmark || StarUI.showForNewBookmarks;
if (isNewBookmark) {
// This is async because we have to validate the guid
// coming from prefs.
let parentGuid = await PlacesUIUtils.defaultParentGuid;
info = { url, parentGuid };
// Bug 1148838 - Make this code work for full page plugins.
let charset = null;
let isErrorPage = false;
if (browser.documentURI) {
isErrorPage = /^about:(neterror|certerror|blocked)/.test(
browser.documentURI.spec
);
}
try {
if (isErrorPage) {
let entry = await PlacesUtils.history.fetch(browser.currentURI);
if (entry) {
info.title = entry.title;
}
} else {
info.title = browser.contentTitle;
}
info.title = info.title || url.href;
charset = browser.characterSet;
} catch (e) {
console.error(e);
}
if (!StarUI.showForNewBookmarks) {
info.guid = await PlacesTransactions.NewBookmark(info).transact();
} else {
info.guid = PlacesUtils.bookmarks.unsavedGuid;
BookmarkingUI.star.setAttribute("starred", "true");
}
if (charset) {
PlacesUIUtils.setCharsetForPage(url, charset, window).catch(
console.error
);
}
}
// Revert the contents of the location bar
gURLBar.handleRevert();
// If it was not requested to open directly in "edit" mode, we are done.
if (!showEditUI) {
StarUI.showConfirmation();
return;
}
let node = await PlacesUIUtils.promiseNodeLikeFromFetchInfo(info);
await StarUI.showEditBookmarkPopup(node, isNewBookmark, url);
},
/**
* Adds a bookmark to the page targeted by a link.
* @param url (string)
* the address of the link target
* @param title
* The link text
*/
async bookmarkLink(url, title) {
let bm = await PlacesUtils.bookmarks.fetch({ url });
if (bm) {
let node = await PlacesUIUtils.promiseNodeLikeFromFetchInfo(bm);
await PlacesUIUtils.showBookmarkDialog(
{ action: "edit", node },
window.top
);
return;
}
let parentGuid = await PlacesUIUtils.defaultParentGuid;
let defaultInsertionPoint = new PlacesInsertionPoint({
parentGuid,
});
await PlacesUIUtils.showBookmarkDialog(
{
action: "add",
type: "bookmark",
uri: Services.io.newURI(url),
title,
defaultInsertionPoint,
hiddenRows: ["location", "keyword"],
},
window.top
);
},
/**
* Bookmarks the given tabs loaded in the current browser.
* @param {Array} tabs
* If no given tabs, bookmark all current tabs.
*/
async bookmarkTabs(tabs) {
tabs = tabs ?? gBrowser.visibleTabs.filter(tab => !tab.pinned);
let pages = PlacesCommandHook.getUniquePages(tabs).map(
// Bookmark exposable url.
page =>
Object.assign(page, { uri: Services.io.createExposableURI(page.uri) })
);
await PlacesUIUtils.showBookmarkPagesDialog(pages);
},
/**
* List of nsIURI objects characterizing tabs given in param.
* Duplicates are discarded.
*/
getUniquePages(tabs) {
let uniquePages = {};
let URIs = [];
tabs.forEach(tab => {
let browser = tab.linkedBrowser;
let uri = browser.currentURI;
let title = browser.contentTitle || tab.label;
let spec = uri.spec;
if (!(spec in uniquePages)) {
uniquePages[spec] = null;
URIs.push({ uri, title });
}
});
return URIs;
},
/**
* Opens the Places Organizer.
* @param {String} item The item to select in the organizer window,
* options are (case sensitive):
* BookmarksMenu, BookmarksToolbar, UnfiledBookmarks,
* AllBookmarks, History, Downloads.
*/
showPlacesOrganizer(item) {
var organizer = Services.wm.getMostRecentWindow("Places:Organizer");
// Due to bug 528706, getMostRecentWindow can return closed windows.
if (!organizer || organizer.closed) {
// No currently open places window, so open one with the specified mode.
openDialog(
"chrome://browser/content/places/places.xhtml",
"",
"chrome,toolbar=yes,dialog=no,resizable",
item
);
} else {
organizer.PlacesOrganizer.selectLeftPaneContainerByHierarchy(item);
organizer.focus();
}
},
async searchBookmarks() {
let win =
BrowserWindowTracker.getTopWindow() ??
(await BrowserWindowTracker.promiseOpenWindow());
win.gURLBar.search(UrlbarTokenizer.RESTRICT.BOOKMARK, {
searchModeEntry: "bookmarkmenu",
});
},
async searchHistory() {
let win =
BrowserWindowTracker.getTopWindow() ??
(await BrowserWindowTracker.promiseOpenWindow());
win.gURLBar.search(UrlbarTokenizer.RESTRICT.HISTORY, {
searchModeEntry: "historymenu",
});
},
};
// View for the history menu.
class HistoryMenu extends PlacesMenu {
constructor(aPopupShowingEvent) {
super(aPopupShowingEvent, "place:sort=4&maxResults=15");
}
// Called by the base class (PlacesViewBase) so we can initialize some
// element references before the several superclass constructors call our
// methods which depend on these.
_init() {
super._init();
let elements = {
undoTabMenu: "historyUndoMenu",
hiddenTabsMenu: "hiddenTabsMenu",
undoWindowMenu: "historyUndoWindowMenu",
syncTabsMenuitem: "sync-tabs-menuitem",
};
for (let [key, elemId] of Object.entries(elements)) {
this[key] = document.getElementById(elemId);
}
}
toggleHiddenTabs() {
const isShown =
window.gBrowser && gBrowser.visibleTabs.length < gBrowser.tabs.length;
this.hiddenTabsMenu.hidden = !isShown;
}
toggleRecentlyClosedTabs() {
// enable/disable the Recently Closed Tabs sub menu
// no restorable tabs, so disable menu
if (SessionStore.getClosedTabCount() == 0) {
this.undoTabMenu.setAttribute("disabled", true);
} else {
this.undoTabMenu.removeAttribute("disabled");
}
}
/**
* Populate when the history menu is opened
*/
populateUndoSubmenu() {
var undoPopup = this.undoTabMenu.menupopup;
// remove existing menu items
while (undoPopup.hasChildNodes()) {
undoPopup.firstChild.remove();
}
// no restorable tabs, so make sure menu is disabled, and return
if (SessionStore.getClosedTabCount() == 0) {
this.undoTabMenu.setAttribute("disabled", true);
return;
}
// enable menu
this.undoTabMenu.removeAttribute("disabled");
// populate menu
let tabsFragment = RecentlyClosedTabsAndWindowsMenuUtils.getTabsFragment(
window,
"menuitem",
/* aPrefixRestoreAll = */ false
);
undoPopup.appendChild(tabsFragment);
}
toggleRecentlyClosedWindows() {
// enable/disable the Recently Closed Windows sub menu
// no restorable windows, so disable menu
if (SessionStore.getClosedWindowCount() == 0) {
this.undoWindowMenu.setAttribute("disabled", true);
} else {
this.undoWindowMenu.removeAttribute("disabled");
}
}
/**
* Populate when the history menu is opened
*/
populateUndoWindowSubmenu() {
let undoPopup = this.undoWindowMenu.menupopup;
// remove existing menu items
while (undoPopup.hasChildNodes()) {
undoPopup.firstChild.remove();
}
// no restorable windows, so make sure menu is disabled, and return
if (SessionStore.getClosedWindowCount() == 0) {
this.undoWindowMenu.setAttribute("disabled", true);
return;
}
// enable menu
this.undoWindowMenu.removeAttribute("disabled");
// populate menu
let windowsFragment =
RecentlyClosedTabsAndWindowsMenuUtils.getWindowsFragment(
window,
"menuitem",
/* aPrefixRestoreAll = */ false
);
undoPopup.appendChild(windowsFragment);
}
toggleTabsFromOtherComputers() {
// Enable/disable the Tabs From Other Computers menu. Some of the menus handled
// by HistoryMenu do not have this menuitem.
if (!this.syncTabsMenuitem) {
return;
}
if (!PlacesUIUtils.shouldShowTabsFromOtherComputersMenuitem()) {
this.syncTabsMenuitem.hidden = true;
return;
}
this.syncTabsMenuitem.hidden = false;
}
_onPopupShowing(aEvent) {
super._onPopupShowing(aEvent);
// Don't handle events for submenus.
if (aEvent.target != aEvent.currentTarget) {
return;
}
this.toggleHiddenTabs();
this.toggleRecentlyClosedTabs();
this.toggleRecentlyClosedWindows();
this.toggleTabsFromOtherComputers();
}
_onCommand(aEvent) {
aEvent = getRootEvent(aEvent);
let placesNode = aEvent.target._placesNode;
if (placesNode) {
if (!PrivateBrowsingUtils.isWindowPrivate(window)) {
PlacesUIUtils.markPageAsTyped(placesNode.uri);
}
openUILink(placesNode.uri, aEvent, {
ignoreAlt: true,
triggeringPrincipal:
Services.scriptSecurityManager.getSystemPrincipal(),
});
}
}
}
/**
* Functions for handling events in the Bookmarks Toolbar and menu.
*/
var BookmarksEventHandler = {
/**
* Handler for click event for an item in the bookmarks toolbar or menu.
* Menus and submenus from the folder buttons bubble up to this handler.
* Left-click is handled in the onCommand function.
* When items are middle-clicked (or clicked with modifier), open in tabs.
* If the click came through a menu, close the menu.
* @param aEvent
* DOMEvent for the click
* @param aView
* The places view which aEvent should be associated with.
*/
onMouseUp(aEvent) {
// Handles middle-click or left-click with modifier if not browser.bookmarks.openInTabClosesMenu.
if (aEvent.button == 2 || PlacesUIUtils.openInTabClosesMenu) {
return;
}
let target = aEvent.originalTarget;
if (target.tagName != "menuitem") {
return;
}
let modifKey =
AppConstants.platform === "macosx" ? aEvent.metaKey : aEvent.ctrlKey;
if (modifKey || aEvent.button == 1) {
target.setAttribute("closemenu", "none");
var menupopup = target.parentNode;
menupopup.addEventListener(
"popuphidden",
() => {
target.removeAttribute("closemenu");
},
{ once: true }
);
} else {
// Handles edge case where same menuitem was opened previously
// while menu was kept open, but now menu should close.
target.removeAttribute("closemenu");
}
},
onClick: function BEH_onClick(aEvent, aView) {
// Only handle middle-click or left-click with modifiers.
let modifKey;
if (AppConstants.platform == "macosx") {
modifKey = aEvent.metaKey || aEvent.shiftKey;
} else {
modifKey = aEvent.ctrlKey || aEvent.shiftKey;
}
if (aEvent.button == 2 || (aEvent.button == 0 && !modifKey)) {
return;
}
var target = aEvent.originalTarget;
// If this event bubbled up from a menu or menuitem,
// close the menus if browser.bookmarks.openInTabClosesMenu.
var tag = target.tagName;
if (
PlacesUIUtils.openInTabClosesMenu &&
(tag == "menuitem" || tag == "menu")
) {
closeMenus(aEvent.target);
}
if (target._placesNode && PlacesUtils.nodeIsContainer(target._placesNode)) {
// Don't open the root folder in tabs when the empty area on the toolbar
// is middle-clicked or when a non-bookmark item (except for Open in Tabs)
// in a bookmarks menupopup is middle-clicked.
if (target.localName == "menu" || target.localName == "toolbarbutton") {
PlacesUIUtils.openMultipleLinksInTabs(
target._placesNode,
aEvent,
aView
);
}
} else if (aEvent.button == 1 && !(tag == "menuitem" || tag == "menu")) {
// Call onCommand in the cases where it's not called automatically:
// Middle-clicks outside of menus.
this.onCommand(aEvent);
aEvent.preventDefault();
aEvent.stopPropagation();
}
},
/**
* Handler for command event for an item in the bookmarks toolbar.
* Menus and submenus from the folder buttons bubble up to this handler.
* Opens the item.
* @param aEvent
* DOMEvent for the command
*/
onCommand: function BEH_onCommand(aEvent) {
var target = aEvent.originalTarget;
if (target._placesNode) {
PlacesUIUtils.openNodeWithEvent(target._placesNode, aEvent);
// Only record interactions through the Bookmarks Toolbar
if (target.closest("#PersonalToolbar")) {
Services.telemetry.scalarAdd(
"browser.engagement.bookmarks_toolbar_bookmark_opened",
1
);
}
}
},
fillInBHTooltip: function BEH_fillInBHTooltip(aTooltip, aEvent) {
var node;
var cropped = false;
var targetURI;
if (aTooltip.triggerNode.localName == "treechildren") {
var tree = aTooltip.triggerNode.parentNode;
var cell = tree.getCellAt(aEvent.clientX, aEvent.clientY);
if (cell.row == -1) {
return false;
}
node = tree.view.nodeForTreeIndex(cell.row);
cropped = tree.isCellCropped(cell.row, cell.col);
} else {
// Check whether the tooltipNode is a Places node.
// In such a case use it, otherwise check for targetURI attribute.
var tooltipNode = aTooltip.triggerNode;
if (tooltipNode._placesNode) {
node = tooltipNode._placesNode;
} else {
// This is a static non-Places node.
targetURI = tooltipNode.getAttribute("targetURI");
}
}
if (!node && !targetURI) {
return false;
}
// Show node.label as tooltip's title for non-Places nodes.
var title = node ? node.title : tooltipNode.label;
// Show URL only for Places URI-nodes or nodes with a targetURI attribute.
var url;
if (targetURI || PlacesUtils.nodeIsURI(node)) {
url = targetURI || node.uri;
}
// Show tooltip for containers only if their title is cropped.
if (!cropped && !url) {
return false;
}
let tooltipTitle = aEvent.target.querySelector(".places-tooltip-title");
tooltipTitle.hidden = !title || title == url;
if (!tooltipTitle.hidden) {
tooltipTitle.textContent = title;
}
let tooltipUrl = aEvent.target.querySelector(".places-tooltip-uri");
tooltipUrl.hidden = !url;
if (!tooltipUrl.hidden) {
// Use `value` instead of `textContent` so cropping will apply
tooltipUrl.value = url;
}
// Show tooltip.
return true;
},
};
// Handles special drag and drop functionality for Places menus that are not
// part of a Places view (e.g. the bookmarks menu in the menubar).
var PlacesMenuDNDHandler = {
_springLoadDelayMs: 350,
_closeDelayMs: 500,
_loadTimer: null,
_closeTimer: null,
_closingTimerNode: null,
/**
* Called when the user enters the <menu> element during a drag.
* @param event
* The DragEnter event that spawned the opening.
*/
onDragEnter: function PMDH_onDragEnter(event) {
// Opening menus in a Places popup is handled by the view itself.
if (!this._isStaticContainer(event.target)) {
return;
}
// If we re-enter the same menu or anchor before the close timer runs out,
// we should ensure that we do not close:
if (this._closeTimer && this._closingTimerNode === event.currentTarget) {
this._closeTimer.cancel();
this._closingTimerNode = null;
this._closeTimer = null;
}
PlacesControllerDragHelper.currentDropTarget = event.target;
let popup = event.target.menupopup;
if (
this._loadTimer ||
popup.state === "showing" ||
popup.state === "open"
) {
return;
}
this._loadTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
this._loadTimer.initWithCallback(
() => {
this._loadTimer = null;
popup.setAttribute("autoopened", "true");
popup.openPopup();
},
this._springLoadDelayMs,
Ci.nsITimer.TYPE_ONE_SHOT
);
event.preventDefault();
event.stopPropagation();
},
/**
* Handles dragleave on the <menu> element.
*/
onDragLeave: function PMDH_onDragLeave(event) {
// Handle menu-button separate targets.
if (
event.relatedTarget === event.currentTarget ||
(event.relatedTarget &&
event.relatedTarget.parentNode === event.currentTarget)
) {
return;
}
// Closing menus in a Places popup is handled by the view itself.
if (!this._isStaticContainer(event.target)) {
return;
}
PlacesControllerDragHelper.currentDropTarget = null;
let popup = event.target.menupopup;
if (this._loadTimer) {
this._loadTimer.cancel();
this._loadTimer = null;
}
this._closeTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
this._closingTimerNode = event.currentTarget;
this._closeTimer.initWithCallback(
function () {
this._closeTimer = null;
this._closingTimerNode = null;
let node = PlacesControllerDragHelper.currentDropTarget;
let inHierarchy = false;
while (node && !inHierarchy) {
inHierarchy = node == event.target;
node = node.parentNode;
}
if (!inHierarchy && popup && popup.hasAttribute("autoopened")) {
popup.removeAttribute("autoopened");
popup.hidePopup();
}
},
this._closeDelayMs,
Ci.nsITimer.TYPE_ONE_SHOT
);
},
/**
* Determines if a XUL element represents a static container.
* @returns true if the element is a container element (menu or
*` menu-toolbarbutton), false otherwise.
*/
_isStaticContainer: function PMDH__isContainer(node) {
let isMenu =
node.localName == "menu" ||
(node.localName == "toolbarbutton" &&
node.getAttribute("type") == "menu");
let isStatic =
!("_placesNode" in node) &&
node.menupopup &&
node.menupopup.hasAttribute("placespopup") &&
!node.parentNode.hasAttribute("placespopup");
return isMenu && isStatic;
},
/**
* Called when the user drags over the <menu> element.
* @param event
* The DragOver event.
*/
onDragOver: function PMDH_onDragOver(event) {
PlacesControllerDragHelper.currentDropTarget = event.target;
let ip = new PlacesInsertionPoint({
parentGuid: PlacesUtils.bookmarks.menuGuid,
});
if (ip && PlacesControllerDragHelper.canDrop(ip, event.dataTransfer)) {
event.preventDefault();
}
event.stopPropagation();
},
/**
* Called when the user drops on the <menu> element.
* @param event
* The Drop event.
*/
onDrop: function PMDH_onDrop(event) {
// Put the item at the end of bookmark menu.
let ip = new PlacesInsertionPoint({
parentGuid: PlacesUtils.bookmarks.menuGuid,
});
PlacesControllerDragHelper.onDrop(ip, event.dataTransfer);
PlacesControllerDragHelper.currentDropTarget = null;
event.stopPropagation();
},
};
/**
* This object handles the initialization and uninitialization of the bookmarks
* toolbar. It also has helper functions for the managed bookmarks button.
*/
var PlacesToolbarHelper = {
get _viewElt() {
return document.getElementById("PlacesToolbar");
},
/**
* Initialize. This will check whether we've finished startup and can
* show toolbars.
*/
async init() {
await PlacesUIUtils.canLoadToolbarContentPromise;
this._realInit();
},
/**
* Actually initialize the places view (if needed; we might still no-op).
*/
_realInit() {
let viewElt = this._viewElt;
if (!viewElt || viewElt._placesView || window.closed) {
return;
}
// CustomizableUI.addListener is idempotent, so we can safely
// call this multiple times.
CustomizableUI.addListener(this);
if (!this._isObservingToolbars) {
this._isObservingToolbars = true;
window.addEventListener("toolbarvisibilitychange", this);
}
// If the bookmarks toolbar item is:
// - not in a toolbar, or;
// - the toolbar is collapsed, or;
// - the toolbar is hidden some other way:
// don't initialize. Also, there is no need to initialize the toolbar if
// customizing, because that will happen when the customization is done.
let toolbar = this._getParentToolbar(viewElt);
if (
!toolbar ||
toolbar.collapsed ||
this._isCustomizing ||
getComputedStyle(toolbar, "").display == "none"
) {
return;
}
new PlacesToolbar(
`place:parent=${PlacesUtils.bookmarks.toolbarGuid}`,
document.getElementById("PlacesToolbarItems"),
viewElt
);
if (toolbar.id == "PersonalToolbar") {
if (!toolbar.hasAttribute("initialized")) {
toolbar.setAttribute("initialized", "true");
}
// We just created a new view, thus we must check again the empty toolbar
// message, regardless of "initialized".
BookmarkingUI.updateEmptyToolbarMessage().catch(console.error);
}
},
async getIsEmpty() {
if (!this._viewElt._placesView) {
return true;
}
await this._viewElt._placesView.promiseRebuilt();
return !document.getElementById("PlacesToolbarItems").hasChildNodes();
},
handleEvent(event) {
switch (event.type) {
case "toolbarvisibilitychange":
if (event.target == this._getParentToolbar(this._viewElt)) {
this._resetView();
}
break;
}
},
/**
* This is a no-op if we haven't been initialized.
*/
uninit: function PTH_uninit() {
if (this._isObservingToolbars) {
delete this._isObservingToolbars;
window.removeEventListener("toolbarvisibilitychange", this);
}
CustomizableUI.removeListener(this);
},
customizeStart: function PTH_customizeStart() {
try {
let viewElt = this._viewElt;
if (viewElt && viewElt._placesView) {
viewElt._placesView.uninit();
}
} finally {
this._isCustomizing = true;
}
},
customizeDone: function PTH_customizeDone() {
this._isCustomizing = false;
this.init();
},
onPlaceholderCommand() {
let widgetGroup = CustomizableUI.getWidget("personal-bookmarks");
let widget = widgetGroup.forWindow(window);
if (
widget.overflowed ||
widgetGroup.areaType == CustomizableUI.TYPE_PANEL
) {
PlacesCommandHook.showPlacesOrganizer("BookmarksToolbar");
}
},
_getParentToolbar(element) {
while (element) {
if (element.localName == "toolbar") {
return element;
}
element = element.parentNode;
}
return null;
},
onWidgetUnderflow(aNode) {
// The view gets broken by being removed and reinserted by the overflowable
// toolbar, so we have to force an uninit and reinit.
let win = aNode.ownerGlobal;
if (aNode.id == "personal-bookmarks" && win == window) {
this._resetView();
}
},
onWidgetAdded(aWidgetId) {
if (aWidgetId == "personal-bookmarks" && !this._isCustomizing) {
// It's possible (with the "Add to Menu", "Add to Toolbar" context
// options) that the Places Toolbar Items have been moved without
// letting us prepare and handle it with with customizeStart and
// customizeDone. If that's the case, we need to reset the views
// since they're probably broken from the DOM reparenting.
this._resetView();
}
},
_resetView() {
if (this._viewElt) {
// It's possible that the placesView might not exist, and we need to
// do a full init. This could happen if the Bookmarks Toolbar Items are
// moved to the Menu Panel, and then to the toolbar with the "Add to Toolbar"
// context menu option, outside of customize mode.
if (this._viewElt._placesView) {
this._viewElt._placesView.uninit();
}
this.init();
}
},
async populateManagedBookmarks(popup) {
if (popup.hasChildNodes()) {
return;
}
// Show item's uri in the status bar when hovering, and clear on exit
popup.addEventListener("DOMMenuItemActive", function (event) {
XULBrowserWindow.setOverLink(event.target.link);
});
popup.addEventListener("DOMMenuItemInactive", function () {
XULBrowserWindow.setOverLink("");
});
let fragment = document.createDocumentFragment();
await this.addManagedBookmarks(
fragment,
Services.policies.getActivePolicies().ManagedBookmarks
);
popup.appendChild(fragment);
},
async addManagedBookmarks(menu, children) {
for (let i = 0; i < children.length; i++) {
let entry = children[i];
if (entry.children) {
// It's a folder.
let submenu = document.createXULElement("menu");
if (entry.name) {
submenu.setAttribute("label", entry.name);
} else {
document.l10n.setAttributes(submenu, "managed-bookmarks-subfolder");
}
submenu.setAttribute("container", "true");
submenu.classList.add("menu-iconic", "bookmark-item");
let submenupopup = document.createXULElement("menupopup");
submenu.appendChild(submenupopup);
menu.appendChild(submenu);
this.addManagedBookmarks(submenupopup, entry.children);
} else if (entry.name && entry.url) {
// It's bookmark.
let { preferredURI } = Services.uriFixup.getFixupURIInfo(entry.url);
let menuitem = document.createXULElement("menuitem");
menuitem.setAttribute("label", entry.name);
menuitem.setAttribute("image", "page-icon:" + preferredURI.spec);
menuitem.classList.add(
"menuitem-iconic",
"menuitem-with-favicon",
"bookmark-item"
);
menuitem.link = preferredURI.spec;
menu.appendChild(menuitem);
}
}
},
openManagedBookmark(event) {
openUILink(event.target.link, event, {
triggeringPrincipal: Services.scriptSecurityManager.getSystemPrincipal(),
});
},
onDragStartManaged(event) {
if (!event.target.link) {
return;
}
let dt = event.dataTransfer;
let node = {};
node.type = 0;
node.title = event.target.label;
node.uri = event.target.link;
function addData(type, index) {
let wrapNode = PlacesUtils.wrapNode(node, type);
dt.mozSetDataAt(type, wrapNode, index);
}
addData(PlacesUtils.TYPE_X_MOZ_URL, 0);
addData(PlacesUtils.TYPE_PLAINTEXT, 0);
addData(PlacesUtils.TYPE_HTML, 0);
},
};
/**
* Handles the bookmarks menu-button in the toolbar.
*/
var BookmarkingUI = {
STAR_ID: "star-button",
STAR_BOX_ID: "star-button-box",
BOOKMARK_BUTTON_ID: "bookmarks-menu-button",
BOOKMARK_BUTTON_SHORTCUT: "addBookmarkAsKb",
get button() {
delete this.button;
let widgetGroup = CustomizableUI.getWidget(this.BOOKMARK_BUTTON_ID);
return (this.button = widgetGroup.forWindow(window).node);
},
get star() {
delete this.star;
return (this.star = document.getElementById(this.STAR_ID));
},
get starBox() {
delete this.starBox;
return (this.starBox = document.getElementById(this.STAR_BOX_ID));
},
get anchor() {
let action = PageActions.actionForID(PageActions.ACTION_ID_BOOKMARK);
return BrowserPageActions.panelAnchorNodeForAction(action);
},
get stringbundleset() {
delete this.stringbundleset;
return (this.stringbundleset = document.getElementById("stringbundleset"));
},
get toolbar() {
delete this.toolbar;
return (this.toolbar = document.getElementById("PersonalToolbar"));
},
STATUS_UPDATING: -1,
STATUS_UNSTARRED: 0,
STATUS_STARRED: 1,
get status() {
if (this._pendingUpdate) {
return this.STATUS_UPDATING;
}
return this.star.hasAttribute("starred")
? this.STATUS_STARRED
: this.STATUS_UNSTARRED;
},
onPopupShowing: function BUI_onPopupShowing(event) {
// Don't handle events for submenus.
if (event.target != event.currentTarget) {
return;
}
// On non-photon, this code should never be reached. However, if you click
// the outer button's border, some cpp code for the menu button's XBL
// binding decides to open the popup even though the dropmarker is invisible.
//
// Separately, in Photon, if the button is in the dynamic portion of the
// overflow panel, we want to show a subview instead.
if (
this.button.getAttribute("cui-areatype") == CustomizableUI.TYPE_PANEL ||
this.button.hasAttribute("overflowedItem")
) {
this._showSubView();
event.preventDefault();
event.stopPropagation();
return;
}
let widget = CustomizableUI.getWidget(this.BOOKMARK_BUTTON_ID).forWindow(
window
);
if (widget.overflowed) {
// Don't open a popup in the overflow popup, rather just open the Library.
event.preventDefault();
widget.node.removeAttribute("closemenu");
PlacesCommandHook.showPlacesOrganizer("BookmarksMenu");
return;
}
this._initMobileBookmarks(document.getElementById("BMB_mobileBookmarks"));
this.updateLabel(
"BMB_viewBookmarksSidebar",
SidebarController.currentID == "viewBookmarksSidebar"
);
this.updateLabel("BMB_viewBookmarksToolbar", !this.toolbar.collapsed);
},
updateLabel(elementId, visible) {
let element = PanelMultiView.getViewNode(document, elementId);
let l10nID = element.getAttribute("data-l10n-id");
document.l10n.setAttributes(element, l10nID, { isVisible: !!visible });
},
toggleBookmarksToolbar(reason) {
let newState = this.toolbar.collapsed ? "always" : "never";
Services.prefs.setCharPref(
"browser.toolbars.bookmarks.visibility",
// See firefox.js for possible values
newState
);
CustomizableUI.setToolbarVisibility(this.toolbar.id, newState, false);
BrowserUsageTelemetry.recordToolbarVisibility(
this.toolbar.id,
newState,
reason
);
},
isOnNewTabPage(uri) {
if (!uri) {
return false;
}
// Prevent loading AboutNewTab.sys.mjs during startup path if it
// is only the newTabURL getter we are interested in.
let newTabURL = Cu.isESModuleLoaded(
"resource:///modules/AboutNewTab.sys.mjs"
)
? AboutNewTab.newTabURL
: "about:newtab";
// Don't treat a custom "about:blank" new tab URL as the "New Tab Page"
// due to about:blank being used in different contexts and the
// difficulty in determining if the eventual page load is
// about:blank or if the about:blank load is just temporary.
if (newTabURL == "about:blank") {
newTabURL = "about:newtab";
}
let newTabURLs = [
newTabURL,
"about:home",
"chrome://browser/content/blanktab.html",
];
if (PrivateBrowsingUtils.isWindowPrivate(window)) {
newTabURLs.push("about:privatebrowsing");
}
return newTabURLs.some(newTabUriString =>
this._newTabURI(newTabUriString)?.equalsExceptRef(uri)
);
},
_newTabURI(uriString) {
let uri = this._newTabURICache.get(uriString);
if (uri === undefined) {
uri = Services.io.newURI(uriString);
this._newTabURICache.set(uriString, uri);
}
return uri;
},
_newTabURICache: new Map(),
buildBookmarksToolbarSubmenu(toolbar) {
let alwaysShowMenuItem = document.createXULElement("menuitem");
let alwaysHideMenuItem = document.createXULElement("menuitem");
let showOnNewTabMenuItem = document.createXULElement("menuitem");
let menuPopup = document.createXULElement("menupopup");
menuPopup.append(
alwaysShowMenuItem,
showOnNewTabMenuItem,
alwaysHideMenuItem
);
let menu = document.createXULElement("menu");
menu.appendChild(menuPopup);
menu.setAttribute("label", toolbar.getAttribute("toolbarname"));
menu.setAttribute("id", "toggle_" + toolbar.id);
menu.setAttribute("accesskey", toolbar.getAttribute("accesskey"));
menu.setAttribute("toolbarId", toolbar.id);
// Used by the Places context menu in the Bookmarks Toolbar
// when nothing is selected
menu.setAttribute("selection-type", "none|single");
MozXULElement.insertFTLIfNeeded("browser/toolbarContextMenu.ftl");
let menuItems = [
[
showOnNewTabMenuItem,
"toolbar-context-menu-bookmarks-toolbar-on-new-tab-2",
"newtab",
],
[
alwaysShowMenuItem,
"toolbar-context-menu-bookmarks-toolbar-always-show-2",
"always",
],
[
alwaysHideMenuItem,
"toolbar-context-menu-bookmarks-toolbar-never-show-2",
"never",
],
];
menuItems.map(([menuItem, l10nId, visibilityEnum]) => {
document.l10n.setAttributes(menuItem, l10nId);
menuItem.setAttribute("type", "radio");
// The persisted state of the PersonalToolbar is stored in
// "browser.toolbars.bookmarks.visibility".
menuItem.setAttribute(
"checked",
gBookmarksToolbarVisibility == visibilityEnum
);
// Identify these items for "onViewToolbarCommand" so
// we know to check the visibilityEnum value.
menuItem.dataset.bookmarksToolbarVisibility = true;
menuItem.dataset.visibilityEnum = visibilityEnum;
menuItem.addEventListener("command", onViewToolbarCommand);
});
let menuItemForNextStateFromKbShortcut =
gBookmarksToolbarVisibility == "never"
? alwaysShowMenuItem
: alwaysHideMenuItem;
menuItemForNextStateFromKbShortcut.setAttribute(
"key",
"viewBookmarksToolbarKb"
);
return menu;
},
/**
* Check if we need to make the empty toolbar message `hidden`.
* We'll have it unhidden during startup, to make sure the toolbar
* has height, and we'll unhide it if there is nothing else on the toolbar.
* We hide it in customize mode, unless there's nothing on the toolbar.
*/
async updateEmptyToolbarMessage() {
let checkNumBookmarksOnToolbar = false;
let hasVisibleChildren = (() => {
// Do we have visible kids?
if (
this.toolbar.querySelector(
`:scope > toolbarpaletteitem > toolbarbutton:not([hidden]),
:scope > toolbarpaletteitem > toolbaritem:not([hidden], #personal-bookmarks),
:scope > toolbarbutton:not([hidden]),
:scope > toolbaritem:not([hidden], #personal-bookmarks)`
)
) {
return true;
}
if (!this.toolbar.hasAttribute("initialized") && !this._isCustomizing) {
// If the bookmarks are here but it's early in startup, show the
// message. It'll get made visibility: hidden early in startup anyway -
// it's just to ensure the toolbar has height.
return false;
}
// Hmm, apparently not. Check for bookmarks or customize mode:
let bookmarksToolbarItemsPlacement =
CustomizableUI.getPlacementOfWidget("personal-bookmarks");
let bookmarksItemInToolbar =
bookmarksToolbarItemsPlacement?.area == CustomizableUI.AREA_BOOKMARKS;
if (!bookmarksItemInToolbar) {
return false;
}
if (this._isCustomizing) {
return true;
}
// Check visible bookmark nodes.
if (
this.toolbar.querySelector(
`#PlacesToolbarItems > toolbarseparator,
#PlacesToolbarItems > toolbarbutton`
)
) {
return true;
}
checkNumBookmarksOnToolbar = true;
return false;
})();
if (checkNumBookmarksOnToolbar) {
hasVisibleChildren = !(await PlacesToolbarHelper.getIsEmpty());
}
let emptyMsg = document.getElementById("personal-toolbar-empty");
emptyMsg.hidden = hasVisibleChildren;
emptyMsg.toggleAttribute("nowidth", !hasVisibleChildren);
},
openLibraryIfLinkClicked(event) {
if (
((event.type == "click" && event.button == 0) ||
(event.type == "keydown" && event.keyCode == KeyEvent.DOM_VK_RETURN)) &&
event.target.localName == "a"
) {
PlacesCommandHook.showPlacesOrganizer("BookmarksToolbar");
}
},
// Set by sync after syncing bookmarks successfully once.
MOBILE_BOOKMARKS_PREF: "browser.bookmarks.showMobileBookmarks",
_shouldShowMobileBookmarks() {
return Services.prefs.getBoolPref(this.MOBILE_BOOKMARKS_PREF, false);
},
_initMobileBookmarks(mobileMenuItem) {
mobileMenuItem.hidden = !this._shouldShowMobileBookmarks();
},
_uninitView: function BUI__uninitView() {
// When an element with a placesView attached is removed and re-inserted,
// XBL reapplies the binding causing any kind of issues and possible leaks,
// so kill current view and let popupshowing generate a new one.
if (this.button._placesView) {
this.button._placesView.uninit();
}
// Also uninit the main menubar placesView, since it would have the same
// issues.
let menubar = document.getElementById("bookmarksMenu");
if (menubar && menubar._placesView) {
menubar._placesView.uninit();
}
// We have to do the same thing for the "special" views underneath the
// the bookmarks menu.
const kSpecialViewNodeIDs = [
"BMB_bookmarksToolbar",
"BMB_unsortedBookmarks",
];
for (let viewNodeID of kSpecialViewNodeIDs) {
let elem = document.getElementById(viewNodeID);
if (elem && elem._placesView) {
elem._placesView.uninit();
}
}
},
onCustomizeStart: function BUI_customizeStart(aWindow) {
if (aWindow == window) {
this._uninitView();
this._isCustomizing = true;
this.updateEmptyToolbarMessage().catch(console.error);
let isVisible =
Services.prefs.getCharPref(
"browser.toolbars.bookmarks.visibility",
"newtab"
) != "never";
// Temporarily show the bookmarks toolbar in Customize mode if
// the toolbar isn't set to Never. We don't have to worry about
// hiding when leaving customize mode since the toolbar will
// hide itself on location change.
setToolbarVisibility(this.toolbar, isVisible, false);
}
},
onWidgetAdded: function BUI_widgetAdded(aWidgetId, aArea) {
if (aWidgetId == this.BOOKMARK_BUTTON_ID) {
this._onWidgetWasMoved();
}
if (aArea == CustomizableUI.AREA_BOOKMARKS) {
this.updateEmptyToolbarMessage().catch(console.error);
}
},
onWidgetRemoved: function BUI_widgetRemoved(aWidgetId, aOldArea) {
if (aWidgetId == this.BOOKMARK_BUTTON_ID) {
this._onWidgetWasMoved();
}
if (aOldArea == CustomizableUI.AREA_BOOKMARKS) {
this.updateEmptyToolbarMessage().catch(console.error);
}
},
onWidgetReset: function BUI_widgetReset(aNode) {
if (aNode == this.button) {
this._onWidgetWasMoved();
}
},
onWidgetUndoMove: function BUI_undoWidgetUndoMove(aNode) {
if (aNode == this.button) {
this._onWidgetWasMoved();
}
},
onWidgetBeforeDOMChange: function BUI_onWidgetBeforeDOMChange(
aNode,
aNextNode,
aContainer,
aIsRemoval
) {
if (aNode.id == "import-button") {
this._updateImportButton(aNode, aIsRemoval ? null : aContainer);
}
},
_updateImportButton: function BUI_updateImportButton(aNode, aContainer) {
// The import button behaves like a bookmark item when in the bookmarks
// toolbar, otherwise like a regular toolbar button.
let isBookmarkItem = aContainer == this.toolbar;
aNode.classList.toggle("toolbarbutton-1", !isBookmarkItem);
aNode.classList.toggle("bookmark-item", isBookmarkItem);
},
_onWidgetWasMoved: function BUI_widgetWasMoved() {
// If we're moved outside of customize mode, we need to uninit
// our view so it gets reconstructed.
if (!this._isCustomizing) {
this._uninitView();
}
},
onCustomizeEnd: function BUI_customizeEnd(aWindow) {
if (aWindow == window) {
this._isCustomizing = false;
this.updateEmptyToolbarMessage().catch(console.error);
}
},
init() {
CustomizableUI.addListener(this);
let importButton = document.getElementById("import-button");
if (importButton) {
this._updateImportButton(importButton, importButton.parentNode);
}
this.updateEmptyToolbarMessage().catch(console.error);
},
_hasBookmarksObserver: false,
_itemGuids: new Set(),
uninit: function BUI_uninit() {
this.updateBookmarkPageMenuItem(true);
CustomizableUI.removeListener(this);
this._uninitView();
if (this._hasBookmarksObserver) {
PlacesUtils.observers.removeListener(
[
"bookmark-added",
"bookmark-removed",
"bookmark-moved",
"bookmark-url-changed",
],
this.handlePlacesEvents
);
}
if (this._pendingUpdate) {
delete this._pendingUpdate;
}
},
onLocationChange: function BUI_onLocationChange() {
if (this._uri && gBrowser.currentURI.equals(this._uri)) {
return;
}
this.updateStarState();
},
updateStarState: function BUI_updateStarState() {
this._uri = gBrowser.currentURI;
this._itemGuids.clear();
let guids = new Set();
// those objects are use to check if we are in the current iteration before
// returning any result.
let pendingUpdate = (this._pendingUpdate = {});
PlacesUtils.bookmarks
.fetch({ url: this._uri }, b => guids.add(b.guid), { concurrent: true })
.catch(console.error)
.then(() => {
if (pendingUpdate != this._pendingUpdate) {
return;
}
// It's possible that "bookmark-added" gets called before the async statement
// calls back. For such an edge case, retain all unique entries from the
// array.
if (this._itemGuids.size > 0) {
this._itemGuids = new Set(...this._itemGuids, ...guids);
} else {
this._itemGuids = guids;
}
this._updateStar();
// Start observing bookmarks if needed.
if (!this._hasBookmarksObserver) {
try {
this.handlePlacesEvents = this.handlePlacesEvents.bind(this);
PlacesUtils.observers.addListener(
[
"bookmark-added",
"bookmark-removed",
"bookmark-moved",
"bookmark-url-changed",
],
this.handlePlacesEvents
);
this._hasBookmarksObserver = true;
} catch (ex) {
console.error(
"BookmarkingUI failed adding a bookmarks observer: ",
ex
);
}
}
delete this._pendingUpdate;
});
},
_updateStar: function BUI__updateStar() {
let starred = this._itemGuids.size > 0;
// Update the image for all elements.
for (let element of [
this.star,
document.getElementById("context-bookmarkpage"),
PanelMultiView.getViewNode(document, "panelMenuBookmarkThisPage"),
document.getElementById("pageAction-panel-bookmark"),
]) {
if (!element) {
// The page action panel element may not have been created yet.
continue;
}
if (starred) {
element.setAttribute("starred", "true");
} else {
element.removeAttribute("starred");
}
}
if (!this.starBox) {
// The BOOKMARK_BUTTON_SHORTCUT exists only in browser.xhtml.
// Return early if we're not in this context, but still reset the
// Bookmark Page items.
this.updateBookmarkPageMenuItem(true);
return;
}
// Update the tooltip for elements that require it.
let shortcut = document.getElementById(this.BOOKMARK_BUTTON_SHORTCUT);
let l10nArgs = {
shortcut: ShortcutUtils.prettifyShortcut(shortcut),
};
document.l10n.setAttributes(
this.starBox,
starred ? "urlbar-star-edit-bookmark" : "urlbar-star-add-bookmark",
l10nArgs
);
// Update the Bookmark Page menuitem when bookmarked state changes.
this.updateBookmarkPageMenuItem();
Services.obs.notifyObservers(
null,
"bookmark-icon-updated",
starred ? "starred" : "unstarred"
);
},
/**
* Update the "Bookmark Page…" menuitems on the menubar, panels, context
* menu and page actions.
* @param {boolean} [forceReset] passed when we're destroyed and the label
* should go back to the default (Bookmark Page), for MacOS.
*/
updateBookmarkPageMenuItem(forceReset = false) {
let isStarred = !forceReset && this._itemGuids.size > 0;
// Define the l10n id which will be used to localize elements
// that only require a label using the menubar.ftl messages.
let menuItemL10nId = isStarred ? "menu-edit-bookmark" : "menu-bookmark-tab";
let menuItem = document.getElementById("menu_bookmarkThisPage");
if (menuItem) {
// Localize the menubar item.
document.l10n.setAttributes(menuItem, menuItemL10nId);
}
let panelMenuItemL10nId = isStarred
? "bookmarks-subview-edit-bookmark"
: "bookmarks-subview-bookmark-tab";
let panelMenuToolbarButton = PanelMultiView.getViewNode(
document,
"panelMenuBookmarkThisPage"
);
if (panelMenuToolbarButton) {
document.l10n.setAttributes(panelMenuToolbarButton, panelMenuItemL10nId);
}
// Localize the context menu item element.
let contextItem = document.getElementById("context-bookmarkpage");
// On macOS regular menuitems are used and the shortcut isn't added
if (contextItem) {
if (AppConstants.platform == "macosx") {
let contextItemL10nId = isStarred
? "main-context-menu-edit-bookmark-mac"
: "main-context-menu-bookmark-page-mac";
document.l10n.setAttributes(contextItem, contextItemL10nId);
} else {
let shortcutElem = document.getElementById(
this.BOOKMARK_BUTTON_SHORTCUT
);
if (shortcutElem) {
let shortcut = ShortcutUtils.prettifyShortcut(shortcutElem);
let contextItemL10nId = isStarred
? "main-context-menu-edit-bookmark-with-shortcut"
: "main-context-menu-bookmark-page-with-shortcut";
let l10nArgs = { shortcut };
document.l10n.setAttributes(contextItem, contextItemL10nId, l10nArgs);
} else {
let contextItemL10nId = isStarred
? "main-context-menu-edit-bookmark"
: "main-context-menu-bookmark-page";
document.l10n.setAttributes(contextItem, contextItemL10nId);
}
}
}
// Update Page Actions.
if (document.getElementById("page-action-buttons")) {
// Fetch the label attribute value of the message and
// apply it on the star title.
//
// Note: This should be updated once bug 1608198 is fixed.
this._latestMenuItemL10nId = menuItemL10nId;
document.l10n.formatMessages([{ id: menuItemL10nId }]).then(l10n => {
// It's possible for this promise to be scheduled multiple times.
// In such a case, we'd like to avoid setting the title if there's
// a newer l10n id pending to be set.
if (this._latestMenuItemL10nId != menuItemL10nId) {
return;
}
// We assume that menuItemL10nId has a single attribute.
let label = l10n[0].attributes[0].value;
// Update the label for the page action panel.
let panelButton = BrowserPageActions.panelButtonNodeForActionID(
PageActions.ACTION_ID_BOOKMARK
);
if (panelButton) {
panelButton.setAttribute("label", label);
}
});
}
},
onMainMenuPopupShowing: function BUI_onMainMenuPopupShowing(event) {
// Don't handle events for submenus.
if (event.target != event.currentTarget) {
return;
}
this._initMobileBookmarks(document.getElementById("menu_mobileBookmarks"));
},
showSubView(anchor) {
this._showSubView(null, anchor);
},
_showSubView(
event,
anchor = document.getElementById(this.BOOKMARK_BUTTON_ID)
) {
let view = PanelMultiView.getViewNode(document, "PanelUI-bookmarks");
view.addEventListener("ViewShowing", this);
view.addEventListener("ViewHiding", this);
anchor.setAttribute("closemenu", "none");
this.updateLabel("panelMenu_viewBookmarksToolbar", !this.toolbar.collapsed);
PanelUI.showSubView("PanelUI-bookmarks", anchor, event);
},
onCommand: function BUI_onCommand(aEvent) {
if (aEvent.target != aEvent.currentTarget) {
return;
}
// Handle special case when the button is in the panel.
if (this.button.getAttribute("cui-areatype") == CustomizableUI.TYPE_PANEL) {
this._showSubView(aEvent);
return;
}
let widget = CustomizableUI.getWidget(this.BOOKMARK_BUTTON_ID).forWindow(
window
);
if (widget.overflowed) {
// Close the overflow panel because the Edit Bookmark panel will appear.
widget.node.removeAttribute("closemenu");
}
this.onStarCommand(aEvent);
},
onStarCommand(aEvent) {
// Ignore non-left clicks on the star, or if we are updating its state.
if (
!this._pendingUpdate &&
(aEvent.type != "click" || aEvent.button == 0)
) {
PlacesCommandHook.bookmarkPage();
}
},
handleEvent: function BUI_handleEvent(aEvent) {
switch (aEvent.type) {
case "ViewShowing":
this.onPanelMenuViewShowing(aEvent);
break;
case "ViewHiding":
this.onPanelMenuViewHiding(aEvent);
break;
case "command":
if (aEvent.target.id == "panelMenu_searchBookmarks") {
PlacesCommandHook.searchBookmarks();
} else if (aEvent.target.id == "panelMenu_viewBookmarksToolbar") {
this.toggleBookmarksToolbar("bookmark-tools");
}
break;
}
},
onPanelMenuViewShowing: function BUI_onViewShowing(aEvent) {
let panelview = aEvent.target;
// Get all statically placed buttons to supply them with keyboard shortcuts.
let staticButtons = panelview.getElementsByTagName("toolbarbutton");
for (let i = 0, l = staticButtons.length; i < l; ++i) {
CustomizableUI.addShortcut(staticButtons[i]);
}
// Setup the Places view.
// We restrict the amount of results to 42. Not 50, but 42. Why? Because 42.
let query =
"place:queryType=" +
Ci.nsINavHistoryQueryOptions.QUERY_TYPE_BOOKMARKS +
"&sort=" +
Ci.nsINavHistoryQueryOptions.SORT_BY_DATEADDED_DESCENDING +
"&maxResults=42&excludeQueries=1";
this._panelMenuView = new PlacesPanelview(
query,
document.getElementById("panelMenu_bookmarksMenu"),
panelview
);
panelview.removeEventListener("ViewShowing", this);
panelview.addEventListener("command", this);
},
onPanelMenuViewHiding: function BUI_onViewHiding(aEvent) {
this._panelMenuView.uninit();
delete this._panelMenuView;
let panelview = aEvent.target;
panelview.removeEventListener("ViewHiding", this);
panelview.removeEventListener("command", this);
},
handlePlacesEvents(aEvents) {
let isStarUpdateNeeded = false;
let affectsOtherBookmarksFolder = false;
let affectsBookmarksToolbarFolder = false;
for (let ev of aEvents) {
switch (ev.type) {
case "bookmark-added":
// Only need to update the UI if it wasn't marked as starred before:
if (this._itemGuids.size == 0) {
if (ev.url && ev.url == this._uri.spec) {
// If a new bookmark has been added to the tracked uri, register it.
if (!this._itemGuids.has(ev.guid)) {
this._itemGuids.add(ev.guid);
isStarUpdateNeeded = true;
}
}
}
if (ev.parentGuid === PlacesUtils.bookmarks.toolbarGuid) {
Services.telemetry.scalarAdd(
"browser.engagement.bookmarks_toolbar_bookmark_added",
1
);
}
if (ev.parentGuid == PlacesUtils.bookmarks.tagsGuid) {
StarUI.userHasTags = true;
}
break;
case "bookmark-removed":
// If one of the tracked bookmarks has been removed, unregister it.
if (this._itemGuids.has(ev.guid)) {
this._itemGuids.delete(ev.guid);
// Only need to update the UI if the page is no longer starred
if (this._itemGuids.size == 0) {
isStarUpdateNeeded = true;
}
}
// Reset the default location if it is equal to the folder
// being deleted. Just check the preference directly since we
// do not want to do a asynchronous db lookup.
PlacesUIUtils.defaultParentGuid.then(parentGuid => {
if (
ev.itemType == PlacesUtils.bookmarks.TYPE_FOLDER &&
ev.guid == parentGuid
) {
Services.prefs.setCharPref(
"browser.bookmarks.defaultLocation",
PlacesUtils.bookmarks.toolbarGuid
);
}
});
break;
case "bookmark-moved":
if (
ev.parentGuid === PlacesUtils.bookmarks.unfiledGuid ||
ev.oldParentGuid === PlacesUtils.bookmarks.unfiledGuid
) {
affectsOtherBookmarksFolder = true;
}
if (
ev.parentGuid == PlacesUtils.bookmarks.toolbarGuid ||
ev.oldParentGuid == PlacesUtils.bookmarks.toolbarGuid
) {
affectsBookmarksToolbarFolder = true;
if (ev.oldParentGuid != PlacesUtils.bookmarks.toolbarGuid) {
Services.telemetry.scalarAdd(
"browser.engagement.bookmarks_toolbar_bookmark_added",
1
);
}
}
break;
case "bookmark-url-changed":
// If the changed bookmark was tracked, check if it is now pointing to
// a different uri and unregister it.
if (this._itemGuids.has(ev.guid) && ev.url != this._uri.spec) {
this._itemGuids.delete(ev.guid);
// Only need to update the UI if the page is no longer starred
if (this._itemGuids.size == 0) {
this._updateStar();
}
} else if (
!this._itemGuids.has(ev.guid) &&
ev.url == this._uri.spec
) {
// If another bookmark is now pointing to the tracked uri, register it.
this._itemGuids.add(ev.guid);
// Only need to update the UI if it wasn't marked as starred before:
if (this._itemGuids.size == 1) {
this._updateStar();
}
}
break;
}
if (ev.parentGuid == PlacesUtils.bookmarks.unfiledGuid) {
affectsOtherBookmarksFolder = true;
} else if (ev.parentGuid == PlacesUtils.bookmarks.toolbarGuid) {
affectsBookmarksToolbarFolder = true;
}
}
if (isStarUpdateNeeded) {
this._updateStar();
}
// Run after the notification has been handled by the views.
Services.tm.dispatchToMainThread(() => {
if (affectsOtherBookmarksFolder) {
this.maybeShowOtherBookmarksFolder().catch(console.error);
}
if (affectsBookmarksToolbarFolder) {
this.updateEmptyToolbarMessage().catch(console.error);
}
});
},
onWidgetUnderflow(aNode) {
let win = aNode.ownerGlobal;
if (aNode.id != this.BOOKMARK_BUTTON_ID || win != window) {
return;
}
// The view gets broken by being removed and reinserted. Uninit
// here so popupshowing will generate a new one:
this._uninitView();
},
async maybeShowOtherBookmarksFolder() {
// PlacesToolbar._placesView can be undefined if the toolbar isn't initialized,
// collapsed, or hidden in some other way.
let toolbar = document.getElementById("PlacesToolbar");
if (!toolbar?._placesView) {
return;
}
let placement = CustomizableUI.getPlacementOfWidget("personal-bookmarks");
let otherBookmarks = document.getElementById("OtherBookmarks");
if (
!SHOW_OTHER_BOOKMARKS ||
placement?.area != CustomizableUI.AREA_BOOKMARKS
) {
if (otherBookmarks) {
otherBookmarks.hidden = true;
}
return;
}
let instance = (this._showOtherBookmarksInstance = {});
let unfiledGuid = PlacesUtils.bookmarks.unfiledGuid;
let numberOfBookmarks = (await PlacesUtils.bookmarks.fetch(unfiledGuid))
.childCount;
if (instance != this._showOtherBookmarksInstance) {
return;
}
if (numberOfBookmarks > 0) {
// Build the "Other Bookmarks" button if it doesn't exist.
if (!otherBookmarks) {
const node = PlacesUtils.getFolderContents(unfiledGuid).root;
otherBookmarks = this.buildOtherBookmarksFolder(node);
}
otherBookmarks.hidden = false;
} else if (otherBookmarks) {
otherBookmarks.hidden = true;
}
},
buildShowOtherBookmarksMenuItem() {
// Building this only if there's bookmarks in unfiled would cause
// synchronous IO, thus we just add it as disabled and enable it once the
// information is available.
let menuItem = document.createXULElement("menuitem");
menuItem.setAttribute("id", "show-other-bookmarks_PersonalToolbar");
menuItem.setAttribute("toolbarId", "PersonalToolbar");
menuItem.setAttribute("type", "checkbox");
menuItem.setAttribute("checked", SHOW_OTHER_BOOKMARKS);
menuItem.setAttribute("selection-type", "none|single");
menuItem.setAttribute("start-disabled", "true");
MozXULElement.insertFTLIfNeeded("browser/toolbarContextMenu.ftl");
document.l10n.setAttributes(
menuItem,
"toolbar-context-menu-bookmarks-show-other-bookmarks"
);
menuItem.addEventListener("command", () => {
Services.prefs.setBoolPref(
"browser.toolbars.bookmarks.showOtherBookmarks",
!SHOW_OTHER_BOOKMARKS
);
});
// Enable the menuItem if there's unfiled bookmarks
PlacesUtils.bookmarks.fetch(PlacesUtils.bookmarks.unfiledGuid).then(bm => {
if (bm.childCount) {
menuItem.disabled = false;
}
});
return menuItem;
},
buildOtherBookmarksFolder(node) {
let otherBookmarksButton = document.createXULElement("toolbarbutton");
otherBookmarksButton.setAttribute("type", "menu");
otherBookmarksButton.setAttribute("container", "true");
otherBookmarksButton.setAttribute(
"onpopupshowing",
"document.getElementById('PlacesToolbar')._placesView._onOtherBookmarksPopupShowing(event);"
);
otherBookmarksButton.id = "OtherBookmarks";
otherBookmarksButton.className = "bookmark-item";
otherBookmarksButton.hidden = "true";
MozXULElement.insertFTLIfNeeded("browser/places.ftl");
document.l10n.setAttributes(otherBookmarksButton, "other-bookmarks-folder");
let otherBookmarksPopup = document.createXULElement("menupopup", {
is: "places-popup",
});
otherBookmarksPopup.setAttribute("placespopup", "true");
otherBookmarksPopup.setAttribute("context", "placesContext");
otherBookmarksPopup.classList.add("toolbar-menupopup");
otherBookmarksPopup.id = "OtherBookmarksPopup";
otherBookmarksPopup._placesNode = PlacesUtils.asContainer(node);
otherBookmarksButton._placesNode = PlacesUtils.asContainer(node);
otherBookmarksButton.appendChild(otherBookmarksPopup);
let chevronButton = document.getElementById("PlacesChevron");
chevronButton.parentNode.append(otherBookmarksButton);
let placesToolbar = document.getElementById("PlacesToolbar");
placesToolbar._placesView._otherBookmarks = otherBookmarksButton;
placesToolbar._placesView._otherBookmarksPopup = otherBookmarksPopup;
return otherBookmarksButton;
},
};
|