History: Rename Page to Visit, remove some unused code, other cleanups.

chrome/browser/resources/history/history.js

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 <include src="../uber/uber_utils.js">
 
 ///////////////////////////////////////////////////////////////////////////////
 // Globals:
 /** @const */ var RESULTS_PER_PAGE = 150;
 /** @const */ var MAX_SEARCH_DEPTH_MONTHS = 18;
@@ skipping 23 matching lines @@
   return null;
 }
 
 // TODO(glen): Get rid of these global references, replace with a controller
 //     or just make the classes own more of the page.
 var historyModel;
 var historyView;
 var pageState;
 var deleteQueue = [];
 var selectionAnchor = -1;
-var activePage = null;
+var activeVisit = null;
 
 /** @const */ var Command = cr.ui.Command;
 /** @const */ var Menu = cr.ui.Menu;
 /** @const */ var MenuButton = cr.ui.MenuButton;
 
 MenuButton.createDropDownArrows();
 
 ///////////////////////////////////////////////////////////////////////////////
-// Page:
+// Visit:
 
 /**
  * Class to hold all the information about an entry in our model.
- * @param {Object} result An object containing the page's data.
- * @param {boolean} continued Whether this page is on the same day as the
- *     page before it
+ * @param {Object} result An object containing the visit's data.
+ * @param {boolean} continued Whether this visit is on the same day as the
+ *     visit before it.
  * @param {HistoryModel} model The model object this entry belongs to.
  * @param {Number} id The identifier for the entry.
  * @constructor
  */
-function Page(result, continued, model, id) {
+function Visit(result, continued, model, id) {
   this.model_ = model;
   this.title_ = result.title;
   this.url_ = result.url;
-  this.domain_ = this.getDomainFromURL_(this.url_);
   this.starred_ = result.starred;
   this.snippet_ = result.snippet || '';
   this.id_ = id;
 
   this.changed = false;
 
   this.isRendered = false;
 
   // All the date information is public so that owners can compare properties of
   // two items easily.
 
   // We get the time in seconds, but we want it in milliseconds.
   this.time = new Date(result.time * 1000);
 
   // See comment in BrowsingHistoryHandler::QueryComplete - we won't always
   // get all of these.
   this.dateRelativeDay = result.dateRelativeDay || '';
   this.dateTimeOfDay = result.dateTimeOfDay || '';
   this.dateShort = result.dateShort || '';
 
   // Whether this is the continuation of a previous day.
   this.continued = continued;
 }
 
-// Page, Public: --------------------------------------------------------------
+// Visit, public: -------------------------------------------------------------
 
 /**
  * Returns a dom structure for a browse page result or a search page result.
  * @param {boolean} searchResultFlag Indicates whether the result is a search
  *     result or not.
  * @return {Node} A DOM node to represent the history entry or search result.
  */
-Page.prototype.getResultDOM = function(searchResultFlag) {
+Visit.prototype.getResultDOM = function(searchResultFlag) {
   var node = createElementWithClassName('li', 'entry');
   var time = createElementWithClassName('div', 'time');
   var entryBox = createElementWithClassName('label', 'entry-box');
   var domain = createElementWithClassName('div', 'domain');
 
   var dropDown = createElementWithClassName('button', 'drop-down');
   dropDown.value = 'Open action menu';
   dropDown.title = loadTimeData.getString('actionMenuDescription');
   dropDown.setAttribute('menu', '#action-menu');
   cr.ui.decorate(dropDown, MenuButton);
 
   // Checkbox is always created, but only visible on hover & when checked.
   var checkbox = document.createElement('input');
   checkbox.type = 'checkbox';
   checkbox.id = 'checkbox-' + this.id_;
   checkbox.time = this.time.getTime();
   checkbox.addEventListener('click', checkboxClicked);
   time.appendChild(checkbox);
 
   // Keep track of the drop down that triggered the menu, so we know
   // which element to apply the command to.
   // TODO(dubroy): Ideally we'd use 'activate', but MenuButton swallows it.
   var self = this;
-  var setActivePage = function(e) {
-    activePage = self;
+  var setActiveVisit = function(e) {
+    activeVisit = self;
   };
-  dropDown.addEventListener('mousedown', setActivePage);
-  dropDown.addEventListener('focus', setActivePage);
+  dropDown.addEventListener('mousedown', setActiveVisit);
+  dropDown.addEventListener('focus', setActiveVisit);
 
-  domain.textContent = this.domain_;
+  domain.textContent = this.getDomainFromURL_(this.url_);
 
   // Clicking anywhere in the entryBox will check/uncheck the checkbox.
   entryBox.setAttribute('for', checkbox.id);
   entryBox.addEventListener('mousedown', entryBoxMousedown);
 
   // Prevent clicks on the drop down from affecting the checkbox.
   dropDown.addEventListener('click', function(e) { e.preventDefault(); });
 
   // We use a wrapper div so that the entry contents will be shinkwrapped.
   entryBox.appendChild(time);
@@ skipping 15 matching lines @@
     time.appendChild(document.createTextNode(this.dateShort));
     var snippet = createElementWithClassName('div', 'snippet');
     this.addHighlightedText_(snippet,
                              this.snippet_,
                              this.model_.getSearchText());
     node.appendChild(snippet);
   } else {
     time.appendChild(document.createTextNode(this.dateTimeOfDay));
   }
 
-  if (typeof this.domNode_ != 'undefined') {
-      console.error('Already generated node for page.');

[Patrick Dubroy, 2012/05/10 16:52:01]

This is not actually an error -- it happens whenever you view a page of results
that you already viewed before.

-  }
   this.domNode_ = node;
 
   return node;
 };
 
-// Page, private: -------------------------------------------------------------
+// Visit, private: ------------------------------------------------------------
 
 /**
  * Extracts and returns the domain (and subdomains) from a URL.
  * @param {string} url The url.
  * @return {string} The domain. An empty string is returned if no domain can
  *     be found.
  * @private
  */
-Page.prototype.getDomainFromURL_ = function(url) {
+Visit.prototype.getDomainFromURL_ = function(url) {
   var domain = url.replace(/^.+:\/\//, '').match(/[^/]+/);
   return domain ? domain[0] : '';
 };
 
 /**
  * Add child text nodes to a node such that occurrences of the specified text is
  * highlighted.
  * @param {Node} node The node under which new text nodes will be made as
  *     children.
  * @param {string} content Text to be added beneath |node| as one or more
  *     text nodes.
  * @param {string} highlightText Occurences of this text inside |content| will
  *     be highlighted.
  * @private
  */
-Page.prototype.addHighlightedText_ = function(node, content, highlightText) {
+Visit.prototype.addHighlightedText_ = function(node, content, highlightText) {
   var i = 0;
   if (highlightText) {
-    var re = new RegExp(Page.pregQuote_(highlightText), 'gim');
+    var re = new RegExp(Visit.pregQuote_(highlightText), 'gim');
     var match;
     while (match = re.exec(content)) {
       if (match.index > i)
         node.appendChild(document.createTextNode(content.slice(i,
                                                                match.index)));
       i = re.lastIndex;
       // Mark the highlighted text in bold.
       var b = document.createElement('b');
       b.textContent = content.substring(match.index, i);
       node.appendChild(b);
     }
   }
   if (i < content.length)
     node.appendChild(document.createTextNode(content.slice(i)));
 };
 
 /**
  * @return {DOMObject} DOM representation for the title block.
  * @private
  */
-Page.prototype.getTitleDOM_ = function() {
+Visit.prototype.getTitleDOM_ = function() {
   var node = createElementWithClassName('div', 'title');
   node.style.backgroundImage =
       'url(chrome://favicon/' + encodeURIForCSS(this.url_) + ')';
 
   var link = document.createElement('a');
   link.href = this.url_;
   link.id = 'id-' + this.id_;
   link.target = '_top';
 
   // Add a tooltip, since it might be ellipsized.
   // TODO(dubroy): Find a way to show the tooltip only when necessary.
   link.title = this.title_;
 
   this.addHighlightedText_(link, this.title_, this.model_.getSearchText());
   node.appendChild(link);
 
   if (this.starred_) {
     var star = createElementWithClassName('div', 'starred');
     node.appendChild(star);
     star.addEventListener('click', this.starClicked_.bind(this));
   }
 
   return node;
 };
 
 /**
  * Launch a search for more history entries from the same domain.
  * @private
  */
-Page.prototype.showMoreFromSite_ = function() {
-  setSearch(this.domain_);
+Visit.prototype.showMoreFromSite_ = function() {
+  setSearch(this.getDomainFromURL_(this.url_));
 };
 
 /**
  * Remove a single entry from the history.
  * @private
  */
-Page.prototype.removeFromHistory_ = function() {
+Visit.prototype.removeFromHistory_ = function() {
   var self = this;
   var onSuccessCallback = function() {
     removeEntryFromView(self.domNode_);
   };
   queueURLsForDeletion(this.time, [this.url_], onSuccessCallback);
   deleteNextInQueue();
 };
 
 /**
  * Click event handler for the star icon that appears beside bookmarked URLs.
  * When clicked, the bookmark is removed for that URL.
  * @param {Event} event The click event.
  * @private
  */
-Page.prototype.starClicked_ = function(event) {
+Visit.prototype.starClicked_ = function(event) {
   chrome.send('removeBookmark', [this.url_]);
   event.currentTarget.hidden = true;
   event.preventDefault();
 };
 
-// Page, private, static: -----------------------------------------------------
+// Visit, private, static: ----------------------------------------------------
 
 /**
  * Quote a string so it can be used in a regular expression.
  * @param {string} str The source string
  * @return {string} The escaped string
  * @private
  */
-Page.pregQuote_ = function(str) {
+Visit.pregQuote_ = function(str) {
   return str.replace(/([\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:])/g, '\\$1');
 };
 
 ///////////////////////////////////////////////////////////////////////////////
 // HistoryModel:
 
 /**
  * Global container for history data. Future optimizations might include
  * allowing the creation of a HistoryModel for each search string, allowing
  * quick flips back and forth between results.
@@ skipping 71 matching lines @@
   this.inFlight_ = false;
   if (info.term != this.searchText_) {
     // If our results aren't for our current search term, they're rubbish.
     return;
   }
 
   // Currently we assume we're getting things in date order. This needs to
   // be updated if that ever changes.
   if (results) {
     var lastURL, lastDay;
-    var oldLength = this.pages_.length;
+    var oldLength = this.visits_.length;
     if (oldLength) {
-      var oldPage = this.pages_[oldLength - 1];
-      lastURL = oldPage.url;
-      lastDay = oldPage.dateRelativeDay;
+      var oldVisit = this.visits_[oldLength - 1];
+      lastURL = oldVisit.url;
+      lastDay = oldVisit.dateRelativeDay;
     }
 
     for (var i = 0, thisResult; thisResult = results[i]; i++) {
       var thisURL = thisResult.url;
       var thisDay = thisResult.dateRelativeDay;
 
       // Remove adjacent duplicates.
       if (!lastURL || lastURL != thisURL) {
-        // Figure out if this page is in the same day as the previous page,
-        // this is used to determine how day headers should be drawn.
-        this.pages_.push(new Page(thisResult, thisDay == lastDay, this,
-            this.last_id_++));
+        // Figure out if this visit is in the same day as the previous visit.
+        // This is used to determine how day headers should be drawn.
+        this.visits_.push(
+            new Visit(thisResult, thisDay == lastDay, this, this.last_id_++));
         lastDay = thisDay;
         lastURL = thisURL;
       }
     }
     if (results.length)
       this.changed = true;
   }
 
   this.updateSearch_(info.finished);
 };
 
 /**
- * @return {Number} The number of pages in the model.
+ * @return {Number} The number of visits in the model.
  */
 HistoryModel.prototype.getSize = function() {
-  return this.pages_.length;
+  return this.visits_.length;
 };
 
 /**
- * @return {boolean} Whether our history query has covered all of
- *     the user's history
- */
-HistoryModel.prototype.isComplete = function() {
-  return this.complete_;
-};
-
-/**
- * Get a list of pages between specified index positions.
+ * Get a list of visits between specified index positions.
  * @param {Number} start The start index
  * @param {Number} end The end index
- * @return {Array} A list of pages
+ * @return {Array.<Visit>} A list of visits
  */
 HistoryModel.prototype.getNumberedRange = function(start, end) {
   if (start >= this.getSize())
     return [];
 
   var end = end > this.getSize() ? this.getSize() : end;
-  return this.pages_.slice(start, end);
+  return this.visits_.slice(start, end);
 };
 
 // HistoryModel, Private: -----------------------------------------------------
 
 /**
  * Clear the history model.
  * @private
  */
 HistoryModel.prototype.clearModel_ = function() {
   this.inFlight_ = false; // Whether a query is inflight.
   this.searchText_ = '';
   this.searchDepth_ = 0;
-  this.pages_ = []; // Date-sorted list of pages.
+  this.visits_ = []; // Date-sorted list of visits.
   this.last_id_ = 0;
   selectionAnchor = -1;
 
   // The page that the view wants to see - we only fetch slightly past this
   // point. If the view requests a page that we don't have data for, we try
   // to fetch it and call back when we're done.
   this.requestedPage_ = 0;
 
-  this.complete_ = false;
-
-  if (this.view_) {
+  if (this.view_)
     this.view_.clear_();
-  }
 };
 
 /**
  * Figure out if we need to do more searches to fill the currently requested
  * page. If we think we can fill the page, call the view and let it know
  * we're ready to show something.
  * @param {boolean} finished Indicates if there is any more data to come.
  * @private
  */
 HistoryModel.prototype.updateSearch_ = function(finished) {
@@ skipping 26 matching lines @@
  * used.
  *
  * TODO: Fix this for when the user's clock goes across month boundaries.
  * @param {number=} depth How many days (or months, if the search text is
  *     non-empty) back to do the search.
  * @private
  */
 HistoryModel.prototype.getSearchResults_ = function(depth) {
   this.searchDepth_ = depth || 0;
 
-  if (this.searchText_ == '') {
+  if (this.searchText_) {
+    chrome.send('searchHistory',
+        [this.searchText_, String(this.searchDepth_)]);
+  } else {
     chrome.send('getHistory',
         [String(this.searchDepth_)]);
-  } else {
-    chrome.send('searchHistory',
-        [this.searchText_, String(this.searchDepth_)]);
   }
 
   this.inFlight_ = true;
 };
 
 /**
  * Check to see if we have data for a given page.
  * @param {number} page The page number
  * @return {boolean} Whether we have any data for the given page.
  * @private
@@ skipping 26 matching lines @@
   this.editButtonTd_ = $('edit-button');
   this.editingControlsDiv_ = $('editing-controls');
   this.resultDiv_ = $('results-display');
   this.pageDiv_ = $('results-pagination');
   this.model_ = model;
   this.pageIndex_ = 0;
   this.lastDisplayed_ = [];
 
   this.model_.setView(this);
 
-  this.currentPages_ = [];
+  this.currentVisits_ = [];
 
   var self = this;
   window.onresize = function() {
     self.updateEntryAnchorWidth_();
   };
 
   $('clear-browsing-data').addEventListener('click', openClearBrowsingData);
   $('remove-selected').addEventListener('click', removeItems);
 }
 
@@ skipping 57 matching lines @@
 // HistoryView, private: ------------------------------------------------------
 
 /**
  * Clear the results in the view.  Since we add results piecemeal, we need
  * to clear them out when we switch to a new page or reload.
  * @private
  */
 HistoryView.prototype.clear_ = function() {
   this.resultDiv_.textContent = '';
 
-  var pages = this.currentPages_;
-  for (var i = 0; i < pages.length; i++) {
-    pages[i].isRendered = false;
-  }
-  this.currentPages_ = [];
+  this.currentVisits_.forEach(function(visit) {
+    visit.isRendered = false;
+  });
+  this.currentVisits_ = [];
 };
 
 /**
- * Record that the given page has been rendered.
- * @param {Page} page The page that was rendered.
+ * Record that the given visit has been rendered.
+ * @param {Visit} visit The visit that was rendered.
  * @private
  */
-HistoryView.prototype.setPageRendered_ = function(page) {
-  page.isRendered = true;
-  this.currentPages_.push(page);
+HistoryView.prototype.setVisitRendered_ = function(visit) {
+  visit.isRendered = true;
+  this.currentVisits_.push(visit);
 };
 
 /**
  * Update the page with results.
  * @private
  */
 HistoryView.prototype.displayResults_ = function() {
   var results = this.model_.getNumberedRange(
       this.pageIndex_ * RESULTS_PER_PAGE,
       this.pageIndex_ * RESULTS_PER_PAGE + RESULTS_PER_PAGE);
 
   var searchText = this.model_.getSearchText();
   if (searchText) {
     // Add a header for the search results, if there isn't already one.
     if (!this.resultDiv_.querySelector('h3')) {
       var header = document.createElement('h3');
       header.textContent = loadTimeData.getStringF('searchresultsfor',
                                                    searchText);
       this.resultDiv_.appendChild(header);
     }
 
     var searchResults = createElementWithClassName('ol', 'search-results');
-    for (var i = 0, page; page = results[i]; i++) {
-      if (!page.isRendered) {
-        searchResults.appendChild(page.getResultDOM(true));
-        this.setPageRendered_(page);
+    for (var i = 0, visit; visit = results[i]; i++) {
+      if (!visit.isRendered) {
+        searchResults.appendChild(visit.getResultDOM(true));
+        this.setVisitRendered_(visit);
       }
     }
     this.resultDiv_.appendChild(searchResults);
   } else {
     var resultsFragment = document.createDocumentFragment();
     var lastTime = Math.infinity;
     var dayResults;
-    for (var i = 0, page; page = results[i]; i++) {
-      if (page.isRendered) {
+    for (var i = 0, visit; visit = results[i]; i++) {
+      if (visit.isRendered) {
         continue;
       }
       // Break across day boundaries and insert gaps for browsing pauses.
       // Create a dayResults element to contain results for each day
-      var thisTime = page.time.getTime();
+      var thisTime = visit.time.getTime();
 
-      if ((i == 0 && page.continued) || !page.continued) {
+      if ((i == 0 && visit.continued) || !visit.continued) {
         var day = createElementWithClassName('h3', 'day');
-        day.appendChild(document.createTextNode(page.dateRelativeDay));
-        if (i == 0 && page.continued) {
+        day.appendChild(document.createTextNode(visit.dateRelativeDay));
+        if (i == 0 && visit.continued) {
           day.appendChild(document.createTextNode(' ' +
               loadTimeData.getString('cont')));
         }
 
         // If there is an existing dayResults element, append it.
         if (dayResults) {
           resultsFragment.appendChild(dayResults);
         }
         resultsFragment.appendChild(day);
         dayResults = createElementWithClassName('ol', 'day-results');
       } else if (lastTime - thisTime > BROWSING_GAP_TIME) {
         if (dayResults) {
           dayResults.appendChild(createElementWithClassName('li', 'gap'));
         }
       }
       lastTime = thisTime;
       // Add entry.
       if (dayResults) {
-        dayResults.appendChild(page.getResultDOM(false));
-        this.setPageRendered_(page);
+        dayResults.appendChild(visit.getResultDOM(false));
+        this.setVisitRendered_(visit);
       }
     }
     // Add final dayResults element.
     if (dayResults) {
       resultsFragment.appendChild(dayResults);
     }
     this.resultDiv_.appendChild(resultsFragment);
   }
   this.displayNavBar_();
   this.updateEntryAnchorWidth_();
@@ skipping 185 matching lines @@
 
   // Create default view.
   var hashData = pageState.getHashData();
   historyView.setSearch(hashData.q, hashData.p);
 
   $('search-form').onsubmit = function() {
     setSearch(searchField.value);
     return false;
   };
 
-  $('remove-page').addEventListener('activate', function(e) {
-    activePage.removeFromHistory_();
-    activePage = null;
+  $('remove-visit').addEventListener('activate', function(e) {
+    activeVisit.removeFromHistory_();
+    activeVisit = null;
   });
   $('more-from-site').addEventListener('activate', function(e) {
-    activePage.showMoreFromSite_();
-    activePage = null;
+    activeVisit.showMoreFromSite_();
+    activeVisit = null;
   });
 
   var title = loadTimeData.getString('title');
   uber.invokeMethodOnParent('setTitle', {title: title});
 
   window.addEventListener('message', function(e) {
     if (e.data.method == 'frameSelected')
       searchField.focus();
   });
 }
@@ skipping 231 matching lines @@
     historyView.reload();
 }
 
 // Add handlers to HTML elements.
 document.addEventListener('DOMContentLoaded', load);
 
 // This event lets us enable and disable menu items before the menu is shown.
 document.addEventListener('canExecute', function(e) {
   e.canExecute = true;
 });