1 /* 2 * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved. 3 * Copyright (C) 2007 Justin Haygood (jhaygood (at) reaktix.com) 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY 15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR 18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 21 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 22 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #ifndef SQLiteDatabase_h 28 #define SQLiteDatabase_h 29 30 #include "PlatformString.h" 31 #include <wtf/Threading.h> 32 33 #if COMPILER(MSVC) 34 #pragma warning(disable: 4800) 35 #endif 36 37 struct sqlite3; 38 39 namespace WebCore { 40 41 class DatabaseAuthorizer; 42 class SQLiteStatement; 43 class SQLiteTransaction; 44 45 extern const int SQLResultDone; 46 extern const int SQLResultError; 47 extern const int SQLResultOk; 48 extern const int SQLResultRow; 49 extern const int SQLResultSchema; 50 extern const int SQLResultFull; 51 extern const int SQLResultInterrupt; 52 53 class SQLiteDatabase { 54 WTF_MAKE_NONCOPYABLE(SQLiteDatabase); 55 friend class SQLiteTransaction; 56 public: 57 SQLiteDatabase(); 58 ~SQLiteDatabase(); 59 60 bool open(const String& filename, bool forWebSQLDatabase = false); 61 bool isOpen() const { return m_db; } 62 void close(); 63 void interrupt(); 64 bool isInterrupted(); 65 66 bool executeCommand(const String&); 67 bool returnsAtLeastOneResult(const String&); 68 69 bool tableExists(const String&); 70 void clearAllTables(); 71 void runVacuumCommand(); 72 void runIncrementalVacuumCommand(); 73 74 bool transactionInProgress() const { return m_transactionInProgress; } 75 76 int64_t lastInsertRowID(); 77 int lastChanges(); 78 79 void setBusyTimeout(int ms); 80 void setBusyHandler(int(*)(void*, int)); 81 82 void setFullsync(bool); 83 84 // Gets/sets the maximum size in bytes 85 // Depending on per-database attributes, the size will only be settable in units that are the page size of the database, which is established at creation 86 // These chunks will never be anything other than 512, 1024, 2048, 4096, 8192, 16384, or 32768 bytes in size. 87 // setMaximumSize() will round the size down to the next smallest chunk if the passed size doesn't align. 88 int64_t maximumSize(); 89 void setMaximumSize(int64_t); 90 91 // Gets the number of unused bytes in the database file. 92 int64_t freeSpaceSize(); 93 int64_t totalSize(); 94 95 // The SQLite SYNCHRONOUS pragma can be either FULL, NORMAL, or OFF 96 // FULL - Any writing calls to the DB block until the data is actually on the disk surface 97 // NORMAL - SQLite pauses at some critical moments when writing, but much less than FULL 98 // OFF - Calls return immediately after the data has been passed to disk 99 enum SynchronousPragma { SyncOff = 0, SyncNormal = 1, SyncFull = 2 }; 100 void setSynchronous(SynchronousPragma); 101 102 int lastError(); 103 const char* lastErrorMsg(); 104 105 sqlite3* sqlite3Handle() const { 106 ASSERT(m_sharable || currentThread() == m_openingThread); 107 return m_db; 108 } 109 110 void setAuthorizer(PassRefPtr<DatabaseAuthorizer>); 111 112 Mutex& databaseMutex() { return m_lockingMutex; } 113 bool isAutoCommitOn() const; 114 115 // The SQLite AUTO_VACUUM pragma can be either NONE, FULL, or INCREMENTAL. 116 // NONE - SQLite does not do any vacuuming 117 // FULL - SQLite moves all empty pages to the end of the DB file and truncates 118 // the file to remove those pages after every transaction. This option 119 // requires SQLite to store additional information about each page in 120 // the database file. 121 // INCREMENTAL - SQLite stores extra information for each page in the database 122 // file, but removes the empty pages only when PRAGMA INCREMANTAL_VACUUM 123 // is called. 124 enum AutoVacuumPragma { AutoVacuumNone = 0, AutoVacuumFull = 1, AutoVacuumIncremental = 2 }; 125 bool turnOnIncrementalAutoVacuum(); 126 127 // Set this flag to allow access from multiple threads. Not all multi-threaded accesses are safe! 128 // See http://www.sqlite.org/cvstrac/wiki?p=MultiThreading for more info. 129 #ifndef NDEBUG 130 void disableThreadingChecks(); 131 #else 132 void disableThreadingChecks() {} 133 #endif 134 135 private: 136 static int authorizerFunction(void*, int, const char*, const char*, const char*, const char*); 137 138 void enableAuthorizer(bool enable); 139 140 int pageSize(); 141 142 sqlite3* m_db; 143 int m_pageSize; 144 145 bool m_transactionInProgress; 146 bool m_sharable; 147 148 Mutex m_authorizerLock; 149 RefPtr<DatabaseAuthorizer> m_authorizer; 150 151 Mutex m_lockingMutex; 152 ThreadIdentifier m_openingThread; 153 154 Mutex m_databaseClosingMutex; 155 bool m_interrupted; 156 }; // class SQLiteDatabase 157 158 } // namespace WebCore 159 160 #endif 161
