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
|
/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* 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/. */
/* import-globals-from editBookmark.js */
/* import-globals-from /toolkit/content/contentAreaUtils.js */
/* import-globals-from /browser/components/downloads/content/allDownloadsView.js */
/* Shared Places Import - change other consumers if you change this: */
var { XPCOMUtils } = ChromeUtils.importESModule(
"resource://gre/modules/XPCOMUtils.sys.mjs"
);
ChromeUtils.defineESModuleGetters(this, {
BookmarkJSONUtils: "resource://gre/modules/BookmarkJSONUtils.sys.mjs",
MigrationUtils: "resource:///modules/MigrationUtils.sys.mjs",
PlacesBackups: "resource://gre/modules/PlacesBackups.sys.mjs",
PrivateBrowsingUtils: "resource://gre/modules/PrivateBrowsingUtils.sys.mjs",
DownloadUtils: "resource://gre/modules/DownloadUtils.sys.mjs",
});
XPCOMUtils.defineLazyScriptGetter(
this,
"PlacesTreeView",
"chrome://browser/content/places/treeView.js"
);
XPCOMUtils.defineLazyScriptGetter(
this,
["PlacesInsertionPoint", "PlacesController", "PlacesControllerDragHelper"],
"chrome://browser/content/places/controller.js"
);
/* End Shared Places Import */
var { AppConstants } = ChromeUtils.importESModule(
"resource://gre/modules/AppConstants.sys.mjs"
);
const RESTORE_FILEPICKER_FILTER_EXT = "*.json;*.jsonlz4";
const SORTBY_L10N_IDS = new Map([
["title", "places-view-sortby-name"],
["url", "places-view-sortby-url"],
["date", "places-view-sortby-date"],
["visitCount", "places-view-sortby-visit-count"],
["dateAdded", "places-view-sortby-date-added"],
["lastModified", "places-view-sortby-last-modified"],
["tags", "places-view-sortby-tags"],
]);
var PlacesOrganizer = {
_places: null,
_initFolderTree() {
this._places.place = `place:type=${Ci.nsINavHistoryQueryOptions.RESULTS_AS_LEFT_PANE_QUERY}&excludeItems=1&expandQueries=0`;
},
/**
* Selects a left pane built-in item.
*
* @param {string} item The built-in item to select, may be one of (case sensitive):
* AllBookmarks, BookmarksMenu, BookmarksToolbar,
* History, Downloads, Tags, UnfiledBookmarks.
*/
selectLeftPaneBuiltIn(item) {
switch (item) {
case "AllBookmarks":
this._places.selectItems([PlacesUtils.virtualAllBookmarksGuid]);
PlacesUtils.asContainer(this._places.selectedNode).containerOpen = true;
break;
case "History":
this._places.selectItems([PlacesUtils.virtualHistoryGuid]);
PlacesUtils.asContainer(this._places.selectedNode).containerOpen = true;
break;
case "Downloads":
this._places.selectItems([PlacesUtils.virtualDownloadsGuid]);
break;
case "Tags":
this._places.selectItems([PlacesUtils.virtualTagsGuid]);
break;
case "BookmarksMenu":
this.selectLeftPaneContainerByHierarchy([
PlacesUtils.virtualAllBookmarksGuid,
PlacesUtils.bookmarks.virtualMenuGuid,
]);
break;
case "BookmarksToolbar":
this.selectLeftPaneContainerByHierarchy([
PlacesUtils.virtualAllBookmarksGuid,
PlacesUtils.bookmarks.virtualToolbarGuid,
]);
break;
case "UnfiledBookmarks":
this.selectLeftPaneContainerByHierarchy([
PlacesUtils.virtualAllBookmarksGuid,
PlacesUtils.bookmarks.virtualUnfiledGuid,
]);
break;
default:
throw new Error(
`Unrecognized item ${item} passed to selectLeftPaneRootItem`
);
}
},
/**
* Opens a given hierarchy in the left pane, stopping at the last reachable
* container. Note: item ids should be considered deprecated.
*
* @param {Array | string | number} aHierarchy
* A single container or an array of containers, sorted from
* the outmost to the innermost in the hierarchy. Each
* container may be either an item id, a Places URI string,
* or a named query, like:
* "BookmarksMenu", "BookmarksToolbar", "UnfiledBookmarks", "AllBookmarks".
*/
selectLeftPaneContainerByHierarchy(aHierarchy) {
if (!aHierarchy) {
throw new Error("Containers hierarchy not specified");
}
let hierarchy = [].concat(aHierarchy);
let selectWasSuppressed =
this._places.view.selection.selectEventsSuppressed;
if (!selectWasSuppressed) {
this._places.view.selection.selectEventsSuppressed = true;
}
try {
for (let container of hierarchy) {
if (typeof container != "string") {
throw new Error("Invalid container type found: " + container);
}
try {
this.selectLeftPaneBuiltIn(container);
} catch (ex) {
if (container.substr(0, 6) == "place:") {
this._places.selectPlaceURI(container);
} else {
// Must be a guid.
this._places.selectItems([container], false);
}
}
PlacesUtils.asContainer(this._places.selectedNode).containerOpen = true;
}
} finally {
if (!selectWasSuppressed) {
this._places.view.selection.selectEventsSuppressed = false;
}
}
},
init: function PO_init() {
// Register the downloads view.
const DOWNLOADS_QUERY =
"place:transition=" +
Ci.nsINavHistoryService.TRANSITION_DOWNLOAD +
"&sort=" +
Ci.nsINavHistoryQueryOptions.SORT_BY_DATE_DESCENDING;
ContentArea.setContentViewForQueryString(
DOWNLOADS_QUERY,
() =>
new DownloadsPlacesView(
document.getElementById("downloadsListBox"),
false
),
{
showDetailsPane: false,
toolbarSet:
"back-button, forward-button, organizeButton, clearDownloadsButton, libraryToolbarSpacer, searchFilter",
}
);
ContentArea.init();
this._places = document.getElementById("placesList");
this._places.addEventListener("select", () => this.onPlaceSelected(true));
this._places.addEventListener("click", event =>
this.onPlacesListClick(event)
);
this._places.addEventListener("focus", event =>
this.updateDetailsPane(event)
);
this._initFolderTree();
var leftPaneSelection = "AllBookmarks"; // default to all-bookmarks
if (window.arguments && window.arguments[0]) {
leftPaneSelection = window.arguments[0];
}
this.selectLeftPaneContainerByHierarchy(leftPaneSelection);
if (leftPaneSelection === "History") {
let historyNode = this._places.selectedNode;
if (historyNode.childCount > 0) {
this._places.selectNode(historyNode.getChild(0));
}
Glean.library.opened.history.add(1);
} else {
Glean.library.opened.bookmarks.add(1);
}
// clear the back-stack
this._backHistory.splice(0, this._backHistory.length);
document
.getElementById("OrganizerCommand:Back")
.setAttribute("disabled", true);
// Set up the search UI.
PlacesSearchBox.init();
ViewMenu.init();
window.addEventListener("AppCommand", this, true);
document.addEventListener("command", this);
let placeContentElement = document.getElementById("placeContent");
placeContentElement.addEventListener("onOpenFlatContainer", event =>
this.openFlatContainer(event.detail)
);
placeContentElement.addEventListener("focus", event =>
this.updateDetailsPane(event)
);
placeContentElement.addEventListener("select", event =>
this.updateDetailsPane(event)
);
if (AppConstants.platform === "macosx") {
// 1. Map Edit->Find command to OrganizerCommand_find:all. Need to map
// both the menuitem and the Find key.
let findMenuItem = document.getElementById("menu_find");
findMenuItem.setAttribute("command", "OrganizerCommand_find:all");
let findKey = document.getElementById("key_find");
findKey.setAttribute("command", "OrganizerCommand_find:all");
// 2. Disable some keybindings from browser.xhtml
let elements = ["cmd_handleBackspace", "cmd_handleShiftBackspace"];
for (let i = 0; i < elements.length; i++) {
document.getElementById(elements[i]).setAttribute("disabled", "true");
}
// 3. MacOS uses a <toolbarbutton> instead of a <menu>
document
.getElementById("organizeButton")
.addEventListener("popupshowing", () => {
document.getElementById("placeContent").focus();
});
}
// remove the "Edit" and "Edit Bookmark" context-menu item, we're in our own details pane
let contextMenu = document.getElementById("placesContext");
contextMenu.removeChild(document.getElementById("placesContext_show:info"));
contextMenu.removeChild(
document.getElementById("placesContext_show_bookmark:info")
);
contextMenu.removeChild(
document.getElementById("placesContext_show_folder:info")
);
let columnsContextPopup = document.getElementById("placesColumnsContext");
columnsContextPopup.addEventListener("command", event => {
ViewMenu.showHideColumn(event.target);
event.stopPropagation();
});
columnsContextPopup.addEventListener("popupshowing", event =>
ViewMenu.fillWithColumns(event, null, null, "checkbox", false)
);
document
.getElementById("fileRestorePopup")
.addEventListener("popupshowing", () => this.populateRestoreMenu());
if (!Services.policies.isAllowed("profileImport")) {
document
.getElementById("OrganizerCommand_browserImport")
.setAttribute("disabled", true);
}
ContentArea.focus();
},
QueryInterface: ChromeUtils.generateQI([]),
handleEvent: function PO_handleEvent(event) {
switch (event.type) {
case "load":
this.init();
break;
case "unload":
this.destroy();
break;
case "command":
switch (event.target.id) {
// == organizerCommandSet ==
case "OrganizerCommand_find:all":
PlacesSearchBox.findAll();
break;
case "OrganizerCommand_export":
this.exportBookmarks();
break;
case "OrganizerCommand_import":
this.importFromFile();
break;
case "OrganizerCommand_browserImport":
this.importFromBrowser();
break;
case "OrganizerCommand_backup":
this.backupBookmarks();
break;
case "OrganizerCommand_restoreFromFile":
this.onRestoreBookmarksFromFile();
break;
case "OrganizerCommand_search:save":
this.saveSearch();
break;
case "OrganizerCommand_search:moreCriteria":
PlacesQueryBuilder.addRow();
break;
case "OrganizerCommand:Back":
this.back();
break;
case "OrganizerCommand:Forward":
this.forward();
break;
case "OrganizerCommand:CloseWindow":
window.close();
break;
}
break;
case "AppCommand":
event.stopPropagation();
switch (event.command) {
case "Back":
if (this._backHistory.length) {
this.back();
}
break;
case "Forward":
if (this._forwardHistory.length) {
this.forward();
}
break;
case "Search":
PlacesSearchBox.findAll();
break;
}
break;
}
},
destroy: function PO_destroy() {},
_location: null,
get location() {
return this._location;
},
set location(aLocation) {
if (!aLocation || this._location == aLocation) {
return;
}
if (this.location) {
this._backHistory.unshift(this.location);
this._forwardHistory.splice(0, this._forwardHistory.length);
}
this._location = aLocation;
this._places.selectPlaceURI(aLocation);
if (!this._places.hasSelection) {
// If no node was found for the given place: uri, just load it directly
ContentArea.currentPlace = aLocation;
}
this.updateDetailsPane();
// update navigation commands
if (!this._backHistory.length) {
document
.getElementById("OrganizerCommand:Back")
.setAttribute("disabled", true);
} else {
document
.getElementById("OrganizerCommand:Back")
.removeAttribute("disabled");
}
if (!this._forwardHistory.length) {
document
.getElementById("OrganizerCommand:Forward")
.setAttribute("disabled", true);
} else {
document
.getElementById("OrganizerCommand:Forward")
.removeAttribute("disabled");
}
},
_backHistory: [],
_forwardHistory: [],
back: function PO_back() {
this._forwardHistory.unshift(this.location);
var historyEntry = this._backHistory.shift();
this._location = null;
this.location = historyEntry;
},
forward: function PO_forward() {
this._backHistory.unshift(this.location);
var historyEntry = this._forwardHistory.shift();
this._location = null;
this.location = historyEntry;
},
/**
* Called when a place folder is selected in the left pane.
*
* @param resetSearchBox
* true if the search box should also be reset, false otherwise.
* The search box should be reset when a new folder in the left
* pane is selected; the search scope and text need to be cleared in
* preparation for the new folder. Note that if the user manually
* resets the search box, either by clicking its reset button or by
* deleting its text, this will be false.
*/
_cachedLeftPaneSelectedURI: null,
onPlaceSelected: function PO_onPlaceSelected(resetSearchBox) {
// Don't change the right-hand pane contents when there's no selection.
if (!this._places.hasSelection) {
return;
}
let node = this._places.selectedNode;
let placeURI = node.uri;
// If either the place of the content tree in the right pane has changed or
// the user cleared the search box, update the place, hide the search UI,
// and update the back/forward buttons by setting location.
if (ContentArea.currentPlace != placeURI || !resetSearchBox) {
ContentArea.currentPlace = placeURI;
this.location = placeURI;
}
// When we invalidate a container we use suppressSelectionEvent, when it is
// unset a select event is fired, in many cases the selection did not really
// change, so we should check for it, and return early in such a case. Note
// that we cannot return any earlier than this point, because when
// !resetSearchBox, we need to update location and hide the UI as above,
// even though the selection has not changed.
if (placeURI == this._cachedLeftPaneSelectedURI) {
return;
}
this._cachedLeftPaneSelectedURI = placeURI;
// At this point, resetSearchBox is true, because the left pane selection
// has changed; otherwise we would have returned earlier.
let input = PlacesSearchBox.searchFilter;
input.value = "";
input.editor?.clearUndoRedo();
this._setSearchScopeForNode(node);
this.updateDetailsPane();
},
/**
* Sets the search scope based on aNode's properties.
*
* @param {object} aNode
* the node to set up scope from
*/
_setSearchScopeForNode: function PO__setScopeForNode(aNode) {
let itemGuid = aNode.bookmarkGuid;
if (
PlacesUtils.nodeIsHistoryContainer(aNode) ||
itemGuid == PlacesUtils.virtualHistoryGuid
) {
PlacesQueryBuilder.setScope("history");
} else if (itemGuid == PlacesUtils.virtualDownloadsGuid) {
PlacesQueryBuilder.setScope("downloads");
} else {
// Default to All Bookmarks for all other nodes, per bug 469437.
PlacesQueryBuilder.setScope("bookmarks");
}
},
/**
* Handle clicks on the places list.
* Single Left click, right click or modified click do not result in any
* special action, since they're related to selection.
*
* @param {object} aEvent
* The mouse event.
*/
onPlacesListClick: function PO_onPlacesListClick(aEvent) {
// Only handle clicks on tree children.
if (aEvent.target.localName != "treechildren") {
return;
}
let node = this._places.selectedNode;
if (node) {
let middleClick = aEvent.button == 1 && aEvent.detail == 1;
if (middleClick && PlacesUtils.nodeIsContainer(node)) {
// The command execution function will take care of seeing if the
// selection is a folder or a different container type, and will
// load its contents in tabs.
PlacesUIUtils.openMultipleLinksInTabs(node, aEvent, this._places);
}
}
},
/**
* Handle focus changes on the places list and the current content view.
*/
updateDetailsPane: function PO_updateDetailsPane() {
if (!ContentArea.currentViewOptions.showDetailsPane) {
return;
}
// _fillDetailsPane is only invoked when the activeElement is a tree,
// there's no other case where we need to update the details pane. This
// means it's not possible that while some input field in the panel is
// focused we try to update the panel contents causing potential dataloss
// of the user's input.
let view = PlacesUIUtils.getViewForNode(document.activeElement);
if (view) {
let selectedNodes = view.selectedNode
? [view.selectedNode]
: view.selectedNodes;
this._fillDetailsPane(selectedNodes);
}
},
/**
* Handle openFlatContainer events.
*
* @param {object} aContainer
* The node the event was dispatched on.
*/
openFlatContainer(aContainer) {
if (aContainer.bookmarkGuid) {
PlacesUtils.asContainer(this._places.selectedNode).containerOpen = true;
this._places.selectItems([aContainer.bookmarkGuid], false);
} else if (PlacesUtils.nodeIsQuery(aContainer)) {
this._places.selectPlaceURI(aContainer.uri);
}
},
/**
* @returns {object}
* Returns the options associated with the query currently loaded in the
* main places pane.
*/
getCurrentOptions: function PO_getCurrentOptions() {
return PlacesUtils.asQuery(ContentArea.currentView.result.root)
.queryOptions;
},
/**
* Show the migration wizard for importing passwords,
* cookies, history, preferences, and bookmarks.
*/
importFromBrowser: function PO_importFromBrowser() {
// We pass in the type of source we're using for use in telemetry:
MigrationUtils.showMigrationWizard(window, {
entrypoint: MigrationUtils.MIGRATION_ENTRYPOINTS.PLACES,
});
},
/**
* Open a file-picker and import the selected file into the bookmarks store
*/
importFromFile: function PO_importFromFile() {
let fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
let fpCallback = function fpCallback_done(aResult) {
if (aResult != Ci.nsIFilePicker.returnCancel && fp.fileURL) {
var { BookmarkHTMLUtils } = ChromeUtils.importESModule(
"resource://gre/modules/BookmarkHTMLUtils.sys.mjs"
);
BookmarkHTMLUtils.importFromURL(fp.fileURL.spec).catch(console.error);
}
};
fp.init(
window.browsingContext,
PlacesUIUtils.promptLocalization.formatValueSync(
"places-bookmarks-import"
),
Ci.nsIFilePicker.modeOpen
);
fp.appendFilters(Ci.nsIFilePicker.filterHTML);
fp.open(fpCallback);
},
/**
* Allows simple exporting of bookmarks.
*/
exportBookmarks: function PO_exportBookmarks() {
let fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
let fpCallback = function fpCallback_done(aResult) {
if (aResult != Ci.nsIFilePicker.returnCancel) {
var { BookmarkHTMLUtils } = ChromeUtils.importESModule(
"resource://gre/modules/BookmarkHTMLUtils.sys.mjs"
);
BookmarkHTMLUtils.exportToFile(fp.file.path).catch(console.error);
}
};
fp.init(
window.browsingContext,
PlacesUIUtils.promptLocalization.formatValueSync(
"places-bookmarks-export"
),
Ci.nsIFilePicker.modeSave
);
fp.appendFilters(Ci.nsIFilePicker.filterHTML);
fp.defaultString = "bookmarks.html";
fp.open(fpCallback);
},
/**
* Populates the restore menu with the dates of the backups available.
*/
populateRestoreMenu: function PO_populateRestoreMenu() {
let restorePopup = document.getElementById("fileRestorePopup");
const dtOptions = {
dateStyle: "long",
};
let dateFormatter = new Services.intl.DateTimeFormat(undefined, dtOptions);
// Remove existing menu items. Last item is the restoreFromFile item.
while (restorePopup.childNodes.length > 1) {
restorePopup.firstChild.remove();
}
(async () => {
let backupFiles = await PlacesBackups.getBackupFiles();
if (!backupFiles.length) {
return;
}
// Populate menu with backups.
for (let file of backupFiles) {
let fileSize = (await IOUtils.stat(file)).size;
let [size, unit] = DownloadUtils.convertByteUnits(fileSize);
let sizeString = PlacesUtils.getFormattedString("backupFileSizeText", [
size,
unit,
]);
let countString;
let count = PlacesBackups.getBookmarkCountForFile(file);
if (count != null) {
const [msg] = await document.l10n.formatMessages([
{ id: "places-details-pane-items-count", args: { count } },
]);
countString = msg.attributes.find(
attr => attr.name === "value"
)?.value;
}
const backupDate = PlacesBackups.getDateForFile(file);
let label = dateFormatter.format(backupDate);
label += countString
? ` (${sizeString} - ${countString})`
: ` (${sizeString})`;
let m = restorePopup.insertBefore(
document.createXULElement("menuitem"),
document.getElementById("restoreFromFile")
);
m.setAttribute("label", label);
m.setAttribute("value", PathUtils.filename(file));
m.addEventListener("command", () => this.onRestoreMenuItemClick(m));
}
// Add the restoreFromFile item.
restorePopup.insertBefore(
document.createXULElement("menuseparator"),
document.getElementById("restoreFromFile")
);
})();
},
/**
* Called when a menuitem is selected from the restore menu.
*
* @param {object} aMenuItem The menuitem that was selected.
*/
async onRestoreMenuItemClick(aMenuItem) {
let backupName = aMenuItem.getAttribute("value");
let backupFilePaths = await PlacesBackups.getBackupFiles();
for (let backupFilePath of backupFilePaths) {
if (PathUtils.filename(backupFilePath) == backupName) {
PlacesOrganizer.restoreBookmarksFromFile(backupFilePath);
break;
}
}
},
/**
* Called when 'Choose File...' is selected from the restore menu.
* Prompts for a file and restores bookmarks to those in the file.
*/
onRestoreBookmarksFromFile: function PO_onRestoreBookmarksFromFile() {
let backupsDir = Services.dirsvc.get("Desk", Ci.nsIFile);
let fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
let fpCallback = aResult => {
if (aResult != Ci.nsIFilePicker.returnCancel) {
this.restoreBookmarksFromFile(fp.file.path);
}
};
const [title, filterName] =
PlacesUIUtils.promptLocalization.formatValuesSync([
"places-bookmarks-restore-title",
"places-bookmarks-restore-filter-name",
]);
fp.init(window.browsingContext, title, Ci.nsIFilePicker.modeOpen);
fp.appendFilter(filterName, RESTORE_FILEPICKER_FILTER_EXT);
fp.appendFilters(Ci.nsIFilePicker.filterAll);
fp.displayDirectory = backupsDir;
fp.open(fpCallback);
},
/**
* Restores bookmarks from a JSON file.
*
* @param {string} aFilePath
* The path of the file to restore from.
*/
restoreBookmarksFromFile: function PO_restoreBookmarksFromFile(aFilePath) {
// check file extension
if (
!aFilePath.toLowerCase().endsWith("json") &&
!aFilePath.toLowerCase().endsWith("jsonlz4")
) {
this._showErrorAlert("places-bookmarks-restore-format-error");
return;
}
const [title, body] = PlacesUIUtils.promptLocalization.formatValuesSync([
"places-bookmarks-restore-alert-title",
"places-bookmarks-restore-alert",
]);
// confirm ok to delete existing bookmarks
if (!Services.prompt.confirm(null, title, body)) {
return;
}
(async function () {
try {
await BookmarkJSONUtils.importFromFile(aFilePath, {
replace: true,
});
} catch (ex) {
PlacesOrganizer._showErrorAlert("places-bookmarks-restore-parse-error");
}
})();
},
_showErrorAlert: function PO__showErrorAlert(l10nId) {
const [title, msg] = PlacesUIUtils.promptLocalization.formatValuesSync([
"places-error-title",
l10nId,
]);
Services.prompt.alert(window, title, msg);
},
/**
* Backup bookmarks to desktop, auto-generate a filename with a date.
* The file is a JSON serialization of bookmarks, tags and any annotations
* of those items.
*/
backupBookmarks: function PO_backupBookmarks() {
let backupsDir = Services.dirsvc.get("Desk", Ci.nsIFile);
let fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
let fpCallback = function fpCallback_done(aResult) {
if (aResult != Ci.nsIFilePicker.returnCancel) {
// There is no OS.File version of the filepicker yet (Bug 937812).
PlacesBackups.saveBookmarksToJSONFile(fp.file.path).catch(
console.error
);
}
};
const [title, filterName] =
PlacesUIUtils.promptLocalization.formatValuesSync([
"places-bookmarks-backup-title",
"places-bookmarks-restore-filter-name",
]);
fp.init(window.browsingContext, title, Ci.nsIFilePicker.modeSave);
fp.appendFilter(filterName, RESTORE_FILEPICKER_FILTER_EXT);
fp.defaultString = PlacesBackups.getFilenameForDate();
fp.defaultExtension = "json";
fp.displayDirectory = backupsDir;
fp.open(fpCallback);
},
_fillDetailsPane: function PO__fillDetailsPane(aNodeList) {
var infoBox = document.getElementById("infoBox");
var itemsCountBox = document.getElementById("itemsCountBox");
// Make sure the infoBox UI is visible if we need to use it, we hide it
// below when we don't.
infoBox.hidden = false;
itemsCountBox.hidden = true;
let selectedNode = aNodeList.length == 1 ? aNodeList[0] : null;
// Don't update the panel if it's already editing this node, unless we're
// in multi-edit mode.
if (
selectedNode &&
!gEditItemOverlay.multiEdit &&
((gEditItemOverlay.concreteGuid &&
gEditItemOverlay.concreteGuid ==
PlacesUtils.getConcreteItemGuid(selectedNode)) ||
(!selectedNode.bookmarkGuid &&
gEditItemOverlay.uri &&
gEditItemOverlay.uri == selectedNode.uri))
) {
return;
}
// Clean up the panel before initing it again.
gEditItemOverlay.uninitPanel(false);
if (selectedNode && !PlacesUtils.nodeIsSeparator(selectedNode)) {
gEditItemOverlay
.initPanel({
node: selectedNode,
hiddenRows: ["folderPicker"],
})
.catch(ex => console.error(ex));
} else if (!selectedNode && aNodeList[0]) {
if (aNodeList.every(PlacesUtils.nodeIsURI)) {
let uris = aNodeList.map(node => Services.io.newURI(node.uri));
gEditItemOverlay
.initPanel({
uris,
hiddenRows: ["folderPicker", "location", "keyword", "name"],
})
.catch(ex => console.error(ex));
} else {
let selectItemDesc = document.getElementById("selectItemDescription");
let itemsCountLabel = document.getElementById("itemsCountText");
selectItemDesc.hidden = false;
document.l10n.setAttributes(
itemsCountLabel,
"places-details-pane-items-count",
{ count: aNodeList.length }
);
infoBox.hidden = true;
}
} else {
infoBox.hidden = true;
let selectItemDesc = document.getElementById("selectItemDescription");
let itemsCountLabel = document.getElementById("itemsCountText");
let itemsCount = 0;
if (ContentArea.currentView.result) {
let rootNode = ContentArea.currentView.result.root;
if (rootNode.containerOpen) {
itemsCount = rootNode.childCount;
}
}
if (itemsCount == 0) {
selectItemDesc.hidden = true;
document.l10n.setAttributes(
itemsCountLabel,
"places-details-pane-no-items"
);
} else {
selectItemDesc.hidden = false;
document.l10n.setAttributes(
itemsCountLabel,
"places-details-pane-items-count",
{ count: itemsCount }
);
}
}
itemsCountBox.hidden = !infoBox.hidden;
},
};
window.addEventListener("load", PlacesOrganizer);
window.addEventListener("unload", PlacesOrganizer);
/**
* A set of utilities relating to search within Bookmarks and History.
*/
var PlacesSearchBox = {
/**
* The Search text field
*
* @see {@link https://searchfox.org/mozilla-central/source/toolkit/content/widgets/moz-input-search}
* @returns {HTMLInputElement}
*/
get searchFilter() {
return document.getElementById("searchFilter");
},
cumulativeHistorySearches: 0,
cumulativeBookmarkSearches: 0,
/**
* Folders to include when searching.
*/
_folders: [],
get folders() {
if (!this._folders.length) {
this._folders = PlacesUtils.bookmarks.userContentRoots;
}
return this._folders;
},
set folders(aFolders) {
this._folders = aFolders;
},
/**
* Run a search for the specified text, over the collection specified by
* the dropdown arrow. The default is all bookmarks, but can be
* localized to the active collection.
*
* @param {string} filterString
* The text to search for.
*/
search(filterString) {
var PO = PlacesOrganizer;
// If the user empties the search box manually, reset it and load all
// contents of the current scope.
// XXX this might be to jumpy, maybe should search for "", so results
// are ungrouped, and search box not reset
if (filterString == "") {
PO.onPlaceSelected(false);
return;
}
let currentView = ContentArea.currentView;
// Search according to the current scope, which was set by
// PQB_setScope()
switch (PlacesSearchBox.filterCollection) {
case "bookmarks":
currentView.applyFilter(filterString, this.folders);
Glean.library.search.bookmarks.add(1);
this.cumulativeBookmarkSearches++;
break;
case "history": {
let currentOptions = PO.getCurrentOptions();
if (
currentOptions.queryType !=
Ci.nsINavHistoryQueryOptions.QUERY_TYPE_HISTORY
) {
let query = PlacesUtils.history.getNewQuery();
query.searchTerms = filterString;
let options = currentOptions.clone();
// Make sure we're getting uri results.
options.resultType = currentOptions.RESULTS_AS_URI;
options.queryType = Ci.nsINavHistoryQueryOptions.QUERY_TYPE_HISTORY;
options.includeHidden = true;
currentView.load([query], options);
} else {
let timerId = Glean.library.historySearchTime.start();
currentView.applyFilter(filterString, null, true);
Glean.library.historySearchTime.stopAndAccumulate(timerId);
Glean.library.search.history.add(1);
this.cumulativeHistorySearches++;
}
break;
}
case "downloads": {
// The new downloads view doesn't use places for searching downloads.
currentView.searchTerm = filterString;
break;
}
default:
throw new Error("Invalid filterCollection on search");
}
// Update the details panel
PlacesOrganizer.updateDetailsPane();
},
/**
* Finds across all history, downloads or all bookmarks.
*/
findAll() {
switch (this.filterCollection) {
case "history":
PlacesQueryBuilder.setScope("history");
break;
case "downloads":
PlacesQueryBuilder.setScope("downloads");
break;
default:
PlacesQueryBuilder.setScope("bookmarks");
break;
}
this.focus();
},
/**
* Updates the search input placeholder to match the current collection.
*/
updatePlaceholder() {
let l10nId = "";
switch (this.filterCollection) {
case "history":
l10nId = "places-search-history";
break;
case "downloads":
l10nId = "places-search-downloads";
break;
default:
l10nId = "places-search-bookmarks";
}
document.l10n.setAttributes(this.searchFilter, l10nId);
},
/**
* Gets/sets the active collection from the dropdown menu.
*
* @returns {string}
*/
get filterCollection() {
return this.searchFilter.getAttribute("collection");
},
set filterCollection(collectionName) {
if (collectionName == this.filterCollection) {
return;
}
this.searchFilter.setAttribute("collection", collectionName);
this.updatePlaceholder();
},
/**
* Focus the search box
*/
focus() {
this.searchFilter.focus();
},
/**
* Set up the gray text in the search bar as the Places View loads.
*/
init() {
this.searchFilter.addEventListener("MozInputSearch:search", e => {
this.search(e.target.value);
});
this.updatePlaceholder();
},
/**
* Gets or sets the text shown in the Places Search Box
*
* @returns {string}
*/
get value() {
return this.searchFilter.value;
},
set value(value) {
this.searchFilter.value = value;
},
};
function updateTelemetry(urlsOpened) {
let historyLinks = urlsOpened.filter(
link => !link.isBookmark && !PlacesUtils.nodeIsBookmark(link)
);
if (!historyLinks.length) {
Glean.library.cumulativeBookmarkSearches.accumulateSingleSample(
PlacesSearchBox.cumulativeBookmarkSearches
);
// Clear cumulative search counter
PlacesSearchBox.cumulativeBookmarkSearches = 0;
Glean.library.link.bookmarks.add(urlsOpened.length);
return;
}
// Record cumulative search count before selecting History link from Library
Glean.library.cumulativeHistorySearches.accumulateSingleSample(
PlacesSearchBox.cumulativeHistorySearches
);
// Clear cumulative search counter
PlacesSearchBox.cumulativeHistorySearches = 0;
Glean.library.link.history.add(historyLinks.length);
}
/**
* Functions and data for advanced query builder
*/
var PlacesQueryBuilder = {
queries: [],
queryOptions: null,
/**
* Sets the search scope. This can be called when no search is active, and
* in that case, when `search()` is called, `aScope` will be used.
* If there is an active search, it's performed again to
* update the content tree.
*
* @param {"bookmarks" | "downloads" | "history"} aScope
* The search scope: "bookmarks", "downloads" or "history".
*/
setScope(aScope) {
// Determine filterCollection, folders, and scopeButtonId based on aScope.
var filterCollection;
var folders = [];
switch (aScope) {
case "history":
filterCollection = "history";
break;
case "bookmarks":
filterCollection = "bookmarks";
folders = PlacesUtils.bookmarks.userContentRoots;
break;
case "downloads":
filterCollection = "downloads";
break;
default:
throw new Error("Invalid search scope");
}
// Update the search box. Re-search if there's an active search.
PlacesSearchBox.filterCollection = filterCollection;
PlacesSearchBox.folders = folders;
var searchStr = PlacesSearchBox.searchFilter.value;
if (searchStr) {
PlacesSearchBox.search(searchStr);
}
},
};
/**
* Population and commands for the View Menu.
*/
var ViewMenu = {
init() {
let columnsPopup = document.querySelector("#viewColumns > menupopup");
columnsPopup.addEventListener("command", event => {
event.stopPropagation();
this.showHideColumn(event.target);
});
columnsPopup.addEventListener("popupshowing", event =>
this.fillWithColumns(event, null, null, "checkbox", false)
);
let sortPopup = document.querySelector("#viewSort > menupopup");
sortPopup.addEventListener("command", event => {
event.stopPropagation();
switch (event.target.id) {
case "viewUnsorted":
this.setSortColumn(null, null);
break;
case "viewSortAscending":
this.setSortColumn(null, "ascending");
break;
case "viewSortDescending":
this.setSortColumn(null, "descending");
break;
default:
this.setSortColumn(event.target.column, null);
break;
}
});
sortPopup.addEventListener("popupshowing", event =>
this.populateSortMenu(event)
);
},
/**
* Removes content generated previously from a menupopup.
*
* @param {object} popup
* The popup that contains the previously generated content.
* @param {string} startID
* The id attribute of an element that is the start of the
* dynamically generated region - remove elements after this
* item only.
* Must be contained by popup. Can be null (in which case the
* contents of popup are removed).
* @param {string} endID
* The id attribute of an element that is the end of the
* dynamically generated region - remove elements up to this
* item only.
* Must be contained by popup. Can be null (in which case all
* items until the end of the popup will be removed). Ignored
* if startID is null.
* @returns {object|null} The element for the caller to insert new items before,
* null if the caller should just append to the popup.
*/
_clean: function VM__clean(popup, startID, endID) {
if (endID && !startID) {
throw new Error("meaningless to have valid endID and null startID");
}
if (startID) {
var startElement = document.getElementById(startID);
if (startElement.parentNode != popup) {
throw new Error("startElement is not in popup");
}
if (!startElement) {
throw new Error("startID does not correspond to an existing element");
}
var endElement = null;
if (endID) {
endElement = document.getElementById(endID);
if (endElement.parentNode != popup) {
throw new Error("endElement is not in popup");
}
if (!endElement) {
throw new Error("endID does not correspond to an existing element");
}
}
while (startElement.nextSibling != endElement) {
popup.removeChild(startElement.nextSibling);
}
return endElement;
}
while (popup.hasChildNodes()) {
popup.firstChild.remove();
}
return null;
},
/**
* Fills a menupopup with a list of columns
*
* @param {object} event
* The popupshowing event that invoked this function.
* @param {string} startID
* see _clean
* @param {string} endID
* see _clean
* @param {string} type
* the type of the menuitem, e.g. "radio" or "checkbox".
* Can be null (no-type).
* Checkboxes are checked if the column is visible.
* @param {boolean} localize
* If localize is true, the column label and accesskey are set
* via DOM Localization.
* If localize is false, the column label is used as label and
* no accesskey is assigned.
*/
fillWithColumns: function VM_fillWithColumns(
event,
startID,
endID,
type,
localize
) {
var popup = event.target;
var pivot = this._clean(popup, startID, endID);
var content = document.getElementById("placeContent");
var columns = content.columns;
for (var i = 0; i < columns.count; ++i) {
var column = columns.getColumnAt(i).element;
var menuitem = document.createXULElement("menuitem");
menuitem.id = "menucol_" + column.id;
menuitem.column = column;
if (localize) {
const l10nId = SORTBY_L10N_IDS.get(column.getAttribute("anonid"));
document.l10n.setAttributes(menuitem, l10nId);
} else {
const label = column.getAttribute("label");
menuitem.setAttribute("label", label);
}
if (type == "radio") {
menuitem.setAttribute("type", "radio");
menuitem.setAttribute("name", "columns");
// This column is the sort key. Its item is checked.
if (column.hasAttribute("sortDirection")) {
menuitem.setAttribute("checked", "true");
}
} else if (type == "checkbox") {
menuitem.setAttribute("type", "checkbox");
// Cannot uncheck the primary column.
if (column.getAttribute("primary") == "true") {
menuitem.setAttribute("disabled", "true");
}
// Items for visible columns are checked.
if (!column.hidden) {
menuitem.setAttribute("checked", "true");
}
}
if (pivot) {
popup.insertBefore(menuitem, pivot);
} else {
popup.appendChild(menuitem);
}
}
event.stopPropagation();
},
/**
* Set up the content of the view menu.
*
* @param {object} event
* The event that invoked this function
*/
populateSortMenu: function VM_populateSortMenu(event) {
this.fillWithColumns(
event,
"viewUnsorted",
"directionSeparator",
"radio",
true
);
var sortColumn = this._getSortColumn();
var viewSortAscending = document.getElementById("viewSortAscending");
var viewSortDescending = document.getElementById("viewSortDescending");
// We need to remove an existing checked attribute because the unsorted
// menu item is not rebuilt every time we open the menu like the others.
var viewUnsorted = document.getElementById("viewUnsorted");
if (!sortColumn) {
viewSortAscending.removeAttribute("checked");
viewSortDescending.removeAttribute("checked");
viewUnsorted.setAttribute("checked", "true");
} else if (sortColumn.getAttribute("sortDirection") == "ascending") {
viewSortAscending.setAttribute("checked", "true");
viewSortDescending.removeAttribute("checked");
viewUnsorted.removeAttribute("checked");
} else if (sortColumn.getAttribute("sortDirection") == "descending") {
viewSortDescending.setAttribute("checked", "true");
viewSortAscending.removeAttribute("checked");
viewUnsorted.removeAttribute("checked");
}
},
/**
* Shows/Hides a tree column.
*
* @param {object} element
* The menuitem element for the column
*/
showHideColumn: function VM_showHideColumn(element) {
var column = element.column;
var splitter = column.nextSibling;
if (splitter && splitter.localName != "splitter") {
splitter = null;
}
const isChecked = element.getAttribute("checked") == "true";
column.hidden = !isChecked;
if (splitter) {
splitter.hidden = !isChecked;
}
},
/**
* Gets the last column that was sorted.
*
* @returns {object|null} the currently sorted column, null if there is no sorted column.
*/
_getSortColumn: function VM__getSortColumn() {
var content = document.getElementById("placeContent");
var cols = content.columns;
for (var i = 0; i < cols.count; ++i) {
var column = cols.getColumnAt(i).element;
var sortDirection = column.getAttribute("sortDirection");
if (sortDirection == "ascending" || sortDirection == "descending") {
return column;
}
}
return null;
},
/**
* Sorts the view by the specified column.
*
* @param {object} aColumn
* The colum that is the sort key. Can be null - the
* current sort column or the title column will be used.
* @param {string} aDirection
* The direction to sort - "ascending" or "descending".
* Can be null - the last direction or descending will be used.
*
* If both aColumnID and aDirection are null, the view will be unsorted.
*/
setSortColumn: function VM_setSortColumn(aColumn, aDirection) {
var result = document.getElementById("placeContent").result;
if (!aColumn && !aDirection) {
result.sortingMode = Ci.nsINavHistoryQueryOptions.SORT_BY_NONE;
return;
}
var columnId;
if (aColumn) {
columnId = aColumn.getAttribute("anonid");
if (!aDirection) {
let sortColumn = this._getSortColumn();
if (sortColumn) {
aDirection = sortColumn.getAttribute("sortDirection");
}
}
} else {
let sortColumn = this._getSortColumn();
columnId = sortColumn ? sortColumn.getAttribute("anonid") : "title";
}
// This maps the possible values of columnId (i.e., anonid's of treecols in
// placeContent) to the default sortingMode for each column.
// key: Sort key in the name of one of the
// nsINavHistoryQueryOptions.SORT_BY_* constants
// dir: Default sort direction to use if none has been specified
const colLookupTable = {
title: { key: "TITLE", dir: "ascending" },
tags: { key: "TAGS", dir: "ascending" },
url: { key: "URI", dir: "ascending" },
date: { key: "DATE", dir: "descending" },
visitCount: { key: "VISITCOUNT", dir: "descending" },
dateAdded: { key: "DATEADDED", dir: "descending" },
lastModified: { key: "LASTMODIFIED", dir: "descending" },
};
// Make sure we have a valid column.
if (!colLookupTable.hasOwnProperty(columnId)) {
throw new Error("Invalid column");
}
// Use a default sort direction if none has been specified. If aDirection
// is invalid, result.sortingMode will be undefined, which has the effect
// of unsorting the tree.
aDirection = (aDirection || colLookupTable[columnId].dir).toUpperCase();
var sortConst =
"SORT_BY_" + colLookupTable[columnId].key + "_" + aDirection;
result.sortingMode = Ci.nsINavHistoryQueryOptions[sortConst];
},
};
var ContentArea = {
_specialViews: new Map(),
init: function CA_init() {
this._box = document.getElementById("placesViewsBox");
this._toolbar = document.getElementById("placesToolbar");
ContentTree.init();
this._setupView();
},
/**
* Gets the content view to be used for loading the given query.
* If a custom view was set by setContentViewForQueryString, that
* view would be returned, else the default tree view is returned
*
* @param {string} aQueryString
* a query string
* @returns {object} the view to be used for loading aQueryString.
*/
getContentViewForQueryString: function CA_getContentViewForQueryString(
aQueryString
) {
try {
if (this._specialViews.has(aQueryString)) {
let { view, options } = this._specialViews.get(aQueryString);
if (typeof view == "function") {
view = view();
this._specialViews.set(aQueryString, { view, options });
}
return view;
}
} catch (ex) {
console.error(ex);
}
return ContentTree.view;
},
/**
* Sets a custom view to be used rather than the default places tree
* whenever the given query is selected in the left pane.
*
* @param {string} aQueryString
* a query string
* @param {object} aView
* Either the custom view or a function that will return the view
* the first (and only) time it's called.
* @param {object} [aOptions]
* Object defining special options for the view.
* @see ContentTree.viewOptions for supported options and default values.
*/
setContentViewForQueryString: function CA_setContentViewForQueryString(
aQueryString,
aView,
aOptions
) {
if (
!aQueryString ||
(typeof aView != "object" && typeof aView != "function")
) {
throw new Error("Invalid arguments");
}
this._specialViews.set(aQueryString, {
view: aView,
options: aOptions || {},
});
},
get currentView() {
let selectedPane = [...this._box.children].filter(
child => !child.hidden
)[0];
return PlacesUIUtils.getViewForNode(selectedPane);
},
set currentView(aNewView) {
let oldView = this.currentView;
if (oldView != aNewView) {
oldView.associatedElement.hidden = true;
aNewView.associatedElement.hidden = false;
// If the content area inactivated view was focused, move focus
// to the new view.
if (document.activeElement == oldView.associatedElement) {
aNewView.associatedElement.focus();
}
}
},
get currentPlace() {
return this.currentView.place;
},
set currentPlace(aQueryString) {
let oldView = this.currentView;
let newView = this.getContentViewForQueryString(aQueryString);
newView.place = aQueryString;
if (oldView != newView) {
oldView.active = false;
this.currentView = newView;
this._setupView();
newView.active = true;
}
},
/**
* Applies view options.
*/
_setupView: function CA__setupView() {
let options = this.currentViewOptions;
// showDetailsPane.
let detailsPane = document.getElementById("detailsPane");
detailsPane.hidden = !options.showDetailsPane;
// toolbarSet.
for (let elt of this._toolbar.childNodes) {
// On Windows and Linux the menu buttons are menus wrapped in a menubar.
if (elt.id == "placesMenu") {
for (let menuElt of elt.childNodes) {
menuElt.hidden = !options.toolbarSet.includes(menuElt.id);
}
} else {
elt.hidden = !options.toolbarSet.includes(elt.id);
}
}
},
/**
* Options for the current view.
*
* @see {@link ContentTree.viewOptions} for supported options and default values.
* @returns {{showDetailsPane: boolean;toolbarSet: string;}}
*/
get currentViewOptions() {
// Use ContentTree options as default.
let viewOptions = ContentTree.viewOptions;
if (this._specialViews.has(this.currentPlace)) {
let { options } = this._specialViews.get(this.currentPlace);
for (let option in options) {
viewOptions[option] = options[option];
}
}
return viewOptions;
},
focus() {
this.currentView.associatedElement.focus();
},
};
var ContentTree = {
init: function CT_init() {
this._view = document.getElementById("placeContent");
this.view.addEventListener("keypress", this);
document
.querySelector("#placeContent > treechildren")
.addEventListener("click", this);
},
get view() {
return this._view;
},
get viewOptions() {
return Object.seal({
showDetailsPane: true,
toolbarSet:
"back-button, forward-button, organizeButton, viewMenu, maintenanceButton, libraryToolbarSpacer, searchFilter",
});
},
openSelectedNode: function CT_openSelectedNode(aEvent) {
let view = this.view;
PlacesUIUtils.openNodeWithEvent(view.selectedNode, aEvent);
},
handleEvent(event) {
switch (event.type) {
case "click":
this.onClick(event);
break;
case "keypress":
this.onKeyPress(event);
break;
}
},
onClick: function CT_onClick(aEvent) {
let node = this.view.selectedNode;
if (node) {
let doubleClick = aEvent.button == 0 && aEvent.detail == 2;
let middleClick = aEvent.button == 1 && aEvent.detail == 1;
if (PlacesUtils.nodeIsURI(node) && (doubleClick || middleClick)) {
// Open associated uri in the browser.
this.openSelectedNode(aEvent);
} else if (middleClick && PlacesUtils.nodeIsContainer(node)) {
// The command execution function will take care of seeing if the
// selection is a folder or a different container type, and will
// load its contents in tabs.
PlacesUIUtils.openMultipleLinksInTabs(node, aEvent, this.view);
}
}
},
onKeyPress: function CT_onKeyPress(aEvent) {
if (aEvent.keyCode == KeyEvent.DOM_VK_RETURN) {
this.openSelectedNode(aEvent);
}
},
};
|