7f18c902f4617c7db6b81b3c0e36fe8ff725a2fc
[WebKit-https.git] / Source / WebCore / Modules / webdatabase / DatabaseSync.h
1 /*
2  * Copyright (C) 2010 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 DatabaseSync_h
32 #define DatabaseSync_h
33
34 #if ENABLE(SQL_DATABASE)
35
36 #include "AbstractDatabase.h"
37 #include <wtf/Forward.h>
38 #include <wtf/text/WTFString.h>
39
40 #ifndef NDEBUG
41 #include "SecurityOrigin.h"
42 #endif
43
44 namespace WebCore {
45
46 class DatabaseCallback;
47 class SQLTransactionSync;
48 class SQLTransactionSyncCallback;
49 class ScriptExecutionContext;
50 class SecurityOrigin;
51
52 typedef int ExceptionCode;
53
54 // Instances of this class should be created and used only on the worker's context thread.
55 class DatabaseSync : public AbstractDatabase {
56 public:
57     virtual ~DatabaseSync();
58
59     static PassRefPtr<DatabaseSync> openDatabaseSync(ScriptExecutionContext*, const String& name, const String& expectedVersion,
60                                                      const String& displayName, unsigned long estimatedSize, PassRefPtr<DatabaseCallback>, ExceptionCode&);
61     void changeVersion(const String& oldVersion, const String& newVersion, PassRefPtr<SQLTransactionSyncCallback>, ExceptionCode&);
62     void transaction(PassRefPtr<SQLTransactionSyncCallback>, ExceptionCode&);
63     void readTransaction(PassRefPtr<SQLTransactionSyncCallback>, ExceptionCode&);
64
65     virtual void markAsDeletedAndClose();
66     virtual void closeImmediately();
67
68     const String& lastErrorMessage() const { return m_lastErrorMessage; }
69     void setLastErrorMessage(const String& message) { m_lastErrorMessage = message; }
70     void setLastErrorMessage(const char* message, int sqliteCode)
71     {
72         setLastErrorMessage(String::format("%s (%d)", message, sqliteCode));
73     }
74     void setLastErrorMessage(const char* message, int sqliteCode, const char* sqliteMessage)
75     {
76         setLastErrorMessage(String::format("%s (%d, %s)", message, sqliteCode, sqliteMessage));
77     }
78
79 private:
80     DatabaseSync(ScriptExecutionContext*, const String& name, const String& expectedVersion,
81                  const String& displayName, unsigned long estimatedSize);
82     void runTransaction(PassRefPtr<SQLTransactionSyncCallback>, bool readOnly, ExceptionCode&);
83
84     String m_lastErrorMessage;
85 };
86
87 } // namespace WebCore
88
89 #endif // ENABLE(SQL_DATABASE)
90
91 #endif