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#ifndef SQLiteFileSystem_h
32#define SQLiteFileSystem_h
33
34#include <wtf/WallTime.h>
35#include <wtf/text/WTFString.h>
36
37struct sqlite3;
38
39namespace WebCore {
40
41class SQLiteDatabase;
42
43// A class that abstracts the file system related operations required
44// by the WebKit database code.
45class SQLiteFileSystem {
46public:
47 // Creates an absolute file path given a directory and a file name.
48 //
49 // path - The directory.
50 // fileName - The file name.
51 WEBCORE_EXPORT static String appendDatabaseFileNameToPath(const String& path, const String& fileName);
52
53 // Makes sure the given directory exists, by creating all missing directories
54 // on the given path.
55 //
56 // path - The directory.
57 WEBCORE_EXPORT static bool ensureDatabaseDirectoryExists(const String& path);
58
59 // If 'checkPathOnly' is false, then this method only checks if the given file exists.
60 // If 'checkPathOnly' is true, then this method makes sure all directories on the
61 // given path exist by creating the missing ones, and does not check if the file
62 // itself exists.
63 //
64 // Sometimes we expect a DB file to exist; other times, we're OK with creating a new
65 // DB file, but we want to make sure that the directory in which we want to put the
66 // new DB file exists. This method covers both cases.
67 //
68 // fileName - The file name.
69 // checkPathOnly - If true, we only make sure that the given directory exists.
70 // If false, we only check if the file exists.
71 static bool ensureDatabaseFileExists(const String& fileName, bool checkPathOnly);
72
73 // Deletes an empty database directory.
74 //
75 // path - The directory.
76 static bool deleteEmptyDatabaseDirectory(const String& path);
77
78 // Deletes a database file.
79 //
80 // fileName - The file name.
81 WEBCORE_EXPORT static bool deleteDatabaseFile(const String& fileName);
82
83 WEBCORE_EXPORT static String computeHashForFileName(const String& fileName);
84
85#if PLATFORM(IOS_FAMILY)
86 // Truncates a database file. Used when MobileSafariSettings deletes a database file,
87 // since deleting the file nukes the POSIX file locks which would potentially cause Safari
88 // to corrupt the new db if it's running in the background.
89 static bool truncateDatabaseFile(sqlite3* database);
90#endif
91
92 static long long getDatabaseFileSize(const String& fileName);
93 WEBCORE_EXPORT static Optional<WallTime> databaseCreationTime(const String& fileName);
94 WEBCORE_EXPORT static Optional<WallTime> databaseModificationTime(const String& fileName);
95
96private:
97 // do not instantiate this class
98 SQLiteFileSystem();
99}; // class SQLiteFileSystem
100
101} // namespace WebCore
102
103#endif
104