Move SessionStorageNamespace entirely into NavigationController and support StoragePartitions.

content/browser/web_contents/navigation_controller_impl.cc

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+ // Copyright (c) 2012 The Chromium Authors. All rights reserved.

[Charlie Reis, 2012/08/02 23:06:47]

Extra space

[awong, 2012/08/03 00:31:04]

Done.

 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "content/browser/web_contents/navigation_controller_impl.h"
 
 #include "base/file_util.h"
 #include "base/logging.h"
 #include "base/string_number_conversions.h"  // Temporary
 #include "base/string_util.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "content/browser/browser_url_handler_impl.h"
 #include "content/browser/child_process_security_policy_impl.h"
 #include "content/browser/dom_storage/dom_storage_context_impl.h"
 #include "content/browser/dom_storage/session_storage_namespace_impl.h"
 #include "content/browser/renderer_host/render_view_host_impl.h"  // Temporary
 #include "content/browser/site_instance_impl.h"
 #include "content/browser/web_contents/debug_urls.h"
 #include "content/browser/web_contents/interstitial_page_impl.h"
 #include "content/browser/web_contents/navigation_entry_impl.h"
 #include "content/browser/web_contents/web_contents_impl.h"
 #include "content/common/view_messages.h"
 #include "content/public/browser/browser_context.h"
+#include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/invalidate_type.h"
 #include "content/public/browser/navigation_details.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents_delegate.h"
+#include "content/public/common/content_client.h"
 #include "content/public/common/content_constants.h"
 #include "content/public/common/url_constants.h"
 #include "net/base/escape.h"
 #include "net/base/mime_util.h"
 #include "net/base/net_util.h"
 #include "webkit/glue/webkit_glue.h"
 
 using content::BrowserContext;
 using content::DOMStorageContext;
+using content::GetContentClient;
 using content::GlobalRequestID;
 using content::NavigationController;
 using content::NavigationEntry;
 using content::NavigationEntryImpl;
 using content::RenderViewHostImpl;
 using content::SessionStorageNamespace;
+using content::SessionStorageNamespaceMap;
 using content::SiteInstance;
 using content::UserMetricsAction;
 using content::WebContents;
 
 namespace {
 
 const int kInvalidateAll = 0xFFFFFFFF;
 
 // Invoked when entries have been pruned, or removed. For example, if the
 // current entries are [google, digg, yahoo], with the current entry google,
@@ skipping 115 matching lines @@
 
 // static
 void NavigationController::DisablePromptOnRepost() {
   g_check_for_repost = false;
 }
 
 }  // namespace content
 
 NavigationControllerImpl::NavigationControllerImpl(
     WebContentsImpl* web_contents,
-    BrowserContext* browser_context,
-    SessionStorageNamespaceImpl* session_storage_namespace)
+    BrowserContext* browser_context)
     : browser_context_(browser_context),
       pending_entry_(NULL),
       last_committed_entry_index_(-1),
       pending_entry_index_(-1),
       transient_entry_index_(-1),
       web_contents_(web_contents),
       max_restored_page_id_(-1),
       ALLOW_THIS_IN_INITIALIZER_LIST(ssl_manager_(this)),
       needs_reload_(false),
-      session_storage_namespace_(session_storage_namespace),
       pending_reload_(NO_RELOAD) {
   DCHECK(browser_context_);
-  if (!session_storage_namespace_) {
-    session_storage_namespace_ = new SessionStorageNamespaceImpl(
-        static_cast<DOMStorageContextImpl*>(
-            BrowserContext::GetDefaultDOMStorageContext(browser_context_)));
-  }
 }
 
 NavigationControllerImpl::~NavigationControllerImpl() {
   DiscardNonCommittedEntriesInternal();
 }
 
 WebContents* NavigationControllerImpl::GetWebContents() const {
   return web_contents_;
 }
 
@@ skipping 914 matching lines @@
       static_cast<const NavigationControllerImpl&>(temp);
   // Verify that we look new.
   DCHECK(GetEntryCount() == 0 && !GetPendingEntry());
 
   if (source.GetEntryCount() == 0)
     return;  // Nothing new to do.
 
   needs_reload_ = true;
   InsertEntriesFrom(source, source.GetEntryCount());
 
-  session_storage_namespace_ = source.session_storage_namespace_->Clone();
+  for (SessionStorageNamespaceMap::const_iterator it =
+           source.session_storage_namespace_map_.begin();
+       it != source.session_storage_namespace_map_.end();
+       ++it) {
+    SessionStorageNamespaceImpl* source_namespace =
+        static_cast<SessionStorageNamespaceImpl*>(it->second.get());
+    session_storage_namespace_map_.insert(
+        make_pair(it->first, source_namespace->Clone()));
+  }
 
   FinishRestore(source.last_committed_entry_index_, false);
 
   // Copy the max page id map from the old tab to the new tab.  This ensures
   // that new and existing navigations in the tab's current SiteInstances
   // are identified properly.
   web_contents_->CopyMaxPageIDsFrom(source.web_contents());
 }
 
 void NavigationControllerImpl::CopyStateFromAndPrune(
@@ skipping 59 matching lines @@
   // that new and existing navigations in the tab's current SiteInstances
   // are identified properly.
   web_contents_->CopyMaxPageIDsFrom(source->web_contents());
 
   // If there is a last committed entry, be sure to include it in the new
   // max page ID map.
   if (max_page_id > -1) {
     web_contents_->UpdateMaxPageIDForSiteInstance(site_instance.get(),
                                                   max_page_id);
   }
+
+  // TODO(ajwong): Do we need to handle SessionStorage here?

[Charlie Reis, 2012/08/02 23:06:47]

I would think so.  We want all the SessionStorageNamespaces for the entries we
just copied over, right?

[awong, 2012/08/03 00:31:04]

I'm actually not sure....the prerenderer and instant versions should have been
created off our web contents should we should have exactly the same session
storage state?  I mean, otherwise, our session storage was broken previously.

[Charlie Reis, 2012/08/03 22:11:28]

Should be easy to check manually, right?  Just set a breakpoint here and see if
the current tab's map already has the namespaces for the newly copied entries.

[awong, 2012/08/04 01:01:32]

At this point, I think I understand instant and prerender enough to know that we
should *not* copy over the session storage map.  On construction, they should
already have the right thing.

Let me address this in the prerender CL. I've added a note on my little
vim-checklist-file and removed this TODO.

 }
 
 void NavigationControllerImpl::PruneAllButActive() {
   if (transient_entry_index_ != -1) {
     // There is a transient entry. Prune up to it.
     DCHECK_EQ(GetEntryCount() - 1, transient_entry_index_);
     entries_.erase(entries_.begin(), entries_.begin() + transient_entry_index_);
     transient_entry_index_ = 0;
     last_committed_entry_index_ = -1;
     pending_entry_index_ = -1;
@@ skipping 21 matching lines @@
 
   if (web_contents_->GetInterstitialPage()) {
     // Normally the interstitial page hides itself if the user doesn't proceeed.
     // This would result in showing a NavigationEntry we just removed. Set this
     // so the interstitial triggers a reload if the user doesn't proceed.
     static_cast<InterstitialPageImpl*>(web_contents_->GetInterstitialPage())->
         set_reload_on_dont_proceed(true);
   }
 }
 
+void NavigationControllerImpl::SetSessionStorageNamespace(
+    const std::string& partition_id,
+    content::SessionStorageNamespace* session_storage_namespace) {
+  if (!session_storage_namespace) {

[Charlie Reis, 2012/08/02 23:06:47]

nit: No braces

[awong, 2012/08/03 00:31:04]

Done.

+    return;
+  }
+
+  // We can't overwrite an existing SessionStorage without violating spec.
+  // Attempts to do so may give a tab access to another tab's session storage
+  // so die hard on an error.
+  bool successful_insert = session_storage_namespace_map_.insert(
+      make_pair(partition_id,
+                static_cast<SessionStorageNamespaceImpl*>(
+                    session_storage_namespace)))
+          .second;
+  CHECK(successful_insert) << "Cannot replace existing SessionStorageNamespace";
+}
+
 void NavigationControllerImpl::SetMaxRestoredPageID(int32 max_id) {
   max_restored_page_id_ = max_id;
 }
 
 int32 NavigationControllerImpl::GetMaxRestoredPageID() const {
   return max_restored_page_id_;
 }
 
 SessionStorageNamespace*
-    NavigationControllerImpl::GetSessionStorageNamespace() const {
-  return session_storage_namespace_;
+NavigationControllerImpl::GetSessionStorageNamespace(int renderer_id) {
+  const std::string& partition_id =
+      GetContentClient()->browser()->GetStoragePartitionIdForChildProcess(
+          browser_context_,
+          renderer_id);
+
+  SessionStorageNamespaceMap::const_iterator it =
+      session_storage_namespace_map_.find(partition_id);
+  if (it != session_storage_namespace_map_.end()) {

[Charlie Reis, 2012/08/02 23:06:47]

nit: No braces

[awong, 2012/08/03 00:31:04]

Done.

+    return it->second.get();
+  }
+
+  // Create one if no one has accessed session storage for this partition yet.
+  SessionStorageNamespaceImpl* session_storage_namespace =
+      new SessionStorageNamespaceImpl(
+          static_cast<DOMStorageContextImpl*>(
+              BrowserContext::GetDOMStorageContext(browser_context_,
+                                                   renderer_id)));
+  session_storage_namespace_map_[partition_id] = session_storage_namespace;
+
+  return session_storage_namespace;
+}
+
+const SessionStorageNamespaceMap&
+NavigationControllerImpl::GetSessionStorageNamespaceMap() const {
+  return session_storage_namespace_map_;
 }
 
 bool NavigationControllerImpl::NeedsReload() const {
   return needs_reload_;
 }
 
 void NavigationControllerImpl::RemoveEntryAtIndexInternal(int index) {
   DCHECK(index < GetEntryCount());
   DCHECK(index != last_committed_entry_index_);
 
@@ skipping 240 matching lines @@
   for (int i = 0; i < max_index; i++) {
     // When cloning a tab, copy all entries except interstitial pages
     if (source.entries_[i].get()->GetPageType() !=
         content::PAGE_TYPE_INTERSTITIAL) {
       entries_.insert(entries_.begin() + insert_index++,
                       linked_ptr<NavigationEntryImpl>(
                           new NavigationEntryImpl(*source.entries_[i])));
     }
   }
 }