chromium/src/third_party/blink/renderer/modules/storage/storage_area.cc - manifest_repos/chromium_src - Git at Google

 /*
  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */

 #include "third_party/blink/renderer/modules/storage/storage_area.h"

 #include "base/feature_list.h"
 #include "base/memory/scoped_refptr.h"
 #include "base/metrics/histogram_macros.h"
 #include "third_party/blink/public/common/action_after_pagehide.h"
 #include "third_party/blink/public/common/features.h"
 #include "third_party/blink/public/platform/task_type.h"
 #include "third_party/blink/renderer/core/dom/document.h"
 #include "third_party/blink/renderer/core/frame/local_dom_window.h"
 #include "third_party/blink/renderer/modules/storage/dom_window_storage.h"
 #include "third_party/blink/renderer/modules/storage/inspector_dom_storage_agent.h"
 #include "third_party/blink/renderer/modules/storage/storage_controller.h"
 #include "third_party/blink/renderer/modules/storage/storage_event.h"
 #include "third_party/blink/renderer/modules/storage/storage_namespace.h"
 #include "third_party/blink/renderer/platform/bindings/exception_state.h"
 #include "third_party/blink/renderer/platform/weborigin/security_origin.h"
 #include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"

 namespace blink {

 StorageArea* StorageArea::Create(LocalDOMWindow* window,
                                  scoped_refptr<CachedStorageArea> storage_area,
                                  StorageType storage_type) {
   return MakeGarbageCollected<StorageArea>(window, std::move(storage_area),
                                            storage_type,
                                            /* should_enqueue_events */ true);
 }

 StorageArea* StorageArea::CreateForInspectorAgent(
     LocalDOMWindow* window,
     scoped_refptr<CachedStorageArea> storage_area,
     StorageType storage_type) {
   return MakeGarbageCollected<StorageArea>(window, std::move(storage_area),
                                            storage_type,
                                            /* should_enqueue_events */ false);
 }

 StorageArea::StorageArea(LocalDOMWindow* window,
                          scoped_refptr<CachedStorageArea> storage_area,
                          StorageType storage_type,
                          bool should_enqueue_events)
     : ExecutionContextClient(window),
       cached_area_(std::move(storage_area)),
       storage_type_(storage_type),
       should_enqueue_events_(should_enqueue_events) {
   DCHECK(window);
   DCHECK(cached_area_);
   cached_area_->RegisterSource(this);
 }

 unsigned StorageArea::length(ExceptionState& exception_state) const {
   if (!CanAccessStorage()) {
     exception_state.ThrowSecurityError("access is denied for this document.");
     return 0;
   }
   return cached_area_->GetLength();
 }

 String StorageArea::key(unsigned index, ExceptionState& exception_state) const {
   if (!CanAccessStorage()) {
     exception_state.ThrowSecurityError("access is denied for this document.");
     return String();
   }
   return cached_area_->GetKey(index);
 }

 String StorageArea::getItem(const String& key,
                             ExceptionState& exception_state) const {
   if (!CanAccessStorage()) {
     exception_state.ThrowSecurityError("access is denied for this document.");
     return String();
   }
   return cached_area_->GetItem(key);
 }

 NamedPropertySetterResult StorageArea::setItem(
     const String& key,
     const String& value,
     ExceptionState& exception_state) {
   if (!CanAccessStorage()) {
     exception_state.ThrowSecurityError("access is denied for this document.");
     return NamedPropertySetterResult::kIntercepted;
   }
   if (!cached_area_->SetItem(key, value, this)) {
     exception_state.ThrowDOMException(
         DOMExceptionCode::kQuotaExceededError,
         "Setting the value of '" + key + "' exceeded the quota.");
     return NamedPropertySetterResult::kIntercepted;
   }
   RecordModificationInMetrics();
   return NamedPropertySetterResult::kIntercepted;
 }

 NamedPropertyDeleterResult StorageArea::removeItem(
     const String& key,
     ExceptionState& exception_state) {
   if (!CanAccessStorage()) {
     exception_state.ThrowSecurityError("access is denied for this document.");
     return NamedPropertyDeleterResult::kDidNotDelete;
   }
   RecordModificationInMetrics();
   cached_area_->RemoveItem(key, this);
   return NamedPropertyDeleterResult::kDeleted;
 }

 void StorageArea::clear(ExceptionState& exception_state) {
   if (!CanAccessStorage()) {
     exception_state.ThrowSecurityError("access is denied for this document.");
     return;
   }
   RecordModificationInMetrics();
   cached_area_->Clear(this);
 }

 bool StorageArea::Contains(const String& key,
                            ExceptionState& exception_state) const {
   if (!CanAccessStorage()) {
     exception_state.ThrowSecurityError("access is denied for this document.");
     return false;
   }
   return !cached_area_->GetItem(key).IsNull();
 }

 void StorageArea::NamedPropertyEnumerator(Vector<String>& names,
                                           ExceptionState& exception_state) {
   unsigned length = this->length(exception_state);
   if (exception_state.HadException())
     return;
   names.resize(length);
   for (unsigned i = 0; i < length; ++i) {
     String key = this->key(i, exception_state);
     if (exception_state.HadException())
       return;
     DCHECK(!key.IsNull());
     String val = getItem(key, exception_state);
     if (exception_state.HadException())
       return;
     names[i] = key;
   }
 }

 bool StorageArea::NamedPropertyQuery(const AtomicString& name,
                                      ExceptionState& exception_state) {
   if (name == "length")
     return false;
   bool found = Contains(name, exception_state);
   return found && !exception_state.HadException();
 }

 void StorageArea::Trace(Visitor* visitor) const {
   ScriptWrappable::Trace(visitor);
   ExecutionContextClient::Trace(visitor);
 }

 bool StorageArea::CanAccessStorage() const {
   if (!DomWindow())
     return false;

   if (did_check_can_access_storage_)
     return can_access_storage_cached_result_;
   can_access_storage_cached_result_ = StorageController::CanAccessStorageArea(
       DomWindow()->GetFrame(), storage_type_);
   did_check_can_access_storage_ = true;
   return can_access_storage_cached_result_;
 }

 void StorageArea::RecordModificationInMetrics() {
   TRACE_EVENT0("blink", "StorageArea::RecordModificationInMetrics");
   if (!DomWindow() ||
       !DomWindow()->GetFrame()->GetPage()->DispatchedPagehideAndStillHidden()) {
     return;
   }
   // The storage modification is done after the pagehide event got dispatched
   // and the page is still hidden, which is not normally possible (this might
   // happen if we're doing a same-site cross-RenderFrame navigation where we
   // dispatch pagehide during the new RenderFrame's commit but won't actually
   // unload/freeze the page after the new RenderFrame finished committing). We
   // should track this case to measure how often this is happening, except for
   // when the unload event is currently in progress, which means the page is not
   // actually stored in the back-forward cache and this behavior is ok.
   if (DomWindow()->document() &&
       DomWindow()->document()->UnloadEventInProgress()) {
     return;
   }
   UMA_HISTOGRAM_ENUMERATION(
       "BackForwardCache.SameSite.ActionAfterPagehide2",
       storage_type_ == StorageType::kLocalStorage
           ? ActionAfterPagehide::kLocalStorageModification
           : ActionAfterPagehide::kSessionStorageModification);
 }

 KURL StorageArea::GetPageUrl() const {
   return DomWindow() ? DomWindow()->Url() : KURL();
 }

 bool StorageArea::EnqueueStorageEvent(const String& key,
                                       const String& old_value,
                                       const String& new_value,
                                       const String& url) {
   if (!should_enqueue_events_)
     return true;
   if (!DomWindow())
     return false;
   DomWindow()->EnqueueWindowEvent(
       *StorageEvent::Create(event_type_names::kStorage, key, old_value,
                             new_value, url, this),
       TaskType::kDOMManipulation);
   return true;
 }

 blink::WebScopedVirtualTimePauser StorageArea::CreateWebScopedVirtualTimePauser(
     const char* name,
     WebScopedVirtualTimePauser::VirtualTaskDuration duration) {
   if (!DomWindow())
     return blink::WebScopedVirtualTimePauser();
   return DomWindow()
       ->GetFrame()
       ->GetFrameScheduler()
       ->CreateWebScopedVirtualTimePauser(name, duration);
 }

 }  // namespace blink
	/*
	* Copyright (C) 2008 Apple Inc. All Rights Reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in the
	* documentation and/or other materials provided with the distribution.
	*
	* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
	* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
	* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
	* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
	* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#include "third_party/blink/renderer/modules/storage/storage_area.h"

	#include "base/feature_list.h"
	#include "base/memory/scoped_refptr.h"
	#include "base/metrics/histogram_macros.h"
	#include "third_party/blink/public/common/action_after_pagehide.h"
	#include "third_party/blink/public/common/features.h"
	#include "third_party/blink/public/platform/task_type.h"
	#include "third_party/blink/renderer/core/dom/document.h"
	#include "third_party/blink/renderer/core/frame/local_dom_window.h"
	#include "third_party/blink/renderer/modules/storage/dom_window_storage.h"
	#include "third_party/blink/renderer/modules/storage/inspector_dom_storage_agent.h"
	#include "third_party/blink/renderer/modules/storage/storage_controller.h"
	#include "third_party/blink/renderer/modules/storage/storage_event.h"
	#include "third_party/blink/renderer/modules/storage/storage_namespace.h"
	#include "third_party/blink/renderer/platform/bindings/exception_state.h"
	#include "third_party/blink/renderer/platform/weborigin/security_origin.h"
	#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"

	namespace blink {

	StorageArea* StorageArea::Create(LocalDOMWindow* window,
	scoped_refptr<CachedStorageArea> storage_area,
	StorageType storage_type) {
	return MakeGarbageCollected<StorageArea>(window, std::move(storage_area),
	storage_type,
	/* should_enqueue_events */ true);
	}

	StorageArea* StorageArea::CreateForInspectorAgent(
	LocalDOMWindow* window,
	scoped_refptr<CachedStorageArea> storage_area,
	StorageType storage_type) {
	return MakeGarbageCollected<StorageArea>(window, std::move(storage_area),
	storage_type,
	/* should_enqueue_events */ false);
	}

	StorageArea::StorageArea(LocalDOMWindow* window,
	scoped_refptr<CachedStorageArea> storage_area,
	StorageType storage_type,
	bool should_enqueue_events)
	: ExecutionContextClient(window),
	cached_area_(std::move(storage_area)),
	storage_type_(storage_type),
	should_enqueue_events_(should_enqueue_events) {
	DCHECK(window);
	DCHECK(cached_area_);
	cached_area_->RegisterSource(this);
	}

	unsigned StorageArea::length(ExceptionState& exception_state) const {
	if (!CanAccessStorage()) {
	exception_state.ThrowSecurityError("access is denied for this document.");
	return 0;
	}
	return cached_area_->GetLength();
	}

	String StorageArea::key(unsigned index, ExceptionState& exception_state) const {
	if (!CanAccessStorage()) {
	exception_state.ThrowSecurityError("access is denied for this document.");
	return String();
	}
	return cached_area_->GetKey(index);
	}

	String StorageArea::getItem(const String& key,
	ExceptionState& exception_state) const {
	if (!CanAccessStorage()) {
	exception_state.ThrowSecurityError("access is denied for this document.");
	return String();
	}
	return cached_area_->GetItem(key);
	}

	NamedPropertySetterResult StorageArea::setItem(
	const String& key,
	const String& value,
	ExceptionState& exception_state) {
	if (!CanAccessStorage()) {
	exception_state.ThrowSecurityError("access is denied for this document.");
	return NamedPropertySetterResult::kIntercepted;
	}
	if (!cached_area_->SetItem(key, value, this)) {
	exception_state.ThrowDOMException(
	DOMExceptionCode::kQuotaExceededError,
	"Setting the value of '" + key + "' exceeded the quota.");
	return NamedPropertySetterResult::kIntercepted;
	}
	RecordModificationInMetrics();
	return NamedPropertySetterResult::kIntercepted;
	}

	NamedPropertyDeleterResult StorageArea::removeItem(
	const String& key,
	ExceptionState& exception_state) {
	if (!CanAccessStorage()) {
	exception_state.ThrowSecurityError("access is denied for this document.");
	return NamedPropertyDeleterResult::kDidNotDelete;
	}
	RecordModificationInMetrics();
	cached_area_->RemoveItem(key, this);
	return NamedPropertyDeleterResult::kDeleted;
	}

	void StorageArea::clear(ExceptionState& exception_state) {
	if (!CanAccessStorage()) {
	exception_state.ThrowSecurityError("access is denied for this document.");
	return;
	}
	RecordModificationInMetrics();
	cached_area_->Clear(this);
	}

	bool StorageArea::Contains(const String& key,
	ExceptionState& exception_state) const {
	if (!CanAccessStorage()) {
	exception_state.ThrowSecurityError("access is denied for this document.");
	return false;
	}
	return !cached_area_->GetItem(key).IsNull();
	}

	void StorageArea::NamedPropertyEnumerator(Vector<String>& names,
	ExceptionState& exception_state) {
	unsigned length = this->length(exception_state);
	if (exception_state.HadException())
	return;
	names.resize(length);
	for (unsigned i = 0; i < length; ++i) {
	String key = this->key(i, exception_state);
	if (exception_state.HadException())
	return;
	DCHECK(!key.IsNull());
	String val = getItem(key, exception_state);
	if (exception_state.HadException())
	return;
	names[i] = key;
	}
	}

	bool StorageArea::NamedPropertyQuery(const AtomicString& name,
	ExceptionState& exception_state) {
	if (name == "length")
	return false;
	bool found = Contains(name, exception_state);
	return found && !exception_state.HadException();
	}

	void StorageArea::Trace(Visitor* visitor) const {
	ScriptWrappable::Trace(visitor);
	ExecutionContextClient::Trace(visitor);
	}

	bool StorageArea::CanAccessStorage() const {
	if (!DomWindow())
	return false;

	if (did_check_can_access_storage_)
	return can_access_storage_cached_result_;
	can_access_storage_cached_result_ = StorageController::CanAccessStorageArea(
	DomWindow()->GetFrame(), storage_type_);
	did_check_can_access_storage_ = true;
	return can_access_storage_cached_result_;
	}

	void StorageArea::RecordModificationInMetrics() {
	TRACE_EVENT0("blink", "StorageArea::RecordModificationInMetrics");
	if (!DomWindow() \|\|
	!DomWindow()->GetFrame()->GetPage()->DispatchedPagehideAndStillHidden()) {
	return;
	}
	// The storage modification is done after the pagehide event got dispatched
	// and the page is still hidden, which is not normally possible (this might
	// happen if we're doing a same-site cross-RenderFrame navigation where we
	// dispatch pagehide during the new RenderFrame's commit but won't actually
	// unload/freeze the page after the new RenderFrame finished committing). We
	// should track this case to measure how often this is happening, except for
	// when the unload event is currently in progress, which means the page is not
	// actually stored in the back-forward cache and this behavior is ok.
	if (DomWindow()->document() &&
	DomWindow()->document()->UnloadEventInProgress()) {
	return;
	}
	UMA_HISTOGRAM_ENUMERATION(
	"BackForwardCache.SameSite.ActionAfterPagehide2",
	storage_type_ == StorageType::kLocalStorage
	? ActionAfterPagehide::kLocalStorageModification
	: ActionAfterPagehide::kSessionStorageModification);
	}

	KURL StorageArea::GetPageUrl() const {
	return DomWindow() ? DomWindow()->Url() : KURL();
	}

	bool StorageArea::EnqueueStorageEvent(const String& key,
	const String& old_value,
	const String& new_value,
	const String& url) {
	if (!should_enqueue_events_)
	return true;
	if (!DomWindow())
	return false;
	DomWindow()->EnqueueWindowEvent(
	*StorageEvent::Create(event_type_names::kStorage, key, old_value,
	new_value, url, this),
	TaskType::kDOMManipulation);
	return true;
	}

	blink::WebScopedVirtualTimePauser StorageArea::CreateWebScopedVirtualTimePauser(
	const char* name,
	WebScopedVirtualTimePauser::VirtualTaskDuration duration) {
	if (!DomWindow())
	return blink::WebScopedVirtualTimePauser();
	return DomWindow()
	->GetFrame()
	->GetFrameScheduler()
	->CreateWebScopedVirtualTimePauser(name, duration);
	}

	} // namespace blink