blob: 870e7765e9983bb3ab18bd924a84df256612a243 [file] [log] [blame]
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001/* statement.c - the statement type
2 *
3 * Copyright (C) 2005-2006 Gerhard Häring <gh@ghaering.de>
4 *
5 * This file is part of pysqlite.
6 *
7 * This software is provided 'as-is', without any express or implied
8 * warranty. In no event will the authors be held liable for any damages
9 * arising from the use of this software.
10 *
11 * Permission is granted to anyone to use this software for any purpose,
12 * including commercial applications, and to alter it and redistribute it
13 * freely, subject to the following restrictions:
14 *
15 * 1. The origin of this software must not be misrepresented; you must not
16 * claim that you wrote the original software. If you use this software
17 * in a product, an acknowledgment in the product documentation would be
18 * appreciated but is not required.
19 * 2. Altered source versions must be plainly marked as such, and must not be
20 * misrepresented as being the original software.
21 * 3. This notice may not be removed or altered from any source distribution.
22 */
23
24#include "statement.h"
25#include "cursor.h"
26#include "connection.h"
27#include "microprotocols.h"
28#include "prepare_protocol.h"
29#include "sqlitecompat.h"
30
31/* prototypes */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000032static int pysqlite_check_remaining_sql(const char* tail);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000033
34typedef enum {
35 LINECOMMENT_1,
36 IN_LINECOMMENT,
37 COMMENTSTART_1,
38 IN_COMMENT,
39 COMMENTEND_1,
40 NORMAL
41} parse_remaining_sql_state;
42
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000043int pysqlite_statement_create(pysqlite_Statement* self, pysqlite_Connection* connection, PyObject* sql)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000044{
45 const char* tail;
46 int rc;
47 PyObject* sql_str;
48 char* sql_cstr;
49
50 self->st = NULL;
51 self->in_use = 0;
52
53 if (PyString_Check(sql)) {
54 sql_str = sql;
55 Py_INCREF(sql_str);
56 } else if (PyUnicode_Check(sql)) {
57 sql_str = PyUnicode_AsUTF8String(sql);
58 if (!sql_str) {
59 rc = PYSQLITE_SQL_WRONG_TYPE;
60 return rc;
61 }
62 } else {
63 rc = PYSQLITE_SQL_WRONG_TYPE;
64 return rc;
65 }
66
Thomas Wouters477c8d52006-05-27 19:21:47 +000067 self->in_weakreflist = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000068 self->sql = sql_str;
69
70 sql_cstr = PyString_AsString(sql_str);
71
72 rc = sqlite3_prepare(connection->db,
73 sql_cstr,
74 -1,
75 &self->st,
76 &tail);
77
78 self->db = connection->db;
79
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000080 if (rc == SQLITE_OK && pysqlite_check_remaining_sql(tail)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000081 (void)sqlite3_finalize(self->st);
82 self->st = NULL;
83 rc = PYSQLITE_TOO_MUCH_SQL;
84 }
85
86 return rc;
87}
88
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000089int pysqlite_statement_bind_parameter(pysqlite_Statement* self, int pos, PyObject* parameter)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000090{
91 int rc = SQLITE_OK;
92 long longval;
93#ifdef HAVE_LONG_LONG
94 PY_LONG_LONG longlongval;
95#endif
96 const char* buffer;
97 char* string;
98 Py_ssize_t buflen;
99 PyObject* stringval;
100
101 if (parameter == Py_None) {
102 rc = sqlite3_bind_null(self->st, pos);
Guido van Rossum523d4f92007-01-15 00:31:49 +0000103 } else if (PyInt_CheckExact(parameter)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000104 longval = PyInt_AsLong(parameter);
105 rc = sqlite3_bind_int64(self->st, pos, (sqlite_int64)longval);
106#ifdef HAVE_LONG_LONG
107 } else if (PyLong_Check(parameter)) {
108 longlongval = PyLong_AsLongLong(parameter);
109 /* in the overflow error case, longlongval is -1, and an exception is set */
110 rc = sqlite3_bind_int64(self->st, pos, (sqlite_int64)longlongval);
111#endif
112 } else if (PyFloat_Check(parameter)) {
113 rc = sqlite3_bind_double(self->st, pos, PyFloat_AsDouble(parameter));
114 } else if (PyBuffer_Check(parameter)) {
115 if (PyObject_AsCharBuffer(parameter, &buffer, &buflen) == 0) {
116 rc = sqlite3_bind_blob(self->st, pos, buffer, buflen, SQLITE_TRANSIENT);
117 } else {
118 PyErr_SetString(PyExc_ValueError, "could not convert BLOB to buffer");
119 rc = -1;
120 }
121 } else if PyString_Check(parameter) {
122 string = PyString_AsString(parameter);
123 rc = sqlite3_bind_text(self->st, pos, string, -1, SQLITE_TRANSIENT);
124 } else if PyUnicode_Check(parameter) {
125 stringval = PyUnicode_AsUTF8String(parameter);
126 string = PyString_AsString(stringval);
127 rc = sqlite3_bind_text(self->st, pos, string, -1, SQLITE_TRANSIENT);
128 Py_DECREF(stringval);
129 } else {
130 rc = -1;
131 }
132
133 return rc;
134}
135
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000136void pysqlite_statement_bind_parameters(pysqlite_Statement* self, PyObject* parameters)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000137{
138 PyObject* current_param;
139 PyObject* adapted;
140 const char* binding_name;
141 int i;
142 int rc;
143 int num_params_needed;
144 int num_params;
145
146 Py_BEGIN_ALLOW_THREADS
147 num_params_needed = sqlite3_bind_parameter_count(self->st);
148 Py_END_ALLOW_THREADS
149
150 if (PyDict_Check(parameters)) {
151 /* parameters passed as dictionary */
152 for (i = 1; i <= num_params_needed; i++) {
153 Py_BEGIN_ALLOW_THREADS
154 binding_name = sqlite3_bind_parameter_name(self->st, i);
155 Py_END_ALLOW_THREADS
156 if (!binding_name) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000157 PyErr_Format(pysqlite_ProgrammingError, "Binding %d has no name, but you supplied a dictionary (which has only names).", i);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000158 return;
159 }
160
161 binding_name++; /* skip first char (the colon) */
162 current_param = PyDict_GetItemString(parameters, binding_name);
163 if (!current_param) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000164 PyErr_Format(pysqlite_ProgrammingError, "You did not supply a value for binding %d.", i);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000165 return;
166 }
167
168 Py_INCREF(current_param);
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000169 adapted = microprotocols_adapt(current_param, (PyObject*)&pysqlite_PrepareProtocolType, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000170 if (adapted) {
171 Py_DECREF(current_param);
172 } else {
173 PyErr_Clear();
174 adapted = current_param;
175 }
176
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000177 rc = pysqlite_statement_bind_parameter(self, i, adapted);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000178 Py_DECREF(adapted);
179
180 if (rc != SQLITE_OK) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000181 PyErr_Format(pysqlite_InterfaceError, "Error binding parameter :%s - probably unsupported type.", binding_name);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000182 return;
183 }
184 }
185 } else {
186 /* parameters passed as sequence */
187 num_params = PySequence_Length(parameters);
188 if (num_params != num_params_needed) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000189 PyErr_Format(pysqlite_ProgrammingError, "Incorrect number of bindings supplied. The current statement uses %d, and there are %d supplied.",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000190 num_params_needed, num_params);
191 return;
192 }
193 for (i = 0; i < num_params; i++) {
194 current_param = PySequence_GetItem(parameters, i);
195 if (!current_param) {
196 return;
197 }
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000198 adapted = microprotocols_adapt(current_param, (PyObject*)&pysqlite_PrepareProtocolType, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000199
200 if (adapted) {
201 Py_DECREF(current_param);
202 } else {
203 PyErr_Clear();
204 adapted = current_param;
205 }
206
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000207 rc = pysqlite_statement_bind_parameter(self, i + 1, adapted);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000208 Py_DECREF(adapted);
209
210 if (rc != SQLITE_OK) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000211 PyErr_Format(pysqlite_InterfaceError, "Error binding parameter %d - probably unsupported type.", i);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000212 return;
213 }
214 }
215 }
216}
217
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000218int pysqlite_statement_recompile(pysqlite_Statement* self, PyObject* params)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000219{
220 const char* tail;
221 int rc;
222 char* sql_cstr;
223 sqlite3_stmt* new_st;
224
225 sql_cstr = PyString_AsString(self->sql);
226
227 rc = sqlite3_prepare(self->db,
228 sql_cstr,
229 -1,
230 &new_st,
231 &tail);
232
233 if (rc == SQLITE_OK) {
234 /* The efficient sqlite3_transfer_bindings is only available in SQLite
235 * version 3.2.2 or later. For older SQLite releases, that might not
236 * even define SQLITE_VERSION_NUMBER, we do it the manual way.
237 */
238 #ifdef SQLITE_VERSION_NUMBER
239 #if SQLITE_VERSION_NUMBER >= 3002002
240 (void)sqlite3_transfer_bindings(self->st, new_st);
241 #endif
242 #else
243 statement_bind_parameters(self, params);
244 #endif
245
246 (void)sqlite3_finalize(self->st);
247 self->st = new_st;
248 }
249
250 return rc;
251}
252
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000253int pysqlite_statement_finalize(pysqlite_Statement* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000254{
255 int rc;
256
257 rc = SQLITE_OK;
258 if (self->st) {
259 Py_BEGIN_ALLOW_THREADS
260 rc = sqlite3_finalize(self->st);
261 Py_END_ALLOW_THREADS
262 self->st = NULL;
263 }
264
265 self->in_use = 0;
266
267 return rc;
268}
269
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000270int pysqlite_statement_reset(pysqlite_Statement* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000271{
272 int rc;
273
274 rc = SQLITE_OK;
275
276 if (self->in_use && self->st) {
277 Py_BEGIN_ALLOW_THREADS
278 rc = sqlite3_reset(self->st);
279 Py_END_ALLOW_THREADS
280
281 if (rc == SQLITE_OK) {
282 self->in_use = 0;
283 }
284 }
285
286 return rc;
287}
288
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000289void pysqlite_statement_mark_dirty(pysqlite_Statement* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000290{
291 self->in_use = 1;
292}
293
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000294void pysqlite_statement_dealloc(pysqlite_Statement* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000295{
296 int rc;
297
298 if (self->st) {
299 Py_BEGIN_ALLOW_THREADS
300 rc = sqlite3_finalize(self->st);
301 Py_END_ALLOW_THREADS
302 }
303
304 self->st = NULL;
305
306 Py_XDECREF(self->sql);
307
Thomas Wouters477c8d52006-05-27 19:21:47 +0000308 if (self->in_weakreflist != NULL) {
309 PyObject_ClearWeakRefs((PyObject*)self);
310 }
311
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000312 self->ob_type->tp_free((PyObject*)self);
313}
314
315/*
316 * Checks if there is anything left in an SQL string after SQLite compiled it.
317 * This is used to check if somebody tried to execute more than one SQL command
318 * with one execute()/executemany() command, which the DB-API and we don't
319 * allow.
320 *
321 * Returns 1 if there is more left than should be. 0 if ok.
322 */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000323static int pysqlite_check_remaining_sql(const char* tail)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000324{
325 const char* pos = tail;
326
327 parse_remaining_sql_state state = NORMAL;
328
329 for (;;) {
330 switch (*pos) {
331 case 0:
332 return 0;
333 case '-':
334 if (state == NORMAL) {
335 state = LINECOMMENT_1;
336 } else if (state == LINECOMMENT_1) {
337 state = IN_LINECOMMENT;
338 }
339 break;
340 case ' ':
341 case '\t':
342 break;
343 case '\n':
344 case 13:
345 if (state == IN_LINECOMMENT) {
346 state = NORMAL;
347 }
348 break;
349 case '/':
350 if (state == NORMAL) {
351 state = COMMENTSTART_1;
352 } else if (state == COMMENTEND_1) {
353 state = NORMAL;
354 } else if (state == COMMENTSTART_1) {
355 return 1;
356 }
357 break;
358 case '*':
359 if (state == NORMAL) {
360 return 1;
361 } else if (state == LINECOMMENT_1) {
362 return 1;
363 } else if (state == COMMENTSTART_1) {
364 state = IN_COMMENT;
365 } else if (state == IN_COMMENT) {
366 state = COMMENTEND_1;
367 }
368 break;
369 default:
370 if (state == COMMENTEND_1) {
371 state = IN_COMMENT;
372 } else if (state == IN_LINECOMMENT) {
373 } else if (state == IN_COMMENT) {
374 } else {
375 return 1;
376 }
377 }
378
379 pos++;
380 }
381
382 return 0;
383}
384
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000385PyTypeObject pysqlite_StatementType = {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000386 PyObject_HEAD_INIT(NULL)
387 0, /* ob_size */
388 MODULE_NAME ".Statement", /* tp_name */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000389 sizeof(pysqlite_Statement), /* tp_basicsize */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000390 0, /* tp_itemsize */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000391 (destructor)pysqlite_statement_dealloc, /* tp_dealloc */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000392 0, /* tp_print */
393 0, /* tp_getattr */
394 0, /* tp_setattr */
395 0, /* tp_compare */
396 0, /* tp_repr */
397 0, /* tp_as_number */
398 0, /* tp_as_sequence */
399 0, /* tp_as_mapping */
400 0, /* tp_hash */
401 0, /* tp_call */
402 0, /* tp_str */
403 0, /* tp_getattro */
404 0, /* tp_setattro */
405 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000406 Py_TPFLAGS_DEFAULT, /* tp_flags */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000407 0, /* tp_doc */
408 0, /* tp_traverse */
409 0, /* tp_clear */
410 0, /* tp_richcompare */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000411 offsetof(pysqlite_Statement, in_weakreflist), /* tp_weaklistoffset */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000412 0, /* tp_iter */
413 0, /* tp_iternext */
414 0, /* tp_methods */
415 0, /* tp_members */
416 0, /* tp_getset */
417 0, /* tp_base */
418 0, /* tp_dict */
419 0, /* tp_descr_get */
420 0, /* tp_descr_set */
421 0, /* tp_dictoffset */
422 (initproc)0, /* tp_init */
423 0, /* tp_alloc */
424 0, /* tp_new */
425 0 /* tp_free */
426};
427
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000428extern int pysqlite_statement_setup_types(void)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000429{
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000430 pysqlite_StatementType.tp_new = PyType_GenericNew;
431 return PyType_Ready(&pysqlite_StatementType);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000432}