[WK2][Cocoa] Implement in-WebProcess cookie cache to avoid sync IPC for document...
[WebKit.git] / Source / WebKit / WebProcess / WebPage / WebCookieJar.h
1 /*
2  * Copyright (C) 2019-2020 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "WebCookieCache.h"
29 #include <WebCore/CookieJar.h>
30
31 namespace WebCore {
32 struct Cookie;
33 }
34
35 namespace WebKit {
36
37 class WebFrame;
38
39 class WebCookieJar final : public WebCore::CookieJar {
40 public:
41     static Ref<WebCookieJar> create() { return adoptRef(*new WebCookieJar); }
42     
43     String cookies(WebCore::Document&, const URL&) const final;
44     void setCookies(WebCore::Document&, const URL&, const String& cookieString) final;
45     bool cookiesEnabled(const WebCore::Document&) const final;
46     std::pair<String, WebCore::SecureCookiesAccessed> cookieRequestHeaderFieldValue(const URL& firstParty, const WebCore::SameSiteInfo&, const URL&, Optional<WebCore::FrameIdentifier>, Optional<WebCore::PageIdentifier>, WebCore::IncludeSecureCookies) const final;
47     bool getRawCookies(const WebCore::Document&, const URL&, Vector<WebCore::Cookie>&) const final;
48     void deleteCookie(const WebCore::Document&, const URL&, const String& cookieName) final;
49
50     void cookiesAdded(const String& host, const Vector<WebCore::Cookie>&);
51     void cookiesDeleted();
52
53 private:
54     WebCookieJar();
55
56     void clearCache() final;
57     void clearCacheForHost(const String&) final;
58     bool isEligibleForCache(WebFrame&, const URL& firstPartyForCookies, const URL& resourceURL) const;
59
60     mutable WebCookieCache m_cache;
61 };
62
63 } // namespace WebKit