Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebKit / UIProcess / WebCookieManagerProxy.h
1 /*
2  * Copyright (C) 2011, 2013 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 "GenericCallback.h"
30 #include "MessageReceiver.h"
31 #include "WebContextSupplement.h"
32 #include "WebCookieManagerProxyClient.h"
33 #include <pal/SessionID.h>
34 #include <wtf/Forward.h>
35 #include <wtf/RefPtr.h>
36
37 #if USE(SOUP)
38 #include "SoupCookiePersistentStorageType.h"
39 #endif
40
41 namespace API {
42 class Array;
43 }
44
45 namespace WebCore {
46 struct Cookie;
47 }
48
49 namespace WebKit {
50
51 class WebProcessPool;
52 class WebProcessProxy;
53
54 typedef GenericCallback<API::Array*> ArrayCallback;
55 typedef GenericCallback<HTTPCookieAcceptPolicy> HTTPCookieAcceptPolicyCallback;
56 typedef GenericCallback<const Vector<WebCore::Cookie>&> GetCookiesCallback;
57
58 class WebCookieManagerProxy : public API::ObjectImpl<API::Object::Type::CookieManager>, public WebContextSupplement, private IPC::MessageReceiver {
59 public:
60     static const char* supplementName();
61
62     static Ref<WebCookieManagerProxy> create(WebProcessPool*);
63     virtual ~WebCookieManagerProxy();
64
65     void initializeClient(const WKCookieManagerClientBase*);
66     
67     void getHostnamesWithCookies(PAL::SessionID, Function<void (API::Array*, CallbackBase::Error)>&&);
68     void deleteCookie(PAL::SessionID, const WebCore::Cookie&, Function<void (CallbackBase::Error)>&&);
69     void deleteCookiesForHostname(PAL::SessionID, const String& hostname);
70     void deleteAllCookies(PAL::SessionID);
71     void deleteAllCookiesModifiedSince(PAL::SessionID, WallTime, Function<void (CallbackBase::Error)>&&);
72
73     void setCookie(PAL::SessionID, const WebCore::Cookie&, Function<void (CallbackBase::Error)>&&);
74     void setCookies(PAL::SessionID, const Vector<WebCore::Cookie>&, const URL&, const URL& mainDocumentURL, Function<void(CallbackBase::Error)>&&);
75
76     void getAllCookies(PAL::SessionID, Function<void (const Vector<WebCore::Cookie>&, CallbackBase::Error)>&& completionHandler);
77     void getCookies(PAL::SessionID, const URL&, Function<void(const Vector<WebCore::Cookie>&, CallbackBase::Error)>&& completionHandler);
78
79     void setHTTPCookieAcceptPolicy(PAL::SessionID, HTTPCookieAcceptPolicy, Function<void (CallbackBase::Error)>&&);
80     void getHTTPCookieAcceptPolicy(PAL::SessionID, Function<void (HTTPCookieAcceptPolicy, CallbackBase::Error)>&&);
81
82     void setStorageAccessAPIEnabled(bool);
83
84     void startObservingCookieChanges(PAL::SessionID);
85     void stopObservingCookieChanges(PAL::SessionID);
86
87     void setCookieObserverCallback(PAL::SessionID, WTF::Function<void ()>&&);
88
89     class Observer {
90     public:
91         virtual ~Observer() { }
92         virtual void cookiesDidChange() = 0;
93         virtual void managerDestroyed() = 0;
94     };
95
96     void registerObserver(PAL::SessionID, Observer&);
97     void unregisterObserver(PAL::SessionID, Observer&);
98
99 #if USE(SOUP)
100     void setCookiePersistentStorage(const String& storagePath, uint32_t storageType);
101     void getCookiePersistentStorage(String& storagePath, uint32_t& storageType) const;
102 #endif
103
104     using API::Object::ref;
105     using API::Object::deref;
106
107 private:
108     WebCookieManagerProxy(WebProcessPool*);
109
110     void didGetHostnamesWithCookies(const Vector<String>&, WebKit::CallbackID);
111     void didGetHTTPCookieAcceptPolicy(uint32_t policy, WebKit::CallbackID);
112
113     void didSetHTTPCookieAcceptPolicy(WebKit::CallbackID);
114     void didSetCookies(WebKit::CallbackID);
115     void didGetCookies(const Vector<WebCore::Cookie>&, WebKit::CallbackID);
116     void didDeleteCookies(WebKit::CallbackID);
117
118     void cookiesDidChange(PAL::SessionID);
119
120     // WebContextSupplement
121     void processPoolDestroyed() override;
122     void processDidClose(WebProcessProxy*) override;
123     void processDidClose(NetworkProcessProxy*) override;
124     void refWebContextSupplement() override;
125     void derefWebContextSupplement() override;
126
127     // IPC::MessageReceiver
128     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
129
130 #if PLATFORM(COCOA)
131     void persistHTTPCookieAcceptPolicy(HTTPCookieAcceptPolicy);
132 #endif
133
134     CallbackMap m_callbacks;
135
136     HashMap<PAL::SessionID, WTF::Function<void ()>> m_legacyCookieObservers;
137     HashMap<PAL::SessionID, HashSet<Observer*>> m_cookieObservers;
138
139     WebCookieManagerProxyClient m_client;
140
141 #if USE(SOUP)
142     String m_cookiePersistentStoragePath;
143     SoupCookiePersistentStorageType m_cookiePersistentStorageType;
144 #endif
145 };
146
147 } // namespace WebKit