Add pyauto hook for getting and manipulating the data underneath the NTP....

chrome/browser/history/top_sites.h

 // Copyright (c) 2009 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_H_
 #define CHROME_BROWSER_HISTORY_TOP_SITES_H_
 #pragma once
 
 #include <map>
 #include <set>
@@ skipping 30 matching lines @@
 // Stores the data for the top "most visited" sites. This includes a cache of
 // the most visited data from history, as well as the corresponding thumbnails
 // of those sites.
 //
 // This class IS threadsafe. It is designed to be used from the UI thread of
 // the browser (where history requests must be kicked off and received from)
 // and from the I/O thread (where new tab page requests come in). Handling the
 // new tab page requests on the I/O thread without proxying to the UI thread is
 // a nontrivial performance win, especially when the browser is starting and
 // the UI thread is busy.
-class TopSites :
-      public base::RefCountedThreadSafe<TopSites,
+class TopSites
+    : public base::RefCountedThreadSafe<TopSites,
                                         ChromeThread::DeleteOnUIThread>,
       public NotificationObserver,
       public CancelableRequestProvider {
  public:
   explicit TopSites(Profile* profile);
 
   // Returns whether top sites is enabled.
   static bool IsEnabled();
 
   class MockHistoryService {
@@ skipping 67 matching lines @@
 
   // Return a URL pinned at |index| via |out|. Returns true if there
   // is a URL pinned at |index|.
   bool GetPinnedURLAtIndex(size_t index, GURL* out);
 
   // TopSites must be deleted on a UI thread. This happens
   // automatically in a real browser, but in unit_tests we don't have
   // a real UI thread. Use this function to delete a TopSites object.
   static void DeleteTopSites(scoped_refptr<TopSites>& ptr);
 
+  // For use only in testing. Refreshes the top sites list and invokes the
+  // callback on the UI thread when done. Should be called on the UI thread.
+  void RefreshAndCallback(CancelableRequestConsumer* consumer,
+                          Callback0::Type* callback);
+
   // Sets the profile pointer to NULL. This is for the case where
   // TopSites outlives the profile, since TopSites is refcounted.
   void ClearProfile();
 
  private:
   friend struct ChromeThread::DeleteOnThread<ChromeThread::UI>;
   friend class DeleteTask<TopSites>;
   friend class TopSitesTest;
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, GetMostVisited);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, RealDatabase);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, MockDatabase);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, DeleteNotifications);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, PinnedURLsDeleted);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, GetUpdateDelay);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, Migration);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, QueueingRequestsForTopSites);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, CancelingRequestsForTopSites);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, AddTemporaryThumbnail);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, Blacklisting);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, PinnedURLs);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, BlacklistingAndPinnedURLs);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, AddPrepopulatedPages);
   FRIEND_TEST_ALL_PREFIXES(TopSitesTest, GetPageThumbnail);
+  FRIEND_TEST_ALL_PREFIXES(TopSitesTest, RefreshCallback);
 
   ~TopSites();
 
   // Sets the thumbnail without writing to the database. Useful when
   // reading last known top sites from the DB.
   // Returns true if the thumbnail was set, false if the existing one is better.
   bool SetPageThumbnailNoDB(const GURL& url,
                             const RefCountedBytes* thumbnail_data,
                             const ThumbnailScore& score);
 
   // A version of SetPageThumbnail that takes RefCountedBytes as
   // returned by HistoryService.
   bool SetPageThumbnailEncoded(const GURL& url,
                                const RefCountedBytes* thumbnail,
                                const ThumbnailScore& score);
 
-  // Query history service for the list of available thumbnails.
-  void StartQueryForMostVisited();
+  // Query history service for the list of available thumbnails. Returns the
+  // handle for the request, or NULL if a request could not be made.
+  CancelableRequestProvider::Handle StartQueryForMostVisited();
+
+  // Called by our timer. Starts the query for the most visited sites.
+  void TimerFired();
 
   // Query history service for the thumbnail for a given url. |index|
   // is the index into top_sites_.
   void StartQueryForThumbnail(size_t index);
 
   // Called when history service returns a list of top URLs.
   void OnTopSitesAvailable(CancelableRequestProvider::Handle handle,
                            MostVisitedURLList data);
 
   // Returns a list of urls to each pending callback.
@@ skipping 97 matching lines @@
   // blacklisted URLs and reordering pinned URLs.
   void ApplyBlacklistAndPinnedURLs(const MostVisitedURLList& urls,
                                    MostVisitedURLList* out);
 
   // Converts a url into a canonical string representation.
   std::string GetURLString(const GURL& url);
 
   // Returns an MD5 hash of the URL. Hashing is required for blacklisted URLs.
   std::string GetURLHash(const GURL& url);
 
+  // Invokes the callback signaling the cache has been completely refreshed.
+  // This is only used for testing.
+  void InvokeRefreshCallback();
+  void InvokeRefreshCallbackOnUIThread();
+
   Profile* profile_;
   // A mockup to use for testing. If NULL, use the real HistoryService
   // from the profile_. See SetMockHistoryService.
   MockHistoryService* mock_history_service_;
   CancelableRequestConsumerTSimple<size_t> cancelable_consumer_;
   mutable Lock lock_;
 
   // The cached version of the top sites. The 0th item in this vector is the
   // #1 site.
   MostVisitedURLList top_sites_;
@@ skipping 47 matching lines @@
   // key is the URL, value is a dummy value. This is owned by the
   // PrefService.
   DictionaryValue* blacklist_;
 
   // This is a dictionary for the pinned URLs for the the most visited
   // part of the new tab page. Key is the URL, value is
   // index where it is pinned at (may be the same as key). This is
   // owned by the PrefService.
   DictionaryValue* pinned_urls_;
 
+  // For testing use only. The callback to invoke after a refresh has occurred.
+  // Should be accessed on the UI thread.
+  scoped_refptr<CancelableRequest<Callback0::Type> > refresh_callback_;
+
+  // For testing use only. The history request handle that is being waited upon.
+  // Should be accessed on the UI thread.
+  CancelableRequestProvider::Handle handle_to_wait_for_;
+
   DISALLOW_COPY_AND_ASSIGN(TopSites);
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_TOP_SITES_H_