Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebKit / DatabaseProcess / DatabaseProcess.h
1 /*
2  * Copyright (C) 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 #if ENABLE(DATABASE_PROCESS)
29
30 #include "ChildProcess.h"
31 #include "SandboxExtension.h"
32 #include <WebCore/IDBBackingStore.h>
33 #include <WebCore/IDBServer.h>
34 #include <WebCore/SessionID.h>
35 #include <WebCore/UniqueIDBDatabase.h>
36 #include <wtf/CrossThreadTask.h>
37 #include <wtf/Function.h>
38
39 namespace WebCore {
40 struct SecurityOriginData;
41 }
42
43 namespace WebKit {
44
45 class DatabaseToWebProcessConnection;
46 enum class WebsiteDataType;
47 struct DatabaseProcessCreationParameters;
48
49 class DatabaseProcess : public ChildProcess
50 #if ENABLE(INDEXED_DATABASE)
51     , public WebCore::IDBServer::IDBBackingStoreTemporaryFileHandler
52 #endif
53 {
54     WTF_MAKE_NONCOPYABLE(DatabaseProcess);
55     friend class NeverDestroyed<DatabaseProcess>;
56 public:
57     static DatabaseProcess& singleton();
58     ~DatabaseProcess();
59
60 #if ENABLE(INDEXED_DATABASE)
61     WebCore::IDBServer::IDBServer& idbServer(WebCore::SessionID);
62 #endif
63
64     WorkQueue& queue() { return m_queue.get(); }
65
66     void postDatabaseTask(CrossThreadTask&&);
67
68 #if ENABLE(INDEXED_DATABASE)
69     // WebCore::IDBServer::IDBBackingStoreFileHandler
70     void prepareForAccessToTemporaryFile(const String& path) final;
71     void accessToTemporaryFileComplete(const String& path) final;
72 #endif
73
74 #if ENABLE(SANDBOX_EXTENSIONS)
75     void getSandboxExtensionsForBlobFiles(const Vector<String>& filenames, WTF::Function<void (SandboxExtension::HandleArray&&)>&& completionHandler);
76 #endif
77
78 private:
79     DatabaseProcess();
80
81     // ChildProcess
82     void initializeProcess(const ChildProcessInitializationParameters&) override;
83     void initializeProcessName(const ChildProcessInitializationParameters&) override;
84     void initializeSandbox(const ChildProcessInitializationParameters&, SandboxInitializationParameters&) override;
85     void initializeConnection(IPC::Connection*) override;
86     bool shouldTerminate() override;
87
88     // IPC::Connection::Client
89     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
90     void didClose(IPC::Connection&) override;
91     void didReceiveDatabaseProcessMessage(IPC::Connection&, IPC::Decoder&);
92
93     // Message Handlers
94     void initializeWebsiteDataStore(const DatabaseProcessCreationParameters&);
95     void createDatabaseToWebProcessConnection();
96
97     void fetchWebsiteData(WebCore::SessionID, OptionSet<WebsiteDataType> websiteDataTypes, uint64_t callbackID);
98     void deleteWebsiteData(WebCore::SessionID, OptionSet<WebsiteDataType> websiteDataTypes, std::chrono::system_clock::time_point modifiedSince, uint64_t callbackID);
99     void deleteWebsiteDataForOrigins(WebCore::SessionID, OptionSet<WebsiteDataType> websiteDataTypes, const Vector<WebCore::SecurityOriginData>& origins, uint64_t callbackID);
100 #if ENABLE(SANDBOX_EXTENSIONS)
101     void grantSandboxExtensionsForBlobs(const Vector<String>& paths, const SandboxExtension::HandleArray&);
102     void didGetSandboxExtensionsForBlobFiles(uint64_t requestID, SandboxExtension::HandleArray&&);
103 #endif
104
105 #if ENABLE(INDEXED_DATABASE)
106     Vector<WebCore::SecurityOriginData> indexedDatabaseOrigins(const String& path);
107 #endif
108
109     // For execution on work queue thread only
110     void performNextDatabaseTask();
111     void ensurePathExists(const String&);
112
113     Vector<RefPtr<DatabaseToWebProcessConnection>> m_databaseToWebProcessConnections;
114
115     Ref<WorkQueue> m_queue;
116
117 #if ENABLE(INDEXED_DATABASE)
118     HashMap<WebCore::SessionID, String> m_idbDatabasePaths;
119     HashMap<WebCore::SessionID, RefPtr<WebCore::IDBServer::IDBServer>> m_idbServers;
120 #endif
121     HashMap<String, RefPtr<SandboxExtension>> m_blobTemporaryFileSandboxExtensions;
122     HashMap<uint64_t, WTF::Function<void (SandboxExtension::HandleArray&&)>> m_sandboxExtensionForBlobsCompletionHandlers;
123
124     Deque<CrossThreadTask> m_databaseTasks;
125     Lock m_databaseTaskMutex;
126 };
127
128 } // namespace WebKit
129
130 #endif // ENABLE(DATABASE_PROCESS)