fc45b05e1b1a453474503ce391723ff5e8b5b4ab
[WebKit-https.git] / WebCore / storage / SQLStatement.cpp
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 #include "config.h"
29 #include "SQLStatement.h"
30
31 #include "Database.h"
32 #include "DatabaseAuthorizer.h"
33 #include "Logging.h"
34 #include "SQLError.h"
35 #include "SQLiteDatabase.h"
36 #include "SQLiteStatement.h"
37 #include "SQLResultSet.h"
38 #include "SQLStatementCallback.h"
39 #include "SQLStatementErrorCallback.h"
40 #include "SQLTransaction.h"
41 #include "SQLValue.h"
42
43 namespace WebCore {
44
45 SQLStatement::SQLStatement(const String& statement, const Vector<SQLValue>& arguments, PassRefPtr<SQLStatementCallback> callback, PassRefPtr<SQLStatementErrorCallback> errorCallback)
46     : m_statement(statement.copy())
47     , m_arguments(arguments)
48     , m_statementCallback(callback)
49     , m_statementErrorCallback(errorCallback)
50 {
51 }
52    
53 bool SQLStatement::execute(Database* db)
54 {
55     ASSERT(!m_resultSet);
56
57     // This transaction might have been marked bad while it was being set up on the main thread
58     if (m_error)
59         return false;
60         
61     // If we're re-running this statement after a quota violation, we need to clear that error now
62     clearFailureDueToQuota();
63     
64     SQLiteDatabase* database = &db->m_sqliteDatabase;
65     
66     SQLiteStatement statement(*database, m_statement);
67     int result = statement.prepare();
68
69     if (result != SQLResultOk) {
70         LOG(StorageAPI, "Unable to verify correctness of statement %s - error %i (%s)", m_statement.ascii().data(), result, statement.lastErrorMsg());
71         m_error = new SQLError(1, database->lastErrorMsg());
72         return false;
73     }
74
75     // FIXME:  If the statement uses the ?### syntax supported by sqlite, the bind parameter count is very likely off from the number of question marks.
76     // If this is the case, they might be trying to do something fishy or malicious
77     if (statement.bindParameterCount() != m_arguments.size()) {
78         LOG(StorageAPI, "Bind parameter count doesn't match number of question marks");
79         m_error = new SQLError(1, "number of '?'s in statement string does not match argument count");
80         return false;
81     }
82
83     for (unsigned i = 0; i < m_arguments.size(); ++i) {
84         result = statement.bindValue(i + 1, m_arguments[i]);
85         if (result == SQLResultFull) {
86             setFailureDueToQuota();
87             return false;
88         }
89         
90         if (result != SQLResultOk) {
91             LOG(StorageAPI, "Failed to bind value index %i to statement for query '%s'", i + 1, m_statement.ascii().data());
92             m_error = new SQLError(1, database->lastErrorMsg());
93             return false;
94         }
95     }
96
97     RefPtr<SQLResultSet> resultSet = new SQLResultSet;
98
99     // Step so we can fetch the column names.
100     result = statement.step();
101     if (result == SQLResultRow) {
102         int columnCount = statement.columnCount();
103         SQLResultSetRowList* rows = resultSet->rows();
104
105         for (int i = 0; i < columnCount; i++)
106             rows->addColumn(statement.getColumnName16(i));
107
108         do {
109             for (int i = 0; i < columnCount; i++) {
110                 // FIXME: Look at the column type?
111                 rows->addResult(statement.getColumnText16(i));
112             }
113
114             result = statement.step();
115         } while (result == SQLResultRow);
116
117         if (result != SQLResultDone) {
118             m_error = new SQLError(1, database->lastErrorMsg());
119             return false;
120         }
121     } else if (result == SQLResultDone) {
122         // Didn't find anything, or was an insert
123         if (db->m_databaseAuthorizer->lastActionWasInsert())
124             resultSet->setInsertId(database->lastInsertRowID());
125     } else if (result == SQLResultFull) {
126         // Return the Quota error - the delegate will be asked for more space and this statement might be re-run
127         setFailureDueToQuota();
128         return false;
129     } else {
130         m_error = new SQLError(1, database->lastErrorMsg());
131         return false;
132     }
133
134     // FIXME: If the spec allows triggers, and we want to be "accurate" in a different way, we'd use
135     // sqlite3_total_changes() here instead of sqlite3_changed, because that includes rows modified from within a trigger
136     // For now, this seems sufficient
137     resultSet->setRowsAffected(database->lastChanges());
138
139     m_resultSet = resultSet;
140     return true;
141 }
142
143 void SQLStatement::setVersionMismatchedError()
144 {
145     ASSERT(!m_error && !m_resultSet);
146     m_error = new SQLError(2, "current version of the database and `oldVersion` argument do not match");
147 }
148
149 bool SQLStatement::performCallback(SQLTransaction* transaction)
150 {
151     ASSERT(transaction);
152     
153     bool callbackError = false;
154     
155     // Call the appropriate statement callback and track if it resulted in an error,
156     // because then we need to jump to the transaction error callback.
157     if (m_error) {
158         ASSERT(m_statementErrorCallback);
159         callbackError = m_statementErrorCallback->handleEvent(transaction, m_error.get());
160     } else if (m_statementCallback)
161         m_statementCallback->handleEvent(transaction, m_resultSet.get(), callbackError);
162
163     return callbackError;
164 }
165
166 void SQLStatement::setFailureDueToQuota()
167 {
168     ASSERT(!m_error && !m_resultSet);
169     m_error = new SQLError(4, "there was not enough remaining storage space, or the storage quota was reached and the user declined to allow more space");
170 }
171
172 void SQLStatement::clearFailureDueToQuota()
173 {
174     ASSERT(!m_error || m_error->code() == 4);
175     m_error = 0;
176 }
177
178 bool SQLStatement::lastExecutionFailedDueToQuota() const 
179
180     return m_error && m_error->code() == 4; 
181 }
182
183 } // namespace WebCore