blob: 066cec7dfc54d7f2799fd710eab160a11a01328b [file] [log] [blame]
/*
* Copyright (C) 2019-2020 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. AND ITS CONTRIBUTORS ``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 ITS 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.
*/
#pragma once
#if ENABLE(RESOURCE_LOAD_STATISTICS)
#include "RegistrableDomain.h"
#include "Supplementable.h"
#include <wtf/Optional.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class DeferredPromise;
class Document;
class UserGestureIndicator;
enum class StorageAccessWasGranted : bool {
No,
Yes
};
enum class StorageAccessPromptWasShown : bool {
No,
Yes
};
enum class StorageAccessScope : bool {
PerFrame,
PerPage
};
enum class StorageAccessQuickResult : bool {
Grant,
Reject
};
struct RequestStorageAccessResult {
StorageAccessWasGranted wasGranted;
StorageAccessPromptWasShown promptWasShown;
StorageAccessScope scope;
RegistrableDomain topFrameDomain;
RegistrableDomain subFrameDomain;
template<class Encoder> void encode(Encoder&) const;
template<class Decoder> static Optional<RequestStorageAccessResult> decode(Decoder&);
};
const unsigned maxNumberOfTimesExplicitlyDeniedFrameSpecificStorageAccess = 2;
class DocumentStorageAccess final : public Supplement<Document>, public CanMakeWeakPtr<DocumentStorageAccess> {
WTF_MAKE_FAST_ALLOCATED;
public:
explicit DocumentStorageAccess(Document&);
~DocumentStorageAccess();
static void hasStorageAccess(Document&, Ref<DeferredPromise>&&);
static bool hasStorageAccessForDocumentQuirk(Document&);
static void requestStorageAccess(Document&, Ref<DeferredPromise>&&);
static void requestStorageAccessForDocumentQuirk(Document&, CompletionHandler<void(StorageAccessWasGranted)>&&);
static void requestStorageAccessForNonDocumentQuirk(Document& hostingDocument, RegistrableDomain&& requestingDomain, CompletionHandler<void(StorageAccessWasGranted)>&&);
private:
Optional<bool> hasStorageAccessQuickCheck();
void hasStorageAccess(Ref<DeferredPromise>&&);
bool hasStorageAccessQuirk();
Optional<StorageAccessQuickResult> requestStorageAccessQuickCheck();
void requestStorageAccess(Ref<DeferredPromise>&&);
void requestStorageAccessForDocumentQuirk(CompletionHandler<void(StorageAccessWasGranted)>&&);
void requestStorageAccessForNonDocumentQuirk(RegistrableDomain&& requestingDomain, CompletionHandler<void(StorageAccessWasGranted)>&&);
void requestStorageAccessQuirk(RegistrableDomain&& requestingDomain, CompletionHandler<void(StorageAccessWasGranted)>&&);
static DocumentStorageAccess* from(Document&);
static const char* supplementName();
bool hasFrameSpecificStorageAccess() const;
void setWasExplicitlyDeniedFrameSpecificStorageAccess() { ++m_numberOfTimesExplicitlyDeniedFrameSpecificStorageAccess; };
bool isAllowedToRequestFrameSpecificStorageAccess() { return m_numberOfTimesExplicitlyDeniedFrameSpecificStorageAccess < maxNumberOfTimesExplicitlyDeniedFrameSpecificStorageAccess; };
void enableTemporaryTimeUserGesture();
void consumeTemporaryTimeUserGesture();
std::unique_ptr<UserGestureIndicator> m_temporaryUserGesture;
Document& m_document;
uint8_t m_numberOfTimesExplicitlyDeniedFrameSpecificStorageAccess = 0;
StorageAccessScope m_storageAccessScope = StorageAccessScope::PerFrame;
};
template<class Encoder>
void RequestStorageAccessResult::encode(Encoder& encoder) const
{
encoder << wasGranted << promptWasShown << scope << topFrameDomain << subFrameDomain;
}
template<class Decoder>
Optional<RequestStorageAccessResult> RequestStorageAccessResult::decode(Decoder& decoder)
{
Optional<StorageAccessWasGranted> wasGranted;
decoder >> wasGranted;
if (!wasGranted)
return WTF::nullopt;
Optional<StorageAccessPromptWasShown> promptWasShown;
decoder >> promptWasShown;
if (!promptWasShown)
return WTF::nullopt;
Optional<StorageAccessScope> scope;
decoder >> scope;
if (!scope)
return WTF::nullopt;
Optional<RegistrableDomain> topFrameDomain;
decoder >> topFrameDomain;
if (!topFrameDomain)
return WTF::nullopt;
Optional<RegistrableDomain> subFrameDomain;
decoder >> subFrameDomain;
if (!subFrameDomain)
return WTF::nullopt;
return { { WTFMove(*wasGranted), WTFMove(*promptWasShown), WTFMove(*scope), WTFMove(*topFrameDomain), WTFMove(*subFrameDomain) } };
}
} // namespace WebCore
#endif // ENABLE(RESOURCE_LOAD_STATISTICS)