Deprecate all WKCookieManagerRef functions
[WebKit-https.git] / Source / WebKit / UIProcess / API / APIHTTPCookieStore.h
1 /*
2  * Copyright (C) 2017 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 "APIObject.h"
29 #include "HTTPCookieAcceptPolicy.h"
30 #include <WebCore/Cookie.h>
31 #include <wtf/CompletionHandler.h>
32 #include <wtf/Forward.h>
33 #include <wtf/HashSet.h>
34
35 namespace WebCore {
36 struct Cookie;
37 #if PLATFORM(COCOA)
38 class CookieStorageObserver;
39 #endif
40 }
41
42 namespace WebKit {
43 class WebCookieManagerProxy;
44 class WebsiteDataStore;
45 enum class HTTPCookieAcceptPolicy : uint8_t;
46 }
47
48 namespace API {
49
50 class APIWebCookieManagerProxyObserver;
51 class WebsiteDataStore;
52
53 class HTTPCookieStore final : public ObjectImpl<Object::Type::HTTPCookieStore> {
54 public:
55     static Ref<HTTPCookieStore> create(WebKit::WebsiteDataStore& websiteDataStore)
56     {
57         return adoptRef(*new HTTPCookieStore(websiteDataStore));
58     }
59
60     virtual ~HTTPCookieStore();
61
62     void cookies(CompletionHandler<void(const Vector<WebCore::Cookie>&)>&&);
63     void setCookies(const Vector<WebCore::Cookie>&, CompletionHandler<void()>&&);
64     void deleteCookie(const WebCore::Cookie&, CompletionHandler<void()>&&);
65     
66     void deleteAllCookies(CompletionHandler<void()>&&);
67     void setHTTPCookieAcceptPolicy(WebKit::HTTPCookieAcceptPolicy, CompletionHandler<void()>&&);
68
69     class Observer {
70     public:
71         virtual ~Observer() { }
72         virtual void cookiesDidChange(HTTPCookieStore&) = 0;
73     };
74
75     void registerObserver(Observer&);
76     void unregisterObserver(Observer&);
77
78     void cookiesDidChange();
79     void cookieManagerDestroyed();
80
81 private:
82     HTTPCookieStore(WebKit::WebsiteDataStore&);
83
84     void registerForNewProcessPoolNotifications();
85     void unregisterForNewProcessPoolNotifications();
86
87     static void flushDefaultUIProcessCookieStore();
88     static Vector<WebCore::Cookie> getAllDefaultUIProcessCookieStoreCookies();
89     static void setCookieInDefaultUIProcessCookieStore(const WebCore::Cookie&);
90     static void deleteCookieFromDefaultUIProcessCookieStore(const WebCore::Cookie&);
91     void startObservingChangesToDefaultUIProcessCookieStore(Function<void()>&&);
92     void stopObservingChangesToDefaultUIProcessCookieStore();
93     void deleteCookiesInDefaultUIProcessCookieStore();
94     void setHTTPCookieAcceptPolicyInDefaultUIProcessCookieStore(WebKit::HTTPCookieAcceptPolicy);
95     
96     // FIXME: This is a reference cycle.
97     Ref<WebKit::WebsiteDataStore> m_owningDataStore;
98     HashSet<Observer*> m_observers;
99
100     WebKit::WebCookieManagerProxy* m_observedCookieManagerProxy { nullptr };
101     std::unique_ptr<APIWebCookieManagerProxyObserver> m_cookieManagerProxyObserver;
102     bool m_observingUIProcessCookies { false };
103
104     uint64_t m_processPoolCreationListenerIdentifier { 0 };
105
106 #if PLATFORM(COCOA)
107     std::unique_ptr<WebCore::CookieStorageObserver> m_defaultUIProcessObserver;
108 #endif
109 };
110
111 }