Add info about user agent overrides to WebContents

chrome/browser/sessions/base_session_service.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/sessions/base_session_service.h"
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/pickle.h"
 #include "base/stl_util.h"
@@ skipping 169 matching lines @@
 
   pickle.WriteInt(entry.GetTransitionType());
   int type_mask = entry.GetHasPostData() ? TabNavigation::HAS_POST_DATA : 0;
   pickle.WriteInt(type_mask);
 
   WriteStringToPickle(pickle, &bytes_written, max_state_size,
       entry.GetReferrer().url.is_valid() ?
           entry.GetReferrer().url.spec() : std::string());
   pickle.WriteInt(entry.GetReferrer().policy);
 
+  // Save info required to override the user agent.
   WriteStringToPickle(pickle, &bytes_written, max_state_size,
       entry.GetOriginalRequestURL().is_valid() ?
           entry.GetOriginalRequestURL().spec() : std::string());
+  pickle.WriteBool(entry.GetOverrideUserAgent());
 
   return new SessionCommand(command_id, pickle);
 }
 
 SessionCommand* BaseSessionService::CreateSetTabExtensionAppIDCommand(
     SessionID::id_type command_id,
     SessionID::id_type tab_id,
     const std::string& extension_id) {
   // Use pickle to handle marshalling.
   Pickle pickle;
   pickle.WriteInt(tab_id);
 
   // Enforce a max for ids. They should never be anywhere near this size.
   static const SessionCommand::size_type max_id_size =
       std::numeric_limits<SessionCommand::size_type>::max() - 1024;
 
   int bytes_written = 0;
 
   WriteStringToPickle(pickle, &bytes_written, max_id_size, extension_id);
 
   return new SessionCommand(command_id, pickle);
 }
 
+SessionCommand* BaseSessionService::CreateSetTabUserAgentOverrideCommand(
+    SessionID::id_type command_id,
+    SessionID::id_type tab_id,
+    const std::string& user_agent_override) {
+  // Use pickle to handle marshalling.
+  Pickle pickle;
+  pickle.WriteInt(tab_id);
+
+  // Enforce a max for the user agent length.  They should never be anywhere
+  // near this size.
+  static const SessionCommand::size_type max_user_agent_size =
+      std::numeric_limits<SessionCommand::size_type>::max() - 1024;

[tony, 2012/05/10 18:40:59]

How did you pick this size?  Why subtract 1024?  Maybe you were copying and
pasting from above?  If so, perhaps this constant should be shared (i.e., make a
function for it)?  This could be a follow up refactoring change.

[gone, 2012/05/11 15:40:30]

Yeah, I copied it from above, which appears to be copied from the function above
that, etc.  I'm not sure when/why the original value came into existence, but I
just followed suit.  Follow up change sounds good.

+
+  int bytes_written = 0;
+
+  WriteStringToPickle(pickle, &bytes_written, max_user_agent_size,
+      user_agent_override);
+
+  return new SessionCommand(command_id, pickle);
+}
+
 SessionCommand* BaseSessionService::CreateSetWindowAppNameCommand(
     SessionID::id_type command_id,
     SessionID::id_type window_id,
     const std::string& app_name) {
   // Use pickle to handle marshalling.
   Pickle pickle;
   pickle.WriteInt(window_id);
 
   // Enforce a max for ids. They should never be anywhere near this size.
   static const SessionCommand::size_type max_id_size =
@@ skipping 42 matching lines @@
       policy = WebKit::WebReferrerPolicyDefault;
     navigation->referrer_ = content::Referrer(
         referrer_spec.empty() ? GURL() : GURL(referrer_spec),
         policy);
 
     // If the original URL can't be found, leave it empty.
     std::string url_spec;
     if (!pickle->ReadString(&iterator, &url_spec))
       url_spec = std::string();
     navigation->set_original_request_url(GURL(url_spec));
+
+    // Default to not overriding the user agent if we don't have info.
+    bool override_user_agent;
+    if (!pickle->ReadBool(&iterator, &override_user_agent))
+      override_user_agent = false;
+    navigation->set_override_user_agent(override_user_agent);
   }
 
   navigation->virtual_url_ = GURL(url_spec);
   return true;
 }
 
 bool BaseSessionService::RestoreSetTabExtensionAppIDCommand(
     const SessionCommand& command,
     SessionID::id_type* tab_id,
     std::string* extension_app_id) {
   scoped_ptr<Pickle> pickle(command.PayloadAsPickle());
   if (!pickle.get())
     return false;
 
   PickleIterator iterator(*pickle);
   return pickle->ReadInt(&iterator, tab_id) &&
       pickle->ReadString(&iterator, extension_app_id);
 }
 
+bool BaseSessionService::RestoreSetTabUserAgentOverrideCommand(
+    const SessionCommand& command,
+    SessionID::id_type* tab_id,
+    std::string* user_agent_override) {
+  scoped_ptr<Pickle> pickle(command.PayloadAsPickle());
+  if (!pickle.get())
+    return false;
+
+  PickleIterator iterator(*pickle);
+  return pickle->ReadInt(&iterator, tab_id) &&
+      pickle->ReadString(&iterator, user_agent_override);
+}
+
 bool BaseSessionService::RestoreSetWindowAppNameCommand(
     const SessionCommand& command,
     SessionID::id_type* window_id,
     std::string* app_name) {
   scoped_ptr<Pickle> pickle(command.PayloadAsPickle());
   if (!pickle.get())
     return false;
 
   PickleIterator iterator(*pickle);
   return pickle->ReadInt(&iterator, window_id) &&
@@ skipping 24 matching lines @@
   if (profile_ && BrowserThread::IsMessageLoopValid(BrowserThread::FILE)) {
     return BrowserThread::PostTask(BrowserThread::FILE, from_here, task);
   } else {
     // Fall back to executing on the main thread if the file thread
     // has gone away (around shutdown time) or if we're running as
     // part of a unit test that does not set profile_.
     task.Run();
     return true;
   }
 }