c9db647df38a442539380a8386a0bc9ca4428d28
[WebKit-https.git] / Source / WebKit2 / NetworkProcess / NetworkProcess.h
1 /*
2  * Copyright (C) 2012, 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 #ifndef NetworkProcess_h
27 #define NetworkProcess_h
28
29 #if ENABLE(NETWORK_PROCESS)
30
31 #include "CacheModel.h"
32 #include "ChildProcess.h"
33 #include "DownloadManager.h"
34 #include "MessageReceiverMap.h"
35 #include "NetworkResourceLoadScheduler.h"
36 #include <WebCore/DiagnosticLoggingResultType.h>
37 #include <WebCore/SessionID.h>
38 #include <memory>
39 #include <wtf/Forward.h>
40 #include <wtf/NeverDestroyed.h>
41
42 namespace WebCore {
43 class CertificateInfo;
44 }
45
46 namespace WebKit {
47 class AuthenticationManager;
48 class NetworkConnectionToWebProcess;
49 class NetworkProcessSupplement;
50 struct NetworkProcessCreationParameters;
51
52 class NetworkProcess : public ChildProcess, private DownloadManager::Client {
53     WTF_MAKE_NONCOPYABLE(NetworkProcess);
54     friend class NeverDestroyed<NetworkProcess>;
55     friend class NeverDestroyed<DownloadManager>;
56 public:
57     static NetworkProcess& singleton();
58
59     template <typename T>
60     T* supplement()
61     {
62         return static_cast<T*>(m_supplements.get(T::supplementName()));
63     }
64
65     template <typename T>
66     void addSupplement()
67     {
68         m_supplements.add(T::supplementName(), std::make_unique<T>(this));
69     }
70
71     void removeNetworkConnectionToWebProcess(NetworkConnectionToWebProcess*);
72
73     NetworkResourceLoadScheduler& networkResourceLoadScheduler() { return m_networkResourceLoadScheduler; }
74
75     AuthenticationManager& authenticationManager();
76     DownloadManager& downloadManager();
77     bool canHandleHTTPSServerTrustEvaluation() const { return m_canHandleHTTPSServerTrustEvaluation; }
78
79     // Diagnostic messages logging.
80     void logDiagnosticMessage(uint64_t webPageID, const String& message, const String& description);
81     void logDiagnosticMessageWithResult(uint64_t webPageID, const String& message, const String& description, WebCore::DiagnosticLoggingResultType);
82     void logDiagnosticMessageWithValue(uint64_t webPageID, const String& message, const String& description, const String& value);
83
84 private:
85     NetworkProcess();
86     ~NetworkProcess();
87
88     void platformInitializeNetworkProcess(const NetworkProcessCreationParameters&);
89
90     virtual void terminate() override;
91     void platformTerminate();
92
93     static void lowMemoryHandler(bool critical);
94     static void platformLowMemoryHandler(bool critical);
95
96     // ChildProcess
97     virtual void initializeProcess(const ChildProcessInitializationParameters&) override;
98     virtual void initializeProcessName(const ChildProcessInitializationParameters&) override;
99     virtual void initializeSandbox(const ChildProcessInitializationParameters&, SandboxInitializationParameters&) override;
100     virtual void initializeConnection(IPC::Connection*) override;
101     virtual bool shouldTerminate() override;
102
103     // IPC::Connection::Client
104     virtual void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&) override;
105     virtual void didReceiveSyncMessage(IPC::Connection&, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&) override;
106     virtual void didClose(IPC::Connection&) override;
107     virtual void didReceiveInvalidMessage(IPC::Connection&, IPC::StringReference messageReceiverName, IPC::StringReference messageName) override;
108     virtual IPC::ProcessType localProcessType() override { return IPC::ProcessType::Network; }
109     virtual IPC::ProcessType remoteProcessType() override { return IPC::ProcessType::UI; }
110
111     // DownloadManager::Client
112     virtual void didCreateDownload() override;
113     virtual void didDestroyDownload() override;
114     virtual IPC::Connection* downloadProxyConnection() override;
115     virtual AuthenticationManager& downloadsAuthenticationManager() override;
116
117     // Message Handlers
118     void didReceiveNetworkProcessMessage(IPC::Connection&, IPC::MessageDecoder&);
119     void initializeNetworkProcess(const NetworkProcessCreationParameters&);
120     void createNetworkConnectionToWebProcess();
121     void ensurePrivateBrowsingSession(WebCore::SessionID);
122     void destroyPrivateBrowsingSession(WebCore::SessionID);
123
124     void deleteWebsiteData(WebCore::SessionID, uint64_t websiteDataTypes, std::chrono::system_clock::time_point modifiedSince, uint64_t callbackID);
125
126     // FIXME: This should take a session ID so we can identify which disk cache to delete.
127     void clearDiskCache(std::chrono::system_clock::time_point modifiedSince, std::function<void ()> completionHandler);
128
129     void downloadRequest(uint64_t downloadID, const WebCore::ResourceRequest&);
130     void resumeDownload(uint64_t downloadID, const IPC::DataReference& resumeData, const String& path, const SandboxExtension::Handle&);
131     void cancelDownload(uint64_t downloadID);
132     void setCacheModel(uint32_t);
133     void allowSpecificHTTPSCertificateForHost(const WebCore::CertificateInfo&, const String& host);
134     void setCanHandleHTTPSServerTrustEvaluation(bool);
135     void getNetworkProcessStatistics(uint64_t callbackID);
136     void clearCacheForAllOrigins(uint32_t cachesToClear);
137
138 #if USE(SOUP)
139     void setIgnoreTLSErrors(bool);
140     void userPreferredLanguagesChanged(const Vector<String>&);
141 #endif
142
143     // Platform Helpers
144     void platformSetCacheModel(CacheModel);
145
146     // Connections to WebProcesses.
147     Vector<RefPtr<NetworkConnectionToWebProcess>> m_webProcessConnections;
148
149     NetworkResourceLoadScheduler m_networkResourceLoadScheduler;
150
151     String m_diskCacheDirectory;
152     bool m_hasSetCacheModel;
153     CacheModel m_cacheModel;
154     bool m_diskCacheIsDisabledForTesting;
155     bool m_canHandleHTTPSServerTrustEvaluation;
156
157     typedef HashMap<const char*, std::unique_ptr<NetworkProcessSupplement>, PtrHash<const char*>> NetworkProcessSupplementMap;
158     NetworkProcessSupplementMap m_supplements;
159
160 #if PLATFORM(COCOA)
161     void platformInitializeNetworkProcessCocoa(const NetworkProcessCreationParameters&);
162
163     // FIXME: We'd like to be able to do this without the #ifdef, but WorkQueue + BinarySemaphore isn't good enough since
164     // multiple requests to clear the cache can come in before previous requests complete, and we need to wait for all of them.
165     // In the future using WorkQueue and a counting semaphore would work, as would WorkQueue supporting the libdispatch concept of "work groups".
166     dispatch_group_t m_clearCacheDispatchGroup;
167 #endif
168 };
169
170 } // namespace WebKit
171
172 #endif // ENABLE(NETWORK_PROCESS)
173
174 #endif // NetworkProcess_h