Transfer user agent override info between browser and renderer

content/renderer/render_view_impl.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 CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
 #define CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
 #pragma once
 
 #include <deque>
 #include <map>
@@ skipping 180 matching lines @@
   CONTENT_EXPORT static RenderViewImpl* Create(
       gfx::NativeViewId parent_hwnd,
       int32 opener_id,
       const content::RendererPreferences& renderer_prefs,
       const webkit_glue::WebPreferences& webkit_prefs,
       SharedRenderViewCounter* counter,
       int32 routing_id,
       int32 surface_id,
       int64 session_storage_namespace_id,
       const string16& frame_name,
+      const std::string& user_agent_override,
       bool is_renderer_created,
       bool swapped_out,
       int32 next_page_id,
       const WebKit::WebScreenInfo& screen_info,
       content::GuestToEmbedderChannel* guest_to_embedder_channel,
       AccessibilityMode accessibility_mode);
 
   // Returns the RenderViewImpl containing the given WebView.
   CONTENT_EXPORT static RenderViewImpl* FromWebView(WebKit::WebView* webview);
 
@@ skipping 412 matching lines @@
       WebKit::WebFrame* frame,
       const WebKit::WebIntentServiceInfo& service);
   virtual void dispatchIntent(WebKit::WebFrame* frame,
                               const WebKit::WebIntentRequest& intentRequest);
   virtual void willOpenSocketStream(
       WebKit::WebSocketStreamHandle* handle);
   virtual bool willCheckAndDispatchMessageEvent(
       WebKit::WebFrame* source,
       WebKit::WebSecurityOrigin targetOrigin,
       WebKit::WebDOMMessageEvent event) OVERRIDE;
+  virtual bool userAgent(const WebKit::WebURL& url,

[Charlie Reis, 2012/06/01 00:36:08]

That function name doesn't indicate what it's doing.  I realize this would be a
task for a separate WebKit patch, but could the name reflect more of what
question it's answering?

[gone, 2012/06/01 01:04:06]

This appears to be the naming convention for accessing the user agent for a few
classes in WebKit... we could try to change it to userAgentOverride() or
something.

[Charlie Reis, 2012/06/01 18:04:09]

Most of those appear to return a String, which makes sense to me (i.e.,
userAgent() returns the user agent string).  This one returns a bool indicating
whether to use a custom userAgent.  Or is that an out parameter?  Either way, it
feels different than a normal accessor.

Maybe something like shouldOverrideUserAgent()?  Anyway, this is probably
Darin's territory for WebKit API, so we can defer it for this CL.

[gone, 2012/06/14 00:46:39]

https://bugs.webkit.org/show_bug.cgi?id=89028

+                         WebKit::WebString* userAgent) OVERRIDE;
 
   // WebKit::WebPageSerializerClient implementation ----------------------------
 
   virtual void didSerializeDataForFrame(
       const WebKit::WebURL& frame_url,
       const WebKit::WebCString& data,
       PageSerializationStatus status) OVERRIDE;
 
   // content::RenderView implementation ----------------------------------------
 
@@ skipping 134 matching lines @@
 
   RenderViewImpl(gfx::NativeViewId parent_hwnd,
                  int32 opener_id,
                  const content::RendererPreferences& renderer_prefs,
                  const webkit_glue::WebPreferences& webkit_prefs,
                  SharedRenderViewCounter* counter,
                  int32 routing_id,
                  int32 surface_id,
                  int64 session_storage_namespace_id,
                  const string16& frame_name,
+                 const std::string& user_agent_override,
                  bool is_renderer_created,
                  bool swapped_out,
                  int32 next_page_id,
                  const WebKit::WebScreenInfo& screen_info,
                  content::GuestToEmbedderChannel* guest_to_embedder_channel,
                  AccessibilityMode accessibility_mode);
 
   // Do not delete directly.  This class is reference counted.
   virtual ~RenderViewImpl();
 
@@ skipping 137 matching lines @@
       const EditCommands& edit_commands);
   CONTENT_EXPORT void OnSetHistoryLengthAndPrune(int history_length,
                                                  int32 minimum_page_id);
   void OnSetInitialFocus(bool reverse);
 #if defined(OS_MACOSX)
   void OnSetInLiveResize(bool in_live_resize);
 #endif
   void OnScrollFocusedEditableNodeIntoRect(const gfx::Rect& rect);
   void OnSetPageEncoding(const std::string& encoding_name);
   void OnSetRendererPrefs(const content::RendererPreferences& renderer_prefs);
+  void OnSetUserAgentOverride(const std::string& override);
 #if defined(OS_MACOSX)
   void OnSetWindowVisibility(bool visible);
 #endif
   void OnSetZoomLevel(double zoom_level);
   void OnSetZoomLevelForLoadingURL(const GURL& url, double zoom_level);
   void OnExitFullscreen();
   void OnShouldClose();
   void OnStop();
   void OnStopFinding(content::StopFindAction action);
   CONTENT_EXPORT void OnSwapOut(const ViewMsg_SwapOut_Params& params);
@@ skipping 141 matching lines @@
   // scroll bars on windows smaller than this size.  Used for windows that the
   // browser resizes to the size of the content, such as browser action popups.
   // If a render view is set to the minimum size of its content, webkit may add
   // scroll bars.  This makes sense for fixed sized windows, but it does not
   // make sense when the size of the view was chosen to fit the content.
   // This setting ensures that no scroll bars are drawn.  The size limit exists
   // because if the view grows beyond a size known to the browser, scroll bars
   // should be drawn.
   gfx::Size disable_scrollbars_size_limit_;
 
+  // String to use when overriding the default user agent.
+  std::string user_agent_override_;
+
+  // Whether or not the override is being used.
+  bool is_overriding_user_agent_;
+
   // Loading state -------------------------------------------------------------
 
   // True if the top level frame is currently being loaded.
   bool is_loading_;
 
   // The gesture that initiated the current navigation.
   NavigationGesture navigation_gesture_;
 
   // Used for popups.
   bool opened_by_user_gesture_;
@@ skipping 280 matching lines @@
   // bunch of stuff, you should probably create a helper class and put your
   // data and methods on that to avoid bloating RenderView more.  You can
   // use the Observer interface to filter IPC messages and receive frame change
   // notifications.
   // ---------------------------------------------------------------------------
 
   DISALLOW_COPY_AND_ASSIGN(RenderViewImpl);
 };
 
 #endif  // CONTENT_RENDERER_RENDER_VIEW_IMPL_H_