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 "PlatformString.h" 35 #include <wtf/Threading.h> 36 37 struct sqlite3; 38 39 namespace WebCore { 40 41 class SQLiteDatabase; 42 43 // A class that abstracts the file system related operations required 44 // by the WebKit database code. 45 class SQLiteFileSystem { 46 public: 47 // Registers a user-defined SQLite VFS. 48 static void registerSQLiteVFS(); 49 50 // Opens a database file. 51 // 52 // fileName - The name of the database file. 53 // database - The SQLite structure that represents the database stored 54 // in the given file. 55 static int openDatabase(const String& fileName, sqlite3** database); 56 57 // Returns the file name for a database. 58 // 59 // dbDir - The directory where all databases are stored. 60 // dbName - The name of the database. 61 // originIdentifier - The origin that wants to use this database. 62 // db - A database with a number generator used to create unique file names. 63 static String getFileNameForNewDatabase(const String& dbDir, const String& dbName, 64 const String& originIdentifier, SQLiteDatabase* db); 65 66 // Creates an absolute file path given a directory and a file name. 67 // 68 // path - The directory. 69 // fileName - The file name. 70 static String appendDatabaseFileNameToPath(const String& path, const String& fileName); 71 72 // Makes sure the given directory exists, by creating all missing directories 73 // on the given path. 74 // 75 // path - The directory. 76 static bool ensureDatabaseDirectoryExists(const String& path); 77 78 // If 'checkPathOnly' is false, then this method only checks if the given file exists. 79 // If 'checkPathOnly' is true, then this method makes sure all directories on the 80 // given path exist by creating the missing ones, and does not check if the file 81 // itself exists. 82 // 83 // Sometimes we expect a DB file to exist; other times, we're OK with creating a new 84 // DB file, but we want to make sure that the directory in which we want to put the 85 // new DB file exists. This method covers both cases. 86 // 87 // fileName - The file name. 88 // checkPathOnly - If true, we only make sure that the given directory exists. 89 // If false, we only check if the file exists. 90 static bool ensureDatabaseFileExists(const String& fileName, bool checkPathOnly); 91 92 // Deletes an empty database directory. 93 // 94 // path - The directory. 95 static bool deleteEmptyDatabaseDirectory(const String& path); 96 97 // Deletes a database file. 98 // 99 // fileName - The file name. 100 static bool deleteDatabaseFile(const String& fileName); 101 102 // Returns the size of the database file. 103 // 104 // fileName - The file name. 105 static long long getDatabaseFileSize(const String& fileName); 106 107 private: 108 // do not instantiate this class 109 SQLiteFileSystem(); 110 }; // class SQLiteFileSystem 111 112 } // namespace WebCore 113 114 #endif 115