Use sendWithAsyncReply for cookie getting/clearing functions
[WebKit.git] / Source / WebKit / NetworkProcess / Cookies / WebCookieManager.h
1 /*
2  * Copyright (C) 2011-2018 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 "MessageReceiver.h"
29 #include "NetworkProcessSupplement.h"
30 #include <pal/SessionID.h>
31 #include <stdint.h>
32 #include <wtf/Forward.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/WallTime.h>
35
36 #if USE(SOUP)
37 #include "SoupCookiePersistentStorageType.h"
38 #endif
39
40 namespace WebCore {
41 struct Cookie;
42 }
43
44 namespace WebKit {
45
46 class NetworkProcess;
47 enum class HTTPCookieAcceptPolicy : uint8_t;
48
49 class WebCookieManager : public NetworkProcessSupplement, public IPC::MessageReceiver {
50     WTF_MAKE_FAST_ALLOCATED;
51     WTF_MAKE_NONCOPYABLE(WebCookieManager);
52 public:
53     WebCookieManager(NetworkProcess&);
54     ~WebCookieManager();
55
56     static const char* supplementName();
57
58     void setHTTPCookieAcceptPolicy(HTTPCookieAcceptPolicy, CompletionHandler<void()>&&);
59
60 #if USE(SOUP)
61     void setCookiePersistentStorage(PAL::SessionID, const String& storagePath, SoupCookiePersistentStorageType);
62 #endif
63
64     void notifyCookiesDidChange(PAL::SessionID);
65
66 private:
67     // IPC::MessageReceiver
68     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
69
70     void getHostnamesWithCookies(PAL::SessionID, CompletionHandler<void(Vector<String>&&)>&&);
71
72     void deleteCookie(PAL::SessionID, const WebCore::Cookie&, CompletionHandler<void()>&&);
73     void deleteCookiesForHostnames(PAL::SessionID, const Vector<String>&);
74     void deleteAllCookies(PAL::SessionID);
75     void deleteAllCookiesModifiedSince(PAL::SessionID, WallTime, CompletionHandler<void()>&&);
76
77     void setCookie(PAL::SessionID, const Vector<WebCore::Cookie>&, CompletionHandler<void()>&&);
78     void setCookies(PAL::SessionID, const Vector<WebCore::Cookie>&, const URL&, const URL& mainDocumentURL, CompletionHandler<void()>&&);
79     void getAllCookies(PAL::SessionID, CompletionHandler<void(Vector<WebCore::Cookie>&&)>&&);
80     void getCookies(PAL::SessionID, const URL&, CompletionHandler<void(Vector<WebCore::Cookie>&&)>&&);
81
82     void platformSetHTTPCookieAcceptPolicy(HTTPCookieAcceptPolicy);
83     void getHTTPCookieAcceptPolicy(CompletionHandler<void(HTTPCookieAcceptPolicy)>&&);
84     HTTPCookieAcceptPolicy platformGetHTTPCookieAcceptPolicy();
85
86     void startObservingCookieChanges(PAL::SessionID);
87     void stopObservingCookieChanges(PAL::SessionID);
88
89     NetworkProcess& m_process;
90 };
91
92 } // namespace WebKit