1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* Copyright (C) 2024 Igalia, S.L. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "WebExtensionSQLiteDatabase.h"
#if ENABLE(WK_WEB_EXTENSIONS)
#include "APIError.h"
#include "Logging.h"
#include "WebExtensionSQLiteHelpers.h"
#include <sqlite3.h>
#include <wtf/FileSystem.h>
#include <wtf/RefPtr.h>
#include <wtf/TZoneMallocInlines.h>
static constexpr auto WebExtensionSQLiteErrorDomain = "com.apple.WebKit.SQLite"_s;
static constexpr auto WebExtensionSQLiteInMemoryDatabaseName = "file::memory:"_s;
using namespace WebKit;
WTF_MAKE_TZONE_ALLOCATED_IMPL(WebExtensionSQLiteDatabase);
WebExtensionSQLiteDatabase::WebExtensionSQLiteDatabase(const URL& url, Ref<WorkQueue>&& queue)
: m_queue(WTFMove(queue))
{
ASSERT(url.protocolIsFile());
m_url = url;
}
void WebExtensionSQLiteDatabase::assertQueue()
{
assertIsCurrent(m_queue.get());
}
int WebExtensionSQLiteDatabase::close()
{
assertQueue();
int result = sqlite3_close_v2(m_db);
if (result != SQLITE_OK) {
RELEASE_LOG_ERROR(Extensions, "Failed to close database: %s (%d)", m_lastErrorMessage.data(), result);
return result;
}
m_db = nullptr;
return result;
}
void WebExtensionSQLiteDatabase::reportErrorWithCode(int errorCode, const String& query, RefPtr<API::Error> outError)
{
assertQueue();
ASSERT(errorCode != SQLITE_OK);
if (outError)
outError = API::Error::create({ WebExtensionSQLiteErrorDomain, errorCode, m_url, emptyString() });
else
RELEASE_LOG_ERROR(Extensions, "Unhandled SQLite error: %d", errorCode);
}
void WebExtensionSQLiteDatabase::reportErrorWithCode(int errorCode, sqlite3_stmt* statement, RefPtr<API::Error> outError)
{
assertQueue();
ASSERT(errorCode != SQLITE_OK);
if (statement) {
if (char* sql = sqlite3_expanded_sql(statement)) {
reportErrorWithCode(errorCode, String::fromUTF8(sql), outError);
sqlite3_free(sql);
}
}
reportErrorWithCode(errorCode, emptyString(), outError);
}
RefPtr<API::Error> WebExtensionSQLiteDatabase::errorWithSQLiteErrorCode(int errorCode)
{
if (errorCode == SQLITE_OK)
return nullptr;
String errorMessage = String::fromUTF8(sqlite3_errstr(errorCode));
return API::Error::create({ WebExtensionSQLiteErrorDomain, errorCode, { }, emptyString() });
}
bool WebExtensionSQLiteDatabase::enableWAL(RefPtr<API::Error>& error)
{
Ref<WebExtensionSQLiteDatabase> protectedThis(*this);
// SQLite docs: The synchronous NORMAL setting is a good choice for most applications running in WAL mode.
if (!SQLiteDatabaseExecuteAndReturnError(*this, error, "PRAGMA synchronous = NORMAL"_s))
return false;
return SQLiteDatabaseEnumerate(*this, error, "PRAGMA journal_mode = WAL"_s, std::tie(std::ignore));
}
bool WebExtensionSQLiteDatabase::openWithAccessType(AccessType accessType, ProtectionType protectionType, const String& vfs, RefPtr<API::Error> outError)
{
int flags = SQLITE_OPEN_NOMUTEX;
switch (accessType) {
case AccessType::ReadOnly:
flags |= SQLITE_OPEN_READONLY;
break;
case AccessType::ReadWrite:
flags |= SQLITE_OPEN_READWRITE;
break;
case AccessType::ReadWriteCreate:
flags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE;
break;
}
#if PLATFORM(IOS_FAMILY)
switch (protectionType) {
case ProtectionType::Default:
case ProtectionType::CompleteUntilFirstUserAuthentication:
flags |= SQLITE_OPEN_FILEPROTECTION_COMPLETEUNTILFIRSTUSERAUTHENTICATION;
break;
case ProtectionType::CompleteUnlessOpen:
flags |= SQLITE_OPEN_FILEPROTECTION_COMPLETEUNLESSOPEN;
break;
case ProtectionType::Complete:
flags |= SQLITE_OPEN_FILEPROTECTION_COMPLETE;
break;
}
#endif
assertQueue();
ASSERT(!m_db);
String databasePath;
if (m_url == inMemoryDatabaseURL())
databasePath = WebExtensionSQLiteInMemoryDatabaseName;
else if (m_url == privateOnDiskDatabaseURL())
databasePath = ""_s;
else {
ASSERT(!m_url.isEmpty());
databasePath = m_url.fileSystemPath();
auto directory = m_url.truncatedForUseAsBase().fileSystemPath();
if (!FileSystem::makeAllDirectories(directory) || FileSystem::fileType(directory) != FileSystem::FileType::Directory) {
if (outError) {
RELEASE_LOG_ERROR(Extensions, "Unable to create parent folder for database at path: %s", m_url.fileSystemPath().utf8().data());
outError = errorWithSQLiteErrorCode(SQLITE_CANTOPEN);
}
return false;
}
}
int result = sqlite3_open_v2(FileSystem::fileSystemRepresentation(databasePath).data(), &m_db, flags, vfs.isEmpty() ? nullptr : vfs.utf8().data());
if (result == SQLITE_OK)
return true;
// SQLite may return a valid database handle even if an error occurred. sqlite3_close silently
// ignores calls with a null handle so we can call it here unconditionally.
sqlite3_close_v2(m_db);
m_db = nullptr;
if (result == SQLITE_CANTOPEN && !(flags & SQLITE_OPEN_CREATE))
return false;
if (outError)
outError = errorWithSQLiteErrorCode(result);
return false;
}
URL WebExtensionSQLiteDatabase::inMemoryDatabaseURL()
{
return URL(WebExtensionSQLiteInMemoryDatabaseName);
}
URL WebExtensionSQLiteDatabase::privateOnDiskDatabaseURL()
{
return URL("webkit::privateondisk"_s);
}
#endif // ENABLE(WK_WEB_EXTENSIONS)
|
