Topsites become keyedService based.

chrome/browser/history/top_sites_service.h

-// Copyright (c) 2013 The Chromium Authors. All rights reserved.

[sdefresne, 2014/12/19 15:11:41]

Do not change copyright notice when moving files.

+// Copyright 2014 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.
 
-#ifndef CHROME_BROWSER_HISTORY_TOP_SITES_IMPL_H_
-#define CHROME_BROWSER_HISTORY_TOP_SITES_IMPL_H_
+#ifndef CHROME_BROWSER_HISTORY_TOP_SITES_SERVICE_H_
+#define CHROME_BROWSER_HISTORY_TOP_SITES_SERVICE_H_
 
 #include <list>
 #include <set>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/ref_counted.h"
 #include "base/synchronization/lock.h"
 #include "base/task/cancelable_task_tracker.h"
 #include "base/time/time.h"
 #include "base/timer/timer.h"
 #include "chrome/browser/history/history_service.h"
-#include "chrome/browser/history/top_sites.h"
 #include "chrome/browser/history/top_sites_backend.h"
+#include "chrome/browser/history/top_sites_provider.h"
 #include "components/history/core/browser/history_types.h"
 #include "components/history/core/browser/page_usage_data.h"
 #include "components/history/core/common/thumbnail_score.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/gfx/image/image.h"
 #include "url/gurl.h"
 
 class Profile;
 
 namespace base {
 class FilePath;
 class RefCountedBytes;
 class RefCountedMemory;
 }
 
 namespace history {
 
 class TopSitesCache;
 class TopSitesImplTest;
 
 // This class allows requests for most visited urls and thumbnails on any
 // thread. All other methods must be invoked on the UI thread. All mutations
 // to internal state happen on the UI thread and are scheduled to update the
 // db using TopSitesBackend.
-class TopSitesImpl : public TopSites {
+class TopSitesService : public KeyedService, public TopSitesProvider {

[sdefresne, 2014/12/19 15:11:41]

TopSitesImpl should not be the KeyedService, it should be TopSites.

[Jitu( very slow this week), 2014/12/26 14:04:27]

Done.

  public:
-  explicit TopSitesImpl(Profile* profile);
+  explicit TopSitesService(Profile* profile);
 
   // Initializes TopSitesImpl.
   void Init(const base::FilePath& db_name);
 
   bool SetPageThumbnail(const GURL& url,
                         const gfx::Image& thumbnail,
                         const ThumbnailScore& score) override;
   bool SetPageThumbnailToJPEGBytes(const GURL& url,
                                    const base::RefCountedMemory* memory,
                                    const ThumbnailScore& score) override;
@@ skipping 15 matching lines @@
   base::CancelableTaskTracker::TaskId StartQueryForMostVisited() override;
   bool IsKnownURL(const GURL& url) override;
   const std::string& GetCanonicalURLString(const GURL& url) const override;
   bool IsNonForcedFull() override;
   bool IsForcedFull() override;
   MostVisitedURLList GetPrepopulatePages() override;
   bool loaded() const override;
   bool AddForcedURL(const GURL& url, const base::Time& time) override;
 
  protected:
-  ~TopSitesImpl() override;
+  ~TopSitesService() override;
 
  private:
   friend class TopSitesImplTest;
   FRIEND_TEST_ALL_PREFIXES(TopSitesImplTest, DiffMostVisited);
   FRIEND_TEST_ALL_PREFIXES(TopSitesImplTest, DiffMostVisitedWithForced);
 
   typedef base::Callback<void(const MostVisitedURLList&,
                               const MostVisitedURLList&)> PendingCallback;
 
   typedef std::pair<GURL, Images> TempImage;
@@ skipping 45 matching lines @@
   void TimerFired();
 
   // Finds the given URL in the redirect chain for the given TopSite, and
   // returns the distance from the destination in hops that the given URL is.
   // The URL is assumed to be in the list. The destination is 0.
   static int GetRedirectDistanceForURL(const MostVisitedURL& most_visited,
                                        const GURL& url);
 
   // Add prepopulated pages: 'welcome to Chrome' and themes gallery to |urls|.
   // Returns true if any pages were added.
-  bool AddPrepopulatedPages(MostVisitedURLList* urls,
-                            size_t num_forced_urls);
+  bool AddPrepopulatedPages(MostVisitedURLList* urls, size_t num_forced_urls);
 
   // Add all the forced URLs from |cache_| into |new_list|, making sure not to
   // add any URL that's already in |new_list|'s non-forced URLs. The forced URLs
   // in |cache_| and |new_list| are assumed to appear at the front of the list
   // and be sorted in increasing |last_forced_time|. This will still be true
   // after the call. If the list of forced URLs overflows the older ones are
   // dropped. Returns the number of forced URLs after the merge.
   size_t MergeCachedForcedURLs(MostVisitedURLList* new_list);
 
   // Takes |urls|, produces it's copy in |out| after removing blacklisted URLs.
@@ skipping 58 matching lines @@
   Profile* profile_;
 
   // Lock used to access |thread_safe_cache_|.
   mutable base::Lock lock_;
 
   // Task tracker for history and backend requests.
   base::CancelableTaskTracker cancelable_task_tracker_;
 
   // Timer that asks history for the top sites. This is used to make sure our
   // data stays in sync with history.
-  base::OneShotTimer<TopSitesImpl> timer_;
+  base::OneShotTimer<TopSitesService> timer_;
 
   // The time we started |timer_| at. Only valid if |timer_| is running.
   base::TimeTicks timer_start_time_;
 
   content::NotificationRegistrar registrar_;
 
   // The number of URLs changed on the last update.
   size_t last_num_urls_changed_;
 
   // The pending requests for the top sites list. Can only be non-empty at
   // startup. After we read the top sites from the DB, we'll always have a
   // cached list and be able to run callbacks immediately.
   PendingCallbacks pending_callbacks_;
 
   // Stores thumbnails for unknown pages. When SetPageThumbnail is
   // called, if we don't know about that URL yet and we don't have
   // enough Top Sites (new profile), we store it until the next
   // SetNonForcedTopSites call.
   TempImages temp_images_;
 
   // URL List of prepopulated page.
   std::vector<GURL> prepopulated_page_urls_;
 
   // Are we loaded?
   bool loaded_;
 
-  DISALLOW_COPY_AND_ASSIGN(TopSitesImpl);
+  DISALLOW_COPY_AND_ASSIGN(TopSitesService);
 };
 
 }  // namespace history
 
-#endif  // CHROME_BROWSER_HISTORY_TOP_SITES_IMPL_H_
+#endif  // CHROME_BROWSER_HISTORY_TOP_SITES_SERVICE_H_