Reviewed by Brady Eidson.
[WebKit-https.git] / WebCore / storage / DatabaseTask.cpp
1 /*
2  * Copyright (C) 2007, 2008 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 #include "config.h"
29 #include "DatabaseTask.h"
30
31 #include "Database.h"
32 #include "Logging.h"
33
34 namespace WebCore {
35
36 DatabaseTask::DatabaseTask(Database* database)
37     : m_database(database)
38     , m_complete(false)
39 {
40 }
41
42 DatabaseTask::~DatabaseTask()
43 {
44 }
45
46 void DatabaseTask::performTask()
47 {
48     // Database tasks are meant to be used only once, so make sure this one hasn't been performed before.
49     ASSERT(!m_complete);
50
51     LOG(StorageAPI, "Performing %s %p\n", debugTaskName(), this);
52
53     m_database->resetAuthorizer();
54     doPerformTask();
55     m_database->performPolicyChecks();
56
57     if (m_synchronousMutex)
58         m_synchronousMutex->lock();
59
60     m_complete = true;
61
62     if (m_synchronousMutex) {
63         m_synchronousCondition->signal();
64         m_synchronousMutex->unlock();
65     }
66 }
67
68 void DatabaseTask::lockForSynchronousScheduling()
69 {
70     // Called from main thread.
71     ASSERT(!m_synchronousMutex);
72     ASSERT(!m_synchronousCondition);
73     m_synchronousMutex.set(new Mutex);
74     m_synchronousCondition.set(new ThreadCondition);
75 }
76
77 void DatabaseTask::waitForSynchronousCompletion()
78 {
79     // Called from main thread.
80     m_synchronousMutex->lock();
81     if (!m_complete)
82         m_synchronousCondition->wait(*m_synchronousMutex);
83     m_synchronousMutex->unlock();
84 }
85
86 // *** DatabaseOpenTask ***
87 // Opens the database file and verifies the version matches the expected version.
88
89 DatabaseOpenTask::DatabaseOpenTask(Database* database)
90     : DatabaseTask(database)
91     , m_code(0)
92     , m_success(false)
93 {
94 }
95
96 void DatabaseOpenTask::doPerformTask()
97 {
98     m_success = database()->performOpenAndVerify(m_code);
99 }
100
101 #ifndef NDEBUG
102 const char* DatabaseOpenTask::debugTaskName() const
103 {
104     return "DatabaseOpenTask";
105 }
106 #endif
107
108 // *** DatabaseCloseTask ***
109 // Closes the database.
110
111 DatabaseCloseTask::DatabaseCloseTask(Database* database)
112     : DatabaseTask(database)
113 {
114 }
115
116 void DatabaseCloseTask::doPerformTask()
117 {
118     database()->close();
119 }
120
121 #ifndef NDEBUG
122 const char* DatabaseCloseTask::debugTaskName() const
123 {
124     return "DatabaseCloseTask";
125 }
126 #endif
127
128 // *** DatabaseTransactionTask ***
129 // Starts a transaction that will report its results via a callback.
130
131 DatabaseTransactionTask::DatabaseTransactionTask(PassRefPtr<SQLTransaction> transaction)
132     : DatabaseTask(transaction->database())
133     , m_transaction(transaction)
134 {
135 }
136
137 DatabaseTransactionTask::~DatabaseTransactionTask()
138 {
139 }
140
141 void DatabaseTransactionTask::doPerformTask()
142 {
143     if (m_transaction->performNextStep()) {
144         // The transaction is complete, we can move on to the next one.
145         MutexLocker locker(m_transaction->database()->m_transactionInProgressMutex);
146         m_transaction->database()->scheduleTransaction();
147     }
148 }
149
150 #ifndef NDEBUG
151 const char* DatabaseTransactionTask::debugTaskName() const
152 {
153     return "DatabaseTransactionTask";
154 }
155 #endif
156
157 // *** DatabaseTableNamesTask ***
158 // Retrieves a list of all tables in the database - for WebInspector support.
159
160 DatabaseTableNamesTask::DatabaseTableNamesTask(Database* database)
161     : DatabaseTask(database)
162 {
163 }
164
165 void DatabaseTableNamesTask::doPerformTask()
166 {
167     m_tableNames = database()->performGetTableNames();
168 }
169
170 #ifndef NDEBUG
171 const char* DatabaseTableNamesTask::debugTaskName() const
172 {
173     return "DatabaseTableNamesTask";
174 }
175 #endif
176
177 } // namespace WebCore