3507421500c194746ec29ba0a1046ae422edb64d
[WebKit.git] / Source / WebCore / Modules / indexeddb / server / IDBServer.h
1 /*
2  * Copyright (C) 2015, 2016 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(INDEXED_DATABASE)
29
30 #include "IDBConnectionToClient.h"
31 #include "IDBDatabaseIdentifier.h"
32 #include "UniqueIDBDatabase.h"
33 #include "UniqueIDBDatabaseConnection.h"
34 #include <wtf/CrossThreadTaskHandler.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/Lock.h>
37 #include <wtf/Ref.h>
38 #include <wtf/RefCounted.h>
39 #include <wtf/RefPtr.h>
40
41 namespace WebCore {
42
43 class IDBCursorInfo;
44 class IDBRequestData;
45 class IDBValue;
46
47 struct IDBGetRecordData;
48
49 namespace IDBServer {
50
51 class IDBBackingStoreTemporaryFileHandler;
52
53 class IDBServer : public RefCounted<IDBServer>, public CrossThreadTaskHandler {
54 public:
55     static Ref<IDBServer> create(IDBBackingStoreTemporaryFileHandler&);
56     WEBCORE_EXPORT static Ref<IDBServer> create(const String& databaseDirectoryPath, IDBBackingStoreTemporaryFileHandler&);
57
58     WEBCORE_EXPORT void registerConnection(IDBConnectionToClient&);
59     WEBCORE_EXPORT void unregisterConnection(IDBConnectionToClient&);
60
61     // Operations requested by the client.
62     WEBCORE_EXPORT void openDatabase(const IDBRequestData&);
63     WEBCORE_EXPORT void deleteDatabase(const IDBRequestData&);
64     WEBCORE_EXPORT void abortTransaction(const IDBResourceIdentifier&);
65     WEBCORE_EXPORT void commitTransaction(const IDBResourceIdentifier&);
66     WEBCORE_EXPORT void didFinishHandlingVersionChangeTransaction(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier&);
67     WEBCORE_EXPORT void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&);
68     WEBCORE_EXPORT void renameObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& newName);
69     WEBCORE_EXPORT void deleteObjectStore(const IDBRequestData&, const String& objectStoreName);
70     WEBCORE_EXPORT void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier);
71     WEBCORE_EXPORT void createIndex(const IDBRequestData&, const IDBIndexInfo&);
72     WEBCORE_EXPORT void deleteIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& indexName);
73     WEBCORE_EXPORT void renameIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
74     WEBCORE_EXPORT void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode);
75     WEBCORE_EXPORT void getRecord(const IDBRequestData&, const IDBGetRecordData&);
76     WEBCORE_EXPORT void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&);
77     WEBCORE_EXPORT void getCount(const IDBRequestData&, const IDBKeyRangeData&);
78     WEBCORE_EXPORT void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&);
79     WEBCORE_EXPORT void openCursor(const IDBRequestData&, const IDBCursorInfo&);
80     WEBCORE_EXPORT void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&);
81
82     WEBCORE_EXPORT void establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo&);
83     WEBCORE_EXPORT void databaseConnectionPendingClose(uint64_t databaseConnectionIdentifier);
84     WEBCORE_EXPORT void databaseConnectionClosed(uint64_t databaseConnectionIdentifier);
85     WEBCORE_EXPORT void abortOpenAndUpgradeNeeded(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& transactionIdentifier);
86     WEBCORE_EXPORT void didFireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier);
87     WEBCORE_EXPORT void openDBRequestCancelled(const IDBRequestData&);
88     WEBCORE_EXPORT void confirmDidCloseFromServer(uint64_t databaseConnectionIdentifier);
89
90     WEBCORE_EXPORT void getAllDatabaseNames(uint64_t serverConnectionIdentifier, const SecurityOriginData& mainFrameOrigin, const SecurityOriginData& openingOrigin, uint64_t callbackID);
91
92     void postDatabaseTask(CrossThreadTask&&);
93     void postDatabaseTaskReply(CrossThreadTask&&);
94
95     void registerDatabaseConnection(UniqueIDBDatabaseConnection&);
96     void unregisterDatabaseConnection(UniqueIDBDatabaseConnection&);
97     void registerTransaction(UniqueIDBDatabaseTransaction&);
98     void unregisterTransaction(UniqueIDBDatabaseTransaction&);
99
100     std::unique_ptr<UniqueIDBDatabase> closeAndTakeUniqueIDBDatabase(UniqueIDBDatabase&);
101
102     std::unique_ptr<IDBBackingStore> createBackingStore(const IDBDatabaseIdentifier&);
103
104     WEBCORE_EXPORT void closeAndDeleteDatabasesModifiedSince(std::chrono::system_clock::time_point, Function<void ()>&& completionHandler);
105     WEBCORE_EXPORT void closeAndDeleteDatabasesForOrigins(const Vector<SecurityOriginData>&, Function<void ()>&& completionHandler);
106
107 private:
108     IDBServer(IDBBackingStoreTemporaryFileHandler&);
109     IDBServer(const String& databaseDirectoryPath, IDBBackingStoreTemporaryFileHandler&);
110
111     UniqueIDBDatabase& getOrCreateUniqueIDBDatabase(const IDBDatabaseIdentifier&);
112
113     void performGetAllDatabaseNames(uint64_t serverConnectionIdentifier, const SecurityOriginData& mainFrameOrigin, const SecurityOriginData& openingOrigin, uint64_t callbackID);
114     void didGetAllDatabaseNames(uint64_t serverConnectionIdentifier, uint64_t callbackID, const Vector<String>& databaseNames);
115
116     void performCloseAndDeleteDatabasesModifiedSince(std::chrono::system_clock::time_point, uint64_t callbackID);
117     void performCloseAndDeleteDatabasesForOrigins(const Vector<SecurityOriginData>&, uint64_t callbackID);
118     void didPerformCloseAndDeleteDatabases(uint64_t callbackID);
119
120     HashMap<uint64_t, RefPtr<IDBConnectionToClient>> m_connectionMap;
121     HashMap<IDBDatabaseIdentifier, std::unique_ptr<UniqueIDBDatabase>> m_uniqueIDBDatabaseMap;
122
123     HashMap<uint64_t, UniqueIDBDatabaseConnection*> m_databaseConnections;
124     HashMap<IDBResourceIdentifier, UniqueIDBDatabaseTransaction*> m_transactions;
125
126     HashMap<uint64_t, Function<void ()>> m_deleteDatabaseCompletionHandlers;
127
128     String m_databaseDirectoryPath;
129     IDBBackingStoreTemporaryFileHandler& m_backingStoreTemporaryFileHandler;
130 };
131
132 } // namespace IDBServer
133 } // namespace WebCore
134
135 #endif // ENABLE(INDEXED_DATABASE)