forked from mirrors/gecko-dev
		
	 d3a8c969bc
			
		
	
	
		d3a8c969bc
		
	
	
	
	
		
			
			This patch doesn't show the view options when right-clicking on folders or bookmarks within the toolbar, and also doesn't include an item to enter Customize mode to keep the menu from growing too large. Differential Revision: https://phabricator.services.mozilla.com/D95798
		
			
				
	
	
		
			1529 lines
		
	
	
	
		
			48 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			1529 lines
		
	
	
	
		
			48 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
| /* -*- 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 ../../../base/content/utilityOverlay.js */
 | |
| /* import-globals-from ../PlacesUIUtils.jsm */
 | |
| /* import-globals-from ../../../../toolkit/components/places/PlacesUtils.jsm */
 | |
| /* import-globals-from ../../../../toolkit/components/places/PlacesTransactions.jsm */
 | |
| 
 | |
| /**
 | |
|  * Represents an insertion point within a container where we can insert
 | |
|  * items.
 | |
|  * @param {object} an object containing the following properties:
 | |
|  *   - parentId
 | |
|  *     The identifier of the parent container
 | |
|  *   - parentGuid
 | |
|  *     The unique identifier of the parent container
 | |
|  *   - index
 | |
|  *     The index within the container where to insert, defaults to appending
 | |
|  *   - orientation
 | |
|  *     The orientation of the insertion. NOTE: the adjustments to the
 | |
|  *     insertion point to accommodate the orientation should be done by
 | |
|  *     the person who constructs the IP, not the user. The orientation
 | |
|  *     is provided for informational purposes only! Defaults to DROP_ON.
 | |
|  *   - tagName
 | |
|  *     The tag name if this IP is set to a tag, null otherwise.
 | |
|  *   - dropNearNode
 | |
|  *     When defined index will be calculated based on this node
 | |
|  */
 | |
| function PlacesInsertionPoint({
 | |
|   parentId,
 | |
|   parentGuid,
 | |
|   index = PlacesUtils.bookmarks.DEFAULT_INDEX,
 | |
|   orientation = Ci.nsITreeView.DROP_ON,
 | |
|   tagName = null,
 | |
|   dropNearNode = null,
 | |
| }) {
 | |
|   this.itemId = parentId;
 | |
|   this.guid = parentGuid;
 | |
|   this._index = index;
 | |
|   this.orientation = orientation;
 | |
|   this.tagName = tagName;
 | |
|   this.dropNearNode = dropNearNode;
 | |
| }
 | |
| 
 | |
| PlacesInsertionPoint.prototype = {
 | |
|   set index(val) {
 | |
|     this._index = val;
 | |
|   },
 | |
| 
 | |
|   async getIndex() {
 | |
|     if (this.dropNearNode) {
 | |
|       // If dropNearNode is set up we must calculate the index of the item near
 | |
|       // which we will drop.
 | |
|       let index = (
 | |
|         await PlacesUtils.bookmarks.fetch(this.dropNearNode.bookmarkGuid)
 | |
|       ).index;
 | |
|       return this.orientation == Ci.nsITreeView.DROP_BEFORE ? index : index + 1;
 | |
|     }
 | |
|     return this._index;
 | |
|   },
 | |
| 
 | |
|   get isTag() {
 | |
|     return typeof this.tagName == "string";
 | |
|   },
 | |
| };
 | |
| 
 | |
| /**
 | |
|  * Places Controller
 | |
|  */
 | |
| 
 | |
| function PlacesController(aView) {
 | |
|   this._view = aView;
 | |
|   XPCOMUtils.defineLazyServiceGetter(
 | |
|     this,
 | |
|     "clipboard",
 | |
|     "@mozilla.org/widget/clipboard;1",
 | |
|     "nsIClipboard"
 | |
|   );
 | |
|   XPCOMUtils.defineLazyGetter(this, "profileName", function() {
 | |
|     return Services.dirsvc.get("ProfD", Ci.nsIFile).leafName;
 | |
|   });
 | |
| }
 | |
| 
 | |
| PlacesController.prototype = {
 | |
|   /**
 | |
|    * The places view.
 | |
|    */
 | |
|   _view: null,
 | |
| 
 | |
|   // This is used in certain views to disable user actions on the places tree
 | |
|   // views. This avoids accidental deletion/modification when the user is not
 | |
|   // actually organising the trees.
 | |
|   disableUserActions: false,
 | |
| 
 | |
|   QueryInterface: ChromeUtils.generateQI(["nsIClipboardOwner"]),
 | |
| 
 | |
|   // nsIClipboardOwner
 | |
|   LosingOwnership: function PC_LosingOwnership(aXferable) {
 | |
|     this.cutNodes = [];
 | |
|   },
 | |
| 
 | |
|   terminate: function PC_terminate() {
 | |
|     this._releaseClipboardOwnership();
 | |
|   },
 | |
| 
 | |
|   supportsCommand: function PC_supportsCommand(aCommand) {
 | |
|     if (this.disableUserActions) {
 | |
|       return false;
 | |
|     }
 | |
|     // Non-Places specific commands that we also support
 | |
|     switch (aCommand) {
 | |
|       case "cmd_undo":
 | |
|       case "cmd_redo":
 | |
|       case "cmd_cut":
 | |
|       case "cmd_copy":
 | |
|       case "cmd_paste":
 | |
|       case "cmd_delete":
 | |
|       case "cmd_selectAll":
 | |
|         return true;
 | |
|     }
 | |
| 
 | |
|     // All other Places Commands are prefixed with "placesCmd_" ... this
 | |
|     // filters out other commands that we do _not_ support (see 329587).
 | |
|     const CMD_PREFIX = "placesCmd_";
 | |
|     return aCommand.substr(0, CMD_PREFIX.length) == CMD_PREFIX;
 | |
|   },
 | |
| 
 | |
|   isCommandEnabled: function PC_isCommandEnabled(aCommand) {
 | |
|     // Determine whether or not nodes can be inserted.
 | |
|     let ip = this._view.insertionPoint;
 | |
|     let canInsert = ip && (aCommand.endsWith("_paste") || !ip.isTag);
 | |
| 
 | |
|     switch (aCommand) {
 | |
|       case "cmd_undo":
 | |
|         return PlacesTransactions.topUndoEntry != null;
 | |
|       case "cmd_redo":
 | |
|         return PlacesTransactions.topRedoEntry != null;
 | |
|       case "cmd_cut":
 | |
|       case "placesCmd_cut":
 | |
|         for (let node of this._view.selectedNodes) {
 | |
|           // If selection includes history nodes or tags-as-bookmark, disallow
 | |
|           // cutting.
 | |
|           if (
 | |
|             node.itemId == -1 ||
 | |
|             (node.parent && PlacesUtils.nodeIsTagQuery(node.parent))
 | |
|           ) {
 | |
|             return false;
 | |
|           }
 | |
|         }
 | |
|       // Otherwise fall through the cmd_delete check.
 | |
|       case "cmd_delete":
 | |
|       case "placesCmd_delete":
 | |
|       case "placesCmd_deleteDataHost":
 | |
|         return this._hasRemovableSelection();
 | |
|       case "cmd_copy":
 | |
|       case "placesCmd_copy":
 | |
|         return this._view.hasSelection;
 | |
|       case "cmd_paste":
 | |
|       case "placesCmd_paste":
 | |
|         // If the clipboard contains a Places flavor it is definitely pasteable,
 | |
|         // otherwise we also allow pasting "text/unicode" and "text/x-moz-url" data.
 | |
|         // We don't check if the data is valid here, because the clipboard may
 | |
|         // contain very large blobs that would largely slowdown commands updating.
 | |
|         // Of course later paste() should ignore any invalid data.
 | |
|         return (
 | |
|           canInsert &&
 | |
|           this.clipboard.hasDataMatchingFlavors(
 | |
|             [
 | |
|               ...PlacesUIUtils.PLACES_FLAVORS,
 | |
|               PlacesUtils.TYPE_X_MOZ_URL,
 | |
|               PlacesUtils.TYPE_UNICODE,
 | |
|             ],
 | |
|             Ci.nsIClipboard.kGlobalClipboard
 | |
|           )
 | |
|         );
 | |
|       case "cmd_selectAll":
 | |
|         if (this._view.selType != "single") {
 | |
|           let rootNode = this._view.result.root;
 | |
|           if (rootNode.containerOpen && rootNode.childCount > 0) {
 | |
|             return true;
 | |
|           }
 | |
|         }
 | |
|         return false;
 | |
|       case "placesCmd_open":
 | |
|       case "placesCmd_open:window":
 | |
|       case "placesCmd_open:privatewindow":
 | |
|       case "placesCmd_open:tab": {
 | |
|         let selectedNode = this._view.selectedNode;
 | |
|         return selectedNode && PlacesUtils.nodeIsURI(selectedNode);
 | |
|       }
 | |
|       case "placesCmd_new:folder":
 | |
|         return canInsert;
 | |
|       case "placesCmd_new:bookmark":
 | |
|         return canInsert;
 | |
|       case "placesCmd_new:separator":
 | |
|         return (
 | |
|           canInsert &&
 | |
|           !PlacesUtils.asQuery(this._view.result.root).queryOptions
 | |
|             .excludeItems &&
 | |
|           this._view.result.sortingMode ==
 | |
|             Ci.nsINavHistoryQueryOptions.SORT_BY_NONE
 | |
|         );
 | |
|       case "placesCmd_show:info": {
 | |
|         let selectedNode = this._view.selectedNode;
 | |
|         return (
 | |
|           selectedNode &&
 | |
|           !PlacesUtils.isRootItem(
 | |
|             PlacesUtils.getConcreteItemGuid(selectedNode)
 | |
|           ) &&
 | |
|           (PlacesUtils.nodeIsTagQuery(selectedNode) ||
 | |
|             PlacesUtils.nodeIsBookmark(selectedNode) ||
 | |
|             (PlacesUtils.nodeIsFolder(selectedNode) &&
 | |
|               !PlacesUtils.isQueryGeneratedFolder(selectedNode)))
 | |
|         );
 | |
|       }
 | |
|       case "placesCmd_sortBy:name": {
 | |
|         let selectedNode = this._view.selectedNode;
 | |
|         return (
 | |
|           selectedNode &&
 | |
|           PlacesUtils.nodeIsFolder(selectedNode) &&
 | |
|           !PlacesUIUtils.isFolderReadOnly(selectedNode) &&
 | |
|           this._view.result.sortingMode ==
 | |
|             Ci.nsINavHistoryQueryOptions.SORT_BY_NONE
 | |
|         );
 | |
|       }
 | |
|       case "placesCmd_createBookmark": {
 | |
|         return !this._view.selectedNodes.some(
 | |
|           node => !PlacesUtils.nodeIsURI(node) || node.itemId != -1
 | |
|         );
 | |
|       }
 | |
|       default:
 | |
|         return false;
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   doCommand: function PC_doCommand(aCommand) {
 | |
|     switch (aCommand) {
 | |
|       case "cmd_undo":
 | |
|         PlacesTransactions.undo().catch(Cu.reportError);
 | |
|         break;
 | |
|       case "cmd_redo":
 | |
|         PlacesTransactions.redo().catch(Cu.reportError);
 | |
|         break;
 | |
|       case "cmd_cut":
 | |
|       case "placesCmd_cut":
 | |
|         this.cut();
 | |
|         break;
 | |
|       case "cmd_copy":
 | |
|       case "placesCmd_copy":
 | |
|         this.copy();
 | |
|         break;
 | |
|       case "cmd_paste":
 | |
|       case "placesCmd_paste":
 | |
|         this.paste().catch(Cu.reportError);
 | |
|         break;
 | |
|       case "cmd_delete":
 | |
|       case "placesCmd_delete":
 | |
|         this.remove("Remove Selection").catch(Cu.reportError);
 | |
|         break;
 | |
|       case "placesCmd_deleteDataHost":
 | |
|         let host;
 | |
|         if (PlacesUtils.nodeIsHost(this._view.selectedNode)) {
 | |
|           host = this._view.selectedNode.query.domain;
 | |
|         } else {
 | |
|           host = Services.io.newURI(this._view.selectedNode.uri).host;
 | |
|         }
 | |
|         let { ForgetAboutSite } = ChromeUtils.import(
 | |
|           "resource://gre/modules/ForgetAboutSite.jsm"
 | |
|         );
 | |
|         ForgetAboutSite.removeDataFromDomain(host).catch(Cu.reportError);
 | |
|         break;
 | |
|       case "cmd_selectAll":
 | |
|         this.selectAll();
 | |
|         break;
 | |
|       case "placesCmd_open":
 | |
|         PlacesUIUtils.openNodeIn(
 | |
|           this._view.selectedNode,
 | |
|           "current",
 | |
|           this._view
 | |
|         );
 | |
|         break;
 | |
|       case "placesCmd_open:window":
 | |
|         PlacesUIUtils.openNodeIn(this._view.selectedNode, "window", this._view);
 | |
|         break;
 | |
|       case "placesCmd_open:privatewindow":
 | |
|         PlacesUIUtils.openNodeIn(
 | |
|           this._view.selectedNode,
 | |
|           "window",
 | |
|           this._view,
 | |
|           true
 | |
|         );
 | |
|         break;
 | |
|       case "placesCmd_open:tab":
 | |
|         PlacesUIUtils.openNodeIn(this._view.selectedNode, "tab", this._view);
 | |
|         break;
 | |
|       case "placesCmd_new:folder":
 | |
|         this.newItem("folder").catch(Cu.reportError);
 | |
|         break;
 | |
|       case "placesCmd_new:bookmark":
 | |
|         this.newItem("bookmark").catch(Cu.reportError);
 | |
|         break;
 | |
|       case "placesCmd_new:separator":
 | |
|         this.newSeparator().catch(Cu.reportError);
 | |
|         break;
 | |
|       case "placesCmd_show:info":
 | |
|         this.showBookmarkPropertiesForSelection();
 | |
|         break;
 | |
|       case "placesCmd_sortBy:name":
 | |
|         this.sortFolderByName().catch(Cu.reportError);
 | |
|         break;
 | |
|       case "placesCmd_createBookmark": {
 | |
|         const nodes = this._view.selectedNodes.map(node => {
 | |
|           return {
 | |
|             uri: Services.io.newURI(node.uri),
 | |
|             title: node.title,
 | |
|           };
 | |
|         });
 | |
|         PlacesUIUtils.showBookmarkPagesDialog(
 | |
|           nodes,
 | |
|           ["keyword", "location"],
 | |
|           window.top
 | |
|         );
 | |
|         break;
 | |
|       }
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   onEvent: function PC_onEvent(eventName) {},
 | |
| 
 | |
|   /**
 | |
|    * Determine whether or not the selection can be removed, either by the
 | |
|    * delete or cut operations based on whether or not any of its contents
 | |
|    * are non-removable. We don't need to worry about recursion here since it
 | |
|    * is a policy decision that a removable item not be placed inside a non-
 | |
|    * removable item.
 | |
|    *
 | |
|    * @return true if all nodes in the selection can be removed,
 | |
|    *         false otherwise.
 | |
|    */
 | |
|   _hasRemovableSelection() {
 | |
|     var ranges = this._view.removableSelectionRanges;
 | |
|     if (!ranges.length) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     var root = this._view.result.root;
 | |
| 
 | |
|     for (var j = 0; j < ranges.length; j++) {
 | |
|       var nodes = ranges[j];
 | |
|       for (var i = 0; i < nodes.length; ++i) {
 | |
|         // Disallow removing the view's root node
 | |
|         if (nodes[i] == root) {
 | |
|           return false;
 | |
|         }
 | |
| 
 | |
|         if (!PlacesUIUtils.canUserRemove(nodes[i])) {
 | |
|           return false;
 | |
|         }
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     return true;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Gathers information about the selected nodes according to the following
 | |
|    * rules:
 | |
|    *    "link"              node is a URI
 | |
|    *    "bookmark"          node is a bookmark
 | |
|    *    "tagChild"          node is a child of a tag
 | |
|    *    "folder"            node is a folder
 | |
|    *    "query"             node is a query
 | |
|    *    "separator"         node is a separator line
 | |
|    *    "host"              node is a host
 | |
|    *
 | |
|    * @return an array of objects corresponding the selected nodes. Each
 | |
|    *         object has each of the properties above set if its corresponding
 | |
|    *         node matches the rule. In addition, the annotations names for each
 | |
|    *         node are set on its corresponding object as properties.
 | |
|    * Notes:
 | |
|    *   1) This can be slow, so don't call it anywhere performance critical!
 | |
|    */
 | |
|   _buildSelectionMetadata: function PC__buildSelectionMetadata() {
 | |
|     var metadata = [];
 | |
|     var nodes = this._view.selectedNodes;
 | |
| 
 | |
|     for (var i = 0; i < nodes.length; i++) {
 | |
|       var nodeData = {};
 | |
|       var node = nodes[i];
 | |
|       var nodeType = node.type;
 | |
| 
 | |
|       // We don't use the nodeIs* methods here to avoid going through the type
 | |
|       // property way too often
 | |
|       switch (nodeType) {
 | |
|         case Ci.nsINavHistoryResultNode.RESULT_TYPE_QUERY:
 | |
|           nodeData.query = true;
 | |
|           if (node.parent) {
 | |
|             switch (PlacesUtils.asQuery(node.parent).queryOptions.resultType) {
 | |
|               case Ci.nsINavHistoryQueryOptions.RESULTS_AS_SITE_QUERY:
 | |
|                 nodeData.host = true;
 | |
|                 break;
 | |
|               case Ci.nsINavHistoryQueryOptions.RESULTS_AS_DATE_SITE_QUERY:
 | |
|               case Ci.nsINavHistoryQueryOptions.RESULTS_AS_DATE_QUERY:
 | |
|                 nodeData.day = true;
 | |
|                 break;
 | |
|             }
 | |
|           }
 | |
|           break;
 | |
|         case Ci.nsINavHistoryResultNode.RESULT_TYPE_FOLDER:
 | |
|         case Ci.nsINavHistoryResultNode.RESULT_TYPE_FOLDER_SHORTCUT:
 | |
|           nodeData.folder = true;
 | |
|           break;
 | |
|         case Ci.nsINavHistoryResultNode.RESULT_TYPE_SEPARATOR:
 | |
|           nodeData.separator = true;
 | |
|           break;
 | |
|         case Ci.nsINavHistoryResultNode.RESULT_TYPE_URI:
 | |
|           nodeData.link = true;
 | |
|           if (PlacesUtils.nodeIsBookmark(node)) {
 | |
|             nodeData.bookmark = true;
 | |
|             var parentNode = node.parent;
 | |
|             if (parentNode && PlacesUtils.nodeIsTagQuery(parentNode)) {
 | |
|               nodeData.tagChild = true;
 | |
|             }
 | |
|           }
 | |
|           break;
 | |
|       }
 | |
| 
 | |
|       metadata.push(nodeData);
 | |
|     }
 | |
| 
 | |
|     return metadata;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Determines if a context-menu item should be shown
 | |
|    * @param   aMenuItem
 | |
|    *          the context menu item
 | |
|    * @param   aMetaData
 | |
|    *          meta data about the selection
 | |
|    * @return true if the conditions (see buildContextMenu) are satisfied
 | |
|    *         and the item can be displayed, false otherwise.
 | |
|    */
 | |
|   _shouldShowMenuItem: function PC__shouldShowMenuItem(aMenuItem, aMetaData) {
 | |
|     if (
 | |
|       aMenuItem.hasAttribute("hideifprivatebrowsing") &&
 | |
|       !PrivateBrowsingUtils.enabled
 | |
|     ) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     var selectiontype = aMenuItem.getAttribute("selectiontype");
 | |
|     if (!selectiontype) {
 | |
|       selectiontype = "single|multiple";
 | |
|     }
 | |
|     var selectionTypes = selectiontype.split("|");
 | |
|     if (selectionTypes.includes("any")) {
 | |
|       return true;
 | |
|     }
 | |
|     var count = aMetaData.length;
 | |
|     if (count > 1 && !selectionTypes.includes("multiple")) {
 | |
|       return false;
 | |
|     }
 | |
|     if (count == 1 && !selectionTypes.includes("single")) {
 | |
|       return false;
 | |
|     }
 | |
|     // NB: if there is no selection, we show the item if and only if
 | |
|     // the selectiontype includes 'none' - the metadata list will be
 | |
|     // empty so none of the other criteria will apply anyway.
 | |
|     if (count == 0) {
 | |
|       return selectionTypes.includes("none");
 | |
|     }
 | |
| 
 | |
|     var forceHideAttr = aMenuItem.getAttribute("forcehideselection");
 | |
|     if (forceHideAttr) {
 | |
|       var forceHideRules = forceHideAttr.split("|");
 | |
|       for (let i = 0; i < aMetaData.length; ++i) {
 | |
|         for (let j = 0; j < forceHideRules.length; ++j) {
 | |
|           if (forceHideRules[j] in aMetaData[i]) {
 | |
|             return false;
 | |
|           }
 | |
|         }
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     var selectionAttr = aMenuItem.getAttribute("selection");
 | |
|     if (!selectionAttr) {
 | |
|       return !aMenuItem.hidden;
 | |
|     }
 | |
| 
 | |
|     if (selectionAttr == "any") {
 | |
|       return true;
 | |
|     }
 | |
| 
 | |
|     var showRules = selectionAttr.split("|");
 | |
|     var anyMatched = false;
 | |
|     function metaDataNodeMatches(metaDataNode, rules) {
 | |
|       for (var i = 0; i < rules.length; i++) {
 | |
|         if (rules[i] in metaDataNode) {
 | |
|           return true;
 | |
|         }
 | |
|       }
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     for (var i = 0; i < aMetaData.length; ++i) {
 | |
|       if (metaDataNodeMatches(aMetaData[i], showRules)) {
 | |
|         anyMatched = true;
 | |
|       } else {
 | |
|         return false;
 | |
|       }
 | |
|     }
 | |
|     return anyMatched;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Detects information (meta-data rules) about the current selection in the
 | |
|    * view (see _buildSelectionMetadata) and sets the visibility state for each
 | |
|    * of the menu-items in the given popup with the following rules applied:
 | |
|    *  0) The "ignoreitem" attribute may be set to "true" for this code not to
 | |
|    *     handle that menuitem.
 | |
|    *  1) The "selectiontype" attribute may be set on a menu-item to "single"
 | |
|    *     if the menu-item should be visible only if there is a single node
 | |
|    *     selected, or to "multiple" if the menu-item should be visible only if
 | |
|    *     multiple nodes are selected, or to "none" if the menuitems should be
 | |
|    *     visible for if there are no selected nodes, or to a |-separated
 | |
|    *     combination of these.
 | |
|    *     If the attribute is not set or set to an invalid value, the menu-item
 | |
|    *     may be visible irrespective of the selection.
 | |
|    *  2) The "selection" attribute may be set on a menu-item to the various
 | |
|    *     meta-data rules for which it may be visible. The rules should be
 | |
|    *     separated with the | character.
 | |
|    *  3) A menu-item may be visible only if at least one of the rules set in
 | |
|    *     its selection attribute apply to each of the selected nodes in the
 | |
|    *     view.
 | |
|    *  4) The "forcehideselection" attribute may be set on a menu-item to rules
 | |
|    *     for which it should be hidden. This attribute takes priority over the
 | |
|    *     selection attribute. A menu-item would be hidden if at least one of the
 | |
|    *     given rules apply to one of the selected nodes. The rules should be
 | |
|    *     separated with the | character.
 | |
|    *  5) The "hideifnoinsertionpoint" attribute may be set on a menu-item to
 | |
|    *     true if it should be hidden when there's no insertion point
 | |
|    *  6) The visibility state of a menu-item is unchanged if none of these
 | |
|    *     attribute are set.
 | |
|    *  7) These attributes should not be set on separators for which the
 | |
|    *     visibility state is "auto-detected."
 | |
|    *  8) The "hideifprivatebrowsing" attribute may be set on a menu-item to
 | |
|    *     true if it should be hidden inside the private browsing mode
 | |
|    *  9) The "forcehideintabbrowser" attribute may be set on a menu-item if
 | |
|    *     it should be hidden when we're in a tabbed browsing window.
 | |
|    * @param   aPopup
 | |
|    *          The menupopup to build children into.
 | |
|    * @return true if at least one item is visible, false otherwise.
 | |
|    */
 | |
|   buildContextMenu: function PC_buildContextMenu(aPopup) {
 | |
|     // In tabbed browsing windows, ensure the plain 'open' item gets hidden,
 | |
|     // unless we open in tabs by default, in which case we want it visible
 | |
|     // so users can use the context menu to force the bookmark to open in
 | |
|     // the current tab.
 | |
|     if (window.top.gBrowser) {
 | |
|       var openInCurrentTab = document.getElementById("placesContext_open");
 | |
|       if (!PlacesUIUtils.loadBookmarksInTabs) {
 | |
|         openInCurrentTab.setAttribute("forcehideintabbrowser", "true");
 | |
|       } else {
 | |
|         openInCurrentTab.removeAttribute("forcehideintabbrowser");
 | |
|       }
 | |
|     }
 | |
|     var metadata = this._buildSelectionMetadata();
 | |
|     var ip = this._view.insertionPoint;
 | |
|     var noIp = !ip || ip.isTag;
 | |
| 
 | |
|     var separator = null;
 | |
|     var visibleItemsBeforeSep = false;
 | |
|     var usableItemCount = 0;
 | |
|     for (var i = 0; i < aPopup.children.length; ++i) {
 | |
|       var item = aPopup.children[i];
 | |
|       if (item.getAttribute("ignoreitem") == "true") {
 | |
|         continue;
 | |
|       }
 | |
|       if (item.localName != "menuseparator") {
 | |
|         // We allow pasting into tag containers, so special case that.
 | |
|         var hideIfNoIP =
 | |
|           item.getAttribute("hideifnoinsertionpoint") == "true" &&
 | |
|           noIp &&
 | |
|           !(ip && ip.isTag && item.id == "placesContext_paste");
 | |
|         var hideIfInTabBrowser =
 | |
|           item.getAttribute("forcehideintabbrowser") == "true" &&
 | |
|           window.top.gBrowser;
 | |
|         var hideIfPrivate =
 | |
|           item.getAttribute("hideifprivatebrowsing") == "true" &&
 | |
|           PrivateBrowsingUtils.isWindowPrivate(window);
 | |
|         var shouldHideItem =
 | |
|           hideIfNoIP ||
 | |
|           hideIfInTabBrowser ||
 | |
|           hideIfPrivate ||
 | |
|           !this._shouldShowMenuItem(item, metadata);
 | |
|         item.hidden = item.disabled = shouldHideItem;
 | |
| 
 | |
|         if (!item.hidden) {
 | |
|           visibleItemsBeforeSep = true;
 | |
|           usableItemCount++;
 | |
| 
 | |
|           // Show the separator above the menu-item if any
 | |
|           if (separator) {
 | |
|             separator.hidden = false;
 | |
|             separator = null;
 | |
|           }
 | |
|         }
 | |
|       } else {
 | |
|         // menuseparator
 | |
|         // Initially hide it. It will be unhidden if there will be at least one
 | |
|         // visible menu-item above and below it.
 | |
|         item.hidden = true;
 | |
| 
 | |
|         // We won't show the separator at all if no items are visible above it
 | |
|         if (visibleItemsBeforeSep) {
 | |
|           separator = item;
 | |
|         }
 | |
| 
 | |
|         // New separator, count again:
 | |
|         visibleItemsBeforeSep = false;
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     // Set Open Folder/Links In Tabs items enabled state if they're visible
 | |
|     if (usableItemCount > 0) {
 | |
|       var openContainerInTabsItem = document.getElementById(
 | |
|         "placesContext_openContainer:tabs"
 | |
|       );
 | |
|       if (!openContainerInTabsItem.hidden) {
 | |
|         var containerToUse = this._view.selectedNode || this._view.result.root;
 | |
|         if (PlacesUtils.nodeIsContainer(containerToUse)) {
 | |
|           if (!PlacesUtils.hasChildURIs(containerToUse)) {
 | |
|             openContainerInTabsItem.disabled = true;
 | |
|             // Ensure that we don't display the menu if nothing is enabled:
 | |
|             usableItemCount--;
 | |
|           }
 | |
|         }
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     // Make sure to display the correct string when multiple pages are selected.
 | |
|     let stringId = metadata.length === 1 ? "SinglePage" : "MultiplePages";
 | |
| 
 | |
|     let deleteHistoryItem = document.getElementById(
 | |
|       "placesContext_delete_history"
 | |
|     );
 | |
|     deleteHistoryItem.label = PlacesUIUtils.getString(
 | |
|       `cmd.delete${stringId}.label`
 | |
|     );
 | |
|     deleteHistoryItem.accessKey = PlacesUIUtils.getString(
 | |
|       `cmd.delete${stringId}.accesskey`
 | |
|     );
 | |
| 
 | |
|     let createBookmarkItem = document.getElementById(
 | |
|       "placesContext_createBookmark"
 | |
|     );
 | |
|     createBookmarkItem.label = PlacesUIUtils.getString(
 | |
|       `cmd.bookmark${stringId}.label`
 | |
|     );
 | |
|     createBookmarkItem.accessKey = PlacesUIUtils.getString(
 | |
|       `cmd.bookmark${stringId}.accesskey`
 | |
|     );
 | |
| 
 | |
|     return usableItemCount > 0;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Select all links in the current view.
 | |
|    */
 | |
|   selectAll: function PC_selectAll() {
 | |
|     this._view.selectAll();
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Opens the bookmark properties for the selected URI Node.
 | |
|    */
 | |
|   showBookmarkPropertiesForSelection() {
 | |
|     let node = this._view.selectedNode;
 | |
|     if (!node) {
 | |
|       return;
 | |
|     }
 | |
| 
 | |
|     PlacesUIUtils.showBookmarkDialog(
 | |
|       { action: "edit", node, hiddenRows: ["folderPicker"] },
 | |
|       window.top
 | |
|     );
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Opens the links in the selected folder, or the selected links in new tabs.
 | |
|    */
 | |
|   openSelectionInTabs: function PC_openLinksInTabs(aEvent) {
 | |
|     var node = this._view.selectedNode;
 | |
|     var nodes = this._view.selectedNodes;
 | |
|     // In the case of no selection, open the root node:
 | |
|     if (!node && !nodes.length) {
 | |
|       node = this._view.result.root;
 | |
|     }
 | |
|     PlacesUIUtils.openMultipleLinksInTabs(
 | |
|       node ? node : nodes,
 | |
|       aEvent,
 | |
|       this._view
 | |
|     );
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Shows the Add Bookmark UI for the current insertion point.
 | |
|    *
 | |
|    * @param aType
 | |
|    *        the type of the new item (bookmark/folder)
 | |
|    */
 | |
|   async newItem(aType) {
 | |
|     let ip = this._view.insertionPoint;
 | |
|     if (!ip) {
 | |
|       throw Components.Exception("", Cr.NS_ERROR_NOT_AVAILABLE);
 | |
|     }
 | |
| 
 | |
|     let bookmarkGuid = PlacesUIUtils.showBookmarkDialog(
 | |
|       {
 | |
|         action: "add",
 | |
|         type: aType,
 | |
|         defaultInsertionPoint: ip,
 | |
|         hiddenRows: ["folderPicker"],
 | |
|       },
 | |
|       window.top
 | |
|     );
 | |
|     if (bookmarkGuid) {
 | |
|       this._view.selectItems([bookmarkGuid], false);
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Create a new Bookmark separator somewhere.
 | |
|    */
 | |
|   async newSeparator() {
 | |
|     var ip = this._view.insertionPoint;
 | |
|     if (!ip) {
 | |
|       throw Components.Exception("", Cr.NS_ERROR_NOT_AVAILABLE);
 | |
|     }
 | |
| 
 | |
|     let index = await ip.getIndex();
 | |
|     let txn = PlacesTransactions.NewSeparator({ parentGuid: ip.guid, index });
 | |
|     let guid = await txn.transact();
 | |
|     // Select the new item.
 | |
|     this._view.selectItems([guid], false);
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Sort the selected folder by name
 | |
|    */
 | |
|   async sortFolderByName() {
 | |
|     let guid = PlacesUtils.getConcreteItemGuid(this._view.selectedNode);
 | |
|     await PlacesTransactions.SortByName(guid).transact();
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Walk the list of folders we're removing in this delete operation, and
 | |
|    * see if the selected node specified is already implicitly being removed
 | |
|    * because it is a child of that folder.
 | |
|    * @param   node
 | |
|    *          Node to check for containment.
 | |
|    * @param   pastFolders
 | |
|    *          List of folders the calling function has already traversed
 | |
|    * @return true if the node should be skipped, false otherwise.
 | |
|    */
 | |
|   _shouldSkipNode: function PC_shouldSkipNode(node, pastFolders) {
 | |
|     /**
 | |
|      * Determines if a node is contained by another node within a resultset.
 | |
|      * @param   node
 | |
|      *          The node to check for containment for
 | |
|      * @param   parent
 | |
|      *          The parent container to check for containment in
 | |
|      * @return true if node is a member of parent's children, false otherwise.
 | |
|      */
 | |
|     function isNodeContainedBy(parent) {
 | |
|       var cursor = node.parent;
 | |
|       while (cursor) {
 | |
|         if (cursor == parent) {
 | |
|           return true;
 | |
|         }
 | |
|         cursor = cursor.parent;
 | |
|       }
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     for (var j = 0; j < pastFolders.length; ++j) {
 | |
|       if (isNodeContainedBy(pastFolders[j])) {
 | |
|         return true;
 | |
|       }
 | |
|     }
 | |
|     return false;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Creates a set of transactions for the removal of a range of items.
 | |
|    * A range is an array of adjacent nodes in a view.
 | |
|    * @param   [in] range
 | |
|    *          An array of nodes to remove. Should all be adjacent.
 | |
|    * @param   [out] transactions
 | |
|    *          An array of transactions.
 | |
|    * @param   [optional] removedFolders
 | |
|    *          An array of folder nodes that have already been removed.
 | |
|    * @return {Integer} The total number of items affected.
 | |
|    */
 | |
|   async _removeRange(range, transactions, removedFolders) {
 | |
|     if (!(transactions instanceof Array)) {
 | |
|       throw new Error("Must pass a transactions array");
 | |
|     }
 | |
|     if (!removedFolders) {
 | |
|       removedFolders = [];
 | |
|     }
 | |
| 
 | |
|     let bmGuidsToRemove = [];
 | |
|     let totalItems = 0;
 | |
| 
 | |
|     for (var i = 0; i < range.length; ++i) {
 | |
|       var node = range[i];
 | |
|       if (this._shouldSkipNode(node, removedFolders)) {
 | |
|         continue;
 | |
|       }
 | |
| 
 | |
|       totalItems++;
 | |
| 
 | |
|       if (PlacesUtils.nodeIsTagQuery(node.parent)) {
 | |
|         // This is a uri node inside a tag container.  It needs a special
 | |
|         // untag transaction.
 | |
|         let tag = node.parent.title || "";
 | |
|         if (!tag) {
 | |
|           // The parent may be the root node, that doesn't have a title.
 | |
|           tag = node.parent.query.tags[0];
 | |
|         }
 | |
|         transactions.push(PlacesTransactions.Untag({ urls: [node.uri], tag }));
 | |
|       } else if (
 | |
|         PlacesUtils.nodeIsTagQuery(node) &&
 | |
|         node.parent &&
 | |
|         PlacesUtils.nodeIsQuery(node.parent) &&
 | |
|         PlacesUtils.asQuery(node.parent).queryOptions.resultType ==
 | |
|           Ci.nsINavHistoryQueryOptions.RESULTS_AS_TAGS_ROOT
 | |
|       ) {
 | |
|         // This is a tag container.
 | |
|         // Untag all URIs tagged with this tag only if the tag container is
 | |
|         // child of the "Tags" query in the library, in all other places we
 | |
|         // must only remove the query node.
 | |
|         let tag = node.title;
 | |
|         let urls = new Set();
 | |
|         await PlacesUtils.bookmarks.fetch({ tags: [tag] }, b =>
 | |
|           urls.add(b.url)
 | |
|         );
 | |
|         transactions.push(
 | |
|           PlacesTransactions.Untag({ tag, urls: Array.from(urls) })
 | |
|         );
 | |
|       } else if (
 | |
|         PlacesUtils.nodeIsURI(node) &&
 | |
|         PlacesUtils.nodeIsQuery(node.parent) &&
 | |
|         PlacesUtils.asQuery(node.parent).queryOptions.queryType ==
 | |
|           Ci.nsINavHistoryQueryOptions.QUERY_TYPE_HISTORY
 | |
|       ) {
 | |
|         // This is a uri node inside an history query.
 | |
|         await PlacesUtils.history.remove(node.uri).catch(Cu.reportError);
 | |
|         // History deletes are not undoable, so we don't have a transaction.
 | |
|       } else if (
 | |
|         node.itemId == -1 &&
 | |
|         PlacesUtils.nodeIsQuery(node) &&
 | |
|         PlacesUtils.asQuery(node).queryOptions.queryType ==
 | |
|           Ci.nsINavHistoryQueryOptions.QUERY_TYPE_HISTORY
 | |
|       ) {
 | |
|         // This is a dynamically generated history query, like queries
 | |
|         // grouped by site, time or both.  Dynamically generated queries don't
 | |
|         // have an itemId even if they are descendants of a bookmark.
 | |
|         await this._removeHistoryContainer(node).catch(Cu.reportError);
 | |
|         // History deletes are not undoable, so we don't have a transaction.
 | |
|       } else {
 | |
|         // This is a common bookmark item.
 | |
|         if (PlacesUtils.nodeIsFolder(node)) {
 | |
|           // If this is a folder we add it to our array of folders, used
 | |
|           // to skip nodes that are children of an already removed folder.
 | |
|           removedFolders.push(node);
 | |
|         }
 | |
|         bmGuidsToRemove.push(node.bookmarkGuid);
 | |
|       }
 | |
|     }
 | |
|     if (bmGuidsToRemove.length) {
 | |
|       transactions.push(PlacesTransactions.Remove({ guids: bmGuidsToRemove }));
 | |
|     }
 | |
|     return totalItems;
 | |
|   },
 | |
| 
 | |
|   async _removeRowsFromBookmarks() {
 | |
|     let ranges = this._view.removableSelectionRanges;
 | |
|     let transactions = [];
 | |
|     let removedFolders = [];
 | |
|     let totalItems = 0;
 | |
| 
 | |
|     for (let range of ranges) {
 | |
|       totalItems += await this._removeRange(
 | |
|         range,
 | |
|         transactions,
 | |
|         removedFolders
 | |
|       );
 | |
|     }
 | |
| 
 | |
|     if (transactions.length) {
 | |
|       await PlacesUIUtils.batchUpdatesForNode(
 | |
|         this._view.result,
 | |
|         totalItems,
 | |
|         async () => {
 | |
|           await PlacesTransactions.batch(transactions);
 | |
|         }
 | |
|       );
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Removes the set of selected ranges from history, asynchronously.
 | |
|    *
 | |
|    * @note history deletes are not undoable.
 | |
|    */
 | |
|   async _removeRowsFromHistory() {
 | |
|     let nodes = this._view.selectedNodes;
 | |
|     let URIs = new Set();
 | |
|     for (let i = 0; i < nodes.length; ++i) {
 | |
|       let node = nodes[i];
 | |
|       if (PlacesUtils.nodeIsURI(node)) {
 | |
|         URIs.add(node.uri);
 | |
|       } else if (
 | |
|         PlacesUtils.nodeIsQuery(node) &&
 | |
|         PlacesUtils.asQuery(node).queryOptions.queryType ==
 | |
|           Ci.nsINavHistoryQueryOptions.QUERY_TYPE_HISTORY
 | |
|       ) {
 | |
|         await this._removeHistoryContainer(node).catch(Cu.reportError);
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     if (URIs.size) {
 | |
|       await PlacesUtils.history.remove([...URIs]);
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Removes history visits for an history container node.
 | |
|    * @param   [in] aContainerNode
 | |
|    *          The container node to remove.
 | |
|    *
 | |
|    * @note history deletes are not undoable.
 | |
|    */
 | |
|   async _removeHistoryContainer(aContainerNode) {
 | |
|     if (PlacesUtils.nodeIsHost(aContainerNode)) {
 | |
|       // This is a site container.
 | |
|       // Check if it's the container for local files (don't be fooled by the
 | |
|       // bogus string name, this is "(local files)").
 | |
|       let host =
 | |
|         "." +
 | |
|         (aContainerNode.title == PlacesUtils.getString("localhost")
 | |
|           ? ""
 | |
|           : aContainerNode.title);
 | |
|       await PlacesUtils.history.removeByFilter({ host });
 | |
|     } else if (PlacesUtils.nodeIsDay(aContainerNode)) {
 | |
|       // This is a day container.
 | |
|       let query = aContainerNode.query;
 | |
|       let beginTime = query.beginTime;
 | |
|       let endTime = query.endTime;
 | |
|       if (!query || !beginTime || !endTime) {
 | |
|         throw new Error("A valid date container query should exist!");
 | |
|       }
 | |
|       // We want to exclude beginTime from the removal because
 | |
|       // removePagesByTimeframe includes both extremes, while date containers
 | |
|       // exclude the lower extreme.  So, if we would not exclude it, we would
 | |
|       // end up removing more history than requested.
 | |
|       await PlacesUtils.history.removeByFilter({
 | |
|         beginDate: PlacesUtils.toDate(beginTime + 1000),
 | |
|         endDate: PlacesUtils.toDate(endTime),
 | |
|       });
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Removes the selection
 | |
|    */
 | |
|   async remove() {
 | |
|     if (!this._hasRemovableSelection()) {
 | |
|       return;
 | |
|     }
 | |
| 
 | |
|     var root = this._view.result.root;
 | |
| 
 | |
|     if (PlacesUtils.nodeIsFolder(root)) {
 | |
|       await this._removeRowsFromBookmarks();
 | |
|     } else if (PlacesUtils.nodeIsQuery(root)) {
 | |
|       var queryType = PlacesUtils.asQuery(root).queryOptions.queryType;
 | |
|       if (queryType == Ci.nsINavHistoryQueryOptions.QUERY_TYPE_BOOKMARKS) {
 | |
|         await this._removeRowsFromBookmarks();
 | |
|       } else if (queryType == Ci.nsINavHistoryQueryOptions.QUERY_TYPE_HISTORY) {
 | |
|         await this._removeRowsFromHistory();
 | |
|       } else {
 | |
|         throw new Error("implement support for QUERY_TYPE_UNIFIED");
 | |
|       }
 | |
|     } else {
 | |
|       throw new Error("unexpected root");
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Fills a DataTransfer object with the content of the selection that can be
 | |
|    * dropped elsewhere.
 | |
|    * @param   aEvent
 | |
|    *          The dragstart event.
 | |
|    */
 | |
|   setDataTransfer: function PC_setDataTransfer(aEvent) {
 | |
|     let dt = aEvent.dataTransfer;
 | |
| 
 | |
|     let result = this._view.result;
 | |
|     let didSuppressNotifications = result.suppressNotifications;
 | |
|     if (!didSuppressNotifications) {
 | |
|       result.suppressNotifications = true;
 | |
|     }
 | |
| 
 | |
|     function addData(type, index) {
 | |
|       let wrapNode = PlacesUtils.wrapNode(node, type);
 | |
|       dt.mozSetDataAt(type, wrapNode, index);
 | |
|     }
 | |
| 
 | |
|     function addURIData(index) {
 | |
|       addData(PlacesUtils.TYPE_X_MOZ_URL, index);
 | |
|       addData(PlacesUtils.TYPE_UNICODE, index);
 | |
|       addData(PlacesUtils.TYPE_HTML, index);
 | |
|     }
 | |
| 
 | |
|     try {
 | |
|       let nodes = this._view.draggableSelection;
 | |
|       for (let i = 0; i < nodes.length; ++i) {
 | |
|         var node = nodes[i];
 | |
| 
 | |
|         // This order is _important_! It controls how this and other
 | |
|         // applications select data to be inserted based on type.
 | |
|         addData(PlacesUtils.TYPE_X_MOZ_PLACE, i);
 | |
|         if (node.uri) {
 | |
|           addURIData(i);
 | |
|         }
 | |
|       }
 | |
|     } finally {
 | |
|       if (!didSuppressNotifications) {
 | |
|         result.suppressNotifications = false;
 | |
|       }
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   get clipboardAction() {
 | |
|     let action = {};
 | |
|     let actionOwner;
 | |
|     try {
 | |
|       let xferable = Cc["@mozilla.org/widget/transferable;1"].createInstance(
 | |
|         Ci.nsITransferable
 | |
|       );
 | |
|       xferable.init(null);
 | |
|       xferable.addDataFlavor(PlacesUtils.TYPE_X_MOZ_PLACE_ACTION);
 | |
|       this.clipboard.getData(xferable, Ci.nsIClipboard.kGlobalClipboard);
 | |
|       xferable.getTransferData(PlacesUtils.TYPE_X_MOZ_PLACE_ACTION, action);
 | |
|       [action, actionOwner] = action.value
 | |
|         .QueryInterface(Ci.nsISupportsString)
 | |
|         .data.split(",");
 | |
|     } catch (ex) {
 | |
|       // Paste from external sources don't have any associated action, just
 | |
|       // fallback to a copy action.
 | |
|       return "copy";
 | |
|     }
 | |
|     // For cuts also check who inited the action, since cuts across different
 | |
|     // instances should instead be handled as copies (The sources are not
 | |
|     // available for this instance).
 | |
|     if (action == "cut" && actionOwner != this.profileName) {
 | |
|       action = "copy";
 | |
|     }
 | |
| 
 | |
|     return action;
 | |
|   },
 | |
| 
 | |
|   _releaseClipboardOwnership: function PC__releaseClipboardOwnership() {
 | |
|     if (this.cutNodes.length) {
 | |
|       // This clears the logical clipboard, doesn't remove data.
 | |
|       this.clipboard.emptyClipboard(Ci.nsIClipboard.kGlobalClipboard);
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   _clearClipboard: function PC__clearClipboard() {
 | |
|     let xferable = Cc["@mozilla.org/widget/transferable;1"].createInstance(
 | |
|       Ci.nsITransferable
 | |
|     );
 | |
|     xferable.init(null);
 | |
|     // Empty transferables may cause crashes, so just add an unknown type.
 | |
|     const TYPE = "text/x-moz-place-empty";
 | |
|     xferable.addDataFlavor(TYPE);
 | |
|     xferable.setTransferData(TYPE, PlacesUtils.toISupportsString(""), 0);
 | |
|     this.clipboard.setData(xferable, null, Ci.nsIClipboard.kGlobalClipboard);
 | |
|   },
 | |
| 
 | |
|   _populateClipboard: function PC__populateClipboard(aNodes, aAction) {
 | |
|     // This order is _important_! It controls how this and other applications
 | |
|     // select data to be inserted based on type.
 | |
|     let contents = [
 | |
|       { type: PlacesUtils.TYPE_X_MOZ_PLACE, entries: [] },
 | |
|       { type: PlacesUtils.TYPE_X_MOZ_URL, entries: [] },
 | |
|       { type: PlacesUtils.TYPE_HTML, entries: [] },
 | |
|       { type: PlacesUtils.TYPE_UNICODE, entries: [] },
 | |
|     ];
 | |
| 
 | |
|     // Avoid handling descendants of a copied node, the transactions take care
 | |
|     // of them automatically.
 | |
|     let copiedFolders = [];
 | |
|     aNodes.forEach(function(node) {
 | |
|       if (this._shouldSkipNode(node, copiedFolders)) {
 | |
|         return;
 | |
|       }
 | |
|       if (PlacesUtils.nodeIsFolder(node)) {
 | |
|         copiedFolders.push(node);
 | |
|       }
 | |
| 
 | |
|       contents.forEach(function(content) {
 | |
|         content.entries.push(PlacesUtils.wrapNode(node, content.type));
 | |
|       });
 | |
|     }, this);
 | |
| 
 | |
|     function addData(type, data) {
 | |
|       xferable.addDataFlavor(type);
 | |
|       xferable.setTransferData(
 | |
|         type,
 | |
|         PlacesUtils.toISupportsString(data),
 | |
|         data.length * 2
 | |
|       );
 | |
|     }
 | |
| 
 | |
|     let xferable = Cc["@mozilla.org/widget/transferable;1"].createInstance(
 | |
|       Ci.nsITransferable
 | |
|     );
 | |
|     xferable.init(null);
 | |
|     let hasData = false;
 | |
|     // This order matters here!  It controls how this and other applications
 | |
|     // select data to be inserted based on type.
 | |
|     contents.forEach(function(content) {
 | |
|       if (content.entries.length) {
 | |
|         hasData = true;
 | |
|         let glue =
 | |
|           content.type == PlacesUtils.TYPE_X_MOZ_PLACE ? "," : PlacesUtils.endl;
 | |
|         addData(content.type, content.entries.join(glue));
 | |
|       }
 | |
|     });
 | |
| 
 | |
|     // Track the exected action in the xferable.  This must be the last flavor
 | |
|     // since it's the least preferred one.
 | |
|     // Enqueue a unique instance identifier to distinguish operations across
 | |
|     // concurrent instances of the application.
 | |
|     addData(
 | |
|       PlacesUtils.TYPE_X_MOZ_PLACE_ACTION,
 | |
|       aAction + "," + this.profileName
 | |
|     );
 | |
| 
 | |
|     if (hasData) {
 | |
|       this.clipboard.setData(
 | |
|         xferable,
 | |
|         aAction == "cut" ? this : null,
 | |
|         Ci.nsIClipboard.kGlobalClipboard
 | |
|       );
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   _cutNodes: [],
 | |
|   get cutNodes() {
 | |
|     return this._cutNodes;
 | |
|   },
 | |
|   set cutNodes(aNodes) {
 | |
|     let self = this;
 | |
|     function updateCutNodes(aValue) {
 | |
|       self._cutNodes.forEach(function(aNode) {
 | |
|         self._view.toggleCutNode(aNode, aValue);
 | |
|       });
 | |
|     }
 | |
| 
 | |
|     updateCutNodes(false);
 | |
|     this._cutNodes = aNodes;
 | |
|     updateCutNodes(true);
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Copy Bookmarks and Folders to the clipboard
 | |
|    */
 | |
|   copy: function PC_copy() {
 | |
|     let result = this._view.result;
 | |
|     let didSuppressNotifications = result.suppressNotifications;
 | |
|     if (!didSuppressNotifications) {
 | |
|       result.suppressNotifications = true;
 | |
|     }
 | |
|     try {
 | |
|       this._populateClipboard(this._view.selectedNodes, "copy");
 | |
|     } finally {
 | |
|       if (!didSuppressNotifications) {
 | |
|         result.suppressNotifications = false;
 | |
|       }
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Cut Bookmarks and Folders to the clipboard
 | |
|    */
 | |
|   cut: function PC_cut() {
 | |
|     let result = this._view.result;
 | |
|     let didSuppressNotifications = result.suppressNotifications;
 | |
|     if (!didSuppressNotifications) {
 | |
|       result.suppressNotifications = true;
 | |
|     }
 | |
|     try {
 | |
|       this._populateClipboard(this._view.selectedNodes, "cut");
 | |
|       this.cutNodes = this._view.selectedNodes;
 | |
|     } finally {
 | |
|       if (!didSuppressNotifications) {
 | |
|         result.suppressNotifications = false;
 | |
|       }
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Paste Bookmarks and Folders from the clipboard
 | |
|    */
 | |
|   async paste() {
 | |
|     // No reason to proceed if there isn't a valid insertion point.
 | |
|     let ip = this._view.insertionPoint;
 | |
|     if (!ip) {
 | |
|       throw Components.Exception("", Cr.NS_ERROR_NOT_AVAILABLE);
 | |
|     }
 | |
| 
 | |
|     let action = this.clipboardAction;
 | |
| 
 | |
|     let xferable = Cc["@mozilla.org/widget/transferable;1"].createInstance(
 | |
|       Ci.nsITransferable
 | |
|     );
 | |
|     xferable.init(null);
 | |
|     // This order matters here!  It controls the preferred flavors for this
 | |
|     // paste operation.
 | |
|     [
 | |
|       PlacesUtils.TYPE_X_MOZ_PLACE,
 | |
|       PlacesUtils.TYPE_X_MOZ_URL,
 | |
|       PlacesUtils.TYPE_UNICODE,
 | |
|     ].forEach(type => xferable.addDataFlavor(type));
 | |
| 
 | |
|     this.clipboard.getData(xferable, Ci.nsIClipboard.kGlobalClipboard);
 | |
| 
 | |
|     // Now get the clipboard contents, in the best available flavor.
 | |
|     let data = {},
 | |
|       type = {},
 | |
|       items = [];
 | |
|     try {
 | |
|       xferable.getAnyTransferData(type, data);
 | |
|       data = data.value.QueryInterface(Ci.nsISupportsString).data;
 | |
|       type = type.value;
 | |
|       items = PlacesUtils.unwrapNodes(data, type);
 | |
|     } catch (ex) {
 | |
|       // No supported data exists or nodes unwrap failed, just bail out.
 | |
|       return;
 | |
|     }
 | |
| 
 | |
|     let doCopy = action == "copy";
 | |
|     let itemsToSelect = await PlacesUIUtils.handleTransferItems(
 | |
|       items,
 | |
|       ip,
 | |
|       doCopy,
 | |
|       this._view
 | |
|     );
 | |
| 
 | |
|     // Cut/past operations are not repeatable, so clear the clipboard.
 | |
|     if (action == "cut") {
 | |
|       this._clearClipboard();
 | |
|     }
 | |
| 
 | |
|     if (itemsToSelect.length) {
 | |
|       this._view.selectItems(itemsToSelect, false);
 | |
|     }
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Checks if we can insert into a container.
 | |
|    * @param   container
 | |
|    *          The container were we are want to drop
 | |
|    */
 | |
|   disallowInsertion(container) {
 | |
|     if (!container) {
 | |
|       throw new Error("empty container");
 | |
|     }
 | |
|     // Allow dropping into Tag containers and editable folders.
 | |
|     return (
 | |
|       !PlacesUtils.nodeIsTagQuery(container) &&
 | |
|       (!PlacesUtils.nodeIsFolder(container) ||
 | |
|         PlacesUIUtils.isFolderReadOnly(container))
 | |
|     );
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Determines if a node can be moved.
 | |
|    *
 | |
|    * @param   aNode
 | |
|    *          A nsINavHistoryResultNode node.
 | |
|    * @return True if the node can be moved, false otherwise.
 | |
|    */
 | |
|   canMoveNode(node) {
 | |
|     // Only bookmark items are movable.
 | |
|     if (node.itemId == -1) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     // Once tags and bookmarked are divorced, the tag-query check should be
 | |
|     // removed.
 | |
|     let parentNode = node.parent;
 | |
|     if (!parentNode) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     // Once tags and bookmarked are divorced, the tag-query check should be
 | |
|     // removed.
 | |
|     if (PlacesUtils.nodeIsTagQuery(parentNode)) {
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     return (
 | |
|       (PlacesUtils.nodeIsFolder(parentNode) &&
 | |
|         !PlacesUIUtils.isFolderReadOnly(parentNode)) ||
 | |
|       PlacesUtils.nodeIsQuery(parentNode)
 | |
|     );
 | |
|   },
 | |
| };
 | |
| 
 | |
| /**
 | |
|  * Handles drag and drop operations for views. Note that this is view agnostic!
 | |
|  * You should not use PlacesController._view within these methods, since
 | |
|  * the view that the item(s) have been dropped on was not necessarily active.
 | |
|  * Drop functions are passed the view that is being dropped on.
 | |
|  */
 | |
| var PlacesControllerDragHelper = {
 | |
|   /**
 | |
|    * DOM Element currently being dragged over
 | |
|    */
 | |
|   currentDropTarget: null,
 | |
| 
 | |
|   /**
 | |
|    * Determines if the mouse is currently being dragged over a child node of
 | |
|    * this menu. This is necessary so that the menu doesn't close while the
 | |
|    * mouse is dragging over one of its submenus
 | |
|    * @param   node
 | |
|    *          The container node
 | |
|    * @return true if the user is dragging over a node within the hierarchy of
 | |
|    *         the container, false otherwise.
 | |
|    */
 | |
|   draggingOverChildNode: function PCDH_draggingOverChildNode(node) {
 | |
|     let currentNode = this.currentDropTarget;
 | |
|     while (currentNode) {
 | |
|       if (currentNode == node) {
 | |
|         return true;
 | |
|       }
 | |
|       currentNode = currentNode.parentNode;
 | |
|     }
 | |
|     return false;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * @return The current active drag session. Returns null if there is none.
 | |
|    */
 | |
|   getSession: function PCDH__getSession() {
 | |
|     return this.dragService.getCurrentSession();
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Extract the first accepted flavor from a list of flavors.
 | |
|    * @param aFlavors
 | |
|    *        The flavors list of type DOMStringList.
 | |
|    */
 | |
|   getFirstValidFlavor: function PCDH_getFirstValidFlavor(aFlavors) {
 | |
|     for (let i = 0; i < aFlavors.length; i++) {
 | |
|       if (PlacesUIUtils.SUPPORTED_FLAVORS.includes(aFlavors[i])) {
 | |
|         return aFlavors[i];
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     // If no supported flavor is found, check if data includes text/plain
 | |
|     // contents.  If so, request them as text/unicode, a conversion will happen
 | |
|     // automatically.
 | |
|     if (aFlavors.contains("text/plain")) {
 | |
|       return PlacesUtils.TYPE_UNICODE;
 | |
|     }
 | |
| 
 | |
|     return null;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Determines whether or not the data currently being dragged can be dropped
 | |
|    * on a places view.
 | |
|    * @param ip
 | |
|    *        The insertion point where the items should be dropped.
 | |
|    */
 | |
|   canDrop: function PCDH_canDrop(ip, dt) {
 | |
|     let dropCount = dt.mozItemCount;
 | |
| 
 | |
|     // Check every dragged item.
 | |
|     for (let i = 0; i < dropCount; i++) {
 | |
|       let flavor = this.getFirstValidFlavor(dt.mozTypesAt(i));
 | |
|       if (!flavor) {
 | |
|         return false;
 | |
|       }
 | |
| 
 | |
|       // Urls can be dropped on any insertionpoint.
 | |
|       // XXXmano: remember that this method is called for each dragover event!
 | |
|       // Thus we shouldn't use unwrapNodes here at all if possible.
 | |
|       // I think it would be OK to accept bogus data here (e.g. text which was
 | |
|       // somehow wrapped as TAB_DROP_TYPE, this is not in our control, and
 | |
|       // will just case the actual drop to be a no-op), and only rule out valid
 | |
|       // expected cases, which are either unsupported flavors, or items which
 | |
|       // cannot be dropped in the current insertionpoint. The last case will
 | |
|       // likely force us to use unwrapNodes for the private data types of
 | |
|       // places.
 | |
|       if (flavor == TAB_DROP_TYPE) {
 | |
|         continue;
 | |
|       }
 | |
| 
 | |
|       let data = dt.mozGetDataAt(flavor, i);
 | |
|       let nodes;
 | |
|       try {
 | |
|         nodes = PlacesUtils.unwrapNodes(data, flavor);
 | |
|       } catch (e) {
 | |
|         return false;
 | |
|       }
 | |
| 
 | |
|       for (let dragged of nodes) {
 | |
|         // Only bookmarks and urls can be dropped into tag containers.
 | |
|         if (
 | |
|           ip.isTag &&
 | |
|           dragged.type != PlacesUtils.TYPE_X_MOZ_URL &&
 | |
|           (dragged.type != PlacesUtils.TYPE_X_MOZ_PLACE ||
 | |
|             (dragged.uri && dragged.uri.startsWith("place:")))
 | |
|         ) {
 | |
|           return false;
 | |
|         }
 | |
| 
 | |
|         // The following loop disallows the dropping of a folder on itself or
 | |
|         // on any of its descendants.
 | |
|         if (
 | |
|           dragged.type == PlacesUtils.TYPE_X_MOZ_PLACE_CONTAINER ||
 | |
|           (dragged.uri && dragged.uri.startsWith("place:"))
 | |
|         ) {
 | |
|           let parentId = ip.itemId;
 | |
|           while (parentId != PlacesUtils.placesRootId) {
 | |
|             if (dragged.concreteId == parentId || dragged.id == parentId) {
 | |
|               return false;
 | |
|             }
 | |
|             parentId = PlacesUtils.bookmarks.getFolderIdForItem(parentId);
 | |
|           }
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|     return true;
 | |
|   },
 | |
| 
 | |
|   /**
 | |
|    * Handles the drop of one or more items onto a view.
 | |
|    *
 | |
|    * @param {Object} insertionPoint The insertion point where the items should
 | |
|    *                                be dropped.
 | |
|    * @param {Object} dt             The dataTransfer information for the drop.
 | |
|    * @param {Object} view           The view or the tree element. This allows
 | |
|    *                                batching to take place.
 | |
|    */
 | |
|   async onDrop(insertionPoint, dt, view) {
 | |
|     let doCopy = ["copy", "link"].includes(dt.dropEffect);
 | |
| 
 | |
|     let dropCount = dt.mozItemCount;
 | |
| 
 | |
|     // Following flavors may contain duplicated data.
 | |
|     let duplicable = new Map();
 | |
|     duplicable.set(PlacesUtils.TYPE_UNICODE, new Set());
 | |
|     duplicable.set(PlacesUtils.TYPE_X_MOZ_URL, new Set());
 | |
| 
 | |
|     // Collect all data from the DataTransfer before processing it, as the
 | |
|     // DataTransfer is only valid during the synchronous handling of the `drop`
 | |
|     // event handler callback.
 | |
|     let nodes = [];
 | |
|     for (let i = 0; i < dropCount; ++i) {
 | |
|       let flavor = this.getFirstValidFlavor(dt.mozTypesAt(i));
 | |
|       if (!flavor) {
 | |
|         return;
 | |
|       }
 | |
| 
 | |
|       let data = dt.mozGetDataAt(flavor, i);
 | |
|       if (duplicable.has(flavor)) {
 | |
|         let handled = duplicable.get(flavor);
 | |
|         if (handled.has(data)) {
 | |
|           continue;
 | |
|         }
 | |
|         handled.add(data);
 | |
|       }
 | |
| 
 | |
|       if (flavor != TAB_DROP_TYPE) {
 | |
|         nodes = [...nodes, ...PlacesUtils.unwrapNodes(data, flavor)];
 | |
|       } else if (
 | |
|         data instanceof XULElement &&
 | |
|         data.localName == "tab" &&
 | |
|         data.ownerGlobal.isChromeWindow
 | |
|       ) {
 | |
|         let uri = data.linkedBrowser.currentURI;
 | |
|         let spec = uri ? uri.spec : "about:blank";
 | |
|         nodes.push({
 | |
|           uri: spec,
 | |
|           title: data.label,
 | |
|           type: PlacesUtils.TYPE_X_MOZ_URL,
 | |
|         });
 | |
|       } else {
 | |
|         throw new Error("bogus data was passed as a tab");
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     await PlacesUIUtils.handleTransferItems(
 | |
|       nodes,
 | |
|       insertionPoint,
 | |
|       doCopy,
 | |
|       view
 | |
|     );
 | |
|   },
 | |
| };
 | |
| 
 | |
| XPCOMUtils.defineLazyServiceGetter(
 | |
|   PlacesControllerDragHelper,
 | |
|   "dragService",
 | |
|   "@mozilla.org/widget/dragservice;1",
 | |
|   "nsIDragService"
 | |
| );
 |