Adding Navigation Throttles to DevTools

content/browser/devtools/protocol/page_handler.cc

 // Copyright 2014 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 "content/browser/devtools/protocol/page_handler.h"
 
 #include <string>
 
 #include "base/base64.h"
 #include "base/bind.h"
 #include "base/location.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string16.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "base/threading/worker_pool.h"
+#include "content/browser/devtools/page_navigation_throttle.h"
 #include "content/browser/devtools/protocol/color_picker.h"
 #include "content/browser/renderer_host/render_widget_host_impl.h"
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
 #include "content/browser/web_contents/web_contents_impl.h"
 #include "content/common/view_messages.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/javascript_dialog_manager.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/navigation_entry.h"
+#include "content/public/browser/navigation_handle.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents_delegate.h"
 #include "content/public/common/referrer.h"
 #include "third_party/WebKit/public/platform/WebScreenInfo.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "ui/base/page_transition_types.h"
 #include "ui/gfx/codec/jpeg_codec.h"
 #include "ui/gfx/codec/png_codec.h"
@@ skipping 59 matching lines @@
       screencast_enabled_(false),
       screencast_quality_(kDefaultScreenshotQuality),
       screencast_max_width_(-1),
       screencast_max_height_(-1),
       capture_every_nth_frame_(1),
       capture_retry_count_(0),
       has_compositor_frame_metadata_(false),
       session_id_(0),
       frame_counter_(0),
       frames_in_flight_(0),
-      color_picker_(new ColorPicker(base::Bind(
-          &PageHandler::OnColorPicked, base::Unretained(this)))),
+      color_picker_(new ColorPicker(
+          base::Bind(&PageHandler::OnColorPicked, base::Unretained(this)))),
+      navigation_throttle_enabled_(false),
+      next_navigation_id_(0),
       host_(nullptr),
-      weak_factory_(this) {
-}
+      weak_factory_(this) {}
 
 PageHandler::~PageHandler() {
 }
 
 void PageHandler::SetRenderFrameHost(RenderFrameHostImpl* host) {
   if (host_ == host)
     return;
 
   RenderWidgetHostImpl* widget_host =
       host_ ? host_->GetRenderWidgetHost() : nullptr;
@@ skipping 74 matching lines @@
 }
 
 Response PageHandler::Enable() {
   enabled_ = true;
   return Response::FallThrough();
 }
 
 Response PageHandler::Disable() {
   enabled_ = false;
   screencast_enabled_ = false;
+  SetControlNavigations(false);
   color_picker_->SetEnabled(false);
   return Response::FallThrough();
 }
 
 Response PageHandler::Reload(const bool* bypassCache,
                              const std::string* script_to_evaluate_on_load,
                              const std::string* script_preprocessor) {
   WebContentsImpl* web_contents = GetWebContents();
   if (!web_contents)
     return Response::InternalError("Could not connect to view");
@@ skipping 152 matching lines @@
 }
 
 Response PageHandler::RequestAppBanner() {
   WebContentsImpl* web_contents = GetWebContents();
   if (!web_contents)
     return Response::InternalError("Could not connect to view");
   web_contents->GetDelegate()->RequestAppBannerFromDevTools(web_contents);
   return Response::OK();
 }
 
+Response PageHandler::SetControlNavigations(bool enabled) {
+  navigation_throttle_enabled_ = enabled;
+  // We don't own the page PageNavigationThrottles so we can't delete them, but
+  // we can turn them into NOPs.
+  for (auto& pair : navigation_throttles_) {
+    pair.second->AlwaysProceed();
+  }
+  navigation_throttles_.clear();
+  return Response::OK();
+}
+
+Response PageHandler::ProcessNavigation(const std::string& response,
+                                        int navigation_id) {
+  auto it = navigation_throttles_.find(navigation_id);
+  if (it == navigation_throttles_.end())
+    return Response::InvalidParams("Unknown navigation id");
+
+  if (response == kNavigationThrottleResponseProceed) {
+    it->second->Resume();
+    return Response::OK();
+  } else if (response == kNavigationThrottleResponseCancel) {
+    it->second->CancelDeferredNavigation(content::NavigationThrottle::CANCEL);
+    return Response::OK();
+  } else if (response == kNavigationThrottleResponseCancelAndIgnore) {
+    it->second->CancelDeferredNavigation(
+        content::NavigationThrottle::CANCEL_AND_IGNORE);
+    return Response::OK();
+  }
+
+  return Response::InvalidParams("Unrecognized response");
+}
+
+std::unique_ptr<PageNavigationThrottle> PageHandler::GetThrottleForNavigation(

[nasko, 2016/07/13 22:37:34]

nit: This should be named Create, as it doesn't Get an existing one, it always
creates one.

[alex clarke (OOO till 29th), 2016/07/14 16:06:04]

Done.

+    NavigationHandle* navigation_handle) {
+  if (!navigation_throttle_enabled_)
+    return nullptr;
+
+  std::unique_ptr<PageNavigationThrottle> throttle(new PageNavigationThrottle(
+      weak_factory_.GetWeakPtr(), next_navigation_id_, navigation_handle));
+  navigation_throttles_[next_navigation_id_++] = throttle.get();
+  return throttle;
+}
+
+void PageHandler::OnPageNavigationThrottleDisposed(int navigation_id) {
+  DCHECK(navigation_throttles_.find(navigation_id) !=
+         navigation_throttles_.end());
+  navigation_throttles_.erase(navigation_id);
+}
+
+void PageHandler::NavigationRequested(const PageNavigationThrottle* throttle) {
+  NavigationHandle* navigation_handle = throttle->navigation_handle();
+  client_->NavigationRequested(
+      NavigationRequestedParams::Create()
+          ->set_is_in_main_frame(navigation_handle->IsInMainFrame())
+          ->set_is_parent_main_frame(navigation_handle->IsParentMainFrame())

[nasko, 2016/07/13 22:37:34]

Is this really needed? I'd rather not expose it if possible, as ideally I'd
remove this method from NavigationHandle. If we expose it, then it becomes much
harder to remove in the future.

[alex clarke (OOO till 29th), 2016/07/14 16:06:04]

Done.

+          ->set_is_redirect(navigation_handle->WasServerRedirect())
+          ->set_navigation_id(throttle->navigation_id())
+          ->set_url(navigation_handle->GetURL().spec())
+          ->set_renderer_initiated(navigation_handle->IsRendererInitiated()));
+}
+
 WebContentsImpl* PageHandler::GetWebContents() {
   return host_ ?
       static_cast<WebContentsImpl*>(WebContents::FromRenderFrameHost(host_)) :
       nullptr;
 }
 
 void PageHandler::NotifyScreencastVisibility(bool visible) {
   if (visible)
     capture_retry_count_ = kCaptureRetryLimit;
   client_->ScreencastVisibilityChanged(
@@ skipping 130 matching lines @@
 
 void PageHandler::OnColorPicked(int r, int g, int b, int a) {
   scoped_refptr<dom::RGBA> color =
       dom::RGBA::Create()->set_r(r)->set_g(g)->set_b(b)->set_a(a);
   client_->ColorPicked(ColorPickedParams::Create()->set_color(color));
 }
 
 }  // namespace page
 }  // namespace devtools
 }  // namespace content