c2ff0e6833bfc44dc17ad2959ad8476c2495313a
[WebKit-https.git] / Source / WebKit2 / 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 #ifndef DatabaseProcess_h
27 #define DatabaseProcess_h
28
29 #if ENABLE(DATABASE_PROCESS)
30
31 #include "ChildProcess.h"
32 #include "UniqueIDBDatabaseIdentifier.h"
33 #include <wtf/NeverDestroyed.h>
34
35 namespace WebCore {
36 class CrossThreadTask;
37 class SessionID;
38 struct SecurityOriginData;
39 }
40
41 namespace WebKit {
42
43 class DatabaseToWebProcessConnection;
44 class UniqueIDBDatabase;
45
46 struct DatabaseProcessCreationParameters;
47
48 class DatabaseProcess : public ChildProcess {
49     WTF_MAKE_NONCOPYABLE(DatabaseProcess);
50     friend class NeverDestroyed<DatabaseProcess>;
51 public:
52     static DatabaseProcess& singleton();
53     ~DatabaseProcess();
54
55 #if ENABLE(INDEXED_DATABASE)
56     const String& indexedDatabaseDirectory() const { return m_indexedDatabaseDirectory; }
57
58     RefPtr<UniqueIDBDatabase> getOrCreateUniqueIDBDatabase(const UniqueIDBDatabaseIdentifier&);
59     void removeUniqueIDBDatabase(const UniqueIDBDatabase&);
60
61     void ensureIndexedDatabaseRelativePathExists(const String&);
62     String absoluteIndexedDatabasePathFromDatabaseRelativePath(const String&);
63 #endif
64
65     WorkQueue& queue() { return m_queue.get(); }
66
67     void postDatabaseTask(std::unique_ptr<WebCore::CrossThreadTask>);
68
69 private:
70     DatabaseProcess();
71
72     // ChildProcess
73     virtual void initializeProcess(const ChildProcessInitializationParameters&) override;
74     virtual void initializeProcessName(const ChildProcessInitializationParameters&) override;
75     virtual void initializeSandbox(const ChildProcessInitializationParameters&, SandboxInitializationParameters&) override;
76     virtual void initializeConnection(IPC::Connection*) override;
77     virtual bool shouldTerminate() override;
78
79     // IPC::Connection::Client
80     virtual void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&) override;
81     virtual void didClose(IPC::Connection&) override;
82     virtual void didReceiveInvalidMessage(IPC::Connection&, IPC::StringReference messageReceiverName, IPC::StringReference messageName) override;
83     virtual IPC::ProcessType localProcessType() override { return IPC::ProcessType::Database; }
84     virtual IPC::ProcessType remoteProcessType() override { return IPC::ProcessType::UI; }
85     void didReceiveDatabaseProcessMessage(IPC::Connection&, IPC::MessageDecoder&);
86
87     // Message Handlers
88     void initializeDatabaseProcess(const DatabaseProcessCreationParameters&);
89     void createDatabaseToWebProcessConnection();
90
91     void fetchWebsiteData(WebCore::SessionID, uint64_t websiteDataTypes, uint64_t callbackID);
92     void deleteWebsiteData(WebCore::SessionID, uint64_t websiteDataTypes, std::chrono::system_clock::time_point modifiedSince, uint64_t callbackID);
93     void deleteWebsiteDataForOrigins(WebCore::SessionID, uint64_t websiteDataTypes, const Vector<WebCore::SecurityOriginData>& origins, uint64_t callbackID);
94
95 #if ENABLE(INDEXED_DATABASE)
96     Vector<RefPtr<WebCore::SecurityOrigin>> indexedDatabaseOrigins();
97     void deleteIndexedDatabaseEntriesForOrigins(const Vector<RefPtr<WebCore::SecurityOrigin>>&);
98     void deleteIndexedDatabaseEntriesModifiedSince(std::chrono::system_clock::time_point modifiedSince);
99 #endif
100
101     // For execution on work queue thread only
102     void performNextDatabaseTask();
103     void ensurePathExists(const String&);
104
105     Vector<RefPtr<DatabaseToWebProcessConnection>> m_databaseToWebProcessConnections;
106
107     Ref<WorkQueue> m_queue;
108
109 #if ENABLE(INDEXED_DATABASE)
110     String m_indexedDatabaseDirectory;
111
112     HashMap<UniqueIDBDatabaseIdentifier, RefPtr<UniqueIDBDatabase>> m_idbDatabases;
113 #endif
114
115     Deque<std::unique_ptr<WebCore::CrossThreadTask>> m_databaseTasks;
116     Lock m_databaseTaskMutex;
117 };
118
119 } // namespace WebKit
120
121 #endif // ENABLE(DATABASE_PROCESS)
122
123 #endif // DatabaseProcess_h