2960a5f738731f3b9593c7191dbda18059ac4843
[WebKit-https.git] / WebCore / platform / sql / chromium / SQLiteFileSystemChromiumPosix.cpp
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "SQLiteFileSystem.h"
33
34 #include "ChromiumBridge.h"
35 #include <sqlite3.h>
36
37 #include <fcntl.h>
38 #include <string.h>
39 #include <unistd.h>
40
41 using namespace WebCore;
42
43 // Defined in Chromium's codebase in third_party/sqlite/src/os_unix.c
44 extern "C" {
45 void initUnixFile(sqlite3_file* file);
46 int fillInUnixFile(sqlite3_vfs* vfs, int fd, int dirfd, sqlite3_file* file, const char* fileName, int noLock);
47 }
48
49 // Chromium's Posix implementation of SQLite VFS
50 namespace {
51
52 // Opens a file.
53 //
54 // vfs - pointer to the sqlite3_vfs object.
55 // fileName - the name of the file.
56 // id - the structure that will manipulate the newly opened file.
57 // desiredFlags - the desired open mode flags.
58 // usedFlags - the actual open mode flags that were used.
59 int chromiumOpen(sqlite3_vfs* vfs, const char* fileName,
60                  sqlite3_file* id, int desiredFlags, int* usedFlags)
61 {
62     initUnixFile(id);
63     int dirfd = -1;
64     int fd = ChromiumBridge::databaseOpenFile(fileName, desiredFlags, &dirfd);
65     if (fd < 0) {
66         if (desiredFlags & SQLITE_OPEN_READWRITE) {
67             int newFlags = (desiredFlags & ~(SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE)) | SQLITE_OPEN_READONLY;
68             return chromiumOpen(vfs, fileName, id, newFlags, usedFlags);
69         } else
70             return SQLITE_CANTOPEN;
71     }
72     if (usedFlags)
73         *usedFlags = desiredFlags;
74
75     fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
76     if (dirfd >= 0)
77         fcntl(dirfd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
78
79     // The mask 0x00007F00 gives us the 7 bits that determine the type of the file SQLite is trying to open.
80     int fileType = desiredFlags & 0x00007F00;
81     int noLock = (fileType != SQLITE_OPEN_MAIN_DB);
82     return fillInUnixFile(vfs, fd, dirfd, id, fileName, noLock);
83 }
84
85 // Deletes the given file.
86 //
87 // vfs - pointer to the sqlite3_vfs object.
88 // fileName - the name of the file.
89 // syncDir - determines if the directory to which this file belongs
90 //           should be synched after the file is deleted.
91 int chromiumDelete(sqlite3_vfs*, const char* fileName, int syncDir)
92 {
93     return ChromiumBridge::databaseDeleteFile(fileName, syncDir);
94 }
95
96 // Check the existance and status of the given file.
97 //
98 // vfs - pointer to the sqlite3_vfs object.
99 // fileName - the name of the file.
100 // flag - the type of test to make on this file.
101 // res - the result.
102 int chromiumAccess(sqlite3_vfs*, const char* fileName, int flag, int* res)
103 {
104     int attr = static_cast<int>(ChromiumBridge::databaseGetFileAttributes(fileName));
105     if (attr < 0) {
106         *res = 0;
107         return SQLITE_OK;
108     }
109
110     switch (flag) {
111     case SQLITE_ACCESS_EXISTS:
112         *res = 1;   // if the file doesn't exist, attr < 0
113         break;
114     case SQLITE_ACCESS_READWRITE:
115         *res = (attr & W_OK) && (attr & R_OK);
116         break;
117     case SQLITE_ACCESS_READ:
118         *res = (attr & R_OK);
119         break;
120     default:
121         return SQLITE_ERROR;
122     }
123
124     return SQLITE_OK;
125 }
126
127 // Turns a relative pathname into a full pathname.
128 //
129 // vfs - pointer to the sqlite3_vfs object.
130 // relativePath - the relative path.
131 // bufSize - the size of the output buffer in bytes.
132 // absolutePath - the output buffer where the absolute path will be stored.
133 int chromiumFullPathname(sqlite3_vfs* vfs, const char* relativePath,
134                          int, char* absolutePath)
135 {
136     // The renderer process doesn't need to know the absolute path of the file
137     sqlite3_snprintf(vfs->mxPathname, absolutePath, "%s", relativePath);
138     return SQLITE_OK;
139 }
140
141 #ifndef SQLITE_OMIT_LOAD_EXTENSION
142 // Returns NULL, thus disallowing loading libraries in the renderer process.
143 //
144 // vfs - pointer to the sqlite3_vfs object.
145 // fileName - the name of the shared library file.
146 void* chromiumDlOpen(sqlite3_vfs*, const char*)
147 {
148     return 0;
149 }
150 #else
151 #define chromiumDlOpen 0
152 #endif // SQLITE_OMIT_LOAD_EXTENSION
153
154 } // namespace
155
156 namespace WebCore {
157
158 void SQLiteFileSystem::registerSQLiteVFS()
159 {
160     // FIXME: Make sure there aren't any unintended consequences when VFS code is called in the browser process.
161     if (!ChromiumBridge::sandboxEnabled()) {
162         ASSERT_NOT_REACHED();
163         return;
164     }
165
166     sqlite3_vfs* unix_vfs = sqlite3_vfs_find("unix");
167     static sqlite3_vfs chromium_vfs = {
168         1,
169         unix_vfs->szOsFile,
170         unix_vfs->mxPathname,
171         0,
172         "chromium_vfs",
173         unix_vfs->pAppData,
174         chromiumOpen,
175         chromiumDelete,
176         chromiumAccess,
177         chromiumFullPathname,
178         chromiumDlOpen,
179         unix_vfs->xDlError,
180         unix_vfs->xDlSym,
181         unix_vfs->xDlClose,
182         unix_vfs->xRandomness,
183         unix_vfs->xSleep,
184         unix_vfs->xCurrentTime,
185         unix_vfs->xGetLastError
186     };
187     sqlite3_vfs_register(&chromium_vfs, 1);
188 }
189
190 } // namespace WebCore