Cancel prerenders from Omnibox if we navigate to a different URL than predicted

chrome/browser/prerender/prerender_manager.h

 // 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.
 
 #ifndef CHROME_BROWSER_PRERENDER_PRERENDER_MANAGER_H_
 #define CHROME_BROWSER_PRERENDER_PRERENDER_MANAGER_H_
 #pragma once
 
 #include <list>
 #include <string>
@@ skipping 103 matching lines @@
       SessionStorageNamespace* session_storage_namespace);
 
   // Destroy all prerenders for the given child route id pair and assign a final
   // status to them.
   virtual void DestroyPrerenderForRenderView(int process_id, int view_id,
                                              FinalStatus final_status);
 
   // Cancels all active prerenders.
   void CancelAllPrerenders();
 
+  // Cancels all active prerenders with the ORIGIN_OMNIBOX origin.
+  void CancelOmniboxPrerenders();
+
   // For a given WebContents that wants to navigate to the URL supplied,
   // determines whether a prerendered version of the URL can be used,
   // and substitutes the prerendered RVH into the WebContents. |opener_url| is
   // set to the window.opener url that the WebContents should have set and
   // will be empty if there is no opener set. Returns whether or not a
   // prerendered RVH could be used or not.
   bool MaybeUsePrerenderedPage(content::WebContents* web_contents,
                                const GURL& url,
                                const GURL& opener_url);
 
@@ skipping 80 matching lines @@
 
   PrerenderTracker* prerender_tracker() { return prerender_tracker_; }
 
   // Adds a condition. This is owned by the PrerenderManager.
   void AddCondition(const PrerenderCondition* condition);
 
   bool IsTopSite(const GURL& url);
 
   bool IsPendingEntry(const GURL& url) const;
 
+  // Returns true if |url| matches any URLs being prerendered.
+  bool IsPrerendering(const GURL& url) const;
+
  protected:
   void SetPrerenderContentsFactory(
       PrerenderContents::Factory* prerender_contents_factory);
 
   // Utility method that is called from the virtual Shutdown method on this
   // class but is called directly from the TestPrerenderManager in the unit
   // tests.
   void DoShutdown();
 
  private:
   // Needs access to AddPrerender.
   friend class PrerenderContents;
 
   // Test that needs needs access to internal functions.
   friend class PrerenderBrowserTest;
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, AliasURLTest);
+  FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, CancelAllTest);
+  FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest,
+                           CancelOmniboxRemovesOmniboxTest);
+  FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest,
+                           CancelOmniboxDoesNotRemoveLinkTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, ClearTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, ControlGroup);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, DropOldestRequestTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, DropSecondRequestTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, ExpireTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, FoundTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, FragmentMatchesFragmentTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, FragmentMatchesPageTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, PageMatchesFragmentTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, PendingPrerenderTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, RateLimitInWindowTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, RateLimitOutsideWindowTest);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, SourceRenderViewClosed);
   FRIEND_TEST_ALL_PREFIXES(PrerenderManagerTest, TwoElementPrerenderTest);
 
   struct PrerenderContentsData;
   struct NavigationRecord;
 
   class OnCloseTabContentsDeleter;
 
   class MostVisitedSites;
 
+  typedef std::list<PrerenderContentsData> PrerenderContentsDataList;
+
   // Adds a prerender for |url| from referrer |referrer| initiated from the
   // RenderViewHost specified by |child_route_id_pair|. The |origin| specifies
   // how the prerender was added. If the |session_storage_namespace| is NULL,
   // it is discovered using the RenderViewHost specified by
   // |child_route_id_pair|.
   bool AddPrerender(
       Origin origin,
       const std::pair<int, int>& child_route_id_pair,
       const GURL& url,
       const content::Referrer& referrer,
       SessionStorageNamespace* session_storage_namespace);
 
-  // Adds a pending preload issued by the prerendering RenderView identified by
-  // |child_route_id_pair|.  If and when that prerendering RenderView is used,
-  // the specified prerender will start.
-  void AddPendingPrerender(Origin origin,
-                           const std::pair<int, int>& child_route_id_pair,
-                           const GURL& url,
-                           const content::Referrer& referrer);
-
   // Retrieves the PrerenderContents object for the specified URL, if it
   // has been prerendered.  The caller will then have ownership of the
   // PrerenderContents object and is responsible for freeing it.
   // Returns NULL if the specified URL has not been prerendered.
   PrerenderContents* GetEntry(const GURL& url);
 
   // Identical to GetEntry, with one exception:
   // The WebContents specified indicates the WC in which to swap the
   // prerendering into.  If the WebContents specified is the one
   // to doing the prerendered itself, will return NULL.
@@ skipping 29 matching lines @@
   // Checks if the PrerenderContents has been added to the pending delete list.
   bool IsPendingDelete(PrerenderContents* entry) const;
 
   // Deletes any PrerenderContents that have been added to the pending delete
   // list.
   void DeletePendingDeleteEntries();
 
   // Finds the specified PrerenderContents and returns it, if it exists.
   // Returns NULL otherwise.  Unlike GetEntry, the PrerenderManager maintains
   // ownership of the PrerenderContents.
-  PrerenderContents* FindEntry(const GURL& url);
+  PrerenderContents* FindEntry(const GURL& url) const;
 
   // Returns the iterator to the PrerenderContentsData entry that is being
   // prerendered from the given child route id pair.
-  std::list<PrerenderContentsData>::iterator
+  PrerenderContentsDataList::iterator
       FindPrerenderContentsForChildRouteIdPair(
           const std::pair<int, int>& child_route_id_pair);
 
-  // Returns whether the PrerenderManager is currently within the prerender
-  // window - effectively, up to 30 seconds after a prerender tag has been
-  // observed.
-  bool WithinWindow() const;
-
   bool DoesRateLimitAllowPrerender() const;
 
   // Deletes old TabContents that have been replaced by prerendered ones.  This
   // is needed because they're replaced in a callback from the old TabContents,
   // so cannot immediately be deleted.
   void DeleteOldTabContents();
 
   // Cleans up old NavigationRecord's.
   void CleanUpOldNavigations();
 
@@ skipping 38 matching lines @@
   // manager. The value can change dynamically during the lifetime
   // of the PrerenderManager.
   bool enabled_;
 
   // The profile that owns this PrerenderManager.
   Profile* profile_;
 
   PrerenderTracker* prerender_tracker_;
 
   // List of prerendered elements.
-  std::list<PrerenderContentsData> prerender_list_;
+  PrerenderContentsDataList prerender_list_;
 
   // List of recent navigations in this profile, sorted by ascending
   // navigate_time_.
   std::list<NavigationRecord> navigations_;
 
   // List of prerender elements to be deleted
   std::list<PrerenderContents*> pending_delete_list_;
 
   // Set of TabContents which are currently displaying a prerendered page.
   base::hash_set<content::WebContents*> prerendered_tab_contents_set_;
@@ skipping 34 matching lines @@
 
   DISALLOW_COPY_AND_ASSIGN(PrerenderManager);
 };
 
 PrerenderManager* FindPrerenderManagerUsingRenderProcessId(
     int render_process_id);
 
 }  // namespace prerender
 
 #endif  // CHROME_BROWSER_PRERENDER_PRERENDER_MANAGER_H_