Transfer user agent override info between browser and renderer

content/common/view_messages.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.
 
 // IPC messages for page rendering.
 // Multiply-included message file, hence no include guard.
 
 #include "base/process.h"
 #include "base/shared_memory.h"
 #include "content/common/content_export.h"
@@ skipping 423 matching lines @@
 
   // The status code of the HTTP request.
   IPC_STRUCT_MEMBER(int, http_status_code)
 
   // True if the connection was proxied.  In this case, socket_address
   // will represent the address of the proxy, rather than the remote host.
   IPC_STRUCT_MEMBER(bool, was_fetched_via_proxy)
 
   // Serialized history item state to store in the navigation entry.
   IPC_STRUCT_MEMBER(std::string, content_state)
+
+  // Original request's URL.
+  IPC_STRUCT_MEMBER(GURL, original_request_url)
+
+  // User agent override used to navigate.
+  IPC_STRUCT_MEMBER(bool, is_overriding_user_agent)
 IPC_STRUCT_END()
 
 // This message is used for supporting popup menus on Mac OS X using native
 // Cocoa controls. The renderer sends us this message which we use to populate
 // the popup menu.
 IPC_STRUCT_BEGIN(ViewHostMsg_ShowPopup_Params)
   // Position on the screen.
   IPC_STRUCT_MEMBER(gfx::Rect, bounds)
 
   // The height of each item in the menu.
@@ skipping 167 matching lines @@
 
   // The following two members identify a previous request that has been
   // created before this navigation is being transferred to a new render view.
   // This serves the purpose of recycling the old request.
   // Unless this refers to a transferred navigation, these values are -1 and -1.
   IPC_STRUCT_MEMBER(int, transferred_request_child_id)
   IPC_STRUCT_MEMBER(int, transferred_request_request_id)
 
   // Whether or not we should allow the url to download.
   IPC_STRUCT_MEMBER(bool, allow_download)
+
+  // Whether or not the user agent override string should be used.
+  IPC_STRUCT_MEMBER(bool, is_overriding_user_agent)

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

It's confusing to me that a single string is set for a RenderView and then it's
turned on or off per navigation.  Why not send the string to use on each
navigation?  Seems like that might be better than having state live on the
RenderView.

For example, if the renderer is currently using its local state for
renderer-initiated navigations, but the browser sends a message to change the
user agent while a page is rendering, a single page could have mixed results. 
Is that intended?

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

I actually had something working like this downstream, but ended up changing it
around because this way seemed cleaner.  Would a renderer-initiated navigation
(i.e. clicking a link) go through NavigationControllerImpl::LoadURLFromRenderer?
Good point; that's definitely not intended.

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

Usually it wouldn't.  Only navigations that force a process swap go through
LoadURLFromRenderer, such as clicking a link from a normal page to a hosted app.
 However, that is a case where you'd likely forget the setting.
I'm inclined to think we need a different approach for handling
renderer-initiated navigations, but I'm not sure how to get the correct setting
to WebKit without an IPC to the browser.  Does WebKit actually need to know the
user agent, or is it something the network stack in the browser process could
take care of?  (Hmm, I suppose WebKit needs it in case JavaScript asks for the
user agent.)

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

As per our meeting, I'm going to look at whether we can dump the state inside
the WebHistoryItem.
This case is something we probably should handle... I've added the logic
required.
If a user agent override is currently being used for a currently loading page,
changing the override string now requires reloading the page.  Should avoid race
conditions.
WebKit needs to know it for at least user agent checks in JavaScript.

 IPC_STRUCT_END()
 
 IPC_STRUCT_BEGIN(ViewMsg_New_Params)
   // The parent window's id.
   IPC_STRUCT_MEMBER(gfx::NativeViewId, parent_window)
 
   // Renderer-wide preferences.
   IPC_STRUCT_MEMBER(content::RendererPreferences, renderer_preferences)
 
   // Preferences for this view.
@@ skipping 11 matching lines @@
   // The name of the frame associated with this view (or empty if none).
   IPC_STRUCT_MEMBER(string16, frame_name)
 
   // The route ID of the opener RenderView if we need to set one
   // (MSG_ROUTING_NONE otherwise).
   IPC_STRUCT_MEMBER(int, opener_route_id)
 
   // Whether the RenderView should initially be swapped out.
   IPC_STRUCT_MEMBER(bool, swapped_out)
 
+  // The user agent given to WebKit when it requests one and the user agent is
+  // being overridden for the current navigation.
+  IPC_STRUCT_MEMBER(std::string, user_agent_override)
+
   // The initial page ID to use for this view, which must be larger than any
   // existing navigation that might be loaded in the view.  Page IDs are unique
   // to a view and are only updated by the renderer after this initial value.
   IPC_STRUCT_MEMBER(int32, next_page_id)
 
   // The properties of the screen associated with the view.
   IPC_STRUCT_MEMBER(WebKit::WebScreenInfo, screen_info)
 
   // The name of the channel with which a guest talks to its embedder.
   // If this newly created RenderView has no embedder this string will be
@@ skipping 53 matching lines @@
 IPC_SYNC_MESSAGE_CONTROL0_1(ViewHostMsg_GetCPUUsage,
                             int /* CPU usage in percents */)
 
 // Tells the renderer to create a new view.
 // This message is slightly different, the view it takes (via
 // ViewMsg_New_Params) is the view to create, the message itself is sent as a
 // non-view control message.
 IPC_MESSAGE_CONTROL1(ViewMsg_New,
                      ViewMsg_New_Params)
 
+// Set the user agent override used by the renderer.
+IPC_MESSAGE_ROUTED1(ViewMsg_SetUserAgentOverride,
+                    std::string /* override to use */)

[tony, 2012/05/31 17:25:00]

Hmm, should we just add a bool to RendererPreferences instead of adding a new
message?  It looks like RendererPreferences is already passed as part of
ViewMsg_New_Params when creating a new RenderView.

[gone, 2012/05/31 21:43:25]

The RenderView may have already been created when
WebContentsImpl::SetUserAgentOverride() is called, I think.

[tony, 2012/05/31 21:59:02]

That's fine, you would just use ViewMsg_SetRendererPrefs instead.

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

If I switch to calling RenderViewImpl::OnSetRendererPrefs() or
RenderViewHost::SyncRendererPrefs(), would there be any fallout from having the
preferences re-set?  RenderViewImpl doesn't seem to change any of these
preferences on its own, so I'd guess it'd be safe.

+
 // Reply in response to ViewHostMsg_ShowView or ViewHostMsg_ShowWidget.
 // similar to the new command, but used when the renderer created a view
 // first, and we need to update it.
 IPC_MESSAGE_ROUTED1(ViewMsg_CreatingNew_ACK,
                     gfx::NativeViewId /* parent_hwnd */)
 
 // Sends updated preferences to the renderer.
 IPC_MESSAGE_ROUTED1(ViewMsg_SetRendererPrefs,
                     content::RendererPreferences)
 
@@ skipping 1310 matching lines @@
 // (according to the value of is_hung). The browser can give the user the
 // option of killing the plugin.
 IPC_MESSAGE_ROUTED3(ViewHostMsg_PepperPluginHung,
                     int /* plugin_child_id */,
                     FilePath /* path */,
                     bool /* is_hung */)
 
 // Screen was rotated. Dispatched to the onorientationchange javascript API.
 IPC_MESSAGE_ROUTED1(ViewMsg_OrientationChangeEvent,
                     int /* orientation */)