ebf96c88d8e6ef0a68e56d6d1173667c606e8466
[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 }
46
47 namespace API {
48
49 class APIWebCookieManagerProxyObserver;
50 class WebsiteDataStore;
51
52 class HTTPCookieStore final : public ObjectImpl<Object::Type::HTTPCookieStore> {
53 public:
54     static Ref<HTTPCookieStore> create(WebKit::WebsiteDataStore& websiteDataStore)
55     {
56         return adoptRef(*new HTTPCookieStore(websiteDataStore));
57     }
58
59     virtual ~HTTPCookieStore();
60
61     void cookies(CompletionHandler<void(const Vector<WebCore::Cookie>&)>&&);
62     void setCookies(const Vector<WebCore::Cookie>&, CompletionHandler<void()>&&);
63     void deleteCookie(const WebCore::Cookie&, CompletionHandler<void()>&&);
64
65     class Observer {
66     public:
67         virtual ~Observer() { }
68         virtual void cookiesDidChange(HTTPCookieStore&) = 0;
69     };
70
71     void registerObserver(Observer&);
72     void unregisterObserver(Observer&);
73
74     void cookiesDidChange();
75     void cookieManagerDestroyed();
76
77 private:
78     HTTPCookieStore(WebKit::WebsiteDataStore&);
79
80     void registerForNewProcessPoolNotifications();
81     void unregisterForNewProcessPoolNotifications();
82
83     static void flushDefaultUIProcessCookieStore();
84     static Vector<WebCore::Cookie> getAllDefaultUIProcessCookieStoreCookies();
85     static void setCookieInDefaultUIProcessCookieStore(const WebCore::Cookie&);
86     static void deleteCookieFromDefaultUIProcessCookieStore(const WebCore::Cookie&);
87     void startObservingChangesToDefaultUIProcessCookieStore(Function<void()>&&);
88     void stopObservingChangesToDefaultUIProcessCookieStore();
89     
90     // FIXME: This is a reference cycle.
91     Ref<WebKit::WebsiteDataStore> m_owningDataStore;
92     HashSet<Observer*> m_observers;
93
94     WebKit::WebCookieManagerProxy* m_observedCookieManagerProxy { nullptr };
95     std::unique_ptr<APIWebCookieManagerProxyObserver> m_cookieManagerProxyObserver;
96     bool m_observingUIProcessCookies { false };
97
98     uint64_t m_processPoolCreationListenerIdentifier { 0 };
99
100 #if PLATFORM(COCOA)
101     std::unique_ptr<WebCore::CookieStorageObserver> m_defaultUIProcessObserver;
102 #endif
103 };
104
105 }