1 /* 2 * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved. 3 * Copyright (C) 2007 Justin Haygood (jhaygood@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 "wtf/Threading.h" 31 #include "wtf/ThreadingPrimitives.h" 32 #include "wtf/text/CString.h" 33 #include "wtf/text/WTFString.h" 34 35 #if COMPILER(MSVC) 36 #pragma warning(disable: 4800) 37 #endif 38 39 struct sqlite3; 40 41 namespace WebCore { 42 43 class DatabaseAuthorizer; 44 class SQLiteStatement; 45 class SQLiteTransaction; 46 47 extern const int SQLResultDone; 48 extern const int SQLResultError; 49 extern const int SQLResultOk; 50 extern const int SQLResultRow; 51 extern const int SQLResultSchema; 52 extern const int SQLResultFull; 53 extern const int SQLResultInterrupt; 54 extern const int SQLResultConstraint; 55 56 class SQLiteDatabase { 57 WTF_MAKE_NONCOPYABLE(SQLiteDatabase); 58 friend class SQLiteTransaction; 59 public: 60 SQLiteDatabase(); 61 ~SQLiteDatabase(); 62 63 bool open(const String& filename, bool forWebSQLDatabase = false); isOpen()64 bool isOpen() const { return m_db; } 65 void close(); 66 void interrupt(); 67 bool isInterrupted(); 68 69 void updateLastChangesCount(); 70 71 bool executeCommand(const String&); 72 bool returnsAtLeastOneResult(const String&); 73 74 bool tableExists(const String&); 75 void clearAllTables(); 76 int runVacuumCommand(); 77 int runIncrementalVacuumCommand(); 78 transactionInProgress()79 bool transactionInProgress() const { return m_transactionInProgress; } 80 81 int64_t lastInsertRowID(); 82 int lastChanges(); 83 84 void setBusyTimeout(int ms); 85 void setBusyHandler(int(*)(void*, int)); 86 87 void setFullsync(bool); 88 89 // Gets/sets the maximum size in bytes 90 // 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 91 // These chunks will never be anything other than 512, 1024, 2048, 4096, 8192, 16384, or 32768 bytes in size. 92 // setMaximumSize() will round the size down to the next smallest chunk if the passed size doesn't align. 93 int64_t maximumSize(); 94 void setMaximumSize(int64_t); 95 96 // Gets the number of unused bytes in the database file. 97 int64_t freeSpaceSize(); 98 int64_t totalSize(); 99 100 // The SQLite SYNCHRONOUS pragma can be either FULL, NORMAL, or OFF 101 // FULL - Any writing calls to the DB block until the data is actually on the disk surface 102 // NORMAL - SQLite pauses at some critical moments when writing, but much less than FULL 103 // OFF - Calls return immediately after the data has been passed to disk 104 enum SynchronousPragma { SyncOff = 0, SyncNormal = 1, SyncFull = 2 }; 105 void setSynchronous(SynchronousPragma); 106 107 int lastError(); 108 const char* lastErrorMsg(); 109 sqlite3Handle()110 sqlite3* sqlite3Handle() const { 111 ASSERT(m_sharable || currentThread() == m_openingThread || !m_db); 112 return m_db; 113 } 114 115 void setAuthorizer(PassRefPtr<DatabaseAuthorizer>); 116 databaseMutex()117 Mutex& databaseMutex() { return m_lockingMutex; } 118 bool isAutoCommitOn() const; 119 120 // The SQLite AUTO_VACUUM pragma can be either NONE, FULL, or INCREMENTAL. 121 // NONE - SQLite does not do any vacuuming 122 // FULL - SQLite moves all empty pages to the end of the DB file and truncates 123 // the file to remove those pages after every transaction. This option 124 // requires SQLite to store additional information about each page in 125 // the database file. 126 // INCREMENTAL - SQLite stores extra information for each page in the database 127 // file, but removes the empty pages only when PRAGMA INCREMANTAL_VACUUM 128 // is called. 129 enum AutoVacuumPragma { AutoVacuumNone = 0, AutoVacuumFull = 1, AutoVacuumIncremental = 2 }; 130 bool turnOnIncrementalAutoVacuum(); 131 132 // Set this flag to allow access from multiple threads. Not all multi-threaded accesses are safe! 133 // See http://www.sqlite.org/cvstrac/wiki?p=MultiThreading for more info. 134 #ifndef NDEBUG 135 void disableThreadingChecks(); 136 #else disableThreadingChecks()137 void disableThreadingChecks() {} 138 #endif 139 140 private: 141 static int authorizerFunction(void*, int, const char*, const char*, const char*, const char*); 142 143 void enableAuthorizer(bool enable); 144 145 int pageSize(); 146 147 sqlite3* m_db; 148 int m_pageSize; 149 150 bool m_transactionInProgress; 151 bool m_sharable; 152 153 Mutex m_authorizerLock; 154 RefPtr<DatabaseAuthorizer> m_authorizer; 155 156 Mutex m_lockingMutex; 157 ThreadIdentifier m_openingThread; 158 159 Mutex m_databaseClosingMutex; 160 bool m_interrupted; 161 162 int m_openError; 163 CString m_openErrorMessage; 164 165 int m_lastChangesCount; 166 }; 167 168 } // namespace WebCore 169 170 #endif 171