Split BrowsingHistoryHandler out of history_ui.cc

chrome/browser/ui/webui/browsing_history_handler.cc

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Copyright 2015 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 "chrome/browser/ui/webui/history_ui.h"
+#include "chrome/browser/ui/webui/browsing_history_handler.h"
 
 #include <set>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
-#include "base/command_line.h"
 #include "base/i18n/rtl.h"
 #include "base/i18n/time_formatting.h"
-#include "base/memory/singleton.h"
-#include "base/message_loop/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "base/values.h"
 #include "chrome/browser/banners/app_banner_settings_helper.h"
 #include "chrome/browser/bookmarks/bookmark_model_factory.h"
-#include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/engagement/site_engagement_service.h"
 #include "chrome/browser/history/history_service_factory.h"
 #include "chrome/browser/history/history_utils.h"
 #include "chrome/browser/history/web_history_service_factory.h"
-#include "chrome/browser/prefs/incognito_mode_prefs.h"
 #include "chrome/browser/profiles/profile.h"
-#include "chrome/browser/signin/signin_manager_factory.h"
 #include "chrome/browser/sync/profile_sync_service_factory.h"
 #include "chrome/browser/ui/browser_finder.h"
 #include "chrome/browser/ui/chrome_pages.h"
 #include "chrome/browser/ui/webui/favicon_source.h"
-#include "chrome/browser/ui/webui/metrics_handler.h"
-#include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
-#include "chrome/common/url_constants.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/bookmarks/browser/bookmark_model.h"
 #include "components/bookmarks/browser/bookmark_utils.h"
 #include "components/browser_sync/browser/profile_sync_service.h"
 #include "components/history/core/browser/history_service.h"
 #include "components/history/core/browser/history_types.h"
 #include "components/history/core/browser/web_history_service.h"
-#include "components/search/search.h"
-#include "components/signin/core/browser/signin_manager.h"
+#include "components/keyed_service/core/service_access_type.h"
+#include "components/query_parser/snippet.h"
 #include "components/sync_driver/device_info.h"
+#include "components/sync_driver/device_info_tracker.h"
 #include "components/url_formatter/url_formatter.h"
 #include "content/public/browser/url_data_source.h"
 #include "content/public/browser/web_ui.h"
-#include "content/public/browser/web_ui_data_source.h"
-#include "grit/browser_resources.h"
-#include "grit/theme_resources.h"
-#include "net/base/escape.h"
 #include "sync/protocol/history_delete_directive_specifics.pb.h"
+#include "sync/protocol/sync_enums.pb.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/l10n/time_format.h"
-#include "ui/base/resource/resource_bundle.h"
-#include "ui/base/webui/web_ui_util.h"
 
 #if defined(ENABLE_EXTENSIONS)
 #include "chrome/browser/extensions/activity_log/activity_log.h"
 #endif
 
 #if defined(ENABLE_SUPERVISED_USERS)
 #include "chrome/browser/supervised_user/supervised_user_navigation_observer.h"
 #include "chrome/browser/supervised_user/supervised_user_service.h"
 #include "chrome/browser/supervised_user/supervised_user_service_factory.h"
 #include "chrome/browser/supervised_user/supervised_user_url_filter.h"
 #endif
 
 #if defined(OS_ANDROID)
 #include "chrome/browser/android/chrome_application.h"
 #endif
 
-#if !defined(OS_ANDROID) && !defined(OS_IOS)
-#include "chrome/browser/ui/webui/foreign_session_handler.h"
-#include "chrome/browser/ui/webui/history_login_handler.h"
-#endif
-
-using bookmarks::BookmarkModel;
-
-static const char kStringsJsFile[] = "strings.js";
-static const char kHistoryJsFile[] = "history.js";
-static const char kOtherDevicesJsFile[] = "other_devices.js";
-
 // The amount of time to wait for a response from the WebHistoryService.
 static const int kWebHistoryTimeoutSeconds = 3;
 
+using bookmarks::BookmarkModel;
+
 namespace {
 
 // Buckets for UMA histograms.
 enum WebHistoryQueryBuckets {
   WEB_HISTORY_QUERY_FAILED = 0,
   WEB_HISTORY_QUERY_SUCCEEDED,
   WEB_HISTORY_QUERY_TIMED_OUT,
   NUM_WEB_HISTORY_QUERY_BUCKETS
 };
 
-#if defined(OS_MACOSX)
-const char kIncognitoModeShortcut[] = "("
-    "\xE2\x87\xA7"  // Shift symbol (U+21E7 'UPWARDS WHITE ARROW').
-    "\xE2\x8C\x98"  // Command symbol (U+2318 'PLACE OF INTEREST SIGN').
-    "N)";
-#elif defined(OS_WIN)
-const char kIncognitoModeShortcut[] = "(Ctrl+Shift+N)";
-#else
-const char kIncognitoModeShortcut[] = "(Shift+Ctrl+N)";
-#endif
-
 // Identifiers for the type of device from which a history entry originated.
 static const char kDeviceTypeLaptop[] = "laptop";
 static const char kDeviceTypePhone[] = "phone";
 static const char kDeviceTypeTablet[] = "tablet";
 
-content::WebUIDataSource* CreateHistoryUIHTMLSource(Profile* profile) {
-  PrefService* prefs = profile->GetPrefs();
-
-  // Check if the profile is authenticated.  Guest profiles or incognito
-  // windows may not have a sign in manager, and are considered not
-  // authenticated.
-  SigninManagerBase* signin_manager =
-      SigninManagerFactory::GetForProfile(profile);
-  bool is_authenticated = signin_manager != nullptr &&
-      signin_manager->IsAuthenticated();
-
-  content::WebUIDataSource* source =
-      content::WebUIDataSource::Create(chrome::kChromeUIHistoryFrameHost);
-  source->AddBoolean("isUserSignedIn", is_authenticated);
-  source->AddLocalizedString("collapseSessionMenuItemText",
-      IDS_HISTORY_OTHER_SESSIONS_COLLAPSE_SESSION);
-  source->AddLocalizedString("expandSessionMenuItemText",
-      IDS_HISTORY_OTHER_SESSIONS_EXPAND_SESSION);
-  source->AddLocalizedString("restoreSessionMenuItemText",
-      IDS_HISTORY_OTHER_SESSIONS_OPEN_ALL);
-  source->AddLocalizedString("xMore", IDS_HISTORY_OTHER_DEVICES_X_MORE);
-  source->AddLocalizedString("loading", IDS_HISTORY_LOADING);
-  source->AddLocalizedString("title", IDS_HISTORY_TITLE);
-  source->AddLocalizedString("newest", IDS_HISTORY_NEWEST);
-  source->AddLocalizedString("newer", IDS_HISTORY_NEWER);
-  source->AddLocalizedString("older", IDS_HISTORY_OLDER);
-  source->AddLocalizedString("searchResultsFor", IDS_HISTORY_SEARCHRESULTSFOR);
-  source->AddLocalizedString("searchResult", IDS_HISTORY_SEARCH_RESULT);
-  source->AddLocalizedString("searchResults", IDS_HISTORY_SEARCH_RESULTS);
-  source->AddLocalizedString("foundSearchResults",
-                             IDS_HISTORY_FOUND_SEARCH_RESULTS);
-  source->AddLocalizedString("history", IDS_HISTORY_BROWSERESULTS);
-  source->AddLocalizedString("cont", IDS_HISTORY_CONTINUED);
-  source->AddLocalizedString("searchButton", IDS_HISTORY_SEARCH_BUTTON);
-  source->AddLocalizedString("noSearchResults", IDS_HISTORY_NO_SEARCH_RESULTS);
-  source->AddLocalizedString("noResults", IDS_HISTORY_NO_RESULTS);
-  source->AddLocalizedString("historyInterval", IDS_HISTORY_INTERVAL);
-  source->AddLocalizedString("removeSelected",
-                             IDS_HISTORY_REMOVE_SELECTED_ITEMS);
-  source->AddLocalizedString("clearAllHistory",
-                             IDS_HISTORY_OPEN_CLEAR_BROWSING_DATA_DIALOG);
-
-  auto availability = IncognitoModePrefs::GetAvailability(profile->GetPrefs());
-  base::string16 delete_warning = availability == IncognitoModePrefs::ENABLED ?
-      l10n_util::GetStringFUTF16(IDS_HISTORY_DELETE_PRIOR_VISITS_WARNING,
-                                 base::UTF8ToUTF16(kIncognitoModeShortcut)) :
-      l10n_util::GetStringUTF16(
-          IDS_HISTORY_DELETE_PRIOR_VISITS_WARNING_NO_INCOGNITO);
-  source->AddString("deleteWarning", delete_warning);
-
-  source->AddLocalizedString("removeBookmark", IDS_HISTORY_REMOVE_BOOKMARK);
-  source->AddLocalizedString("actionMenuDescription",
-                             IDS_HISTORY_ACTION_MENU_DESCRIPTION);
-  source->AddLocalizedString("removeFromHistory", IDS_HISTORY_REMOVE_PAGE);
-  source->AddLocalizedString("moreFromSite", IDS_HISTORY_MORE_FROM_SITE);
-  source->AddLocalizedString("groupByDomainLabel", IDS_GROUP_BY_DOMAIN_LABEL);
-  source->AddLocalizedString("rangeLabel", IDS_HISTORY_RANGE_LABEL);
-  source->AddLocalizedString("rangeAllTime", IDS_HISTORY_RANGE_ALL_TIME);
-  source->AddLocalizedString("rangeWeek", IDS_HISTORY_RANGE_WEEK);
-  source->AddLocalizedString("rangeMonth", IDS_HISTORY_RANGE_MONTH);
-  source->AddLocalizedString("rangeToday", IDS_HISTORY_RANGE_TODAY);
-  source->AddLocalizedString("rangeNext", IDS_HISTORY_RANGE_NEXT);
-  source->AddLocalizedString("rangePrevious", IDS_HISTORY_RANGE_PREVIOUS);
-  source->AddLocalizedString("numberVisits", IDS_HISTORY_NUMBER_VISITS);
-  source->AddLocalizedString("filterAllowed", IDS_HISTORY_FILTER_ALLOWED);
-  source->AddLocalizedString("filterBlocked", IDS_HISTORY_FILTER_BLOCKED);
-  source->AddLocalizedString("inContentPack", IDS_HISTORY_IN_CONTENT_PACK);
-  source->AddLocalizedString("allowItems", IDS_HISTORY_FILTER_ALLOW_ITEMS);
-  source->AddLocalizedString("blockItems", IDS_HISTORY_FILTER_BLOCK_ITEMS);
-  source->AddLocalizedString("blockedVisitText",
-                             IDS_HISTORY_BLOCKED_VISIT_TEXT);
-  source->AddLocalizedString("hasSyncedResults",
-                             IDS_HISTORY_HAS_SYNCED_RESULTS);
-  source->AddLocalizedString("noSyncedResults", IDS_HISTORY_NO_SYNCED_RESULTS);
-  source->AddLocalizedString("cancel", IDS_CANCEL);
-  source->AddLocalizedString("deleteConfirm",
-                             IDS_HISTORY_DELETE_PRIOR_VISITS_CONFIRM_BUTTON);
-  source->AddLocalizedString("bookmarked", IDS_HISTORY_ENTRY_BOOKMARKED);
-  source->AddLocalizedString("entrySummary", IDS_HISTORY_ENTRY_SUMMARY);
-  source->AddBoolean("isFullHistorySyncEnabled",
-                     WebHistoryServiceFactory::GetForProfile(profile) != NULL);
-  bool group_by_domain = base::CommandLine::ForCurrentProcess()->HasSwitch(
-      switches::kHistoryEnableGroupByDomain);
-  // Supervised users get the "group by domain" version, but not on mobile,
-  // because that version isn't adjusted for small screens yet. crbug.com/452859
-#if !defined(OS_ANDROID) && !defined(OS_IOS)
-  group_by_domain = group_by_domain || profile->IsSupervised();
-#endif
-  source->AddBoolean("groupByDomain", group_by_domain);
-  bool allow_deleting_history =
-      prefs->GetBoolean(prefs::kAllowDeletingBrowserHistory);
-  source->AddBoolean("allowDeletingHistory", allow_deleting_history);
-  source->AddBoolean("isInstantExtendedApiEnabled",
-                     search::IsInstantExtendedAPIEnabled());
-  source->AddBoolean("isSupervisedProfile", profile->IsSupervised());
-  source->AddBoolean("hideDeleteVisitUI",
-                     profile->IsSupervised() && !allow_deleting_history);
-
-  source->SetJsonPath(kStringsJsFile);
-  source->AddResourcePath(kHistoryJsFile, IDR_HISTORY_JS);
-  source->AddResourcePath(kOtherDevicesJsFile, IDR_OTHER_DEVICES_JS);
-  source->SetDefaultResource(IDR_HISTORY_HTML);
-  source->DisableDenyXFrameOptions();
-
-  return source;
-}
-
 // Returns a localized version of |visit_time| including a relative
 // indicator (e.g. today, yesterday).
-base::string16 getRelativeDateLocalized(const base::Time& visit_time) {
+base::string16 GetRelativeDateLocalized(const base::Time& visit_time) {
   base::Time midnight = base::Time::Now().LocalMidnight();
   base::string16 date_str = ui::TimeFormat::RelativeDate(visit_time, &midnight);
   if (date_str.empty()) {
     date_str = base::TimeFormatFriendlyDate(visit_time);
   } else {
     date_str = l10n_util::GetStringFUTF16(
         IDS_HISTORY_DATE_WITH_RELATIVE_TIME,
         date_str,
         base::TimeFormatFriendlyDate(visit_time));
   }
   return date_str;
 }
 
-
 // Sets the correct year when substracting months from a date.
-void normalizeMonths(base::Time::Exploded* exploded) {
+void NormalizeMonths(base::Time::Exploded* exploded) {
   // Decrease a year at a time until we have a proper date.
   while (exploded->month < 1) {
     exploded->month += 12;
     exploded->year--;
   }
 }
 
 // Returns true if |entry| represents a local visit that had no corresponding
 // visit on the server.
 bool IsLocalOnlyResult(const BrowsingHistoryHandler::HistoryEntry& entry) {
@@ skipping 28 matching lines @@
     }
     return;
   }
 
   *name = l10n_util::GetStringUTF8(IDS_HISTORY_UNKNOWN_DEVICE);
   *type = kDeviceTypeLaptop;
 }
 
 }  // namespace
 
-////////////////////////////////////////////////////////////////////////////////
-//
-// BrowsingHistoryHandler
-//
-////////////////////////////////////////////////////////////////////////////////
-
 BrowsingHistoryHandler::HistoryEntry::HistoryEntry(
     BrowsingHistoryHandler::HistoryEntry::EntryType entry_type,
     const GURL& url, const base::string16& title, base::Time time,
     const std::string& client_id, bool is_search_result,
     const base::string16& snippet, bool blocked_visit,
     const std::string& accept_languages) {
   this->entry_type = entry_type;
   this->url = url;
   this->title = title;
   this->time = time;
@@ skipping 521 matching lines @@
   // The items which are to be written into results_info_value_ are also
   // described in chrome/browser/resources/history/history.js in @typedef for
   // HistoryQuery. Please update it whenever you add or remove any keys in
   // results_info_value_.
   results_info_value_.SetString("term", search_text);
   results_info_value_.SetBoolean("finished", results->reached_beginning());
 
   // Add the specific dates that were searched to display them.
   // TODO(sergiu): Put today if the start is in the future.
   results_info_value_.SetString("queryStartTime",
-                                getRelativeDateLocalized(options.begin_time));
+                                GetRelativeDateLocalized(options.begin_time));
   if (!options.end_time.is_null()) {
     results_info_value_.SetString("queryEndTime",
-        getRelativeDateLocalized(options.end_time -
+        GetRelativeDateLocalized(options.end_time -
                                  base::TimeDelta::FromDays(1)));
   } else {
     results_info_value_.SetString("queryEndTime",
-        getRelativeDateLocalized(base::Time::Now()));
+        GetRelativeDateLocalized(base::Time::Now()));
   }
   if (!web_history_timer_.IsRunning())
     ReturnResultsToFrontEnd();
 }
 
 void BrowsingHistoryHandler::WebHistoryQueryComplete(
     const base::string16& search_text,
     const history::QueryOptions& options,
     base::TimeTicks start_time,
     history::WebHistoryService::Request* request,
@@ skipping 128 matching lines @@
     // show results from the future, should the user's clock have
     // been set incorrectly).
     options->end_time = base::Time();
   } else {
     // Go back |offset| months in the past. The end time is not inclusive, so
     // use the first day of the |offset| - 1 and |offset| months (e.g. for
     // the last month, |offset| = 1, use the first days of the last month and
     // the current month.
     exploded.month -= offset - 1;
     // Set the correct year.
-    normalizeMonths(&exploded);
+    NormalizeMonths(&exploded);
     options->end_time = base::Time::FromLocalExploded(exploded);
 
     exploded.month -= 1;
     // Set the correct year
-    normalizeMonths(&exploded);
+    NormalizeMonths(&exploded);
     options->begin_time = base::Time::FromLocalExploded(exploded);
   }
 }
 
 // Helper function for Observe that determines if there are any differences
 // between the URLs noticed for deletion and the ones we are expecting.
 static bool DeletionsDiffer(const history::URLRows& deleted_rows,
                             const std::set<GURL>& urls_to_be_deleted) {
   if (deleted_rows.size() != urls_to_be_deleted.size())
     return true;
@@ skipping 11 matching lines @@
 
 void BrowsingHistoryHandler::OnURLsDeleted(
     history::HistoryService* history_service,
     bool all_history,
     bool expired,
     const history::URLRows& deleted_rows,
     const std::set<GURL>& favicon_urls) {
   if (all_history || DeletionsDiffer(deleted_rows, urls_to_be_deleted_))
     web_ui()->CallJavascriptFunction("historyDeleted");
 }
-
-////////////////////////////////////////////////////////////////////////////////
-//
-// HistoryUI
-//
-////////////////////////////////////////////////////////////////////////////////
-
-HistoryUI::HistoryUI(content::WebUI* web_ui) : WebUIController(web_ui) {
-  web_ui->AddMessageHandler(new BrowsingHistoryHandler());
-  web_ui->AddMessageHandler(new MetricsHandler());
-
-  // On mobile we deal with foreign sessions differently.
-#if !defined(OS_ANDROID) && !defined(OS_IOS)
-  if (search::IsInstantExtendedAPIEnabled()) {
-    web_ui->AddMessageHandler(new browser_sync::ForeignSessionHandler());
-    web_ui->AddMessageHandler(new HistoryLoginHandler());
-  }
-#endif
-
-  // Set up the chrome://history-frame/ source.
-  Profile* profile = Profile::FromWebUI(web_ui);
-  content::WebUIDataSource::Add(profile, CreateHistoryUIHTMLSource(profile));
-}
-
-HistoryUI::~HistoryUI() {}
-
-// static
-base::RefCountedMemory* HistoryUI::GetFaviconResourceBytes(
-      ui::ScaleFactor scale_factor) {
-  return ResourceBundle::GetSharedInstance().
-      LoadDataResourceBytesForScale(IDR_HISTORY_FAVICON, scale_factor);
-}