Added prerendering to omnibox.

chrome/browser/prerender/prerender_manager.cc

 // Copyright (c) 2011 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/prerender/prerender_manager.h"
 
 #include <string>
 
+#include "base/command_line.h"
 #include "base/logging.h"
 #include "base/metrics/field_trial.h"
 #include "base/metrics/histogram.h"
 #include "base/time.h"
 #include "base/values.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/favicon/favicon_tab_helper.h"
 #include "chrome/browser/prerender/prerender_contents.h"
 #include "chrome/browser/prerender/prerender_final_status.h"
 #include "chrome/browser/prerender/prerender_history.h"
 #include "chrome/browser/prerender/prerender_observer.h"
 #include "chrome/browser/prerender/prerender_tracker.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper_delegate.h"
+#include "chrome/common/chrome_switches.h"
 #include "chrome/common/render_messages.h"
 #include "content/browser/browser_thread.h"
 #include "content/browser/renderer_host/render_process_host.h"
 #include "content/browser/renderer_host/render_view_host.h"
 #include "content/browser/renderer_host/resource_dispatcher_host.h"
 #include "content/browser/tab_contents/render_view_host_manager.h"
 #include "content/browser/tab_contents/tab_contents.h"
 #include "content/browser/tab_contents/tab_contents_delegate.h"
 #include "content/common/notification_service.h"
 #include "googleurl/src/url_canon.h"
@@ skipping 163 matching lines @@
   GURL url_;
   base::TimeTicks time_;
   NavigationRecord(const GURL& url, base::TimeTicks time)
       : url_(url),
         time_(time) {
   }
 };
 
 struct PrerenderManager::PendingContentsData {
   PendingContentsData(const GURL& url,
-                      const GURL& referrer)
-      : url_(url), referrer_(referrer) { }
+                      const GURL& referrer,
+                      Origin origin)
+      : url_(url), referrer_(referrer), origin_(origin) { }
   ~PendingContentsData() {}
   GURL url_;
   GURL referrer_;
+  Origin origin_;
 };
 
 void HandleTag(
     const base::WeakPtr<PrerenderManager>& prerender_manager_weak_ptr,
     int render_process_id,
     int render_view_id,
     const GURL& url,
     const GURL& referrer) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   PrerenderManager* prerender_manager = prerender_manager_weak_ptr.get();
   if (!prerender_manager || !prerender_manager->is_enabled())
     return;
   prerender_manager->RecordTagObserved();
 
   std::pair<int, int> child_route_id_pair = std::make_pair(render_process_id,
                                                            render_view_id);
 
-  prerender_manager->AddPreload(child_route_id_pair, url, referrer);
+  prerender_manager->AddPrerenderFromPage(ORIGIN_LINK_REL_PRERENDER,
+                                          child_route_id_pair, url, referrer);
 }
 
-void DestroyPreloadForRenderView(
+void DestroyPrerenderForRenderView(
     const base::WeakPtr<PrerenderManager>& prerender_manager_weak_ptr,
     int render_process_id,
     int render_view_id,
     FinalStatus final_status) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   PrerenderManager* prerender_manager = prerender_manager_weak_ptr.get();
   if (!prerender_manager)
     return;
 
-  prerender_manager->DestroyPreloadForChildRouteIdPair(
+  prerender_manager->DestroyPrerenderForChildRouteIdPair(
       std::make_pair(render_process_id, render_view_id),
       final_status);
 }
 
 PrerenderManager::PrerenderManager(Profile* profile,
                                    PrerenderTracker* prerender_tracker)
     : rate_limit_enabled_(true),
       enabled_(true),
       profile_(profile),
       prerender_tracker_(prerender_tracker),
@@ skipping 15 matching lines @@
 PrerenderManager::~PrerenderManager() {
   DestroyAllContents(FINAL_STATUS_MANAGER_SHUTDOWN);
 }
 
 void PrerenderManager::SetPrerenderContentsFactory(
     PrerenderContents::Factory* prerender_contents_factory) {
   DCHECK(CalledOnValidThread());
   prerender_contents_factory_.reset(prerender_contents_factory);
 }
 
-bool PrerenderManager::AddPreload(
+bool PrerenderManager::AddPrerenderFromPage(
+    Origin origin,
     const std::pair<int, int>& child_route_id_pair,
     const GURL& url_arg,
     const GURL& referrer) {
   DCHECK(CalledOnValidThread());
 
   // If the referring page is prerendering, defer the prerender.
   if (FindPrerenderContentsForChildRouteIdPair(child_route_id_pair) !=
           prerender_list_.end()) {
-    AddPendingPreload(child_route_id_pair, url_arg, referrer);
+    AddPendingPrerender(origin, child_route_id_pair, url_arg, referrer);
     return true;
   }
 
   DeleteOldEntries();
   DeletePendingDeleteEntries();
 
   GURL url = url_arg;
   GURL alias_url;
   if (IsControlGroup() &&
       PrerenderManager::MaybeGetQueryStringBasedAliasURL(
           url, &alias_url)) {
     url = alias_url;
   }
 
   if (FindEntry(url))
     return false;
 
   // Do not prerender if there are too many render processes, and we would
   // have to use an existing one.  We do not want prerendering to happen in
   // a shared process, so that we can always reliably lower the CPU
   // priority for prerendering.
   // In single-process mode, ShouldTryToUseExistingProcessHost() always returns
   // true, so that case needs to be explicitly checked for.
   // TODO(tburkard): Figure out how to cancel prerendering in the opposite
   // case, when a new tab is added to a process used for prerendering.
   if (RenderProcessHost::ShouldTryToUseExistingProcessHost() &&
       !RenderProcessHost::run_renderer_in_process()) {
-    RecordFinalStatus(FINAL_STATUS_TOO_MANY_PROCESSES);
+    RecordFinalStatus(origin, FINAL_STATUS_TOO_MANY_PROCESSES);
     return false;
   }
 
   // Check if enough time has passed since the last prerender.
   if (!DoesRateLimitAllowPrerender()) {
     // Cancel the prerender. We could add it to the pending prerender list but
     // this doesn't make sense as the next prerender request will be triggered
     // by a navigation and is unlikely to be the same site.
-    RecordFinalStatus(FINAL_STATUS_RATE_LIMIT_EXCEEDED);
+    RecordFinalStatus(origin, FINAL_STATUS_RATE_LIMIT_EXCEEDED);
     return false;
   }
 
   RenderViewHost* source_render_view_host = NULL;
   // This test should fail only during unit tests.
   if (child_route_id_pair.first != -1) {
     source_render_view_host =
         RenderViewHost::FromID(child_route_id_pair.first,
                                child_route_id_pair.second);
     // Don't prerender page if parent RenderViewHost no longer exists, or it has
     // no view.  The latter should only happen when the RenderView has closed.
     if (!source_render_view_host || !source_render_view_host->view()) {
-      RecordFinalStatus(FINAL_STATUS_SOURCE_RENDER_VIEW_CLOSED);
+      RecordFinalStatus(origin, FINAL_STATUS_SOURCE_RENDER_VIEW_CLOSED);
       return false;
     }
   }
 
   PrerenderContents* prerender_contents =
-      CreatePrerenderContents(url, referrer);
+      CreatePrerenderContents(url, referrer, origin);
   if (!prerender_contents || !prerender_contents->Init())
     return false;
 
   // TODO(cbentzel): Move invalid checks here instead of PrerenderContents?
   PrerenderContentsData data(prerender_contents, GetCurrentTime());
 
   prerender_list_.push_back(data);
+
   if (IsControlGroup()) {
     data.contents_->set_final_status(FINAL_STATUS_CONTROL_GROUP);
   } else {
     last_prerender_start_time_ = GetCurrentTimeTicks();
     data.contents_->StartPrerendering(source_render_view_host);
   }
   while (prerender_list_.size() > max_elements_) {
     data = prerender_list_.front();
     prerender_list_.pop_front();
     data.contents_->Destroy(FINAL_STATUS_EVICTED);
   }
   StartSchedulingPeriodicCleanups();
   return true;
 }
 
-void PrerenderManager::AddPendingPreload(
+bool PrerenderManager::AddPrerender(Origin origin, const GURL& url) {
+  bool should_prerender = true;
+  if (origin == ORIGIN_OMNIBOX) {
+    CommandLine* cl = CommandLine::ForCurrentProcess();
+    should_prerender = cl->HasSwitch(switches::kPrerenderFromOmnibox);
+  }
+
+  if (!should_prerender)
+    return false;
+
+  return AddPrerenderFromPage(origin, std::make_pair(-1, -1), url, GURL());
+}
+
+void PrerenderManager::AddPendingPrerender(
+    Origin origin,
     const std::pair<int, int>& child_route_id_pair,
     const GURL& url,
     const GURL& referrer) {
   DCHECK(FindPrerenderContentsForChildRouteIdPair(child_route_id_pair) !=
              prerender_list_.end());
   PendingPrerenderList::iterator it =
       pending_prerender_list_.find(child_route_id_pair);
   if (it == pending_prerender_list_.end()) {
     PendingPrerenderList::value_type el = std::make_pair(child_route_id_pair,
                                             std::vector<PendingContentsData>());
     it = pending_prerender_list_.insert(el).first;
   }
 
-  it->second.push_back(PendingContentsData(url, referrer));
+  it->second.push_back(PendingContentsData(url, referrer, origin));
 }
 
 std::list<PrerenderManager::PrerenderContentsData>::iterator
     PrerenderManager::FindPrerenderContentsForChildRouteIdPair(
         const std::pair<int, int>& child_route_id_pair) {
   std::list<PrerenderContentsData>::iterator it = prerender_list_.begin();
   for (; it != prerender_list_.end(); ++it) {
     PrerenderContents* prerender_contents = it->contents_;
 
     int child_id;
     int route_id;
     bool has_child_id = prerender_contents->GetChildId(&child_id);
     bool has_route_id = has_child_id &&
                         prerender_contents->GetRouteId(&route_id);
 
     if (has_child_id && has_route_id &&
         child_id == child_route_id_pair.first &&
         route_id == child_route_id_pair.second) {
       break;
     }
   }
   return it;
 }
 
-void PrerenderManager::DestroyPreloadForChildRouteIdPair(
+void PrerenderManager::DestroyPrerenderForChildRouteIdPair(
     const std::pair<int, int>& child_route_id_pair,
     FinalStatus final_status) {
   DCHECK(CalledOnValidThread());
   std::list<PrerenderContentsData>::iterator it =
       FindPrerenderContentsForChildRouteIdPair(child_route_id_pair);
   if (it != prerender_list_.end()) {
     PrerenderContents* prerender_contents = it->contents_;
     prerender_contents->Destroy(final_status);
   }
 }
@@ skipping 29 matching lines @@
     }
   }
   // Entry not found.
   return NULL;
 }
 
 PrerenderContents* PrerenderManager::GetEntry(const GURL& url) {
   return GetEntryButNotSpecifiedTC(url, NULL);
 }
 
-bool PrerenderManager::MaybeUsePreloadedPage(TabContents* tab_contents,
-                                             const GURL& url,
-                                             bool has_opener_set) {
+bool PrerenderManager::MaybeUsePrerenderedPage(TabContents* tab_contents,
+                                               const GURL& url,
+                                               bool has_opener_set) {
   DCHECK(CalledOnValidThread());
   scoped_ptr<PrerenderContents> prerender_contents(
       GetEntryButNotSpecifiedTC(url, tab_contents));
   if (prerender_contents.get() == NULL)
     return false;
 
   // Do not use the prerendered version if the opener window.property was
   // supposed to be set.
   if (has_opener_set) {
     prerender_contents.release()->Destroy(FINAL_STATUS_WINDOW_OPENER);
@@ skipping 84 matching lines @@
 
   // See if we have any pending prerender requests for this routing id and start
   // the preload if we do.
   std::pair<int, int> child_route_pair = std::make_pair(child_id, route_id);
   PendingPrerenderList::iterator pending_it =
       pending_prerender_list_.find(child_route_pair);
   if (pending_it != pending_prerender_list_.end()) {
     for (std::vector<PendingContentsData>::iterator content_it =
             pending_it->second.begin();
          content_it != pending_it->second.end(); ++content_it) {
-      AddPreload(pending_it->first, content_it->url_, content_it->referrer_);
+      AddPrerenderFromPage(content_it->origin_, pending_it->first,
+                           content_it->url_, content_it->referrer_);
     }
     pending_prerender_list_.erase(pending_it);
   }
 
   if (old_tab_contents->tab_contents()->NeedToFireBeforeUnload()) {
     // Schedule the delete to occur after the tab has run its unload handlers.
     on_close_tab_contents_deleters_.push_back(
         new OnCloseTabContentsDeleter(this, old_tab_contents));
     old_tab_contents->render_view_host()->FirePageBeforeUnload(false);
   } else {
     // No unload handler to run, so delete asap.
     ScheduleDeleteOldTabContents(old_tab_contents, NULL);
   }
 
   // TODO(cbentzel): Should prerender_contents move to the pending delete
   //                 list, instead of deleting directly here?
   AddToHistory(prerender_contents.get());
   return true;
 }
 
 void PrerenderManager::MoveEntryToPendingDelete(PrerenderContents* entry) {
   DCHECK(CalledOnValidThread());
   DCHECK(!IsPendingDelete(entry));
   for (std::list<PrerenderContentsData>::iterator it = prerender_list_.begin();
        it != prerender_list_.end();
        ++it) {
     if (it->contents_ == entry) {
-      RemovePendingPreload(entry);
+      RemovePendingPrerender(entry);
       prerender_list_.erase(it);
       break;
     }
   }
   pending_delete_list_.push_back(entry);
 
   // Destroy the old TabContents relatively promptly to reduce resource usage,
   // and in the case of HTML5 media, reduce the change of playing any sound.
   PostCleanupTask();
 }
@@ skipping 20 matching lines @@
 }
 
 bool PrerenderManager::IsPrerenderElementFresh(const base::Time start) const {
   DCHECK(CalledOnValidThread());
   base::Time now = GetCurrentTime();
   return (now - start < max_prerender_age_);
 }
 
 PrerenderContents* PrerenderManager::CreatePrerenderContents(
     const GURL& url,
-    const GURL& referrer) {
+    const GURL& referrer,
+    Origin origin) {
   DCHECK(CalledOnValidThread());
   return prerender_contents_factory_->CreatePrerenderContents(
-      this, prerender_tracker_, profile_, url, referrer);
+      this, prerender_tracker_, profile_, url, referrer, origin);
 }
 
 void PrerenderManager::DeletePendingDeleteEntries() {
   while (!pending_delete_list_.empty()) {
     PrerenderContents* contents = pending_delete_list_.front();
     pending_delete_list_.pop_front();
     AddToHistory(contents);
     delete contents;
   }
 }
@@ skipping 119 matching lines @@
 
 void PrerenderManager::RecordTagObserved() {
   DCHECK(CalledOnValidThread());
 
   // If we observe multiple tags within the 30 second window, we will still
   // reset the window to begin at the most recent occurrence, so that we will
   // always be in a window in the 30 seconds from each occurrence.
   last_prerender_seen_time_ = base::TimeTicks::Now();
 }
 
-void PrerenderManager::RemovePendingPreload(PrerenderContents* entry) {
+void PrerenderManager::RemovePendingPrerender(PrerenderContents* entry) {
   DCHECK(CalledOnValidThread());
   int child_id;
   int route_id;
   bool has_child_id = entry->GetChildId(&child_id);
   bool has_route_id = has_child_id && entry->GetRouteId(&route_id);
 
   // If the entry doesn't have a RenderViewHost then it didn't start
   // prerendering and there shouldn't be any pending preloads to remove.
   if (has_child_id && has_route_id) {
     std::pair<int, int> child_route_pair = std::make_pair(child_id, route_id);
@@ skipping 246 matching lines @@
   DeleteOldTabContents();
   while (!prerender_list_.empty()) {
     PrerenderContentsData data = prerender_list_.front();
     prerender_list_.pop_front();
     data.contents_->Destroy(final_status);
   }
   DeletePendingDeleteEntries();
 }
 
 }  // namespace prerender