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

chrome/browser/history/top_sites.h

 // Copyright (c) 2010 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 <list>
 #include <set>
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
 #include "base/lock.h"
+#include "base/ref_counted.h"
+#include "base/ref_counted_memory.h"
+#include "base/scoped_ptr.h"
 #include "base/time.h"
 #include "base/timer.h"
-#include "base/ref_counted.h"
-#include "base/ref_counted_memory.h"
 #include "chrome/browser/browser_thread.h"
 #include "chrome/browser/cancelable_request.h"
 #include "chrome/browser/history/history_types.h"
 #include "chrome/browser/history/history.h"
 #include "chrome/browser/history/page_usage_data.h"
 #include "chrome/common/notification_service.h"
 #include "chrome/common/thumbnail_score.h"
 #include "googleurl/src/gurl.h"
 
 class DictionaryValue;
@@ skipping 104 matching lines @@
   // The URLs that are in "new" but not "old" will be have their index into
   // "new" put in |added_urls|. The URLs that are in "old" but not "new" will
   // have their index into "old" put into |deleted_urls|.
   //
   // URLs appearing in both old and new lists but having different indices will
   // have their index into "new" be put into |moved_urls|.
   static void DiffMostVisited(const MostVisitedURLList& old_list,
                               const MostVisitedURLList& new_list,
                               TopSitesDelta* delta);
 
+  // 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(Callback0::Type* callback);
+
  private:
   friend class base::RefCountedThreadSafe<TopSites>;
   friend class TopSitesTest;
 
   typedef std::pair<GURL, Images> TempImage;
   typedef std::list<TempImage> TempImages;
 
   // Enumeration of the possible states history can be in.
   enum HistoryLoadState {
     // We're waiting for history to finish loading.
@@ skipping 42 matching lines @@
 
   // Removes the cached thumbnail for url. Does nothing if |url| if not cached
   // in |temp_images_|.
   void RemoveTemporaryThumbnailByURL(const GURL& url);
 
   // Add a thumbnail for an unknown url. See temp_thumbnails_map_.
   void AddTemporaryThumbnail(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();
 
   // 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);
 
   // Returns the set of prepopulate pages.
   static MostVisitedURLList GetPrepopulatePages();
 
@@ skipping 66 matching lines @@
   scoped_refptr<TopSitesBackend> backend_;
 
   // The top sites data.
   scoped_ptr<TopSitesCache> cache_;
 
   // Copy of the top sites data that may be accessed on any thread (assuming
   // you hold |lock_|). The data in |thread_safe_cache_| has blacklisted and
   // pinned urls applied (|cache_| does not).
   scoped_ptr<TopSitesCache> thread_safe_cache_;
 
+  // Invokes the callback signaling the cache has been completely refreshed.
+  // This is only used for testing.
+  void InvokeRefreshCallback(CancelableRequestProvider::Handle handle);
+
   Profile* profile_;
 
   // Lock used to access |thread_safe_cache_|.
   mutable Lock lock_;
 
   CancelableRequestConsumer cancelable_consumer_;
 
   // Timer that asks history for the top sites. This is used to make sure our
   // data stays in sync with history.
   base::OneShotTimer<TopSites> timer_;
@@ skipping 33 matching lines @@
 
   // See description above HistoryLoadState.
   HistoryLoadState history_state_;
 
   // See description above TopSitesLoadState.
   TopSitesLoadState top_sites_state_;
 
   // Are we loaded?
   bool loaded_;
 
+  // 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_;
+
+  // For testing use only. The callback to invoke after a refresh has occurred.
+  // Should be accessed on the UI thread.
+  scoped_ptr<Callback0::Type> refresh_callback_;
+
   DISALLOW_COPY_AND_ASSIGN(TopSites);
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_TOP_SITES_H_