The Tor Browser: browser/metro/base/content/startui/HistoryView.js@b8a032363ba2 (annotated)

browser/metro/base/content/startui/HistoryView.js@b8a032363ba2 (annotated)

browser/metro/base/content/startui/HistoryView.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 'use strict';
 function HistoryView(aSet, aFilterUnpinned) {
   View.call(this, aSet);
   this._inBatch = 0;
   // View monitors this for maximum tile display counts
   this.tilePrefName = "browser.display.startUI.history.maxresults";
   this.showing = this.maxTiles > 0;
   this._filterUnpinned = aFilterUnpinned;
   this._historyService = PlacesUtils.history;
   this._navHistoryService = gHistSvc;
   this._pinHelper = new ItemPinHelper("metro.history.unpinned");
   this._historyService.addObserver(this, false);
   StartUI.chromeWin.addEventListener('MozAppbarDismissing', this, false);
   StartUI.chromeWin.addEventListener('HistoryNeedsRefresh', this, false);
   window.addEventListener("TabClose", this, true);
 }
 HistoryView.prototype = Util.extend(Object.create(View.prototype), {
   _set: null,
   _toRemove: null,
   // For View's showing property
   get vbox() {
     return document.getElementById("start-history");
   },
   destruct: function destruct() {
     this._historyService.removeObserver(this);
     if (StartUI.chromeWin) {
       StartUI.chromeWin.removeEventListener('MozAppbarDismissing', this, false);
       StartUI.chromeWin.removeEventListener('HistoryNeedsRefresh', this, false);
     }
     View.prototype.destruct.call(this);
   },
   refreshView: function () {
     this.onClearHistory();
     this.populateGrid();
   },
   handleItemClick: function tabview_handleItemClick(aItem) {
     let url = aItem.getAttribute("value");
     StartUI.goToURI(url);
   },
   populateGrid: function populateGrid(aRefresh) {
     this._inBatch++; // always batch up grid updates to avoid redundant arrangeItems calls
     let query = this._navHistoryService.getNewQuery();
     let options = this._navHistoryService.getNewQueryOptions();
     options.excludeQueries = true;
     options.queryType = options.QUERY_TYPE_HISTORY;
     options.resultType = options.RESULTS_AS_URI;
     options.sortingMode = options.SORT_BY_DATE_DESCENDING;
     let limit = this.maxTiles;
     let result = this._navHistoryService.executeQuery(query, options);
     let rootNode = result.root;
     rootNode.containerOpen = true;
     let childCount = rootNode.childCount;
     for (let i = 0, addedCount = 0; i < childCount && addedCount < limit; i++) {
       let node = rootNode.getChild(i);
       let uri = node.uri;
       let title = (node.title && node.title.length) ? node.title : uri;
       // If item is marked for deletion, skip it.
       if (this._toRemove && this._toRemove.indexOf(uri) !== -1)
         continue;
       let items = this._set.getItemsByUrl(uri);
       // Item has been unpinned, skip if filterUnpinned set.
       if (this._filterUnpinned && !this._pinHelper.isPinned(uri)) {
         if (items.length > 0)
           this.removeHistory(uri);
         continue;
       }
       if (!aRefresh || items.length === 0) {
         // If we're not refreshing or the item is not in the grid, add it.
         this.addItemToSet(uri, title, node.icon, addedCount);
       } else if (aRefresh && items.length > 0) {
         // Update context action in case it changed in another view.
         for (let item of items) {
           this._setContextActions(item);
         }
       }
       addedCount++;
     }
     // Remove extra items in case a refresh added more than the limit.
     // This can happen when undoing a delete.
     if (aRefresh) {
       while (this._set.itemCount > limit)
         this._set.removeItemAt(this._set.itemCount - 1);
     }
     rootNode.containerOpen = false;
     this._set.arrangeItems();
     if (this._inBatch > 0)
       this._inBatch--;
   },
   addItemToSet: function addItemToSet(aURI, aTitle, aIcon, aPos) {
     let item = this._set.insertItemAt(aPos || 0, aTitle, aURI, this._inBatch);
     this._setContextActions(item);
     this._updateFavicon(item, aURI);
   },
   _setContextActions: function bv__setContextActions(aItem) {
     let uri = aItem.getAttribute("value");
     aItem.setAttribute("data-contextactions", "delete," + (this._pinHelper.isPinned(uri) ? "hide" : "pin"));
     if ("refresh" in aItem) aItem.refresh();
   },
   _sendNeedsRefresh: function bv__sendNeedsRefresh(){
     // Event sent when all views need to refresh.
     let event = document.createEvent("Events");
     event.initEvent("HistoryNeedsRefresh", true, false);
     window.dispatchEvent(event);
   },
   removeHistory: function (aUri) {
     let items = this._set.getItemsByUrl(aUri);
     for (let item of items)
       this._set.removeItem(item, true);
     if (!this._inBatch)
       this._set.arrangeItems();
   },
   doActionOnSelectedTiles: function bv_doActionOnSelectedTiles(aActionName, aEvent) {
     let tileGroup = this._set;
     let selectedTiles = tileGroup.selectedItems;
     // just arrange the grid once at the end of any action handling
     this._inBatch = true;
     switch (aActionName){
       case "delete":
         Array.forEach(selectedTiles, function(aNode) {
           if (!this._toRemove) {
             this._toRemove = [];
           }
           let uri = aNode.getAttribute("value");
           this._toRemove.push(uri);
           this.removeHistory(uri);
         }, this);
         // stop the appbar from dismissing
         aEvent.preventDefault();
         // at next tick, re-populate the context appbar.
         setTimeout(function(){
           // fire a MozContextActionsChange event to update the context appbar
           let event = document.createEvent("Events");
           // we need the restore button to show (the tile node will go away though)
           event.actions = ["restore"];
           event.initEvent("MozContextActionsChange", true, false);
           tileGroup.dispatchEvent(event);
         }, 0);
         break;
       case "restore":
         // clear toRemove and let _sendNeedsRefresh update the items.
         this._toRemove = null;
         break;
       case "unpin":
         Array.forEach(selectedTiles, function(aNode) {
           let uri = aNode.getAttribute("value");
           if (this._filterUnpinned)
             this.removeHistory(uri);
           this._pinHelper.setUnpinned(uri);
         }, this);
         break;
       case "pin":
         Array.forEach(selectedTiles, function(aNode) {
           let uri = aNode.getAttribute("value");
           this._pinHelper.setPinned(uri);
         }, this);
         break;
       default:
         this._inBatch = false;
         return;
     }
     this._inBatch = false;
     // Send refresh event so all view are in sync.
     this._sendNeedsRefresh();
   },
   handleEvent: function bv_handleEvent(aEvent) {
     switch (aEvent.type){
       case "MozAppbarDismissing":
         // If undo wasn't pressed, time to do definitive actions.
         if (this._toRemove) {
           for (let uri of this._toRemove) {
             this._historyService.removePage(NetUtil.newURI(uri));
           }
           // Clear context app bar
           let event = document.createEvent("Events");
           event.actions = [];
           event.initEvent("MozContextActionsChange", true, false);
           this._set.dispatchEvent(event);
           this._toRemove = null;
         }
         break;
       case "HistoryNeedsRefresh":
         this.populateGrid(true);
         break;
       case "TabClose":
         // Flush any pending actions - appbar will call us back
         // before this returns with 'MozAppbarDismissing' above.
         StartUI.chromeWin.ContextUI.dismissContextAppbar();
       break;
     }
   },
   // nsINavHistoryObserver & helpers
   onBeginUpdateBatch: function() {
     // Avoid heavy grid redraws while a batch is in process
     this._inBatch++;
   },
   onEndUpdateBatch: function() {
     this.populateGrid(true);
     if (this._inBatch > 0) {
       this._inBatch--;
       this._set.arrangeItems();
     }
   },
   onVisit: function(aURI, aVisitID, aTime, aSessionID,
                     aReferringID, aTransitionType) {
     if (!this._inBatch) {
       this.populateGrid(true);
     }
   },
   onTitleChanged: function(aURI, aPageTitle) {
     let changedItems = this._set.getItemsByUrl(aURI.spec);
     for (let item of changedItems) {
       item.setAttribute("label", aPageTitle);
     }
   },
   onDeleteURI: function(aURI) {
     this.removeHistory(aURI.spec);
   },
   onClearHistory: function() {
     if ('clearAll' in this._set)
       this._set.clearAll();
   },
   onPageChanged: function(aURI, aWhat, aValue) {
     if (aWhat ==  Ci.nsINavHistoryObserver.ATTRIBUTE_FAVICON) {
       let changedItems = this._set.getItemsByUrl(aURI.spec);
       for (let item of changedItems) {
         let currIcon = item.getAttribute("iconURI");
         if (currIcon != aValue) {
           item.setAttribute("iconURI", aValue);
           if ("refresh" in item)
             item.refresh();
         }
       }
     }
   },
   onDeleteVisits: function (aURI, aVisitTime, aGUID, aReason, aTransitionType) {
     if ((aReason ==  Ci.nsINavHistoryObserver.REASON_DELETED) && !this._inBatch) {
       this.populateGrid(true);
     }
   },
   QueryInterface: function(iid) {
     if (iid.equals(Components.interfaces.nsINavHistoryObserver) ||
         iid.equals(Components.interfaces.nsISupports)) {
       return this;
     }
     throw Cr.NS_ERROR_NO_INTERFACE;
   }
 });
 let HistoryStartView = {
   _view: null,
   get _grid() { return document.getElementById("start-history-grid"); },
   init: function init() {
     this._view = new HistoryView(this._grid, true);
     this._view.populateGrid();
     this._grid.removeAttribute("fade");
   },
   uninit: function uninit() {
     if (this._view) {
       this._view.destruct();
     }
   }
 };