Rewrites SerializedNavigationEntry to not have any //content member variables.

This will pave the way for a future CL that completely removes all //content
dependencies from the class.

[email protected]
BUG=371476
TEST=No visible impact.

Review URL: https://codereview.chromium.org/658073004

Cr-Commit-Position: refs/heads/master@{#300344}

Author: rohitrao

chrome/browser/sessions/session_restore.cc

@@ -48,6 +48,7 @@
 #include "content/public/browser/session_storage_namespace.h"
 #include "content/public/browser/storage_partition.h"
 #include "content/public/browser/web_contents.h"
+#include "content/public/common/page_state.h"
 #include "extensions/browser/extension_registry.h"
 #include "extensions/common/extension_set.h"
 #include "net/base/network_change_notifier.h"
@@ -1053,7 +1054,8 @@ class SessionRestoreImpl : public content::NotificationObserver {
     // Set up the file access rights for the selected navigation entry.
     const int id = web_contents->GetRenderProcessHost()->GetID();
     const content::PageState& page_state =
-        tab.navigations.at(selected_index).page_state();
+        content::PageState::CreateFromEncodedData(
+            tab.navigations.at(selected_index).encoded_page_state());
     const std::vector<base::FilePath>& file_paths =
         page_state.GetReferencedFiles();
     for (std::vector<base::FilePath>::const_iterator file = file_paths.begin();

chrome/browser/sessions/session_service_unittest.cc

@@ -822,7 +822,8 @@ TEST_F(SessionServiceTest, RemovePostDataWithPasswords) {
 
   // Expected: the HTTP body was removed from the page state of the POST
   // navigation with passwords.
-  EXPECT_NE(page_state, windows[0]->tabs[0]->navigations[0].page_state());
+  EXPECT_NE(page_state.ToEncodedData(),
+            windows[0]->tabs[0]->navigations[0].encoded_page_state());
 }
 
 // This test is only applicable to chromeos.

chrome/browser/sessions/session_types_unittest.cc

@@ -64,7 +64,7 @@ TEST(SessionTab, FromSyncData) {
   ASSERT_EQ(5u, tab.navigations.size());
   for (int i = 0; i < 5; ++i) {
     EXPECT_EQ(i, tab.navigations[i].index());
-    EXPECT_EQ(GURL("referrer"), tab.navigations[i].referrer().url);
+    EXPECT_EQ(GURL("referrer"), tab.navigations[i].referrer_url());
     EXPECT_EQ(base::ASCIIToUTF16("title"),tab.navigations[i].title());
     EXPECT_EQ(ui::PAGE_TRANSITION_TYPED,
               tab.navigations[i].transition_type());

chrome/browser/sync/glue/session_sync_test_helper.cc

@@ -82,7 +82,7 @@ void SessionSyncTestHelper::VerifySyncedSession(
       ASSERT_EQ(kAppId, tab->extension_app_id);
       ASSERT_EQ(1U, tab->navigations.size());
       ASSERT_EQ(tab->navigations[0].virtual_url(), GURL(kVirtualUrl));
-      ASSERT_EQ(tab->navigations[0].referrer().url, GURL(kReferrer));
+      ASSERT_EQ(tab->navigations[0].referrer_url(), GURL(kReferrer));
       ASSERT_EQ(tab->navigations[0].title(),
                 base::ASCIIToUTF16(kTitle));
       ASSERT_EQ(tab->navigations[0].transition_type(),

chrome/browser/sync/test/integration/sessions_helper.cc

@@ -289,11 +289,11 @@ bool NavigationEquals(const sessions::SerializedNavigationEntry& expected,
                << ", actual " << actual.virtual_url();
     return false;
   }
-  if (expected.referrer().url != actual.referrer().url) {
+  if (expected.referrer_url() != actual.referrer_url()) {
     LOG(ERROR) << "Expected referrer "
-               << expected.referrer().url
+               << expected.referrer_url()
                << ", actual "
-               << actual.referrer().url;
+               << actual.referrer_url();
     return false;
   }
   if (expected.title() != actual.title()) {

chrome/browser/ui/browser_commands.cc

@@ -70,6 +70,7 @@
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents.h"
+#include "content/public/common/page_state.h"
 #include "content/public/common/renderer_preferences.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/common/url_utils.h"

components/sessions/serialized_navigation_entry.cc

@@ -9,6 +9,8 @@
 #include "content/public/browser/favicon_status.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/navigation_entry.h"
+#include "content/public/common/page_state.h"
+#include "content/public/common/referrer.h"
 #include "sync/protocol/session_specifics.pb.h"
 #include "sync/util/time.h"
 #include "third_party/WebKit/public/platform/WebReferrerPolicy.h"
@@ -28,7 +30,9 @@ SerializedNavigationEntry::SerializedNavigationEntry()
       is_overriding_user_agent_(false),
       http_status_code_(0),
       is_restored_(false),
-      blocked_state_(STATE_INVALID) {}
+      blocked_state_(STATE_INVALID) {
+  referrer_policy_ = GetDefaultReferrerPolicy();
+}
 
 SerializedNavigationEntry::~SerializedNavigationEntry() {}
 
@@ -39,10 +43,11 @@ SerializedNavigationEntry SerializedNavigationEntry::FromNavigationEntry(
   SerializedNavigationEntry navigation;
   navigation.index_ = index;
   navigation.unique_id_ = entry.GetUniqueID();
-  navigation.referrer_ = entry.GetReferrer();
+  navigation.referrer_url_ = entry.GetReferrer().url;
+  navigation.referrer_policy_ = entry.GetReferrer().policy;
   navigation.virtual_url_ = entry.GetVirtualURL();
   navigation.title_ = entry.GetTitle();
-  navigation.page_state_ = entry.GetPageState();
+  navigation.encoded_page_state_ = entry.GetPageState().ToEncodedData();
   navigation.transition_type_ = entry.GetTransitionType();
   navigation.has_post_data_ = entry.GetHasPostData();
   navigation.post_id_ = entry.GetPostID();
@@ -68,13 +73,11 @@ SerializedNavigationEntry SerializedNavigationEntry::FromSyncData(
   SerializedNavigationEntry navigation;
   navigation.index_ = index;
   navigation.unique_id_ = sync_data.unique_id();
-  navigation.referrer_ = content::Referrer(
-      GURL(sync_data.referrer()),
-      static_cast<blink::WebReferrerPolicy>(sync_data.referrer_policy()));
+  navigation.referrer_url_ = GURL(sync_data.referrer());
+  navigation.referrer_policy_ = sync_data.referrer_policy();
   navigation.virtual_url_ = GURL(sync_data.virtual_url());
   navigation.title_ = base::UTF8ToUTF16(sync_data.title());
-  navigation.page_state_ =
-      content::PageState::CreateFromEncodedData(sync_data.state());
+  navigation.encoded_page_state_ = sync_data.state();
 
   uint32 transition = 0;
   if (sync_data.has_page_transition()) {
@@ -210,13 +213,14 @@ enum TypeMask {
 // index_
 // virtual_url_
 // title_
-// page_state_
+// encoded_page_state_
 // transition_type_
 //
 // Added on later:
 //
 // type_mask (has_post_data_)
-// referrer_
+// referrer_url_
+// referrer_policy_
 // original_request_url_
 // is_overriding_user_agent_
 // timestamp_
@@ -234,12 +238,8 @@ void SerializedNavigationEntry::WriteToPickle(int max_size,
 
   WriteString16ToPickle(pickle, &bytes_written, max_size, title_);
 
-  content::PageState page_state = page_state_;
-  if (has_post_data_)
-    page_state = page_state.RemovePasswordData();
-
-  WriteStringToPickle(pickle, &bytes_written, max_size,
-                      page_state.ToEncodedData());
+  const std::string encoded_page_state = GetSanitizedPageStateForPickle();
+  WriteStringToPickle(pickle, &bytes_written, max_size, encoded_page_state);
 
   pickle->WriteInt(transition_type_);
 
@@ -248,9 +248,9 @@ void SerializedNavigationEntry::WriteToPickle(int max_size,
 
   WriteStringToPickle(
       pickle, &bytes_written, max_size,
-      referrer_.url.is_valid() ? referrer_.url.spec() : std::string());
+      referrer_url_.is_valid() ? referrer_url_.spec() : std::string());
 
-  pickle->WriteInt(referrer_.policy);
+  pickle->WriteInt(referrer_policy_);
 
   // Save info required to override the user agent.
   WriteStringToPickle(
@@ -267,16 +267,15 @@ void SerializedNavigationEntry::WriteToPickle(int max_size,
 
 bool SerializedNavigationEntry::ReadFromPickle(PickleIterator* iterator) {
   *this = SerializedNavigationEntry();
-  std::string virtual_url_spec, page_state_data;
+  std::string virtual_url_spec;
   int transition_type_int = 0;
   if (!iterator->ReadInt(&index_) ||
       !iterator->ReadString(&virtual_url_spec) ||
       !iterator->ReadString16(&title_) ||
-      !iterator->ReadString(&page_state_data) ||
+      !iterator->ReadString(&encoded_page_state_) ||
       !iterator->ReadInt(&transition_type_int))
     return false;
   virtual_url_ = GURL(virtual_url_spec);
-  page_state_ = content::PageState::CreateFromEncodedData(page_state_data);
   transition_type_ = ui::PageTransitionFromInt(transition_type_int);
 
   // type_mask did not always exist in the written stream. As such, we
@@ -291,15 +290,12 @@ bool SerializedNavigationEntry::ReadFromPickle(PickleIterator* iterator) {
     std::string referrer_spec;
     if (!iterator->ReadString(&referrer_spec))
       referrer_spec = std::string();
+    referrer_url_ = GURL(referrer_spec);
+
     // The "referrer policy" property was added even later, so we fall back to
     // the default policy if the property is not present.
-    int policy_int;
-    blink::WebReferrerPolicy policy;
-    if (iterator->ReadInt(&policy_int))
-      policy = static_cast<blink::WebReferrerPolicy>(policy_int);
-    else
-      policy = blink::WebReferrerPolicyDefault;
-    referrer_ = content::Referrer(GURL(referrer_spec), policy);
+    if (!iterator->ReadInt(&referrer_policy_))
+      referrer_policy_ = GetDefaultReferrerPolicy();
 
     // If the original URL can't be found, leave it empty.
     std::string original_request_url_spec;
@@ -339,7 +335,9 @@ scoped_ptr<NavigationEntry> SerializedNavigationEntry::ToNavigationEntry(
   scoped_ptr<NavigationEntry> entry(
       content::NavigationController::CreateNavigationEntry(
           virtual_url_,
-          referrer_,
+          content::Referrer(
+              referrer_url_,
+              static_cast<blink::WebReferrerPolicy>(referrer_policy_)),
           // Use a transition type of reload so that we don't incorrectly
           // increase the typed count.
           ui::PAGE_TRANSITION_RELOAD,
@@ -349,7 +347,8 @@ scoped_ptr<NavigationEntry> SerializedNavigationEntry::ToNavigationEntry(
           browser_context));
 
   entry->SetTitle(title_);
-  entry->SetPageState(page_state_);
+  entry->SetPageState(
+      content::PageState::CreateFromEncodedData(encoded_page_state_));
   entry->SetPageID(page_id);
   entry->SetHasPostData(has_post_data_);
   entry->SetPostID(post_id_);
@@ -372,8 +371,8 @@ scoped_ptr<NavigationEntry> SerializedNavigationEntry::ToNavigationEntry(
 sync_pb::TabNavigation SerializedNavigationEntry::ToSyncData() const {
   sync_pb::TabNavigation sync_data;
   sync_data.set_virtual_url(virtual_url_.spec());
-  sync_data.set_referrer(referrer_.url.spec());
-  sync_data.set_referrer_policy(referrer_.policy);
+  sync_data.set_referrer(referrer_url_.spec());
+  sync_data.set_referrer_policy(referrer_policy_);
   sync_data.set_title(base::UTF16ToUTF8(title_));
 
   // Page transition core.
@@ -509,16 +508,42 @@ std::vector<NavigationEntry*> SerializedNavigationEntry::ToNavigationEntries(
   return entries;
 }
 
+// TODO(rohitrao): Move this content-specific code into a
+// SerializedNavigationEntryHelper class.
+int SerializedNavigationEntry::GetDefaultReferrerPolicy() const {
+  return blink::WebReferrerPolicyDefault;
+}
+
+// TODO(rohitrao): Move this content-specific code into a
+// SerializedNavigationEntryHelper class.
+std::string SerializedNavigationEntry::GetSanitizedPageStateForPickle() const {
+  content::PageState page_state =
+      content::PageState::CreateFromEncodedData(encoded_page_state_);
+  if (has_post_data_)
+    page_state = page_state.RemovePasswordData();
+
+  return page_state.ToEncodedData();
+}
+
+// TODO(rohitrao): Move this content-specific code into a
+// SerializedNavigationEntryHelper class.
 void SerializedNavigationEntry::Sanitize() {
+  content::Referrer old_referrer(
+      referrer_url_,
+      static_cast<blink::WebReferrerPolicy>(referrer_policy_));
   content::Referrer new_referrer =
-      content::Referrer::SanitizeForRequest(virtual_url_, referrer_);
+      content::Referrer::SanitizeForRequest(virtual_url_, old_referrer);
 
   // No need to compare the policy, as it doesn't change during
   // sanitization. If there has been a change, the referrer needs to be
   // stripped from the page state as well.
-  if (referrer_.url != new_referrer.url) {
-    referrer_ = content::Referrer();
-    page_state_ = page_state_.RemoveReferrer();
+  if (referrer_url_ != new_referrer.url) {
+    referrer_url_ = GURL();
+    referrer_policy_ = GetDefaultReferrerPolicy();
+    encoded_page_state_ =
+        content::PageState::CreateFromEncodedData(encoded_page_state_)
+            .RemoveReferrer()
+            .ToEncodedData();
   }
 }
 

components/sessions/serialized_navigation_entry.h

@@ -14,8 +14,6 @@
 #include "base/strings/string16.h"
 #include "base/time/time.h"
 #include "components/sessions/sessions_export.h"
-#include "content/public/common/page_state.h"
-#include "content/public/common/referrer.h"
 #include "ui/base/page_transition_types.h"
 #include "url/gurl.h"
 
@@ -97,11 +95,12 @@ class SESSIONS_EXPORT SerializedNavigationEntry {
   int unique_id() const { return unique_id_; }
   const GURL& virtual_url() const { return virtual_url_; }
   const base::string16& title() const { return title_; }
-  const content::PageState& page_state() const { return page_state_; }
+  const std::string& encoded_page_state() const { return encoded_page_state_; }
   const base::string16& search_terms() const { return search_terms_; }
   const GURL& favicon_url() const { return favicon_url_; }
   int http_status_code() const { return http_status_code_; }
-  const content::Referrer& referrer() const { return referrer_; }
+  const GURL& referrer_url() const { return referrer_url_; }
+  int referrer_policy() const { return referrer_policy_; }
   ui::PageTransition transition_type() const {
     return transition_type_;
   }
@@ -134,6 +133,13 @@ class SESSIONS_EXPORT SerializedNavigationEntry {
  private:
   friend class SerializedNavigationEntryTestHelper;
 
+  // Returns the default referrer policy.
+  int GetDefaultReferrerPolicy() const;
+
+  // Returns a sanitized version of |encoded_page_state_| suitable for writing
+  // to disk.
+  std::string GetSanitizedPageStateForPickle() const;
+
   // Sanitizes the data in this class to be more robust against faulty data
   // written by older versions.
   void Sanitize();
@@ -143,10 +149,11 @@ class SESSIONS_EXPORT SerializedNavigationEntry {
 
   // Member variables corresponding to NavigationEntry fields.
   int unique_id_;
-  content::Referrer referrer_;
+  GURL referrer_url_;
+  int referrer_policy_;
   GURL virtual_url_;
   base::string16 title_;
-  content::PageState page_state_;
+  std::string encoded_page_state_;
   ui::PageTransition transition_type_;
   bool has_post_data_;
   int64 post_id_;

components/sessions/serialized_navigation_entry_test_helper.cc

@@ -7,6 +7,7 @@
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "components/sessions/serialized_navigation_entry.h"
+#include "content/public/common/page_state.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/WebKit/public/platform/WebReferrerPolicy.h"
 #include "url/gurl.h"
@@ -17,11 +18,11 @@ namespace sessions {
 void SerializedNavigationEntryTestHelper::ExpectNavigationEquals(
     const SerializedNavigationEntry& expected,
     const SerializedNavigationEntry& actual) {
-  EXPECT_EQ(expected.referrer_.url, actual.referrer_.url);
-  EXPECT_EQ(expected.referrer_.policy, actual.referrer_.policy);
+  EXPECT_EQ(expected.referrer_url_, actual.referrer_url_);
+  EXPECT_EQ(expected.referrer_policy_, actual.referrer_policy_);
   EXPECT_EQ(expected.virtual_url_, actual.virtual_url_);
   EXPECT_EQ(expected.title_, actual.title_);
-  EXPECT_EQ(expected.page_state_, actual.page_state_);
+  EXPECT_EQ(expected.encoded_page_state_, actual.encoded_page_state_);
   EXPECT_EQ(expected.transition_type_, actual.transition_type_);
   EXPECT_EQ(expected.has_post_data_, actual.has_post_data_);
   EXPECT_EQ(expected.original_request_url_, actual.original_request_url_);
@@ -35,13 +36,11 @@ SerializedNavigationEntry SerializedNavigationEntryTestHelper::CreateNavigation(
     const std::string& title) {
   SerializedNavigationEntry navigation;
   navigation.index_ = 0;
-  navigation.referrer_ =
-      content::Referrer(GURL("http://www.referrer.com"),
-                        blink::WebReferrerPolicyDefault);
+  navigation.referrer_url_ = GURL("http://www.referrer.com");
+  navigation.referrer_policy_ = blink::WebReferrerPolicyDefault;
   navigation.virtual_url_ = GURL(virtual_url);
   navigation.title_ = base::UTF8ToUTF16(title);
-  navigation.page_state_ =
-      content::PageState::CreateFromEncodedData("fake_state");
+  navigation.encoded_page_state_ = "fake state";
   navigation.timestamp_ = base::Time::Now();
   navigation.http_status_code_ = 200;
   return navigation;
@@ -51,7 +50,7 @@ SerializedNavigationEntry SerializedNavigationEntryTestHelper::CreateNavigation(
 void SerializedNavigationEntryTestHelper::SetPageState(
     const content::PageState& page_state,
     SerializedNavigationEntry* navigation) {
-  navigation->page_state_ = page_state;
+  navigation->encoded_page_state_ = page_state.ToEncodedData();
 }
 
 // static