Fix crashes in DownloadRequestLimiter when extension popups/bubbles initiate downloads automatically

chrome/browser/download/download_request_limiter.cc

 // 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.
 
 #include "chrome/browser/download/download_request_limiter.h"
 
 #include "base/bind.h"
 #include "base/stl_util.h"
 #include "chrome/browser/download/download_request_infobar_delegate.h"
 #include "chrome/browser/infobars/infobar_tab_helper.h"
@@ skipping 11 matching lines @@
 
 using content::BrowserThread;
 using content::NavigationController;
 using content::NavigationEntry;
 using content::WebContents;
 
 // TabDownloadState ------------------------------------------------------------
 
 DownloadRequestLimiter::TabDownloadState::TabDownloadState(
     DownloadRequestLimiter* host,
-    NavigationController* controller,
-    NavigationController* originating_controller)
-    : host_(host),
-      controller_(controller),
+    WebContents* contents,
+    WebContents* originating_web_contents)
+    : content::WebContentsObserver(contents),
+      host_(host),
       status_(DownloadRequestLimiter::ALLOW_ONE_DOWNLOAD),
       download_count_(0),
       infobar_(NULL) {
-  content::Source<NavigationController> notification_source(controller);
-  content::Source<content::WebContents> web_contents_source(
-       controller->GetWebContents());
+  content::Source<NavigationController> notification_source(
+      &contents->GetController());
+  content::Source<content::WebContents> web_contents_source(contents);
   registrar_.Add(this, content::NOTIFICATION_NAV_ENTRY_PENDING,
                  notification_source);
   registrar_.Add(this, content::NOTIFICATION_WEB_CONTENTS_DESTROYED,
                  web_contents_source);
 
-  NavigationEntry* active_entry = originating_controller ?
-      originating_controller->GetActiveEntry() : controller->GetActiveEntry();
+  NavigationEntry* active_entry = originating_web_contents ?
+      originating_web_contents->GetController().GetActiveEntry() :
+      contents->GetController().GetActiveEntry();
   if (active_entry)
     initial_page_host_ = active_entry->GetURL().host();
 }
 
 DownloadRequestLimiter::TabDownloadState::~TabDownloadState() {
   // We should only be destroyed after the callbacks have been notified.
   DCHECK(callbacks_.empty());
 
   // And we should have closed the infobar.
   DCHECK(!infobar_);
 }
 
-void DownloadRequestLimiter::TabDownloadState::OnUserGesture() {
+void DownloadRequestLimiter::TabDownloadState::DidGetUserGesture() {
   if (is_showing_prompt()) {
     // Don't change the state if the user clicks on the page some where.
     return;
   }
 
-  if (status_ != DownloadRequestLimiter::ALLOW_ALL_DOWNLOADS &&
-      status_ != DownloadRequestLimiter::DOWNLOADS_NOT_ALLOWED) {
+  TabContentsWrapper* tab_wrapper =
+      TabContentsWrapper::GetCurrentWrapperForContents(web_contents());
+  // See PromptUserForDownload(): if there's no TCW, then DOWNLOADS_NOT_ALLOWED
+  // is functionally equivalent to PROMPT_BEFORE_DOWNLOAD.
+  if ((tab_wrapper &&
+       status_ != DownloadRequestLimiter::ALLOW_ALL_DOWNLOADS &&
+       status_ != DownloadRequestLimiter::DOWNLOADS_NOT_ALLOWED) ||
+      (!tab_wrapper &&
+       status_ != DownloadRequestLimiter::ALLOW_ALL_DOWNLOADS)) {
     // Revert to default status.
     host_->Remove(this);
     // WARNING: We've been deleted.
-    return;
   }
 }
 
 void DownloadRequestLimiter::TabDownloadState::PromptUserForDownload(
-    WebContents* tab,
+    WebContents* web_contents,
     const DownloadRequestLimiter::Callback& callback) {
   callbacks_.push_back(callback);
 
   if (is_showing_prompt())
     return;  // Already showing prompt.
 
   if (DownloadRequestLimiter::delegate_) {
     NotifyCallbacks(DownloadRequestLimiter::delegate_->ShouldAllowDownload());
-  } else {
-    InfoBarTabHelper* infobar_helper =
-        TabContentsWrapper::GetCurrentWrapperForContents(tab)->
-            infobar_tab_helper();
-    infobar_ = new DownloadRequestInfoBarDelegate(infobar_helper, this);
-    infobar_helper->AddInfoBar(infobar_);
+    return;
   }
+  TabContentsWrapper* tab_wrapper =
+      TabContentsWrapper::GetCurrentWrapperForContents(web_contents);
+  if (!tab_wrapper) {
+    // If |web_contents| doesn't have a tab_wrapper, then it isn't what a user
+    // thinks of as a tab, it's actually a "raw" WebContents like those used
+    // for extension popups/bubbles and hosted apps etc.
+    // TODO(benjhayden): If this is an automatic download from an extension,
+    // it would be convenient for the extension author if we send a message to
+    // the extension's DevTools console (as we do for CSP) about how
+    // extensions should use chrome.downloads.download() (requires the
+    // "downloads" permission) to automatically download >1 files.
+    Cancel();
+    return;
+  }
+  InfoBarTabHelper* infobar_helper = tab_wrapper->infobar_tab_helper();
+  infobar_ = new DownloadRequestInfoBarDelegate(infobar_helper, this);
+  infobar_helper->AddInfoBar(infobar_);
 }
 
 void DownloadRequestLimiter::TabDownloadState::Cancel() {
   NotifyCallbacks(false);
 }
 
 void DownloadRequestLimiter::TabDownloadState::Accept() {
   NotifyCallbacks(true);
 }
 
 void DownloadRequestLimiter::TabDownloadState::Observe(
     int type,
     const content::NotificationSource& source,
     const content::NotificationDetails& details) {
   if (type != content::NOTIFICATION_NAV_ENTRY_PENDING &&
       type != content::NOTIFICATION_WEB_CONTENTS_DESTROYED) {
     NOTREACHED();
     return;
   }
+  content::NavigationController* controller = &web_contents()->GetController();
   if (type == content::NOTIFICATION_NAV_ENTRY_PENDING &&
-      content::Source<NavigationController>(source).ptr() != controller_) {
+      content::Source<NavigationController>(source).ptr() != controller) {
     NOTREACHED();
     return;
   }
   if (type == content::NOTIFICATION_WEB_CONTENTS_DESTROYED &&
       &content::Source<content::WebContents>(source).ptr()->
-          GetController() != controller_) {
+          GetController() != controller) {
     NOTREACHED();
     return;
   }
 
   switch (type) {
     case content::NOTIFICATION_NAV_ENTRY_PENDING: {
       // NOTE: resetting state on a pending navigate isn't ideal. In particular
       // it is possible that queued up downloads for the page before the
       // pending navigate will be delivered to us after we process this
       // request. If this happens we may let a download through that we
       // shouldn't have. But this is rather rare, and it is difficult to get
       // 100% right, so we don't deal with it.
-      NavigationEntry* entry = controller_->GetPendingEntry();
+      NavigationEntry* entry = controller->GetPendingEntry();
       if (!entry)
         return;
 
       if (content::PageTransitionIsRedirect(entry->GetTransitionType())) {
         // Redirects don't count.
         return;
       }
 
       if (status_ == DownloadRequestLimiter::ALLOW_ALL_DOWNLOADS ||
           status_ == DownloadRequestLimiter::DOWNLOADS_NOT_ALLOWED) {
@@ skipping 15 matching lines @@
 
     default:
       NOTREACHED();
   }
 
   NotifyCallbacks(false);
   host_->Remove(this);
 }
 
 void DownloadRequestLimiter::TabDownloadState::NotifyCallbacks(bool allow) {
-  status_ = allow ?
+  set_download_status(allow ?
       DownloadRequestLimiter::ALLOW_ALL_DOWNLOADS :
-      DownloadRequestLimiter::DOWNLOADS_NOT_ALLOWED;
+      DownloadRequestLimiter::DOWNLOADS_NOT_ALLOWED);
   std::vector<DownloadRequestLimiter::Callback> callbacks;
   bool change_status = false;
 
   // Selectively send first few notifications only if number of downloads exceed
   // kMaxDownloadsAtOnce. In that case, we also retain the infobar instance and
   // don't close it. If allow is false, we send all the notifications to cancel
   // all remaining downloads and close the infobar.
   if (!allow || (callbacks_.size() < kMaxDownloadsAtOnce)) {
     if (infobar_) {
       // Reset the delegate so we don't get notified again.
       infobar_->set_host(NULL);
       infobar_ = NULL;
     }
     callbacks.swap(callbacks_);
   } else {
     std::vector<DownloadRequestLimiter::Callback>::iterator start, end;
     start = callbacks_.begin();
     end = callbacks_.begin() + kMaxDownloadsAtOnce;
     callbacks.assign(start, end);
     callbacks_.erase(start, end);
     change_status = true;
   }
 
   for (size_t i = 0; i < callbacks.size(); ++i)
     host_->ScheduleNotification(callbacks[i], allow);
 
   if (change_status)
-    status_ = DownloadRequestLimiter::PROMPT_BEFORE_DOWNLOAD;
+    set_download_status(DownloadRequestLimiter::PROMPT_BEFORE_DOWNLOAD);
 }
 
 // DownloadRequestLimiter ------------------------------------------------------
 
 DownloadRequestLimiter::DownloadRequestLimiter() {
 }
 
 DownloadRequestLimiter::~DownloadRequestLimiter() {
   // All the tabs should have closed before us, which sends notification and
   // removes from state_map_. As such, there should be no pending callbacks.
   DCHECK(state_map_.empty());
 }
 
 DownloadRequestLimiter::DownloadStatus
-    DownloadRequestLimiter::GetDownloadStatus(WebContents* tab) {
-  TabDownloadState* state = GetDownloadState(&tab->GetController(), NULL, false);
+    DownloadRequestLimiter::GetDownloadStatus(WebContents* web_contents) {
+  TabDownloadState* state = GetDownloadState(web_contents, NULL, false);
   return state ? state->download_status() : ALLOW_ONE_DOWNLOAD;
 }
 
 void DownloadRequestLimiter::CanDownloadOnIOThread(
     int render_process_host_id,
     int render_view_id,
     int request_id,
     const std::string& request_method,
     const Callback& callback) {
   // This is invoked on the IO thread. Schedule the task to run on the UI
   // thread so that we can query UI state.
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   BrowserThread::PostTask(
       BrowserThread::UI, FROM_HERE,
       base::Bind(&DownloadRequestLimiter::CanDownload, this,
                  render_process_host_id, render_view_id, request_id,
                  request_method, callback));
 }
 
-void DownloadRequestLimiter::OnUserGesture(WebContents* tab) {
-  TabDownloadState* state =
-      GetDownloadState(&tab->GetController(), NULL, false);
-  if (!state)
-    return;
-
-  state->OnUserGesture();
-}
-
 // static
 void DownloadRequestLimiter::SetTestingDelegate(TestingDelegate* delegate) {
   delegate_ = delegate;
 }
 
-DownloadRequestLimiter::TabDownloadState* DownloadRequestLimiter::
-    GetDownloadState(NavigationController* controller,
-                     NavigationController* originating_controller,
-                     bool create) {
-  DCHECK(controller);
-  StateMap::iterator i = state_map_.find(controller);
+DownloadRequestLimiter::TabDownloadState*
+DownloadRequestLimiter::GetDownloadState(
+    WebContents* web_contents,
+    WebContents* originating_web_contents,
+    bool create) {
+  DCHECK(web_contents);
+  StateMap::iterator i = state_map_.find(web_contents);
   if (i != state_map_.end())
     return i->second;
 
   if (!create)
     return NULL;
 
   TabDownloadState* state =
-      new TabDownloadState(this, controller, originating_controller);
-  state_map_[controller] = state;
+      new TabDownloadState(this, web_contents, originating_web_contents);
+  state_map_[web_contents] = state;
   return state;
 }
 
 void DownloadRequestLimiter::CanDownload(int render_process_host_id,
                                          int render_view_id,
                                          int request_id,
                                          const std::string& request_method,
                                          const Callback& callback) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 
-  WebContents* originating_tab =
+  WebContents* originating_contents =
       tab_util::GetWebContentsByID(render_process_host_id, render_view_id);
-  if (!originating_tab) {
-    // The tab was closed, don't allow the download.
+  if (!originating_contents) {
+    // The WebContents was closed, don't allow the download.
     ScheduleNotification(callback, false);
     return;
   }
 
   CanDownloadImpl(
-      TabContentsWrapper::GetCurrentWrapperForContents(originating_tab),
+      originating_contents,
       request_id,
       request_method,
       callback);
 }
 
-void DownloadRequestLimiter::CanDownloadImpl(
-    TabContentsWrapper* originating_tab,
-    int request_id,
-    const std::string& request_method,
-    const Callback& callback) {
-  DCHECK(originating_tab);
+void DownloadRequestLimiter::CanDownloadImpl(WebContents* originating_contents,
+                                             int request_id,
+                                             const std::string& request_method,
+                                             const Callback& callback) {
+  DCHECK(originating_contents);
 
   // FYI: Chrome Frame overrides CanDownload in ExternalTabContainer in order
   // to cancel the download operation in chrome and let the host browser
   // take care of it.
-  WebContents* tab = originating_tab->web_contents();
-  if (tab->GetDelegate() && !tab->GetDelegate()->CanDownload(
-      tab->GetRenderViewHost(), request_id, request_method)) {
+  if (originating_contents->GetDelegate() &&
+      !originating_contents->GetDelegate()->CanDownload(
+          originating_contents->GetRenderViewHost(),
+          request_id,
+          request_method)) {
     ScheduleNotification(callback, false);
     return;
   }
 
   // If the tab requesting the download is a constrained popup that is not
   // shown, treat the request as if it came from the parent.
-  TabContentsWrapper* effective_wrapper = originating_tab;
-  if (effective_wrapper->blocked_content_tab_helper()->delegate()) {
-    effective_wrapper = effective_wrapper->blocked_content_tab_helper()->
-        delegate()->GetConstrainingContentsWrapper(effective_wrapper);
+  WebContents* effective_contents = originating_contents;
+  TabContentsWrapper* originating_wrapper =
+     TabContentsWrapper::GetCurrentWrapperForContents(originating_contents);
+  if (originating_wrapper &&
+      originating_wrapper->blocked_content_tab_helper()->delegate()) {
+    effective_contents = originating_wrapper->blocked_content_tab_helper()->
+        delegate()->GetConstrainingContentsWrapper(originating_wrapper)->
+            web_contents();
   }
 
   TabDownloadState* state = GetDownloadState(
-      &effective_wrapper->web_contents()->GetController(),
-      &tab->GetController(), true);
+      effective_contents, originating_contents, true);
   switch (state->download_status()) {
     case ALLOW_ALL_DOWNLOADS:
       if (state->download_count() && !(state->download_count() %
             DownloadRequestLimiter::kMaxDownloadsAtOnce))
         state->set_download_status(PROMPT_BEFORE_DOWNLOAD);
       ScheduleNotification(callback, true);
       state->increment_download_count();
       break;
 
     case ALLOW_ONE_DOWNLOAD:
       state->set_download_status(PROMPT_BEFORE_DOWNLOAD);
       ScheduleNotification(callback, true);
       break;
 
     case DOWNLOADS_NOT_ALLOWED:
       ScheduleNotification(callback, false);
       break;
 
     case PROMPT_BEFORE_DOWNLOAD:
-      state->PromptUserForDownload(effective_wrapper->web_contents(), callback);
+      state->PromptUserForDownload(effective_contents, callback);
       state->increment_download_count();
       break;
 
     default:
       NOTREACHED();
   }
 }
 
 void DownloadRequestLimiter::ScheduleNotification(const Callback& callback,
                                                   bool allow) {
   BrowserThread::PostTask(
       BrowserThread::IO, FROM_HERE, base::Bind(callback, allow));
 }
 
 void DownloadRequestLimiter::Remove(TabDownloadState* state) {
-  DCHECK(ContainsKey(state_map_, state->controller()));
-  state_map_.erase(state->controller());
+  DCHECK(ContainsKey(state_map_, state->web_contents()));
+  state_map_.erase(state->web_contents());
   delete state;
 }
 
 // static
 DownloadRequestLimiter::TestingDelegate* DownloadRequestLimiter::delegate_ =
     NULL;