2007-12-29 Jan Michael Alonzo <jmalonzo@unpluggable.com>
[WebKit.git] / WebCore / storage / Database.h
1 /*
2  * Copyright (C) 2007 Apple 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
6  * are met:
7  *
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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef Database_h
30 #define Database_h
31
32 #include "PlatformString.h"
33 #include "SecurityOrigin.h"
34 #include "SQLiteDatabase.h"
35 #include "SQLTransaction.h"
36 #include "StringHash.h"
37 #include "Threading.h"
38 #include "Timer.h"
39 #include "VoidCallback.h"
40
41 #include <wtf/Forward.h>
42 #include <wtf/HashSet.h>
43 #include <wtf/OwnPtr.h>
44 #include <wtf/PassRefPtr.h>
45 #include <wtf/RefPtr.h>
46 #include <wtf/Deque.h>
47
48 namespace WebCore {
49
50 class DatabaseAuthorizer;
51 class DatabaseThread;
52 class Document;
53 class SecurityOriginData;
54 class SQLResultSet;
55 class SQLTransactionCallback;
56 class SQLTransactionErrorCallback;
57 class SQLValue;
58     
59 typedef int ExceptionCode;
60
61 class Database : public ThreadSafeShared<Database> {
62     friend class SQLStatement;
63     friend class SQLTransaction;
64 public:
65     ~Database();
66
67 // Direct support for the DOM API
68     static PassRefPtr<Database> openDatabase(Document* document, const String& name, const String& expectedVersion, const String& displayName, unsigned long estimatedSize, ExceptionCode&);
69     String version() const;
70     void changeVersion(const String& oldVersion, const String& newVersion, 
71                        PassRefPtr<SQLTransactionCallback> callback, PassRefPtr<SQLTransactionErrorCallback> errorCallback,
72                        PassRefPtr<VoidCallback> successCallback);
73     void transaction(PassRefPtr<SQLTransactionCallback> callback, PassRefPtr<SQLTransactionErrorCallback> errorCallback,
74                      PassRefPtr<VoidCallback> successCallback);
75     
76 // Internal engine support
77     void databaseThreadGoingAway();
78     static const String& databaseInfoTableName();
79
80     void disableAuthorizer();
81     void enableAuthorizer();
82
83     Vector<String> tableNames();
84
85     Document* document() const { return m_document; }
86     SecurityOriginData securityOriginData() const;
87     String stringIdentifier() const;
88     
89     bool getVersionFromDatabase(String&);
90     bool setVersionInDatabase(const String&);
91     void setExpectedVersion(const String&);
92     bool versionMatchesExpected() const;
93     
94 // Called from DatabaseThread, must be prepared to work on the background thread
95     void resetAuthorizer();
96     void performPolicyChecks();
97
98     bool performOpenAndVerify(ExceptionCode&);
99
100     void performTransactionStep();
101
102     Vector<String> performGetTableNames();
103
104 private:
105     Database(Document* document, const String& name, const String& expectedVersion);
106
107     bool openAndVerifyVersion(ExceptionCode&);
108
109     void scheduleTransaction(PassRefPtr<SQLTransaction>);
110     void scheduleTransactionCallback(SQLTransaction*);
111     void scheduleTransactionStep();
112     
113     Mutex m_transactionMutex;
114     Deque<RefPtr<SQLTransaction> > m_transactionQueue;
115     RefPtr<SQLTransaction> m_currentTransaction;
116     
117     static void scheduleFileSizeTimerOnMainThread(Database*);
118     static void performScheduleFileSizeTimers();
119     void scheduleFileSizeTimer();
120     void sizeTimerFired(Timer<Database>*);
121     OwnPtr<Timer<Database> > m_sizeTimer;
122
123     static void deliverAllPendingCallbacks();
124     void deliverPendingCallback();
125
126     Document* m_document;
127     RefPtr<SecurityOrigin> m_securityOrigin;
128     String m_name;
129     int m_guid;
130     String m_expectedVersion;
131     String m_filename;
132
133     SQLiteDatabase m_sqliteDatabase;
134     RefPtr<DatabaseAuthorizer> m_databaseAuthorizer;
135
136     DatabaseThread* m_databaseThread;
137
138     Mutex m_callbackMutex;
139     RefPtr<SQLTransaction> m_transactionPendingCallback;
140
141 #ifndef NDEBUG
142     String databaseDebugName() const { return m_securityOrigin->toString() + "::" + m_name; }
143 #endif
144
145     static Mutex& globalCallbackMutex();
146     static HashSet<RefPtr<Database> >& globalCallbackSet();
147     static bool s_globalCallbackScheduled;
148
149     static int guidForOriginAndName(const String&, const String&);
150
151     static Mutex& guidMutex();
152     static HashMap<int, String>& guidToVersionMap();
153     static HashMap<int, HashSet<Database*>*>& guidToDatabaseMap();
154 };
155
156 } // namespace WebCore
157
158 #endif // Database_h