/* 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.defineLazyScriptGetter(this, ["PlacesToolbar", "PlacesMenu", "PlacesPanelview", "PlacesPanelMenuView"], "chrome://browser/content/places/browserPlacesViews.js"); var StarUI = { _itemGuids: null, _batching: false, _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, _removeBookmarksOnPopupHidden: false, _element(aID) { return document.getElementById(aID); }, // Edit-bookmark panel get panel() { delete this.panel; var element = this._element("editBookmarkPanel"); // initially the panel is hidden // to avoid impacting startup / new window performance element.hidden = false; element.addEventListener("keypress", this); 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; }, // Array of command elements to disable when the panel is opened. get _blockedCommands() { delete this._blockedCommands; return this._blockedCommands = ["cmd_close", "cmd_closeWindow"].map(id => this._element(id)); }, _blockCommands: function SU__blockCommands() { this._blockedCommands.forEach(function(elt) { // make sure not to permanently disable this item (see bug 409155) if (elt.hasAttribute("wasDisabled")) return; if (elt.getAttribute("disabled") == "true") { elt.setAttribute("wasDisabled", "true"); } else { elt.setAttribute("wasDisabled", "false"); elt.setAttribute("disabled", "true"); } }); }, _restoreCommandsState: function SU__restoreCommandsState() { this._blockedCommands.forEach(function(elt) { if (elt.getAttribute("wasDisabled") != "true") elt.removeAttribute("disabled"); elt.removeAttribute("wasDisabled"); }); }, // 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) { if (!this._element("editBookmarkPanelContent").hidden) this.quitEditMode(); if (this._anchorToolbarButton) { this._anchorToolbarButton.removeAttribute("open"); this._anchorToolbarButton = null; } this._restoreCommandsState(); let removeBookmarksOnPopupHidden = this._removeBookmarksOnPopupHidden; this._removeBookmarksOnPopupHidden = false; let guidsForRemoval = this._itemGuids; this._itemGuids = null; if (this._batching) { this.endBatch(); } if (removeBookmarksOnPopupHidden && guidsForRemoval) { if (this._isNewBookmark) { PlacesTransactions.undo().catch(Cu.reportError); break; } // Remove all bookmarks for the bookmark's url, this also removes // the tags for the url. PlacesTransactions.Remove(guidsForRemoval) .transact().catch(Cu.reportError); } else if (this._isNewBookmark) { LibraryUI.triggerLibraryAnimation("bookmark"); } } 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: 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) { // 3500ms matches the timeout that Pocket uses in // browser/extensions/pocket/content/panels/js/saved.js let delay = 3500; if (this._closePanelQuickForTesting) { delay /= 10; } clearTimeout(this._autoCloseTimer); this._autoCloseTimer = setTimeout(() => { if (!this.panel.mozMatchesSelector(":hover")) { this.panel.hidePopup(true); } }, delay); this._autoCloseTimerEnabled = true; } break; } }, _overlayLoaded: false, _overlayLoading: false, async showEditBookmarkPopup(aNode, aAnchorElement, aPosition, aIsNewBookmark, aUrl) { // Slow double-clicks (not true double-clicks) shouldn't // cause the panel to flicker. if (this.panel.state == "showing" || this.panel.state == "open") { return; } this._isNewBookmark = aIsNewBookmark; this._itemGuids = null; // Performance: load the overlay the first time the panel is opened // (see bug 392443). if (this._overlayLoading) return; if (this._overlayLoaded) { await this._doShowEditBookmarkPanel(aNode, aAnchorElement, aPosition, aUrl); return; } this._overlayLoading = true; document.loadOverlay( "chrome://browser/content/places/editBookmarkOverlay.xul", (aSubject, aTopic, aData) => { // Move the header (star, title, button) into the grid, // so that it aligns nicely with the other items (bug 484022). let header = this._element("editBookmarkPanelHeader"); let rows = this._element("editBookmarkPanelGrid").lastChild; rows.insertBefore(header, rows.firstChild); header.hidden = false; this._overlayLoading = false; this._overlayLoaded = true; this._doShowEditBookmarkPanel(aNode, aAnchorElement, aPosition, aUrl); } ); }, async _doShowEditBookmarkPanel(aNode, aAnchorElement, aPosition, aUrl) { if (this.panel.state != "closed") return; this._blockCommands(); // un-done in the popuphidden handler this._element("editBookmarkPanelTitle").value = this._isNewBookmark ? gNavigatorBundle.getString("editBookmarkPanel.pageBookmarkedTitle") : gNavigatorBundle.getString("editBookmarkPanel.editBookmarkTitle"); // No description; show the Done, Remove; this._element("editBookmarkPanelDescription").textContent = ""; this._element("editBookmarkPanelBottomButtons").hidden = false; this._element("editBookmarkPanelContent").hidden = false; // The label of the remove button differs if the URI is bookmarked // multiple times. this._itemGuids = []; await PlacesUtils.bookmarks.fetch({url: aUrl}, bookmark => this._itemGuids.push(bookmark.guid)); let forms = gNavigatorBundle.getString("editBookmark.removeBookmarks.label"); let bookmarksCount = this._itemGuids.length; let label = PluralForm.get(bookmarksCount, forms) .replace("#1", bookmarksCount); this._element("editBookmarkPanelRemoveButton").label = label; this.beginBatch(); if (aAnchorElement && aAnchorElement.closest("#urlbar")) { this._anchorToolbarButton = aAnchorElement; aAnchorElement.setAttribute("open", "true"); } else { this._anchorToolbarButton = null; } 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(event) { fn(); }, {"capture": true, "once": true}); }; gEditItemOverlay.initPanel({ node: aNode, onPanelReady, hiddenRows: ["description", "location", "loadInSidebar", "keyword"], focusedElement: "preferred"}); this.panel.openPopup(aAnchorElement, aPosition); }, panelShown: function SU_panelShown(aEvent) { if (aEvent.target == this.panel) { if (this._element("editBookmarkPanelContent").hidden) { // Note this isn't actually used anymore, we should remove this // once we decide not to bring back the page bookmarked notification this.panel.focus(); } } }, quitEditMode: function SU_quitEditMode() { this._element("editBookmarkPanelContent").hidden = true; this._element("editBookmarkPanelBottomButtons").hidden = true; gEditItemOverlay.uninitPanel(true); }, removeBookmarkButtonCommand: function SU_removeBookmarkButtonCommand() { this._removeBookmarksOnPopupHidden = true; this.panel.hidePopup(); }, // Matching the way it is used in the Library, editBookmarkOverlay implements // an instant-apply UI, having no batched-Undo/Redo support. // However, in this context (the Star UI) we have a Cancel button whose // expected behavior is to undo all the operations done in the panel. // Sometime in the future this needs to be reimplemented using a // non-instant apply code path, but for the time being, we patch-around // editBookmarkOverlay so that all of the actions done in the panel // are treated by PlacesTransactions as a single batch. To do so, // we start a PlacesTransactions batch when the star UI panel is shown, and // we keep the batch ongoing until the panel is hidden. _batchBlockingDeferred: null, beginBatch() { if (this._batching) return; this._batchBlockingDeferred = PromiseUtils.defer(); PlacesTransactions.batch(async () => { await this._batchBlockingDeferred.promise; }); this._batching = true; }, endBatch() { if (!this._batching) return; this._batchBlockingDeferred.resolve(); this._batchBlockingDeferred = null; this._batching = false; } }; // Checks if an element is visible without flushing layout changes. function isVisible(element) { let windowUtils = window.QueryInterface(Ci.nsIInterfaceRequestor) .getInterface(Ci.nsIDOMWindowUtils); let bounds = windowUtils.getBoundsWithoutFlushing(element); return bounds.height > 0 && bounds.width > 0; } var PlacesCommandHook = { /** * Adds a bookmark to the page loaded in the given browser. * * @param aBrowser * a element. * @param [optional] aShowEditUI * whether or not to show the edit-bookmark UI for the bookmark item * @param [optional] aUrl * Option to provide a URL to bookmark rather than the current page * @param [optional] aTitle * Option to provide a title for a bookmark to use rather than the * getting the current page's title */ async bookmarkPage(aBrowser, aShowEditUI, aUrl = null, aTitle = null) { // If aUrl is provided, we want to bookmark that url rather than the // the current page let url = aUrl ? new URL(aUrl) : new URL(aBrowser.currentURI.spec); let info = await PlacesUtils.bookmarks.fetch({ url }); let isNewBookmark = !info; if (!info) { let parentGuid = PlacesUtils.bookmarks.unfiledGuid; info = { url, parentGuid }; // Bug 1148838 - Make this code work for full page plugins. let description = null; let charset = null; let docInfo = aUrl ? {} : await this._getPageDetails(aBrowser); try { if (docInfo.isErrorPage) { let entry = await PlacesUtils.history.fetch(aBrowser.currentURI); if (entry) { info.title = entry.title; } } else { info.title = aTitle || aBrowser.contentTitle; } info.title = info.title || url.href; description = docInfo.description; charset = aUrl ? null : aBrowser.characterSet; } catch (e) { Components.utils.reportError(e); } if (aShowEditUI && isNewBookmark) { // If we bookmark the page here but open right into a cancelable // state (i.e. new bookmark in Library), start batching here so // all of the actions can be undone in a single undo step. StarUI.beginBatch(); } if (description) { info.annotations = [{ name: PlacesUIUtils.DESCRIPTION_ANNO, value: description }]; } info.guid = await PlacesTransactions.NewBookmark(info).transact(); // Set the character-set if (charset && !PrivateBrowsingUtils.isBrowserPrivate(aBrowser)) PlacesUtils.setCharsetForURI(makeURI(url.href), charset); } // Revert the contents of the location bar gURLBar.handleRevert(); // If it was not requested to open directly in "edit" mode, we are done. if (!aShowEditUI) return; let node = await PlacesUIUtils.promiseNodeLikeFromFetchInfo(info); let anchor = BookmarkingUI.anchor; if (anchor) { await StarUI.showEditBookmarkPopup(node, anchor, "bottomcenter topright", isNewBookmark, url); return; } // Fall back to showing the panel over the content area. await StarUI.showEditBookmarkPopup(node, aBrowser, "overlap", isNewBookmark, url); }, _getPageDetails(browser) { return new Promise(resolve => { let mm = browser.messageManager; mm.addMessageListener("Bookmarks:GetPageDetails:Result", function listener(msg) { mm.removeMessageListener("Bookmarks:GetPageDetails:Result", listener); resolve(msg.data); }); mm.sendAsyncMessage("Bookmarks:GetPageDetails", { }); }); }, /** * Adds a bookmark to the page targeted by a link. * @param parentId * The folder in which to create a new bookmark if aURL isn't * bookmarked. * @param url (string) * the address of the link target * @param title * The link text * @param [optional] description * The linked page description, if available */ async bookmarkLink(parentId, url, title, description = "") { let bm = await PlacesUtils.bookmarks.fetch({url}); if (bm) { let node = await PlacesUIUtils.promiseNodeLikeFromFetchInfo(bm); PlacesUIUtils.showBookmarkDialog({ action: "edit", node }, window.top); return; } let parentGuid = parentId == PlacesUtils.bookmarksMenuFolderId ? PlacesUtils.bookmarks.menuGuid : await PlacesUtils.promiseItemGuid(parentId); let defaultInsertionPoint = new InsertionPoint({ parentId, parentGuid }); PlacesUIUtils.showBookmarkDialog({ action: "add", type: "bookmark", uri: makeURI(url), title, description, defaultInsertionPoint, hiddenRows: [ "description", "location", "loadInSidebar", "keyword" ] }, window.top); }, /** * List of nsIURI objects characterizing the tabs currently open in the * browser, modulo pinned tabs. The URIs will be in the order in which their * corresponding tabs appeared and duplicates are discarded. */ get uniqueCurrentPages() { let uniquePages = {}; let URIs = []; gBrowser.visibleTabs.forEach(tab => { let browser = tab.linkedBrowser; let uri = browser.currentURI; let title = browser.contentTitle || tab.label; let spec = uri.spec; if (!tab.pinned && !(spec in uniquePages)) { uniquePages[spec] = null; URIs.push({ uri, title }); } }); return URIs; }, /** * Adds a folder with bookmarks to all of the currently open tabs in this * window. */ bookmarkCurrentPages: function PCH_bookmarkCurrentPages() { let pages = this.uniqueCurrentPages; if (pages.length > 1) { PlacesUIUtils.showBookmarkDialog({ action: "add", type: "folder", URIList: pages, hiddenRows: [ "description" ] }, window); } }, /** * Updates disabled state for the "Bookmark All Tabs" command. */ updateBookmarkAllTabsCommand: function PCH_updateBookmarkAllTabsCommand() { // There's nothing to do in non-browser windows. if (window.location.href != getBrowserURL()) return; // Disable "Bookmark All Tabs" if there are less than two // "unique current pages". goSetCommandEnabled("Browser:BookmarkAllTabs", this.uniqueCurrentPages.length >= 2); }, /** * Adds a Live Bookmark to a feed associated with the current page. * @param url * The nsIURI of the page the feed was attached to * @title title * The title of the feed. Optional. * @subtitle subtitle * A short description of the feed. Optional. */ async addLiveBookmark(url, feedTitle, feedSubtitle) { let toolbarIP = new InsertionPoint({ parentId: PlacesUtils.toolbarFolderId, parentGuid: PlacesUtils.bookmarks.toolbarGuid }); let feedURI = makeURI(url); let title = feedTitle || gBrowser.contentTitle; let description = feedSubtitle; if (!description) { description = (await this._getPageDetails(gBrowser.selectedBrowser)).description; } PlacesUIUtils.showBookmarkDialog({ action: "add", type: "livemark", feedURI, siteURI: gBrowser.currentURI, title, description, defaultInsertionPoint: toolbarIP, hiddenRows: [ "feedLocation", "siteLocation", "description" ] }, window); }, /** * 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.xul", "", "chrome,toolbar=yes,dialog=no,resizable", item); } else { organizer.PlacesOrganizer.selectLeftPaneContainerByHierarchy(item); organizer.focus(); } }, searchBookmarks() { if (!focusAndSelectUrlBar()) { return; } for (let char of ["*", " "]) { let code = char.charCodeAt(0); gURLBar.inputField.dispatchEvent(new KeyboardEvent("keypress", { keyCode: code, charCode: code, bubbles: true })); } } }; ChromeUtils.defineModuleGetter(this, "RecentlyClosedTabsAndWindowsMenuUtils", "resource:///modules/sessionstore/RecentlyClosedTabsAndWindowsMenuUtils.jsm"); // View for the history menu. function HistoryMenu(aPopupShowingEvent) { // Workaround for Bug 610187. The sidebar does not include all the Places // views definitions, and we don't need them there. // Defining the prototype inheritance in the prototype itself would cause // browser.js to halt on "PlacesMenu is not defined" error. this.__proto__.__proto__ = PlacesMenu.prototype; PlacesMenu.call(this, aPopupShowingEvent, "place:sort=4&maxResults=15"); } HistoryMenu.prototype = { _getClosedTabCount() { // SessionStore doesn't track the hidden window, so just return zero then. if (window == Services.appShell.hiddenDOMWindow) { return 0; } return SessionStore.getClosedTabCount(window); }, toggleRecentlyClosedTabs: function HM_toggleRecentlyClosedTabs() { // enable/disable the Recently Closed Tabs sub menu var undoMenu = this._rootElt.getElementsByClassName("recentlyClosedTabsMenu")[0]; // no restorable tabs, so disable menu if (this._getClosedTabCount() == 0) undoMenu.setAttribute("disabled", true); else undoMenu.removeAttribute("disabled"); }, /** * Populate when the history menu is opened */ populateUndoSubmenu: function PHM_populateUndoSubmenu() { var undoMenu = this._rootElt.getElementsByClassName("recentlyClosedTabsMenu")[0]; var undoPopup = undoMenu.firstChild; // remove existing menu items while (undoPopup.hasChildNodes()) undoPopup.firstChild.remove(); // no restorable tabs, so make sure menu is disabled, and return if (this._getClosedTabCount() == 0) { undoMenu.setAttribute("disabled", true); return; } // enable menu undoMenu.removeAttribute("disabled"); // populate menu let tabsFragment = RecentlyClosedTabsAndWindowsMenuUtils.getTabsFragment(window, "menuitem"); undoPopup.appendChild(tabsFragment); }, toggleRecentlyClosedWindows: function PHM_toggleRecentlyClosedWindows() { // enable/disable the Recently Closed Windows sub menu var undoMenu = this._rootElt.getElementsByClassName("recentlyClosedWindowsMenu")[0]; // no restorable windows, so disable menu if (SessionStore.getClosedWindowCount() == 0) undoMenu.setAttribute("disabled", true); else undoMenu.removeAttribute("disabled"); }, /** * Populate when the history menu is opened */ populateUndoWindowSubmenu: function PHM_populateUndoWindowSubmenu() { let undoMenu = this._rootElt.getElementsByClassName("recentlyClosedWindowsMenu")[0]; let undoPopup = undoMenu.firstChild; // 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) { undoMenu.setAttribute("disabled", true); return; } // enable menu undoMenu.removeAttribute("disabled"); // populate menu let windowsFragment = RecentlyClosedTabsAndWindowsMenuUtils.getWindowsFragment(window, "menuitem"); undoPopup.appendChild(windowsFragment); }, toggleTabsFromOtherComputers: function PHM_toggleTabsFromOtherComputers() { // Enable/disable the Tabs From Other Computers menu. Some of the menus handled // by HistoryMenu do not have this menuitem. let menuitem = this._rootElt.getElementsByClassName("syncTabsMenuItem")[0]; if (!menuitem) return; if (!PlacesUIUtils.shouldShowTabsFromOtherComputersMenuitem()) { menuitem.setAttribute("hidden", true); return; } menuitem.setAttribute("hidden", false); }, _onPopupShowing: function HM__onPopupShowing(aEvent) { PlacesMenu.prototype._onPopupShowing.apply(this, arguments); // Don't handle events for submenus. if (aEvent.target != aEvent.currentTarget) return; this.toggleRecentlyClosedTabs(); this.toggleRecentlyClosedWindows(); this.toggleTabsFromOtherComputers(); }, _onCommand: function HM__onCommand(aEvent) { let placesNode = aEvent.target._placesNode; if (placesNode) { if (!PrivateBrowsingUtils.isWindowPrivate(window)) PlacesUIUtils.markPageAsTyped(placesNode.uri); openUILink(placesNode.uri, aEvent, { ignoreAlt: true }); } } }; /** * 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 left-click with modifier if not browser.bookmarks.openInTabClosesMenu. if (aEvent.button != 0 || PlacesUIUtils.openInTabClosesMenu) return; let target = aEvent.originalTarget; if (target.tagName != "menuitem") return; let modifKey = AppConstants.platform === "macosx" ? aEvent.metaKey : aEvent.ctrlKey; if (modifKey) { target.setAttribute("closemenu", "none"); } }, 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); } // Command already processed so remove any closemenu attr set in onMouseUp. if (aEvent.button == 0 && target.tagName == "menuitem" && target.getAttribute("closemenu") == "none") { // On Mac we need to extend when we remove the flag, to avoid any pre-close // animations. setTimeout(() => { target.removeAttribute("closemenu"); }, 500); } 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.openContainerNodeInTabs(target._placesNode, aEvent, aView); } else if (aEvent.button == 1) { // left-clicks with modifier are already served by onCommand this.onCommand(aEvent); } }, /** * 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); }, fillInBHTooltip: function BEH_fillInBHTooltip(aDocument, aEvent) { var node; var cropped = false; var targetURI; if (aDocument.tooltipNode.localName == "treechildren") { var tree = aDocument.tooltipNode.parentNode; var tbo = tree.treeBoxObject; var cell = tbo.getCellAt(aEvent.clientX, aEvent.clientY); if (cell.row == -1) return false; node = tree.view.nodeForTreeIndex(cell.row); cropped = tbo.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 = aDocument.tooltipNode; 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; var tooltipTitle = aDocument.getElementById("bhtTitleText"); tooltipTitle.hidden = (!title || (title == url)); if (!tooltipTitle.hidden) tooltipTitle.textContent = title; var tooltipUrl = aDocument.getElementById("bhtUrlText"); tooltipUrl.hidden = !url; if (!tooltipUrl.hidden) 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 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.lastChild; 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.showPopup(popup); }, this._springLoadDelayMs, Ci.nsITimer.TYPE_ONE_SHOT); event.preventDefault(); event.stopPropagation(); }, /** * Handles dragleave on the 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.lastChild; 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" || node.getAttribute("type") == "menu-button")); let isStatic = !("_placesNode" in node) && node.lastChild && node.lastChild.hasAttribute("placespopup") && !node.parentNode.hasAttribute("placespopup"); return isMenu && isStatic; }, /** * Called when the user drags over the element. * @param event * The DragOver event. */ onDragOver: function PMDH_onDragOver(event) { let ip = new InsertionPoint({ parentId: PlacesUtils.bookmarksMenuFolderId, parentGuid: PlacesUtils.bookmarks.menuGuid }); if (ip && PlacesControllerDragHelper.canDrop(ip, event.dataTransfer)) event.preventDefault(); event.stopPropagation(); }, /** * Called when the user drops on the element. * @param event * The Drop event. */ onDrop: function PMDH_onDrop(event) { // Put the item at the end of bookmark menu. let ip = new InsertionPoint({ parentId: PlacesUtils.bookmarksMenuFolderId, 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. */ var PlacesToolbarHelper = { _place: "place:folder=TOOLBAR", get _viewElt() { return document.getElementById("PlacesToolbar"); }, init: function PTH_init() { let viewElt = this._viewElt; if (!viewElt || viewElt._placesView) 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(this._place); }, handleEvent(event) { switch (event.type) { case "toolbarvisibilitychange": if (event.target == this._getParentToolbar(this._viewElt)) this._resetView(); break; } }, 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_MENU_PANEL) { PlacesCommandHook.showPlacesOrganizer("BookmarksToolbar"); } }, _getParentToolbar(element) { while (element) { if (element.localName == "toolbar") { return element; } element = element.parentNode; } return null; }, onWidgetUnderflow(aNode, aContainer) { // 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, aArea, aPosition) { 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(); } }, }; /** * Handles the Library button in the toolbar. */ var LibraryUI = { triggerLibraryAnimation(animation) { if (!this.hasOwnProperty("COSMETIC_ANIMATIONS_ENABLED")) { XPCOMUtils.defineLazyPreferenceGetter(this, "COSMETIC_ANIMATIONS_ENABLED", "toolkit.cosmeticAnimations.enabled", true); } let libraryButton = document.getElementById("library-button"); if (!libraryButton || libraryButton.getAttribute("cui-areatype") == "menu-panel" || libraryButton.getAttribute("overflowedItem") == "true" || !libraryButton.closest("#nav-bar") || !window.toolbar.visible || !this.COSMETIC_ANIMATIONS_ENABLED) { return; } let animatableBox = document.getElementById("library-animatable-box"); let navBar = document.getElementById("nav-bar"); let libraryIcon = document.getAnonymousElementByAttribute(libraryButton, "class", "toolbarbutton-icon"); let dwu = window.getInterface(Ci.nsIDOMWindowUtils); let iconBounds = dwu.getBoundsWithoutFlushing(libraryIcon); let libraryBounds = dwu.getBoundsWithoutFlushing(libraryButton); let toolboxBounds = dwu.getBoundsWithoutFlushing(gNavToolbox); animatableBox.style.setProperty("--toolbox-y", toolboxBounds.y + "px"); animatableBox.style.setProperty("--library-button-y", libraryBounds.y + "px"); animatableBox.style.setProperty("--library-button-height", libraryBounds.height + "px"); animatableBox.style.setProperty("--library-icon-x", iconBounds.x + "px"); if (navBar.hasAttribute("brighttext")) { animatableBox.setAttribute("brighttext", "true"); } else { animatableBox.removeAttribute("brighttext"); } animatableBox.removeAttribute("fade"); libraryButton.setAttribute("animate", animation); animatableBox.setAttribute("animate", animation); if (!this._libraryButtonAnimationEndListeners[animation]) { this._libraryButtonAnimationEndListeners[animation] = event => { this._libraryButtonAnimationEndListener(event, animation); }; } animatableBox.addEventListener("animationend", this._libraryButtonAnimationEndListeners[animation]); window.addEventListener("resize", this._onWindowResize); }, _libraryButtonAnimationEndListeners: {}, _libraryButtonAnimationEndListener(aEvent, animation) { let animatableBox = document.getElementById("library-animatable-box"); if (aEvent.animationName.startsWith(`library-${animation}-animation`)) { animatableBox.setAttribute("fade", "true"); } else if (aEvent.animationName == `library-${animation}-fade`) { animatableBox.removeEventListener("animationend", LibraryUI._libraryButtonAnimationEndListeners[animation]); animatableBox.removeAttribute("animate"); animatableBox.removeAttribute("fade"); window.removeEventListener("resize", this._onWindowResize); let libraryButton = document.getElementById("library-button"); // Put the 'fill' back in the normal icon. libraryButton.removeAttribute("animate"); } }, _windowResizeRunning: false, _onWindowResize(aEvent) { if (LibraryUI._windowResizeRunning) { return; } LibraryUI._windowResizeRunning = true; requestAnimationFrame(() => { let libraryButton = document.getElementById("library-button"); // Only update the position if the library button remains in the // navbar (not moved to the palette or elsewhere). if (!libraryButton || libraryButton.getAttribute("cui-areatype") == "menu-panel" || libraryButton.getAttribute("overflowedItem") == "true" || !libraryButton.closest("#nav-bar")) { return; } let animatableBox = document.getElementById("library-animatable-box"); let libraryIcon = document.getAnonymousElementByAttribute(libraryButton, "class", "toolbarbutton-icon"); let dwu = window.getInterface(Ci.nsIDOMWindowUtils); let iconBounds = dwu.getBoundsWithoutFlushing(libraryIcon); // Resizing the window will only have the ability to change the X offset of the // library button. animatableBox.style.setProperty("--library-icon-x", iconBounds.x + "px"); LibraryUI._windowResizeRunning = false; }); }, }; /** * 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 notifier() { delete this.notifier; return this.notifier = document.getElementById("bookmarked-notification-anchor"); }, get dropmarkerNotifier() { delete this.dropmarkerNotifier; return this.dropmarkerNotifier = document.getElementById("bookmarked-notification-dropmarker-anchor"); }, get broadcaster() { delete this.broadcaster; let broadcaster = document.getElementById("bookmarkThisPageBroadcaster"); return this.broadcaster = broadcaster; }, STATUS_UPDATING: -1, STATUS_UNSTARRED: 0, STATUS_STARRED: 1, get status() { if (this._pendingUpdate) return this.STATUS_UPDATING; return this.broadcaster.hasAttribute("starred") ? this.STATUS_STARRED : this.STATUS_UNSTARRED; }, get _starredTooltip() { delete this._starredTooltip; return this._starredTooltip = this._getFormattedTooltip("starButtonOn.tooltip2"); }, get _unstarredTooltip() { delete this._unstarredTooltip; return this._unstarredTooltip = this._getFormattedTooltip("starButtonOff.tooltip2"); }, _getFormattedTooltip(strId) { let args = []; let shortcut = document.getElementById(this.BOOKMARK_BUTTON_SHORTCUT); if (shortcut) args.push(ShortcutUtils.prettifyShortcut(shortcut)); return gNavigatorBundle.getFormattedString(strId, args); }, /** * The popup contents must be updated when the user customizes the UI, or * changes the personal toolbar collapsed status. In such a case, any needed * change should be handled in the popupshowing helper, for performance * reasons. */ _popupNeedsUpdate: true, onToolbarVisibilityChange: function BUI_onToolbarVisibilityChange() { this._popupNeedsUpdate = true; }, 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_MENU_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")); if (!this._popupNeedsUpdate) return; this._popupNeedsUpdate = false; let popup = event.target; let getPlacesAnonymousElement = aAnonId => document.getAnonymousElementByAttribute(popup.parentNode, "placesanonid", aAnonId); let viewToolbarMenuitem = getPlacesAnonymousElement("view-toolbar"); if (viewToolbarMenuitem) { // Update View bookmarks toolbar checkbox menuitem. viewToolbarMenuitem.classList.add("subviewbutton"); let personalToolbar = document.getElementById("PersonalToolbar"); viewToolbarMenuitem.setAttribute("checked", !personalToolbar.collapsed); } }, attachPlacesView(event, node) { // If the view is already there, bail out early. if (node.parentNode._placesView) return; new PlacesMenu(event, "place:folder=BOOKMARKS_MENU", { extraClasses: { entry: "subviewbutton", footer: "panel-subview-footer" }, insertionPoint: ".panel-subview-footer" }); }, // Set by sync after syncing bookmarks successfully once. MOBILE_BOOKMARKS_PREF: "browser.bookmarks.showMobileBookmarks", _shouldShowMobileBookmarks() { try { return Services.prefs.getBoolPref(this.MOBILE_BOOKMARKS_PREF); } catch (e) {} // No pref set (or invalid pref set), look for a mobile bookmarks left pane query. const organizerQueryAnno = "PlacesOrganizer/OrganizerQuery"; const mobileBookmarksAnno = "MobileBookmarks"; let shouldShow = PlacesUtils.annotations.getItemsWithAnnotation(organizerQueryAnno, {}).filter( id => PlacesUtils.annotations.getItemAnnotation(id, organizerQueryAnno) == mobileBookmarksAnno ).length > 0; // Sync will change this pref if/when it adds a mobile bookmarks query. Services.prefs.setBoolPref(this.MOBILE_BOOKMARKS_PREF, shouldShow); return shouldShow; }, _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; } }, onWidgetAdded: function BUI_widgetAdded(aWidgetId) { if (aWidgetId == this.BOOKMARK_BUTTON_ID) { this._onWidgetWasMoved(); } }, onWidgetRemoved: function BUI_widgetRemoved(aWidgetId) { if (aWidgetId == this.BOOKMARK_BUTTON_ID) { this._onWidgetWasMoved(); } }, onWidgetReset: function BUI_widgetReset(aNode, aContainer) { if (aNode == this.button) { this._onWidgetWasMoved(); } }, onWidgetUndoMove: function BUI_undoWidgetUndoMove(aNode, aContainer) { if (aNode == this.button) { this._onWidgetWasMoved(); } }, _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.onToolbarVisibilityChange(); } }, init() { CustomizableUI.addListener(this); if (Services.prefs.getBoolPref("toolkit.cosmeticAnimations.enabled")) { let starButtonBox = document.getElementById("star-button-box"); starButtonBox.setAttribute("animationsenabled", "true"); this.star.addEventListener("mouseover", this, {once: true}); } }, _hasBookmarksObserver: false, _itemGuids: new Set(), uninit: function BUI_uninit() { this.updateBookmarkPageMenuItem(true); CustomizableUI.removeListener(this); this.star.removeEventListener("mouseover", this); this._uninitView(); if (this._hasBookmarksObserver) { PlacesUtils.bookmarks.removeObserver(this); } 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(Components.utils.reportError) .then(() => { if (pendingUpdate != this._pendingUpdate) { return; } // It's possible that onItemAdded 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 { PlacesUtils.bookmarks.addObserver(this); this._hasBookmarksObserver = true; } catch (ex) { Components.utils.reportError("BookmarkingUI failed adding a bookmarks observer: " + ex); } } delete this._pendingUpdate; }); }, _updateStar: function BUI__updateStar() { if (this._itemGuids.size > 0) { this.broadcaster.setAttribute("starred", "true"); this.broadcaster.setAttribute("buttontooltiptext", this._starredTooltip); this.broadcaster.setAttribute("tooltiptext", this._starredTooltip); } else { this.star.removeAttribute("animate"); this.broadcaster.removeAttribute("starred"); this.broadcaster.setAttribute("buttontooltiptext", this._unstarredTooltip); this.broadcaster.setAttribute("tooltiptext", this._unstarredTooltip); } }, /** * forceReset is passed when we're destroyed and the label should go back * to the default (Bookmark This Page) for OS X. */ updateBookmarkPageMenuItem: function BUI_updateBookmarkPageMenuItem(forceReset) { let isStarred = !forceReset && this._itemGuids.size > 0; let label = isStarred ? "editlabel" : "bookmarklabel"; if (this.broadcaster) { this.broadcaster.setAttribute("label", this.broadcaster.getAttribute(label)); } }, onMainMenuPopupShowing: function BUI_onMainMenuPopupShowing(event) { // Don't handle events for submenus. if (event.target != event.currentTarget) return; this.updateBookmarkPageMenuItem(); PlacesCommandHook.updateBookmarkAllTabsCommand(); this._initMobileBookmarks(document.getElementById("menu_mobileBookmarks")); }, _showBookmarkedNotification: function BUI_showBookmarkedNotification() { function getCenteringTransformForRects(rectToPosition, referenceRect) { let topDiff = referenceRect.top - rectToPosition.top; let leftDiff = referenceRect.left - rectToPosition.left; let heightDiff = referenceRect.height - rectToPosition.height; let widthDiff = referenceRect.width - rectToPosition.width; return [(leftDiff + .5 * widthDiff) + "px", (topDiff + .5 * heightDiff) + "px"]; } if (this._notificationTimeout) { clearTimeout(this._notificationTimeout); } if (this.notifier.style.transform == "") { // Get all the relevant nodes and computed style objects let dropmarker = document.getAnonymousElementByAttribute(this.button, "anonid", "dropmarker"); let dropmarkerIcon = document.getAnonymousElementByAttribute(dropmarker, "class", "dropmarker-icon"); let dropmarkerStyle = getComputedStyle(dropmarkerIcon); // Check for RTL and get bounds let isRTL = getComputedStyle(this.button).direction == "rtl"; let buttonRect = this.button.getBoundingClientRect(); let notifierRect = this.notifier.getBoundingClientRect(); let dropmarkerRect = dropmarkerIcon.getBoundingClientRect(); let dropmarkerNotifierRect = this.dropmarkerNotifier.getBoundingClientRect(); // Compute, but do not set, transform for star icon let [translateX, translateY] = getCenteringTransformForRects(notifierRect, buttonRect); let starIconTransform = "translate(" + translateX + ", " + translateY + ")"; if (isRTL) { starIconTransform += " scaleX(-1)"; } // Compute, but do not set, transform for dropmarker [translateX, translateY] = getCenteringTransformForRects(dropmarkerNotifierRect, dropmarkerRect); let dropmarkerTransform = "translate(" + translateX + ", " + translateY + ")"; // Do all layout invalidation in one go: this.notifier.style.transform = starIconTransform; this.dropmarkerNotifier.style.transform = dropmarkerTransform; let dropmarkerAnimationNode = this.dropmarkerNotifier.firstChild; dropmarkerAnimationNode.style.listStyleImage = dropmarkerStyle.listStyleImage; dropmarkerAnimationNode.style.fill = dropmarkerStyle.fill; } let isInOverflowPanel = this.button.getAttribute("overflowedItem") == "true"; if (!isInOverflowPanel) { this.notifier.setAttribute("notification", "finish"); this.button.setAttribute("notification", "finish"); this.dropmarkerNotifier.setAttribute("notification", "finish"); } this._notificationTimeout = setTimeout( () => { this.notifier.removeAttribute("notification"); this.dropmarkerNotifier.removeAttribute("notification"); this.button.removeAttribute("notification"); this.dropmarkerNotifier.style.transform = ""; this.notifier.style.transform = ""; }, 1000); }, showSubView(anchor) { this._showSubView(null, anchor); }, _showSubView(event, anchor = document.getElementById(this.BOOKMARK_BUTTON_ID)) { let view = document.getElementById("PanelUI-bookmarks"); view.addEventListener("ViewShowing", this); view.addEventListener("ViewHiding", this); anchor.setAttribute("closemenu", "none"); 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_MENU_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)) { let isBookmarked = this._itemGuids.size > 0; if (!isBookmarked) { BrowserUtils.setToolbarButtonHeightProperty(this.star); this.star.setAttribute("animate", "true"); } PlacesCommandHook.bookmarkPage(gBrowser.selectedBrowser, true); } }, onCurrentPageContextPopupShowing() { this.updateBookmarkPageMenuItem(); }, handleEvent: function BUI_handleEvent(aEvent) { switch (aEvent.type) { case "mouseover": this.star.setAttribute("preloadanimations", "true"); break; case "ViewShowing": this.onPanelMenuViewShowing(aEvent); break; case "ViewHiding": this.onPanelMenuViewHiding(aEvent); break; } }, onPanelMenuViewShowing: function BUI_onViewShowing(aEvent) { let panelview = aEvent.target; this.updateBookmarkPageMenuItem(); // Update checked status of the toolbar toggle. let viewToolbar = document.getElementById("panelMenu_viewBookmarksToolbar"); if (viewToolbar) { let personalToolbar = document.getElementById("PersonalToolbar"); if (personalToolbar.collapsed) viewToolbar.removeAttribute("checked"); else viewToolbar.setAttribute("checked", "true"); } // 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(document.getElementById("panelMenu_bookmarksMenu"), panelview, query); panelview.removeEventListener("ViewShowing", this); }, onPanelMenuViewHiding: function BUI_onViewHiding(aEvent) { this._panelMenuView.uninit(); delete this._panelMenuView; aEvent.target.removeEventListener("ViewHiding", this); }, onPanelMenuViewCommand: function BUI_onPanelMenuViewCommand(aEvent) { let target = aEvent.originalTarget; if (!target._placesNode) return; if (PlacesUtils.nodeIsContainer(target._placesNode)) PlacesCommandHook.showPlacesOrganizer([ "BookmarksMenu", target._placesNode.itemId ]); else PlacesUIUtils.openNodeWithEvent(target._placesNode, aEvent); PanelUI.hide(); }, showBookmarkingTools(triggerNode) { const panelID = "PanelUI-bookmarkingTools"; let viewNode = document.getElementById(panelID); for (let button of [...viewNode.getElementsByTagName("toolbarbutton")]) { let update = true; switch (button.id) { case "panelMenu_toggleBookmarksMenu": let placement = CustomizableUI.getPlacementOfWidget(this.BOOKMARK_BUTTON_ID); button.setAttribute("checked", !!placement && placement.area == CustomizableUI.AREA_NAVBAR); break; case "panelMenu_viewBookmarksSidebar": button.setAttribute("checked", SidebarUI.currentID == "viewBookmarksSidebar"); break; case "panelMenu_viewBookmarksToolbar": let toolbar = document.getElementById("PersonalToolbar"); // This is an actual toolbarbutton[type=checkbox], and its checked // attribute will get added/removed by the binding when clicked. // Setting the attribute to 'false' breaks showing the toolbar, // because the binding removes the attribute instead of setting it // to 'true' when clicked. if (toolbar.getAttribute("collapsed") != "true") { button.setAttribute("checked", "true"); } else { button.removeAttribute("checked"); } break; default: update = false; break; } if (update) { updateToggleControlLabel(button); } } PanelUI.showSubView(panelID, triggerNode); }, toggleMenuButtonInToolbar(triggerNode) { let placement = CustomizableUI.getPlacementOfWidget(this.BOOKMARK_BUTTON_ID); const area = CustomizableUI.AREA_NAVBAR; if (!placement) { // Button is in the palette, so we can move it to the navbar. let pos; let widgetIDs = CustomizableUI.getWidgetIdsInArea(CustomizableUI.AREA_NAVBAR); // If there's a spring inside the navbar, find it and use that as the // placement marker. let lastSpringID = null; for (let i = widgetIDs.length - 1; i >= 0; --i) { let id = widgetIDs[i]; if (CustomizableUI.isSpecialWidget(id) && /spring/.test(id)) { lastSpringID = id; break; } } if (lastSpringID) { pos = CustomizableUI.getPlacementOfWidget(lastSpringID).position + 1; } else { // Next alternative is to use the searchbar as the placement marker. const searchWidgetID = "search-container"; if (widgetIDs.includes(searchWidgetID)) { pos = CustomizableUI.getPlacementOfWidget(searchWidgetID).position + 1; } else { // Last alternative is to use the navbar as the placement marker. pos = CustomizableUI.getPlacementOfWidget("urlbar-container").position + 1; } } CustomizableUI.addWidgetToArea(this.BOOKMARK_BUTTON_ID, area, pos); } else { // Move it back to the palette. CustomizableUI.removeWidgetFromArea(this.BOOKMARK_BUTTON_ID); } triggerNode.setAttribute("checked", !placement); updateToggleControlLabel(triggerNode); }, // nsINavBookmarkObserver onItemAdded(aItemId, aParentId, aIndex, aItemType, aURI, aTitle, aDateAdded, aGuid) { if (aURI && aURI.equals(this._uri)) { // If a new bookmark has been added to the tracked uri, register it. if (!this._itemGuids.has(aGuid)) { this._itemGuids.add(aGuid); // Only need to update the UI if it wasn't marked as starred before: if (this._itemGuids.size == 1) { this._updateStar(); } } } }, onItemRemoved(aItemId, aParentId, aIndex, aItemType, aURI, aGuid) { // If one of the tracked bookmarks has been removed, unregister it. if (this._itemGuids.has(aGuid)) { this._itemGuids.delete(aGuid); // Only need to update the UI if the page is no longer starred if (this._itemGuids.size == 0) { this._updateStar(); } } }, onItemChanged(aItemId, aProperty, aIsAnnotationProperty, aNewValue, aLastModified, aItemType, aParentId, aGuid) { if (aProperty == "uri") { // If the changed bookmark was tracked, check if it is now pointing to // a different uri and unregister it. if (this._itemGuids.has(aGuid) && aNewValue != this._uri.spec) { this._itemGuids.delete(aGuid); // 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(aGuid) && aNewValue == this._uri.spec) { // If another bookmark is now pointing to the tracked uri, register it. this._itemGuids.add(aGuid); // Only need to update the UI if it wasn't marked as starred before: if (this._itemGuids.size == 1) { this._updateStar(); } } } }, onBeginUpdateBatch() {}, onEndUpdateBatch() {}, onBeforeItemRemoved() {}, onItemVisited() {}, onItemMoved() {}, onWidgetUnderflow(aNode, aContainer) { 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(); }, QueryInterface: XPCOMUtils.generateQI([ Ci.nsINavBookmarkObserver ]) }; var AutoShowBookmarksToolbar = { init() { Services.obs.addObserver(this, "autoshow-bookmarks-toolbar"); }, uninit() { Services.obs.removeObserver(this, "autoshow-bookmarks-toolbar"); }, observe(subject, topic, data) { let toolbar = document.getElementById("PersonalToolbar"); if (!toolbar.collapsed) return; let placement = CustomizableUI.getPlacementOfWidget("personal-bookmarks"); let area = placement && placement.area; if (area != CustomizableUI.AREA_BOOKMARKS) return; setToolbarVisibility(toolbar, true); } };