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