blob: 7f13f96cac4d057c03e746615950e27680933a57 [file] [log] [blame]
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001/* connection.c - the connection type
2 *
Florent Xiclunac934f322010-09-03 23:47:32 +00003 * Copyright (C) 2004-2010 Gerhard Häring <gh@ghaering.de>
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004 *
5 * This file is part of pysqlite.
Victor Stinner86999502010-05-19 01:27:23 +00006 *
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007 * 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 "cache.h"
25#include "module.h"
Victor Stinner4a21e572020-04-15 02:35:41 +020026#include "structmember.h" // PyMemberDef
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000027#include "connection.h"
28#include "statement.h"
29#include "cursor.h"
30#include "prepare_protocol.h"
31#include "util.h"
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000032
Gerhard Häringe7ea7452008-03-29 00:45:29 +000033#define ACTION_FINALIZE 1
34#define ACTION_RESET 2
35
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +020036#if SQLITE_VERSION_NUMBER >= 3014000
37#define HAVE_TRACE_V2
38#endif
39
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +010040#include "clinic/connection.c.h"
41/*[clinic input]
42module _sqlite3
43class _sqlite3.Connection "pysqlite_Connection *" "pysqlite_ConnectionType"
44[clinic start generated code]*/
45/*[clinic end generated code: output=da39a3ee5e6b4b0d input=aa796073bd8f69db]*/
46
Martin v. Löwise75fc142013-11-07 18:46:53 +010047_Py_IDENTIFIER(cursor);
48
Serhiy Storchaka28914922016-09-01 22:18:03 +030049static const char * const begin_statements[] = {
50 "BEGIN ",
51 "BEGIN DEFERRED",
52 "BEGIN IMMEDIATE",
53 "BEGIN EXCLUSIVE",
54 NULL
55};
56
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +020057static int pysqlite_connection_set_isolation_level(pysqlite_Connection* self, PyObject* isolation_level, void *Py_UNUSED(ignored));
Gerhard Häringf9cee222010-03-05 15:20:03 +000058static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000059
Thomas Wouters0e3f5912006-08-11 14:57:12 +000060
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +000061int pysqlite_connection_init(pysqlite_Connection* self, PyObject* args, PyObject* kwargs)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000062{
Antoine Pitrou902fc8b2013-02-10 00:02:44 +010063 static char *kwlist[] = {
64 "database", "timeout", "detect_types", "isolation_level",
65 "check_same_thread", "factory", "cached_statements", "uri",
66 NULL
67 };
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000068
Serhiy Storchaka8f87eef2020-04-12 14:58:27 +030069 const char* database;
Anders Lorentsena22a1272017-11-07 01:47:43 +010070 PyObject* database_obj;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000071 int detect_types = 0;
72 PyObject* isolation_level = NULL;
73 PyObject* factory = NULL;
74 int check_same_thread = 1;
75 int cached_statements = 100;
Antoine Pitrou902fc8b2013-02-10 00:02:44 +010076 int uri = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000077 double timeout = 5.0;
78 int rc;
79
Anders Lorentsena22a1272017-11-07 01:47:43 +010080 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O&|diOiOip", kwlist,
81 PyUnicode_FSConverter, &database_obj, &timeout, &detect_types,
Antoine Pitrou902fc8b2013-02-10 00:02:44 +010082 &isolation_level, &check_same_thread,
83 &factory, &cached_statements, &uri))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000084 {
Gerhard Häringe7ea7452008-03-29 00:45:29 +000085 return -1;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000086 }
87
Anders Lorentsena22a1272017-11-07 01:47:43 +010088 database = PyBytes_AsString(database_obj);
89
Gerhard Häringf9cee222010-03-05 15:20:03 +000090 self->initialized = 1;
91
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000092 self->begin_statement = NULL;
93
Oren Milman93c5a5d2017-10-10 22:27:46 +030094 Py_CLEAR(self->statement_cache);
95 Py_CLEAR(self->statements);
96 Py_CLEAR(self->cursors);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000097
98 Py_INCREF(Py_None);
Oren Milman93c5a5d2017-10-10 22:27:46 +030099 Py_XSETREF(self->row_factory, Py_None);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000100
101 Py_INCREF(&PyUnicode_Type);
Oren Milman93c5a5d2017-10-10 22:27:46 +0300102 Py_XSETREF(self->text_factory, (PyObject*)&PyUnicode_Type);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000103
Antoine Pitrou902fc8b2013-02-10 00:02:44 +0100104#ifdef SQLITE_OPEN_URI
105 Py_BEGIN_ALLOW_THREADS
106 rc = sqlite3_open_v2(database, &self->db,
107 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
108 (uri ? SQLITE_OPEN_URI : 0), NULL);
109#else
110 if (uri) {
111 PyErr_SetString(pysqlite_NotSupportedError, "URIs not supported");
112 return -1;
113 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000114 Py_BEGIN_ALLOW_THREADS
Aviv Palivoda86a67052017-03-03 12:58:17 +0200115 /* No need to use sqlite3_open_v2 as sqlite3_open(filename, db) is the
116 same as sqlite3_open_v2(filename, db, SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE, NULL). */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000117 rc = sqlite3_open(database, &self->db);
Antoine Pitrou902fc8b2013-02-10 00:02:44 +0100118#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000119 Py_END_ALLOW_THREADS
120
Anders Lorentsena22a1272017-11-07 01:47:43 +0100121 Py_DECREF(database_obj);
122
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000123 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000124 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000125 return -1;
126 }
127
128 if (!isolation_level) {
Neal Norwitzefee9f52007-10-27 02:50:52 +0000129 isolation_level = PyUnicode_FromString("");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000130 if (!isolation_level) {
131 return -1;
132 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000133 } else {
134 Py_INCREF(isolation_level);
135 }
Oren Milman93c5a5d2017-10-10 22:27:46 +0300136 Py_CLEAR(self->isolation_level);
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +0200137 if (pysqlite_connection_set_isolation_level(self, isolation_level, NULL) < 0) {
Victor Stinnercb1f74e2013-12-19 16:38:03 +0100138 Py_DECREF(isolation_level);
139 return -1;
140 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000141 Py_DECREF(isolation_level);
142
Erlend Egeberg Aaslanda937ab42020-09-27 14:14:50 +0200143 self->statement_cache = (pysqlite_Cache*)PyObject_CallFunction((PyObject*)pysqlite_CacheType, "Oi", self, cached_statements);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000144 if (PyErr_Occurred()) {
145 return -1;
146 }
147
Gerhard Häringf9cee222010-03-05 15:20:03 +0000148 self->created_statements = 0;
149 self->created_cursors = 0;
150
151 /* Create lists of weak references to statements/cursors */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000152 self->statements = PyList_New(0);
Gerhard Häringf9cee222010-03-05 15:20:03 +0000153 self->cursors = PyList_New(0);
154 if (!self->statements || !self->cursors) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000155 return -1;
156 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000157
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000158 /* By default, the Cache class INCREFs the factory in its initializer, and
159 * decrefs it in its deallocator method. Since this would create a circular
160 * reference here, we're breaking it by decrementing self, and telling the
161 * cache class to not decref the factory (self) in its deallocator.
162 */
163 self->statement_cache->decref_factory = 0;
164 Py_DECREF(self);
165
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000166 self->detect_types = detect_types;
167 self->timeout = timeout;
168 (void)sqlite3_busy_timeout(self->db, (int)(timeout*1000));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000169 self->thread_ident = PyThread_get_thread_ident();
170 self->check_same_thread = check_same_thread;
171
gescheitb9a03762019-07-13 06:15:49 +0300172 self->function_pinboard_trace_callback = NULL;
173 self->function_pinboard_progress_handler = NULL;
174 self->function_pinboard_authorizer_cb = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000175
Oren Milman93c5a5d2017-10-10 22:27:46 +0300176 Py_XSETREF(self->collations, PyDict_New());
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000177 if (!self->collations) {
178 return -1;
179 }
180
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000181 self->Warning = pysqlite_Warning;
182 self->Error = pysqlite_Error;
183 self->InterfaceError = pysqlite_InterfaceError;
184 self->DatabaseError = pysqlite_DatabaseError;
185 self->DataError = pysqlite_DataError;
186 self->OperationalError = pysqlite_OperationalError;
187 self->IntegrityError = pysqlite_IntegrityError;
188 self->InternalError = pysqlite_InternalError;
189 self->ProgrammingError = pysqlite_ProgrammingError;
190 self->NotSupportedError = pysqlite_NotSupportedError;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191
192 return 0;
193}
194
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000195/* action in (ACTION_RESET, ACTION_FINALIZE) */
Gerhard Häringf9cee222010-03-05 15:20:03 +0000196void pysqlite_do_all_statements(pysqlite_Connection* self, int action, int reset_cursors)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000197{
Thomas Wouters477c8d52006-05-27 19:21:47 +0000198 int i;
199 PyObject* weakref;
200 PyObject* statement;
Gerhard Häringf9cee222010-03-05 15:20:03 +0000201 pysqlite_Cursor* cursor;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000202
Thomas Wouters477c8d52006-05-27 19:21:47 +0000203 for (i = 0; i < PyList_Size(self->statements); i++) {
204 weakref = PyList_GetItem(self->statements, i);
205 statement = PyWeakref_GetObject(weakref);
206 if (statement != Py_None) {
Benjamin Peterson5c2b09e2011-05-31 21:31:37 -0500207 Py_INCREF(statement);
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000208 if (action == ACTION_RESET) {
209 (void)pysqlite_statement_reset((pysqlite_Statement*)statement);
210 } else {
211 (void)pysqlite_statement_finalize((pysqlite_Statement*)statement);
212 }
Benjamin Peterson5c2b09e2011-05-31 21:31:37 -0500213 Py_DECREF(statement);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000214 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000215 }
Gerhard Häringf9cee222010-03-05 15:20:03 +0000216
217 if (reset_cursors) {
218 for (i = 0; i < PyList_Size(self->cursors); i++) {
219 weakref = PyList_GetItem(self->cursors, i);
220 cursor = (pysqlite_Cursor*)PyWeakref_GetObject(weakref);
221 if ((PyObject*)cursor != Py_None) {
222 cursor->reset = 1;
223 }
224 }
225 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000226}
227
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000228void pysqlite_connection_dealloc(pysqlite_Connection* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000229{
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200230 PyTypeObject *tp = Py_TYPE(self);
231
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000232 Py_XDECREF(self->statement_cache);
233
234 /* Clean up if user has not called .close() explicitly. */
235 if (self->db) {
Aviv Palivoda86a67052017-03-03 12:58:17 +0200236 SQLITE3_CLOSE(self->db);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000237 }
238
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000239 Py_XDECREF(self->isolation_level);
gescheitb9a03762019-07-13 06:15:49 +0300240 Py_XDECREF(self->function_pinboard_trace_callback);
241 Py_XDECREF(self->function_pinboard_progress_handler);
242 Py_XDECREF(self->function_pinboard_authorizer_cb);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000243 Py_XDECREF(self->row_factory);
244 Py_XDECREF(self->text_factory);
245 Py_XDECREF(self->collations);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000246 Py_XDECREF(self->statements);
Gerhard Häringf9cee222010-03-05 15:20:03 +0000247 Py_XDECREF(self->cursors);
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200248
249 tp->tp_free(self);
250 Py_DECREF(tp);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000251}
252
Gerhard Häringf9cee222010-03-05 15:20:03 +0000253/*
254 * Registers a cursor with the connection.
255 *
256 * 0 => error; 1 => ok
257 */
258int pysqlite_connection_register_cursor(pysqlite_Connection* connection, PyObject* cursor)
259{
260 PyObject* weakref;
261
262 weakref = PyWeakref_NewRef((PyObject*)cursor, NULL);
263 if (!weakref) {
264 goto error;
265 }
266
267 if (PyList_Append(connection->cursors, weakref) != 0) {
268 Py_CLEAR(weakref);
269 goto error;
270 }
271
272 Py_DECREF(weakref);
273
274 return 1;
275error:
276 return 0;
277}
278
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100279/*[clinic input]
280_sqlite3.Connection.cursor as pysqlite_connection_cursor
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000281
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100282 factory: object = NULL
283
284Return a cursor for the connection.
285[clinic start generated code]*/
286
287static PyObject *
288pysqlite_connection_cursor_impl(pysqlite_Connection *self, PyObject *factory)
289/*[clinic end generated code: output=562432a9e6af2aa1 input=4127345aa091b650]*/
290{
291 PyObject* cursor;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000292
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000293 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000294 return NULL;
295 }
296
297 if (factory == NULL) {
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200298 factory = (PyObject*)pysqlite_CursorType;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000299 }
300
Petr Viktorinffd97532020-02-11 17:46:57 +0100301 cursor = PyObject_CallOneArg(factory, (PyObject *)self);
Serhiy Storchakaef113cd2016-08-29 14:29:55 +0300302 if (cursor == NULL)
303 return NULL;
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200304 if (!PyObject_TypeCheck(cursor, pysqlite_CursorType)) {
Serhiy Storchakaef113cd2016-08-29 14:29:55 +0300305 PyErr_Format(PyExc_TypeError,
306 "factory must return a cursor, not %.100s",
307 Py_TYPE(cursor)->tp_name);
308 Py_DECREF(cursor);
309 return NULL;
310 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000311
Gerhard Häringf9cee222010-03-05 15:20:03 +0000312 _pysqlite_drop_unused_cursor_references(self);
313
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000314 if (cursor && self->row_factory != Py_None) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000315 Py_INCREF(self->row_factory);
Serhiy Storchaka48842712016-04-06 09:45:48 +0300316 Py_XSETREF(((pysqlite_Cursor *)cursor)->row_factory, self->row_factory);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000317 }
318
319 return cursor;
320}
321
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100322/*[clinic input]
323_sqlite3.Connection.close as pysqlite_connection_close
324
325Closes the connection.
326[clinic start generated code]*/
327
328static PyObject *
329pysqlite_connection_close_impl(pysqlite_Connection *self)
330/*[clinic end generated code: output=a546a0da212c9b97 input=3d58064bbffaa3d3]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000331{
332 int rc;
333
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000334 if (!pysqlite_check_thread(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000335 return NULL;
336 }
337
Gerhard Häringf9cee222010-03-05 15:20:03 +0000338 pysqlite_do_all_statements(self, ACTION_FINALIZE, 1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000339
340 if (self->db) {
Aviv Palivoda86a67052017-03-03 12:58:17 +0200341 rc = SQLITE3_CLOSE(self->db);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000342
343 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000344 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000345 return NULL;
346 } else {
347 self->db = NULL;
348 }
349 }
350
Berker Peksagfe21de92016-04-09 07:34:39 +0300351 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000352}
353
354/*
355 * Checks if a connection object is usable (i. e. not closed).
356 *
357 * 0 => error; 1 => ok
358 */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000359int pysqlite_check_connection(pysqlite_Connection* con)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000360{
Gerhard Häringf9cee222010-03-05 15:20:03 +0000361 if (!con->initialized) {
362 PyErr_SetString(pysqlite_ProgrammingError, "Base Connection.__init__ not called.");
363 return 0;
364 }
365
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000366 if (!con->db) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000367 PyErr_SetString(pysqlite_ProgrammingError, "Cannot operate on a closed database.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000368 return 0;
369 } else {
370 return 1;
371 }
372}
373
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000374PyObject* _pysqlite_connection_begin(pysqlite_Connection* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000375{
376 int rc;
377 const char* tail;
378 sqlite3_stmt* statement;
379
380 Py_BEGIN_ALLOW_THREADS
Benjamin Peterson52526942017-09-20 07:36:18 -0700381 rc = sqlite3_prepare_v2(self->db, self->begin_statement, -1, &statement, &tail);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000382 Py_END_ALLOW_THREADS
383
384 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000385 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000386 goto error;
387 }
388
Benjamin Petersond7b03282008-09-13 15:58:53 +0000389 rc = pysqlite_step(statement, self);
Berker Peksag59da4b32016-09-12 07:16:43 +0300390 if (rc != SQLITE_DONE) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000391 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000392 }
393
394 Py_BEGIN_ALLOW_THREADS
395 rc = sqlite3_finalize(statement);
396 Py_END_ALLOW_THREADS
397
398 if (rc != SQLITE_OK && !PyErr_Occurred()) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000399 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000400 }
401
402error:
403 if (PyErr_Occurred()) {
404 return NULL;
405 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200406 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000407 }
408}
409
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +0100410/*[clinic input]
411_sqlite3.Connection.commit as pysqlite_connection_commit
412
413Commit the current transaction.
414[clinic start generated code]*/
415
416static PyObject *
417pysqlite_connection_commit_impl(pysqlite_Connection *self)
418/*[clinic end generated code: output=3da45579e89407f2 input=39c12c04dda276a8]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000419{
420 int rc;
421 const char* tail;
422 sqlite3_stmt* statement;
423
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000424 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000425 return NULL;
426 }
427
Berker Peksag59da4b32016-09-12 07:16:43 +0300428 if (!sqlite3_get_autocommit(self->db)) {
Gerhard Häringf9cee222010-03-05 15:20:03 +0000429
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000430 Py_BEGIN_ALLOW_THREADS
Benjamin Peterson52526942017-09-20 07:36:18 -0700431 rc = sqlite3_prepare_v2(self->db, "COMMIT", -1, &statement, &tail);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000432 Py_END_ALLOW_THREADS
433 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000434 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000435 goto error;
436 }
437
Benjamin Petersond7b03282008-09-13 15:58:53 +0000438 rc = pysqlite_step(statement, self);
Berker Peksag59da4b32016-09-12 07:16:43 +0300439 if (rc != SQLITE_DONE) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000440 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000441 }
442
443 Py_BEGIN_ALLOW_THREADS
444 rc = sqlite3_finalize(statement);
445 Py_END_ALLOW_THREADS
446 if (rc != SQLITE_OK && !PyErr_Occurred()) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000447 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000448 }
449
450 }
451
452error:
453 if (PyErr_Occurred()) {
454 return NULL;
455 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200456 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000457 }
458}
459
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100460/*[clinic input]
461_sqlite3.Connection.rollback as pysqlite_connection_rollback
462
463Roll back the current transaction.
464[clinic start generated code]*/
465
466static PyObject *
467pysqlite_connection_rollback_impl(pysqlite_Connection *self)
468/*[clinic end generated code: output=b66fa0d43e7ef305 input=12d4e8d068942830]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000469{
470 int rc;
471 const char* tail;
472 sqlite3_stmt* statement;
473
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000474 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000475 return NULL;
476 }
477
Berker Peksag59da4b32016-09-12 07:16:43 +0300478 if (!sqlite3_get_autocommit(self->db)) {
Gerhard Häringf9cee222010-03-05 15:20:03 +0000479 pysqlite_do_all_statements(self, ACTION_RESET, 1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000480
481 Py_BEGIN_ALLOW_THREADS
Benjamin Peterson52526942017-09-20 07:36:18 -0700482 rc = sqlite3_prepare_v2(self->db, "ROLLBACK", -1, &statement, &tail);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000483 Py_END_ALLOW_THREADS
484 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000485 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000486 goto error;
487 }
488
Benjamin Petersond7b03282008-09-13 15:58:53 +0000489 rc = pysqlite_step(statement, self);
Berker Peksag59da4b32016-09-12 07:16:43 +0300490 if (rc != SQLITE_DONE) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000491 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000492 }
493
494 Py_BEGIN_ALLOW_THREADS
495 rc = sqlite3_finalize(statement);
496 Py_END_ALLOW_THREADS
497 if (rc != SQLITE_OK && !PyErr_Occurred()) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000498 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000499 }
500
501 }
502
503error:
504 if (PyErr_Occurred()) {
505 return NULL;
506 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200507 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000508 }
509}
510
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200511static int
512_pysqlite_set_result(sqlite3_context* context, PyObject* py_val)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000513{
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200514 if (py_val == Py_None) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000515 sqlite3_result_null(context);
Christian Heimes217cfd12007-12-02 14:31:20 +0000516 } else if (PyLong_Check(py_val)) {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200517 sqlite_int64 value = _pysqlite_long_as_int64(py_val);
518 if (value == -1 && PyErr_Occurred())
519 return -1;
520 sqlite3_result_int64(context, value);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000521 } else if (PyFloat_Check(py_val)) {
522 sqlite3_result_double(context, PyFloat_AsDouble(py_val));
Guido van Rossumbae07c92007-10-08 02:46:15 +0000523 } else if (PyUnicode_Check(py_val)) {
Serhiy Storchaka06515832016-11-20 09:13:07 +0200524 const char *str = PyUnicode_AsUTF8(py_val);
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200525 if (str == NULL)
526 return -1;
527 sqlite3_result_text(context, str, -1, SQLITE_TRANSIENT);
Guido van Rossumbae07c92007-10-08 02:46:15 +0000528 } else if (PyObject_CheckBuffer(py_val)) {
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200529 Py_buffer view;
530 if (PyObject_GetBuffer(py_val, &view, PyBUF_SIMPLE) != 0) {
Victor Stinner83ed42b2013-11-18 01:24:31 +0100531 PyErr_SetString(PyExc_ValueError,
532 "could not convert BLOB to buffer");
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200533 return -1;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000534 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200535 if (view.len > INT_MAX) {
Victor Stinner83ed42b2013-11-18 01:24:31 +0100536 PyErr_SetString(PyExc_OverflowError,
537 "BLOB longer than INT_MAX bytes");
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200538 PyBuffer_Release(&view);
Victor Stinner83ed42b2013-11-18 01:24:31 +0100539 return -1;
540 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200541 sqlite3_result_blob(context, view.buf, (int)view.len, SQLITE_TRANSIENT);
542 PyBuffer_Release(&view);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000543 } else {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200544 return -1;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000545 }
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200546 return 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000547}
548
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000549PyObject* _pysqlite_build_py_params(sqlite3_context *context, int argc, sqlite3_value** argv)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000550{
551 PyObject* args;
552 int i;
553 sqlite3_value* cur_value;
554 PyObject* cur_py_value;
555 const char* val_str;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000556 Py_ssize_t buflen;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000557
558 args = PyTuple_New(argc);
559 if (!args) {
560 return NULL;
561 }
562
563 for (i = 0; i < argc; i++) {
564 cur_value = argv[i];
565 switch (sqlite3_value_type(argv[i])) {
566 case SQLITE_INTEGER:
Sergey Fedoseevb6f5b9d2019-10-23 13:09:01 +0500567 cur_py_value = PyLong_FromLongLong(sqlite3_value_int64(cur_value));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000568 break;
569 case SQLITE_FLOAT:
570 cur_py_value = PyFloat_FromDouble(sqlite3_value_double(cur_value));
571 break;
572 case SQLITE_TEXT:
573 val_str = (const char*)sqlite3_value_text(cur_value);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000574 cur_py_value = PyUnicode_FromString(val_str);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000575 /* TODO: have a way to show errors here */
576 if (!cur_py_value) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000577 PyErr_Clear();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000578 Py_INCREF(Py_None);
579 cur_py_value = Py_None;
580 }
581 break;
582 case SQLITE_BLOB:
583 buflen = sqlite3_value_bytes(cur_value);
Christian Heimes72b710a2008-05-26 13:28:38 +0000584 cur_py_value = PyBytes_FromStringAndSize(
Guido van Rossumbae07c92007-10-08 02:46:15 +0000585 sqlite3_value_blob(cur_value), buflen);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000586 break;
587 case SQLITE_NULL:
588 default:
589 Py_INCREF(Py_None);
590 cur_py_value = Py_None;
591 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000592
593 if (!cur_py_value) {
594 Py_DECREF(args);
595 return NULL;
596 }
597
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000598 PyTuple_SetItem(args, i, cur_py_value);
599
600 }
601
602 return args;
603}
604
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000605void _pysqlite_func_callback(sqlite3_context* context, int argc, sqlite3_value** argv)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000606{
607 PyObject* args;
608 PyObject* py_func;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000609 PyObject* py_retval = NULL;
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200610 int ok;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000611
612 PyGILState_STATE threadstate;
613
614 threadstate = PyGILState_Ensure();
615
616 py_func = (PyObject*)sqlite3_user_data(context);
617
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000618 args = _pysqlite_build_py_params(context, argc, argv);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000619 if (args) {
620 py_retval = PyObject_CallObject(py_func, args);
621 Py_DECREF(args);
622 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000623
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200624 ok = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000625 if (py_retval) {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200626 ok = _pysqlite_set_result(context, py_retval) == 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000627 Py_DECREF(py_retval);
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200628 }
629 if (!ok) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700630 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000631 PyErr_Print();
632 } else {
633 PyErr_Clear();
634 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200635 sqlite3_result_error(context, "user-defined function raised exception", -1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000636 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000637
638 PyGILState_Release(threadstate);
639}
640
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000641static void _pysqlite_step_callback(sqlite3_context *context, int argc, sqlite3_value** params)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000642{
643 PyObject* args;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000644 PyObject* function_result = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000645 PyObject* aggregate_class;
646 PyObject** aggregate_instance;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000647 PyObject* stepmethod = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000648
649 PyGILState_STATE threadstate;
650
651 threadstate = PyGILState_Ensure();
652
653 aggregate_class = (PyObject*)sqlite3_user_data(context);
654
655 aggregate_instance = (PyObject**)sqlite3_aggregate_context(context, sizeof(PyObject*));
656
Serhiy Storchaka0b3ec192017-03-23 17:53:47 +0200657 if (*aggregate_instance == NULL) {
Victor Stinner070c4d72016-12-09 12:29:18 +0100658 *aggregate_instance = _PyObject_CallNoArg(aggregate_class);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000659
Thomas Wouters477c8d52006-05-27 19:21:47 +0000660 if (PyErr_Occurred()) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000661 *aggregate_instance = 0;
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700662 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000663 PyErr_Print();
664 } else {
665 PyErr_Clear();
666 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200667 sqlite3_result_error(context, "user-defined aggregate's '__init__' method raised error", -1);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000669 }
670 }
671
672 stepmethod = PyObject_GetAttrString(*aggregate_instance, "step");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000673 if (!stepmethod) {
674 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000675 }
676
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000677 args = _pysqlite_build_py_params(context, argc, params);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000678 if (!args) {
679 goto error;
680 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000681
682 function_result = PyObject_CallObject(stepmethod, args);
683 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000684
Thomas Wouters477c8d52006-05-27 19:21:47 +0000685 if (!function_result) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700686 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000687 PyErr_Print();
688 } else {
689 PyErr_Clear();
690 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200691 sqlite3_result_error(context, "user-defined aggregate's 'step' method raised error", -1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000692 }
693
Thomas Wouters477c8d52006-05-27 19:21:47 +0000694error:
695 Py_XDECREF(stepmethod);
696 Py_XDECREF(function_result);
697
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000698 PyGILState_Release(threadstate);
699}
700
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000701void _pysqlite_final_callback(sqlite3_context* context)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000702{
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200703 PyObject* function_result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000704 PyObject** aggregate_instance;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200705 _Py_IDENTIFIER(finalize);
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200706 int ok;
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200707 PyObject *exception, *value, *tb;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000708
709 PyGILState_STATE threadstate;
710
711 threadstate = PyGILState_Ensure();
712
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000713 aggregate_instance = (PyObject**)sqlite3_aggregate_context(context, sizeof(PyObject*));
714 if (!*aggregate_instance) {
715 /* this branch is executed if there was an exception in the aggregate's
716 * __init__ */
717
Thomas Wouters477c8d52006-05-27 19:21:47 +0000718 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000719 }
720
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200721 /* Keep the exception (if any) of the last call to step() */
722 PyErr_Fetch(&exception, &value, &tb);
723
Jeroen Demeyer762f93f2019-07-08 10:19:25 +0200724 function_result = _PyObject_CallMethodIdNoArgs(*aggregate_instance, &PyId_finalize);
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200725
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200726 Py_DECREF(*aggregate_instance);
727
728 ok = 0;
729 if (function_result) {
730 ok = _pysqlite_set_result(context, function_result) == 0;
731 Py_DECREF(function_result);
732 }
733 if (!ok) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700734 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000735 PyErr_Print();
736 } else {
737 PyErr_Clear();
738 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200739 sqlite3_result_error(context, "user-defined aggregate's 'finalize' method raised error", -1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000740 }
741
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200742 /* Restore the exception (if any) of the last call to step(),
743 but clear also the current exception if finalize() failed */
744 PyErr_Restore(exception, value, tb);
Victor Stinner3a857322013-07-22 08:34:32 +0200745
Thomas Wouters477c8d52006-05-27 19:21:47 +0000746error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000747 PyGILState_Release(threadstate);
748}
749
Gerhard Häringf9cee222010-03-05 15:20:03 +0000750static void _pysqlite_drop_unused_statement_references(pysqlite_Connection* self)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000751{
752 PyObject* new_list;
753 PyObject* weakref;
754 int i;
755
756 /* we only need to do this once in a while */
757 if (self->created_statements++ < 200) {
758 return;
759 }
760
761 self->created_statements = 0;
762
763 new_list = PyList_New(0);
764 if (!new_list) {
765 return;
766 }
767
768 for (i = 0; i < PyList_Size(self->statements); i++) {
769 weakref = PyList_GetItem(self->statements, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000770 if (PyWeakref_GetObject(weakref) != Py_None) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000771 if (PyList_Append(new_list, weakref) != 0) {
772 Py_DECREF(new_list);
773 return;
774 }
775 }
776 }
777
Serhiy Storchaka57a01d32016-04-10 18:05:40 +0300778 Py_SETREF(self->statements, new_list);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000779}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000780
Gerhard Häringf9cee222010-03-05 15:20:03 +0000781static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self)
782{
783 PyObject* new_list;
784 PyObject* weakref;
785 int i;
786
787 /* we only need to do this once in a while */
788 if (self->created_cursors++ < 200) {
789 return;
790 }
791
792 self->created_cursors = 0;
793
794 new_list = PyList_New(0);
795 if (!new_list) {
796 return;
797 }
798
799 for (i = 0; i < PyList_Size(self->cursors); i++) {
800 weakref = PyList_GetItem(self->cursors, i);
801 if (PyWeakref_GetObject(weakref) != Py_None) {
802 if (PyList_Append(new_list, weakref) != 0) {
803 Py_DECREF(new_list);
804 return;
805 }
806 }
807 }
808
Serhiy Storchaka57a01d32016-04-10 18:05:40 +0300809 Py_SETREF(self->cursors, new_list);
Gerhard Häringf9cee222010-03-05 15:20:03 +0000810}
811
gescheitb9a03762019-07-13 06:15:49 +0300812static void _destructor(void* args)
813{
814 Py_DECREF((PyObject*)args);
815}
816
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100817/*[clinic input]
818_sqlite3.Connection.create_function as pysqlite_connection_create_function
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000819
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100820 name: str
821 narg: int
822 func: object
823 *
824 deterministic: bool = False
825
826Creates a new function. Non-standard.
827[clinic start generated code]*/
828
829static PyObject *
830pysqlite_connection_create_function_impl(pysqlite_Connection *self,
831 const char *name, int narg,
832 PyObject *func, int deterministic)
833/*[clinic end generated code: output=07d1877dd98c0308 input=f2edcf073e815beb]*/
834{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000835 int rc;
Sergey Fedoseev08308582018-07-08 12:09:20 +0500836 int flags = SQLITE_UTF8;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000837
Gerhard Häringf9cee222010-03-05 15:20:03 +0000838 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
839 return NULL;
840 }
841
Sergey Fedoseev08308582018-07-08 12:09:20 +0500842 if (deterministic) {
843#if SQLITE_VERSION_NUMBER < 3008003
844 PyErr_SetString(pysqlite_NotSupportedError,
845 "deterministic=True requires SQLite 3.8.3 or higher");
846 return NULL;
847#else
848 if (sqlite3_libversion_number() < 3008003) {
849 PyErr_SetString(pysqlite_NotSupportedError,
850 "deterministic=True requires SQLite 3.8.3 or higher");
851 return NULL;
852 }
853 flags |= SQLITE_DETERMINISTIC;
854#endif
855 }
gescheitb9a03762019-07-13 06:15:49 +0300856 Py_INCREF(func);
857 rc = sqlite3_create_function_v2(self->db,
858 name,
859 narg,
860 flags,
861 (void*)func,
862 _pysqlite_func_callback,
863 NULL,
864 NULL,
865 &_destructor); // will decref func
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000866
Thomas Wouters477c8d52006-05-27 19:21:47 +0000867 if (rc != SQLITE_OK) {
868 /* Workaround for SQLite bug: no error code or string is available here */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000869 PyErr_SetString(pysqlite_OperationalError, "Error creating function");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000870 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000871 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +0500872 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000873}
874
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100875/*[clinic input]
876_sqlite3.Connection.create_aggregate as pysqlite_connection_create_aggregate
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000877
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100878 name: str
879 n_arg: int
880 aggregate_class: object
881
882Creates a new aggregate. Non-standard.
883[clinic start generated code]*/
884
885static PyObject *
886pysqlite_connection_create_aggregate_impl(pysqlite_Connection *self,
887 const char *name, int n_arg,
888 PyObject *aggregate_class)
889/*[clinic end generated code: output=fbb2f858cfa4d8db input=c2e13bbf234500a5]*/
890{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000891 int rc;
892
Gerhard Häringf9cee222010-03-05 15:20:03 +0000893 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
894 return NULL;
895 }
896
gescheitb9a03762019-07-13 06:15:49 +0300897 Py_INCREF(aggregate_class);
898 rc = sqlite3_create_function_v2(self->db,
899 name,
900 n_arg,
901 SQLITE_UTF8,
902 (void*)aggregate_class,
903 0,
904 &_pysqlite_step_callback,
905 &_pysqlite_final_callback,
906 &_destructor); // will decref func
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000907 if (rc != SQLITE_OK) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000908 /* Workaround for SQLite bug: no error code or string is available here */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000909 PyErr_SetString(pysqlite_OperationalError, "Error creating aggregate");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000910 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000911 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +0500912 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000913}
914
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000915static int _authorizer_callback(void* user_arg, int action, const char* arg1, const char* arg2 , const char* dbname, const char* access_attempt_source)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000916{
917 PyObject *ret;
918 int rc;
919 PyGILState_STATE gilstate;
920
921 gilstate = PyGILState_Ensure();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000922
Victor Stinnerd4095d92013-07-26 22:23:33 +0200923 ret = PyObject_CallFunction((PyObject*)user_arg, "issss", action, arg1, arg2, dbname, access_attempt_source);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000924
Victor Stinnerd4095d92013-07-26 22:23:33 +0200925 if (ret == NULL) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700926 if (_pysqlite_enable_callback_tracebacks)
Victor Stinnerd4095d92013-07-26 22:23:33 +0200927 PyErr_Print();
928 else
929 PyErr_Clear();
Victor Stinner41801f52013-07-21 13:05:38 +0200930
Victor Stinnerd4095d92013-07-26 22:23:33 +0200931 rc = SQLITE_DENY;
Victor Stinner41801f52013-07-21 13:05:38 +0200932 }
933 else {
Victor Stinnerd4095d92013-07-26 22:23:33 +0200934 if (PyLong_Check(ret)) {
935 rc = _PyLong_AsInt(ret);
936 if (rc == -1 && PyErr_Occurred()) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700937 if (_pysqlite_enable_callback_tracebacks)
Victor Stinnerd4095d92013-07-26 22:23:33 +0200938 PyErr_Print();
939 else
940 PyErr_Clear();
941 rc = SQLITE_DENY;
942 }
943 }
944 else {
945 rc = SQLITE_DENY;
946 }
947 Py_DECREF(ret);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000948 }
949
950 PyGILState_Release(gilstate);
951 return rc;
952}
953
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000954static int _progress_handler(void* user_arg)
955{
956 int rc;
957 PyObject *ret;
958 PyGILState_STATE gilstate;
959
960 gilstate = PyGILState_Ensure();
Victor Stinner070c4d72016-12-09 12:29:18 +0100961 ret = _PyObject_CallNoArg((PyObject*)user_arg);
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000962
963 if (!ret) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700964 if (_pysqlite_enable_callback_tracebacks) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000965 PyErr_Print();
966 } else {
967 PyErr_Clear();
968 }
969
Mark Dickinson934896d2009-02-21 20:59:32 +0000970 /* abort query if error occurred */
Victor Stinner86999502010-05-19 01:27:23 +0000971 rc = 1;
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000972 } else {
973 rc = (int)PyObject_IsTrue(ret);
974 Py_DECREF(ret);
975 }
976
977 PyGILState_Release(gilstate);
978 return rc;
979}
980
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +0200981#ifdef HAVE_TRACE_V2
982/*
983 * From https://sqlite.org/c3ref/trace_v2.html:
984 * The integer return value from the callback is currently ignored, though this
985 * may change in future releases. Callback implementations should return zero
986 * to ensure future compatibility.
987 */
988static int _trace_callback(unsigned int type, void* user_arg, void* prepared_statement, void* statement_string)
989#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +0200990static void _trace_callback(void* user_arg, const char* statement_string)
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +0200991#endif
Antoine Pitrou5bfa0622011-04-04 00:12:04 +0200992{
993 PyObject *py_statement = NULL;
994 PyObject *ret = NULL;
995
Antoine Pitrou5bfa0622011-04-04 00:12:04 +0200996 PyGILState_STATE gilstate;
997
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +0200998#ifdef HAVE_TRACE_V2
999 if (type != SQLITE_TRACE_STMT) {
1000 return 0;
1001 }
1002#endif
1003
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001004 gilstate = PyGILState_Ensure();
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001005 py_statement = PyUnicode_DecodeUTF8(statement_string,
1006 strlen(statement_string), "replace");
1007 if (py_statement) {
Petr Viktorinffd97532020-02-11 17:46:57 +01001008 ret = PyObject_CallOneArg((PyObject*)user_arg, py_statement);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001009 Py_DECREF(py_statement);
1010 }
1011
1012 if (ret) {
1013 Py_DECREF(ret);
1014 } else {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -07001015 if (_pysqlite_enable_callback_tracebacks) {
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001016 PyErr_Print();
1017 } else {
1018 PyErr_Clear();
1019 }
1020 }
1021
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001022 PyGILState_Release(gilstate);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001023#ifdef HAVE_TRACE_V2
1024 return 0;
1025#endif
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001026}
1027
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001028/*[clinic input]
1029_sqlite3.Connection.set_authorizer as pysqlite_connection_set_authorizer
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001030
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001031 authorizer_callback as authorizer_cb: object
1032
1033Sets authorizer callback. Non-standard.
1034[clinic start generated code]*/
1035
1036static PyObject *
1037pysqlite_connection_set_authorizer_impl(pysqlite_Connection *self,
1038 PyObject *authorizer_cb)
1039/*[clinic end generated code: output=f18ba575d788b35c input=df079724c020d2f2]*/
1040{
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001041 int rc;
1042
Gerhard Häringf9cee222010-03-05 15:20:03 +00001043 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1044 return NULL;
1045 }
1046
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001047 rc = sqlite3_set_authorizer(self->db, _authorizer_callback, (void*)authorizer_cb);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001048 if (rc != SQLITE_OK) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001049 PyErr_SetString(pysqlite_OperationalError, "Error setting authorizer callback");
gescheitb9a03762019-07-13 06:15:49 +03001050 Py_XSETREF(self->function_pinboard_authorizer_cb, NULL);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001051 return NULL;
gescheitb9a03762019-07-13 06:15:49 +03001052 } else {
1053 Py_INCREF(authorizer_cb);
1054 Py_XSETREF(self->function_pinboard_authorizer_cb, authorizer_cb);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001055 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +05001056 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001057}
1058
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001059/*[clinic input]
1060_sqlite3.Connection.set_progress_handler as pysqlite_connection_set_progress_handler
1061
1062 progress_handler: object
1063 n: int
1064
1065Sets progress handler callback. Non-standard.
1066[clinic start generated code]*/
1067
1068static PyObject *
1069pysqlite_connection_set_progress_handler_impl(pysqlite_Connection *self,
1070 PyObject *progress_handler,
1071 int n)
1072/*[clinic end generated code: output=35a7c10364cb1b04 input=857696c25f964c64]*/
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001073{
Gerhard Häringf9cee222010-03-05 15:20:03 +00001074 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1075 return NULL;
1076 }
1077
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001078 if (progress_handler == Py_None) {
1079 /* None clears the progress handler previously set */
1080 sqlite3_progress_handler(self->db, 0, 0, (void*)0);
gescheitb9a03762019-07-13 06:15:49 +03001081 Py_XSETREF(self->function_pinboard_progress_handler, NULL);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001082 } else {
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +05001083 sqlite3_progress_handler(self->db, n, _progress_handler, progress_handler);
gescheitb9a03762019-07-13 06:15:49 +03001084 Py_INCREF(progress_handler);
1085 Py_XSETREF(self->function_pinboard_progress_handler, progress_handler);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001086 }
Berker Peksagfe21de92016-04-09 07:34:39 +03001087 Py_RETURN_NONE;
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001088}
1089
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001090/*[clinic input]
1091_sqlite3.Connection.set_trace_callback as pysqlite_connection_set_trace_callback
1092
1093 trace_callback: object
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001094
1095Sets a trace callback called for each SQL statement (passed as unicode).
1096
1097Non-standard.
1098[clinic start generated code]*/
1099
1100static PyObject *
Dong-hee Na21793492020-12-19 00:41:33 +09001101pysqlite_connection_set_trace_callback_impl(pysqlite_Connection *self,
1102 PyObject *trace_callback)
1103/*[clinic end generated code: output=fb0e307b9924d454 input=56d60fd38d763679]*/
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001104{
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001105 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1106 return NULL;
1107 }
1108
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001109 if (trace_callback == Py_None) {
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001110 /*
1111 * None clears the trace callback previously set
1112 *
1113 * Ref.
1114 * - https://sqlite.org/c3ref/c_trace.html
1115 * - https://sqlite.org/c3ref/trace_v2.html
1116 */
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001117#ifdef HAVE_TRACE_V2
1118 sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, 0, 0);
1119#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001120 sqlite3_trace(self->db, 0, (void*)0);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001121#endif
gescheitb9a03762019-07-13 06:15:49 +03001122 Py_XSETREF(self->function_pinboard_trace_callback, NULL);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001123 } else {
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001124#ifdef HAVE_TRACE_V2
1125 sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, _trace_callback, trace_callback);
1126#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001127 sqlite3_trace(self->db, _trace_callback, trace_callback);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001128#endif
gescheitb9a03762019-07-13 06:15:49 +03001129 Py_INCREF(trace_callback);
1130 Py_XSETREF(self->function_pinboard_trace_callback, trace_callback);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001131 }
1132
Berker Peksagfe21de92016-04-09 07:34:39 +03001133 Py_RETURN_NONE;
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001134}
1135
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +02001136#ifndef SQLITE_OMIT_LOAD_EXTENSION
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001137/*[clinic input]
1138_sqlite3.Connection.enable_load_extension as pysqlite_connection_enable_load_extension
1139
Dong-hee Na21793492020-12-19 00:41:33 +09001140 enable as onoff: bool(accept={int})
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001141 /
1142
1143Enable dynamic loading of SQLite extension modules. Non-standard.
1144[clinic start generated code]*/
1145
1146static PyObject *
1147pysqlite_connection_enable_load_extension_impl(pysqlite_Connection *self,
1148 int onoff)
Dong-hee Na21793492020-12-19 00:41:33 +09001149/*[clinic end generated code: output=9cac37190d388baf input=5c0da5b121121cbc]*/
Gerhard Häringf9cee222010-03-05 15:20:03 +00001150{
1151 int rc;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001152
1153 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1154 return NULL;
1155 }
1156
Gerhard Häringf9cee222010-03-05 15:20:03 +00001157 rc = sqlite3_enable_load_extension(self->db, onoff);
1158
1159 if (rc != SQLITE_OK) {
1160 PyErr_SetString(pysqlite_OperationalError, "Error enabling load extension");
1161 return NULL;
1162 } else {
Berker Peksagfe21de92016-04-09 07:34:39 +03001163 Py_RETURN_NONE;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001164 }
1165}
1166
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001167/*[clinic input]
1168_sqlite3.Connection.load_extension as pysqlite_connection_load_extension
1169
1170 name as extension_name: str
1171 /
1172
1173Load SQLite extension module. Non-standard.
1174[clinic start generated code]*/
1175
1176static PyObject *
1177pysqlite_connection_load_extension_impl(pysqlite_Connection *self,
1178 const char *extension_name)
1179/*[clinic end generated code: output=47eb1d7312bc97a7 input=0b711574560db9fc]*/
Gerhard Häringf9cee222010-03-05 15:20:03 +00001180{
1181 int rc;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001182 char* errmsg;
1183
1184 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1185 return NULL;
1186 }
1187
Gerhard Häringf9cee222010-03-05 15:20:03 +00001188 rc = sqlite3_load_extension(self->db, extension_name, 0, &errmsg);
1189 if (rc != 0) {
1190 PyErr_SetString(pysqlite_OperationalError, errmsg);
1191 return NULL;
1192 } else {
Berker Peksagfe21de92016-04-09 07:34:39 +03001193 Py_RETURN_NONE;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001194 }
1195}
1196#endif
1197
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001198int pysqlite_check_thread(pysqlite_Connection* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001199{
1200 if (self->check_same_thread) {
1201 if (PyThread_get_thread_ident() != self->thread_ident) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001202 PyErr_Format(pysqlite_ProgrammingError,
Takuya Akiba030345c2018-03-27 00:14:00 +09001203 "SQLite objects created in a thread can only be used in that same thread. "
1204 "The object was created in thread id %lu and this is thread id %lu.",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001205 self->thread_ident, PyThread_get_thread_ident());
1206 return 0;
1207 }
1208
1209 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001210 return 1;
1211}
1212
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001213static PyObject* pysqlite_connection_get_isolation_level(pysqlite_Connection* self, void* unused)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001214{
1215 Py_INCREF(self->isolation_level);
1216 return self->isolation_level;
1217}
1218
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001219static PyObject* pysqlite_connection_get_total_changes(pysqlite_Connection* self, void* unused)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001220{
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001221 if (!pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001222 return NULL;
1223 } else {
1224 return Py_BuildValue("i", sqlite3_total_changes(self->db));
1225 }
1226}
1227
Berker Peksag59da4b32016-09-12 07:16:43 +03001228static PyObject* pysqlite_connection_get_in_transaction(pysqlite_Connection* self, void* unused)
1229{
1230 if (!pysqlite_check_connection(self)) {
1231 return NULL;
1232 }
1233 if (!sqlite3_get_autocommit(self->db)) {
1234 Py_RETURN_TRUE;
1235 }
1236 Py_RETURN_FALSE;
1237}
1238
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001239static int
1240pysqlite_connection_set_isolation_level(pysqlite_Connection* self, PyObject* isolation_level, void *Py_UNUSED(ignored))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001241{
Zackery Spytz842acaa2018-12-17 07:52:45 -07001242 if (isolation_level == NULL) {
1243 PyErr_SetString(PyExc_AttributeError, "cannot delete attribute");
1244 return -1;
1245 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001246 if (isolation_level == Py_None) {
Serhiy Storchaka28914922016-09-01 22:18:03 +03001247 PyObject *res = pysqlite_connection_commit(self, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001248 if (!res) {
1249 return -1;
1250 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001251 Py_DECREF(res);
1252
Serhiy Storchaka28914922016-09-01 22:18:03 +03001253 self->begin_statement = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001254 } else {
Serhiy Storchaka28914922016-09-01 22:18:03 +03001255 const char * const *candidate;
1256 PyObject *uppercase_level;
1257 _Py_IDENTIFIER(upper);
Neal Norwitzefee9f52007-10-27 02:50:52 +00001258
Serhiy Storchaka28914922016-09-01 22:18:03 +03001259 if (!PyUnicode_Check(isolation_level)) {
1260 PyErr_Format(PyExc_TypeError,
1261 "isolation_level must be a string or None, not %.100s",
1262 Py_TYPE(isolation_level)->tp_name);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001263 return -1;
1264 }
1265
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001266 uppercase_level = _PyObject_CallMethodIdOneArg(
Serhiy Storchaka28914922016-09-01 22:18:03 +03001267 (PyObject *)&PyUnicode_Type, &PyId_upper,
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001268 isolation_level);
Serhiy Storchaka28914922016-09-01 22:18:03 +03001269 if (!uppercase_level) {
Georg Brandl3dbca812008-07-23 16:10:53 +00001270 return -1;
1271 }
Serhiy Storchaka28914922016-09-01 22:18:03 +03001272 for (candidate = begin_statements; *candidate; candidate++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001273 if (_PyUnicode_EqualToASCIIString(uppercase_level, *candidate + 6))
Serhiy Storchaka28914922016-09-01 22:18:03 +03001274 break;
1275 }
1276 Py_DECREF(uppercase_level);
1277 if (!*candidate) {
1278 PyErr_SetString(PyExc_ValueError,
1279 "invalid value for isolation_level");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001280 return -1;
1281 }
Serhiy Storchaka28914922016-09-01 22:18:03 +03001282 self->begin_statement = *candidate;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001283 }
1284
Serhiy Storchaka28914922016-09-01 22:18:03 +03001285 Py_INCREF(isolation_level);
1286 Py_XSETREF(self->isolation_level, isolation_level);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001287 return 0;
1288}
1289
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001290PyObject* pysqlite_connection_call(pysqlite_Connection* self, PyObject* args, PyObject* kwargs)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001291{
1292 PyObject* sql;
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001293 pysqlite_Statement* statement;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001294 PyObject* weakref;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001295 int rc;
1296
Gerhard Häringf9cee222010-03-05 15:20:03 +00001297 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1298 return NULL;
1299 }
1300
Serhiy Storchaka6cca5c82017-06-08 14:41:19 +03001301 if (!_PyArg_NoKeywords(MODULE_NAME ".Connection", kwargs))
Larry Hastings3b12e952015-05-08 07:45:10 -07001302 return NULL;
1303
Victor Stinnerc6a23202019-06-26 03:16:24 +02001304 if (!PyArg_ParseTuple(args, "U", &sql))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001305 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001306
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001307 _pysqlite_drop_unused_statement_references(self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001308
Erlend Egeberg Aasland9031bd42020-10-01 15:24:31 +02001309 statement = PyObject_New(pysqlite_Statement, pysqlite_StatementType);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001310 if (!statement) {
1311 return NULL;
1312 }
1313
Victor Stinner0201f442010-03-13 03:28:34 +00001314 statement->db = NULL;
1315 statement->st = NULL;
1316 statement->sql = NULL;
1317 statement->in_use = 0;
1318 statement->in_weakreflist = NULL;
1319
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001320 rc = pysqlite_statement_create(statement, self, sql);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001321 if (rc != SQLITE_OK) {
1322 if (rc == PYSQLITE_TOO_MUCH_SQL) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001323 PyErr_SetString(pysqlite_Warning, "You can only execute one statement at a time.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001324 } else if (rc == PYSQLITE_SQL_WRONG_TYPE) {
Serhiy Storchaka42d67af2014-09-11 13:29:05 +03001325 if (PyErr_ExceptionMatches(PyExc_TypeError))
1326 PyErr_SetString(pysqlite_Warning, "SQL is of wrong type. Must be string.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001327 } else {
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001328 (void)pysqlite_statement_reset(statement);
1329 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001330 }
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001331 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001332 }
1333
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001334 weakref = PyWeakref_NewRef((PyObject*)statement, NULL);
1335 if (weakref == NULL)
1336 goto error;
1337 if (PyList_Append(self->statements, weakref) != 0) {
1338 Py_DECREF(weakref);
1339 goto error;
1340 }
1341 Py_DECREF(weakref);
1342
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001343 return (PyObject*)statement;
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001344
1345error:
1346 Py_DECREF(statement);
1347 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001348}
1349
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001350/*[clinic input]
1351_sqlite3.Connection.execute as pysqlite_connection_execute
1352
1353 sql: unicode
1354 parameters: object = NULL
1355 /
1356
1357Executes a SQL statement. Non-standard.
1358[clinic start generated code]*/
1359
1360static PyObject *
1361pysqlite_connection_execute_impl(pysqlite_Connection *self, PyObject *sql,
1362 PyObject *parameters)
1363/*[clinic end generated code: output=5be05ae01ee17ee4 input=fbd17c75c7140271]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001364{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001365 _Py_IDENTIFIER(execute);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001366 PyObject* cursor = 0;
1367 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001368
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001369 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001370 if (!cursor) {
1371 goto error;
1372 }
1373
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001374 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_execute, sql, parameters, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001375 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001376 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001377 }
1378
1379error:
1380 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001381
1382 return cursor;
1383}
1384
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001385/*[clinic input]
1386_sqlite3.Connection.executemany as pysqlite_connection_executemany
1387
1388 sql: unicode
1389 parameters: object
1390 /
1391
1392Repeatedly executes a SQL statement. Non-standard.
1393[clinic start generated code]*/
1394
1395static PyObject *
1396pysqlite_connection_executemany_impl(pysqlite_Connection *self,
1397 PyObject *sql, PyObject *parameters)
1398/*[clinic end generated code: output=776cd2fd20bfe71f input=4feab80659ffc82b]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001399{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001400 _Py_IDENTIFIER(executemany);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001401 PyObject* cursor = 0;
1402 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001403
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001404 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001405 if (!cursor) {
1406 goto error;
1407 }
1408
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001409 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_executemany, sql,
1410 parameters, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001411 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001412 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001413 }
1414
1415error:
1416 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001417
1418 return cursor;
1419}
1420
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001421/*[clinic input]
1422_sqlite3.Connection.executescript as pysqlite_connection_executescript
1423
1424 sql_script as script_obj: object
1425 /
1426
1427Executes a multiple SQL statements at once. Non-standard.
1428[clinic start generated code]*/
1429
1430static PyObject *
1431pysqlite_connection_executescript(pysqlite_Connection *self,
1432 PyObject *script_obj)
1433/*[clinic end generated code: output=4c4f9d77aa0ae37d input=c0b14695aa6c81d9]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001434{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001435 _Py_IDENTIFIER(executescript);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001436 PyObject* cursor = 0;
1437 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001438
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001439 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001440 if (!cursor) {
1441 goto error;
1442 }
1443
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001444 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_executescript,
1445 script_obj, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001446 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001447 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001448 }
1449
1450error:
1451 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001452
1453 return cursor;
1454}
1455
1456/* ------------------------- COLLATION CODE ------------------------ */
1457
1458static int
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001459pysqlite_collation_callback(
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001460 void* context,
1461 int text1_length, const void* text1_data,
1462 int text2_length, const void* text2_data)
1463{
1464 PyObject* callback = (PyObject*)context;
1465 PyObject* string1 = 0;
1466 PyObject* string2 = 0;
1467 PyGILState_STATE gilstate;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001468 PyObject* retval = NULL;
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001469 long longval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001470 int result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001471 gilstate = PyGILState_Ensure();
1472
1473 if (PyErr_Occurred()) {
1474 goto finally;
1475 }
1476
Guido van Rossum98297ee2007-11-06 21:34:58 +00001477 string1 = PyUnicode_FromStringAndSize((const char*)text1_data, text1_length);
1478 string2 = PyUnicode_FromStringAndSize((const char*)text2_data, text2_length);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001479
1480 if (!string1 || !string2) {
1481 goto finally; /* failed to allocate strings */
1482 }
1483
1484 retval = PyObject_CallFunctionObjArgs(callback, string1, string2, NULL);
1485
1486 if (!retval) {
1487 /* execution failed */
1488 goto finally;
1489 }
1490
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001491 longval = PyLong_AsLongAndOverflow(retval, &result);
1492 if (longval == -1 && PyErr_Occurred()) {
1493 PyErr_Clear();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001494 result = 0;
1495 }
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001496 else if (!result) {
1497 if (longval > 0)
1498 result = 1;
1499 else if (longval < 0)
1500 result = -1;
1501 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001502
1503finally:
1504 Py_XDECREF(string1);
1505 Py_XDECREF(string2);
1506 Py_XDECREF(retval);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001507 PyGILState_Release(gilstate);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001508 return result;
1509}
1510
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001511/*[clinic input]
1512_sqlite3.Connection.interrupt as pysqlite_connection_interrupt
1513
1514Abort any pending database operation. Non-standard.
1515[clinic start generated code]*/
1516
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001517static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001518pysqlite_connection_interrupt_impl(pysqlite_Connection *self)
1519/*[clinic end generated code: output=f193204bc9e70b47 input=4bd0ad083cf93aa7]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001520{
1521 PyObject* retval = NULL;
1522
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001523 if (!pysqlite_check_connection(self)) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001524 goto finally;
1525 }
1526
1527 sqlite3_interrupt(self->db);
1528
1529 Py_INCREF(Py_None);
1530 retval = Py_None;
1531
1532finally:
1533 return retval;
1534}
1535
Christian Heimesbbe741d2008-03-28 10:53:29 +00001536/* Function author: Paul Kippes <kippesp@gmail.com>
1537 * Class method of Connection to call the Python function _iterdump
1538 * of the sqlite3 module.
1539 */
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001540/*[clinic input]
1541_sqlite3.Connection.iterdump as pysqlite_connection_iterdump
1542
1543Returns iterator to the dump of the database in an SQL text format.
1544
1545Non-standard.
1546[clinic start generated code]*/
1547
Christian Heimesbbe741d2008-03-28 10:53:29 +00001548static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001549pysqlite_connection_iterdump_impl(pysqlite_Connection *self)
1550/*[clinic end generated code: output=586997aaf9808768 input=53bc907cb5eedb85]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001551{
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001552 _Py_IDENTIFIER(_iterdump);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001553 PyObject* retval = NULL;
1554 PyObject* module = NULL;
1555 PyObject* module_dict;
1556 PyObject* pyfn_iterdump;
1557
1558 if (!pysqlite_check_connection(self)) {
1559 goto finally;
1560 }
1561
1562 module = PyImport_ImportModule(MODULE_NAME ".dump");
1563 if (!module) {
1564 goto finally;
1565 }
1566
1567 module_dict = PyModule_GetDict(module);
1568 if (!module_dict) {
1569 goto finally;
1570 }
1571
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001572 pyfn_iterdump = _PyDict_GetItemIdWithError(module_dict, &PyId__iterdump);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001573 if (!pyfn_iterdump) {
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001574 if (!PyErr_Occurred()) {
1575 PyErr_SetString(pysqlite_OperationalError,
1576 "Failed to obtain _iterdump() reference");
1577 }
Christian Heimesbbe741d2008-03-28 10:53:29 +00001578 goto finally;
1579 }
1580
Petr Viktorinffd97532020-02-11 17:46:57 +01001581 retval = PyObject_CallOneArg(pyfn_iterdump, (PyObject *)self);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001582
1583finally:
Christian Heimesbbe741d2008-03-28 10:53:29 +00001584 Py_XDECREF(module);
1585 return retval;
1586}
1587
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001588/*[clinic input]
1589_sqlite3.Connection.backup as pysqlite_connection_backup
1590
1591 target: object(type='pysqlite_Connection *', subclass_of='pysqlite_ConnectionType') = NULL
1592 *
1593 pages: int = -1
1594 progress: object = None
1595 name: str = "main"
1596 sleep: double = 0.250
1597
1598Makes a backup of the database. Non-standard.
1599[clinic start generated code]*/
1600
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001601static PyObject *
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001602pysqlite_connection_backup_impl(pysqlite_Connection *self,
1603 pysqlite_Connection *target, int pages,
1604 PyObject *progress, const char *name,
1605 double sleep)
1606/*[clinic end generated code: output=306a3e6a38c36334 input=2f3497ea530144b1]*/
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001607{
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001608 int rc;
1609 int callback_error = 0;
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001610 int sleep_ms = sleep * 1000.0;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001611 sqlite3 *bck_conn;
1612 sqlite3_backup *bck_handle;
Victor Stinnerca405012018-04-30 12:22:17 +02001613
Peter McCormickbfee9fa2020-09-19 23:40:46 -04001614 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1615 return NULL;
1616 }
1617
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001618 if (!pysqlite_check_connection(target)) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001619 return NULL;
1620 }
1621
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001622 if (target == self) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001623 PyErr_SetString(PyExc_ValueError, "target cannot be the same connection instance");
1624 return NULL;
1625 }
1626
Aviv Palivodabbf7bb72018-03-18 02:48:55 +02001627#if SQLITE_VERSION_NUMBER < 3008008
1628 /* Since 3.8.8 this is already done, per commit
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001629 https://www.sqlite.org/src/info/169b5505498c0a7e */
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001630 if (!sqlite3_get_autocommit(target->db)) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001631 PyErr_SetString(pysqlite_OperationalError, "target is in transaction");
1632 return NULL;
1633 }
1634#endif
1635
1636 if (progress != Py_None && !PyCallable_Check(progress)) {
1637 PyErr_SetString(PyExc_TypeError, "progress argument must be a callable");
1638 return NULL;
1639 }
1640
1641 if (pages == 0) {
1642 pages = -1;
1643 }
1644
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001645 bck_conn = target->db;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001646
1647 Py_BEGIN_ALLOW_THREADS
1648 bck_handle = sqlite3_backup_init(bck_conn, "main", self->db, name);
1649 Py_END_ALLOW_THREADS
1650
1651 if (bck_handle) {
1652 do {
1653 Py_BEGIN_ALLOW_THREADS
1654 rc = sqlite3_backup_step(bck_handle, pages);
1655 Py_END_ALLOW_THREADS
1656
1657 if (progress != Py_None) {
1658 PyObject *res;
1659
1660 res = PyObject_CallFunction(progress, "iii", rc,
1661 sqlite3_backup_remaining(bck_handle),
1662 sqlite3_backup_pagecount(bck_handle));
1663 if (res == NULL) {
1664 /* User's callback raised an error: interrupt the loop and
1665 propagate it. */
1666 callback_error = 1;
1667 rc = -1;
1668 } else {
1669 Py_DECREF(res);
1670 }
1671 }
1672
1673 /* Sleep for a while if there are still further pages to copy and
1674 the engine could not make any progress */
1675 if (rc == SQLITE_BUSY || rc == SQLITE_LOCKED) {
1676 Py_BEGIN_ALLOW_THREADS
Victor Stinnerca405012018-04-30 12:22:17 +02001677 sqlite3_sleep(sleep_ms);
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001678 Py_END_ALLOW_THREADS
1679 }
1680 } while (rc == SQLITE_OK || rc == SQLITE_BUSY || rc == SQLITE_LOCKED);
1681
1682 Py_BEGIN_ALLOW_THREADS
1683 rc = sqlite3_backup_finish(bck_handle);
1684 Py_END_ALLOW_THREADS
1685 } else {
1686 rc = _pysqlite_seterror(bck_conn, NULL);
1687 }
1688
1689 if (!callback_error && rc != SQLITE_OK) {
1690 /* We cannot use _pysqlite_seterror() here because the backup APIs do
1691 not set the error status on the connection object, but rather on
1692 the backup handle. */
1693 if (rc == SQLITE_NOMEM) {
1694 (void)PyErr_NoMemory();
1695 } else {
1696#if SQLITE_VERSION_NUMBER > 3007015
1697 PyErr_SetString(pysqlite_OperationalError, sqlite3_errstr(rc));
1698#else
1699 switch (rc) {
Berker Peksagb10a64d2018-09-20 14:14:33 +03001700 case SQLITE_ERROR:
1701 /* Description of SQLITE_ERROR in SQLite 3.7.14 and older
1702 releases. */
1703 PyErr_SetString(pysqlite_OperationalError,
1704 "SQL logic error or missing database");
1705 break;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001706 case SQLITE_READONLY:
1707 PyErr_SetString(pysqlite_OperationalError,
1708 "attempt to write a readonly database");
1709 break;
1710 case SQLITE_BUSY:
1711 PyErr_SetString(pysqlite_OperationalError, "database is locked");
1712 break;
1713 case SQLITE_LOCKED:
1714 PyErr_SetString(pysqlite_OperationalError,
1715 "database table is locked");
1716 break;
1717 default:
1718 PyErr_Format(pysqlite_OperationalError,
1719 "unrecognized error code: %d", rc);
1720 break;
1721 }
1722#endif
1723 }
1724 }
1725
1726 if (!callback_error && rc == SQLITE_OK) {
1727 Py_RETURN_NONE;
1728 } else {
1729 return NULL;
1730 }
1731}
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001732
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001733/*[clinic input]
1734_sqlite3.Connection.create_collation as pysqlite_connection_create_collation
1735
1736 name: unicode
1737 callback as callable: object
1738 /
1739
1740Creates a collation function. Non-standard.
1741[clinic start generated code]*/
1742
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001743static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001744pysqlite_connection_create_collation_impl(pysqlite_Connection *self,
1745 PyObject *name, PyObject *callable)
1746/*[clinic end generated code: output=0f63b8995565ae22 input=5c3898813a776cf2]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001747{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001748 PyObject* uppercase_name = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001749 PyObject* retval;
Victor Stinner35466c52010-04-22 11:23:23 +00001750 Py_ssize_t i, len;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001751 _Py_IDENTIFIER(upper);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001752 const char *uppercase_name_str;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001753 int rc;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001754 unsigned int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +03001755 const void *data;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001756
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001757 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001758 goto finally;
1759 }
1760
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001761 uppercase_name = _PyObject_CallMethodIdOneArg((PyObject *)&PyUnicode_Type,
1762 &PyId_upper, name);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001763 if (!uppercase_name) {
1764 goto finally;
1765 }
1766
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001767 if (PyUnicode_READY(uppercase_name))
1768 goto finally;
1769 len = PyUnicode_GET_LENGTH(uppercase_name);
1770 kind = PyUnicode_KIND(uppercase_name);
1771 data = PyUnicode_DATA(uppercase_name);
1772 for (i=0; i<len; i++) {
1773 Py_UCS4 ch = PyUnicode_READ(kind, data, i);
1774 if ((ch >= '0' && ch <= '9')
1775 || (ch >= 'A' && ch <= 'Z')
1776 || (ch == '_'))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001777 {
Victor Stinner35466c52010-04-22 11:23:23 +00001778 continue;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001779 } else {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001780 PyErr_SetString(pysqlite_ProgrammingError, "invalid character in collation name");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001781 goto finally;
1782 }
1783 }
1784
Serhiy Storchaka06515832016-11-20 09:13:07 +02001785 uppercase_name_str = PyUnicode_AsUTF8(uppercase_name);
Victor Stinner35466c52010-04-22 11:23:23 +00001786 if (!uppercase_name_str)
1787 goto finally;
1788
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001789 if (callable != Py_None && !PyCallable_Check(callable)) {
1790 PyErr_SetString(PyExc_TypeError, "parameter must be callable");
1791 goto finally;
1792 }
1793
1794 if (callable != Py_None) {
Gerhard Häringf9cee222010-03-05 15:20:03 +00001795 if (PyDict_SetItem(self->collations, uppercase_name, callable) == -1)
1796 goto finally;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001797 } else {
Gerhard Häringf9cee222010-03-05 15:20:03 +00001798 if (PyDict_DelItem(self->collations, uppercase_name) == -1)
1799 goto finally;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001800 }
1801
1802 rc = sqlite3_create_collation(self->db,
Victor Stinner35466c52010-04-22 11:23:23 +00001803 uppercase_name_str,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001804 SQLITE_UTF8,
1805 (callable != Py_None) ? callable : NULL,
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001806 (callable != Py_None) ? pysqlite_collation_callback : NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001807 if (rc != SQLITE_OK) {
1808 PyDict_DelItem(self->collations, uppercase_name);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001809 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001810 goto finally;
1811 }
1812
1813finally:
1814 Py_XDECREF(uppercase_name);
1815
1816 if (PyErr_Occurred()) {
1817 retval = NULL;
1818 } else {
1819 Py_INCREF(Py_None);
1820 retval = Py_None;
1821 }
1822
1823 return retval;
1824}
1825
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001826/*[clinic input]
1827_sqlite3.Connection.__enter__ as pysqlite_connection_enter
1828
1829Called when the connection is used as a context manager.
1830
1831Returns itself as a convenience to the caller.
1832[clinic start generated code]*/
1833
Christian Heimesbbe741d2008-03-28 10:53:29 +00001834static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001835pysqlite_connection_enter_impl(pysqlite_Connection *self)
1836/*[clinic end generated code: output=457b09726d3e9dcd input=127d7a4f17e86d8f]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001837{
1838 Py_INCREF(self);
1839 return (PyObject*)self;
1840}
1841
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001842/*[clinic input]
1843_sqlite3.Connection.__exit__ as pysqlite_connection_exit
1844
1845 type as exc_type: object
1846 value as exc_value: object
1847 traceback as exc_tb: object
1848 /
1849
1850Called when the connection is used as a context manager.
1851
1852If there was any exception, a rollback takes place; otherwise we commit.
1853[clinic start generated code]*/
1854
Christian Heimesbbe741d2008-03-28 10:53:29 +00001855static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001856pysqlite_connection_exit_impl(pysqlite_Connection *self, PyObject *exc_type,
1857 PyObject *exc_value, PyObject *exc_tb)
1858/*[clinic end generated code: output=0705200e9321202a input=bd66f1532c9c54a7]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001859{
Serhiy Storchakae2f92de2017-11-11 13:06:26 +02001860 const char* method_name;
Christian Heimesbbe741d2008-03-28 10:53:29 +00001861 PyObject* result;
1862
Christian Heimesbbe741d2008-03-28 10:53:29 +00001863 if (exc_type == Py_None && exc_value == Py_None && exc_tb == Py_None) {
1864 method_name = "commit";
1865 } else {
1866 method_name = "rollback";
1867 }
1868
Victor Stinner3466bde2016-09-05 18:16:01 -07001869 result = PyObject_CallMethod((PyObject*)self, method_name, NULL);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001870 if (!result) {
1871 return NULL;
1872 }
1873 Py_DECREF(result);
1874
1875 Py_RETURN_FALSE;
1876}
1877
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02001878static const char connection_doc[] =
Thomas Wouters477c8d52006-05-27 19:21:47 +00001879PyDoc_STR("SQLite database connection object.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001880
1881static PyGetSetDef connection_getset[] = {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001882 {"isolation_level", (getter)pysqlite_connection_get_isolation_level, (setter)pysqlite_connection_set_isolation_level},
1883 {"total_changes", (getter)pysqlite_connection_get_total_changes, (setter)0},
Berker Peksag59da4b32016-09-12 07:16:43 +03001884 {"in_transaction", (getter)pysqlite_connection_get_in_transaction, (setter)0},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001885 {NULL}
1886};
1887
1888static PyMethodDef connection_methods[] = {
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001889 PYSQLITE_CONNECTION_BACKUP_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001890 PYSQLITE_CONNECTION_CLOSE_METHODDEF
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001891 PYSQLITE_CONNECTION_COMMIT_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001892 PYSQLITE_CONNECTION_CREATE_AGGREGATE_METHODDEF
1893 PYSQLITE_CONNECTION_CREATE_COLLATION_METHODDEF
1894 PYSQLITE_CONNECTION_CREATE_FUNCTION_METHODDEF
1895 PYSQLITE_CONNECTION_CURSOR_METHODDEF
1896 PYSQLITE_CONNECTION_ENABLE_LOAD_EXTENSION_METHODDEF
1897 PYSQLITE_CONNECTION_ENTER_METHODDEF
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001898 PYSQLITE_CONNECTION_EXECUTEMANY_METHODDEF
1899 PYSQLITE_CONNECTION_EXECUTESCRIPT_METHODDEF
1900 PYSQLITE_CONNECTION_EXECUTE_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001901 PYSQLITE_CONNECTION_EXIT_METHODDEF
1902 PYSQLITE_CONNECTION_INTERRUPT_METHODDEF
1903 PYSQLITE_CONNECTION_ITERDUMP_METHODDEF
1904 PYSQLITE_CONNECTION_LOAD_EXTENSION_METHODDEF
1905 PYSQLITE_CONNECTION_ROLLBACK_METHODDEF
1906 PYSQLITE_CONNECTION_SET_AUTHORIZER_METHODDEF
1907 PYSQLITE_CONNECTION_SET_PROGRESS_HANDLER_METHODDEF
1908 PYSQLITE_CONNECTION_SET_TRACE_CALLBACK_METHODDEF
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001909 {NULL, NULL}
1910};
1911
1912static struct PyMemberDef connection_members[] =
1913{
Guido van Rossum10f07c42007-08-11 15:32:55 +00001914 {"Warning", T_OBJECT, offsetof(pysqlite_Connection, Warning), READONLY},
1915 {"Error", T_OBJECT, offsetof(pysqlite_Connection, Error), READONLY},
1916 {"InterfaceError", T_OBJECT, offsetof(pysqlite_Connection, InterfaceError), READONLY},
1917 {"DatabaseError", T_OBJECT, offsetof(pysqlite_Connection, DatabaseError), READONLY},
1918 {"DataError", T_OBJECT, offsetof(pysqlite_Connection, DataError), READONLY},
1919 {"OperationalError", T_OBJECT, offsetof(pysqlite_Connection, OperationalError), READONLY},
1920 {"IntegrityError", T_OBJECT, offsetof(pysqlite_Connection, IntegrityError), READONLY},
1921 {"InternalError", T_OBJECT, offsetof(pysqlite_Connection, InternalError), READONLY},
1922 {"ProgrammingError", T_OBJECT, offsetof(pysqlite_Connection, ProgrammingError), READONLY},
1923 {"NotSupportedError", T_OBJECT, offsetof(pysqlite_Connection, NotSupportedError), READONLY},
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001924 {"row_factory", T_OBJECT, offsetof(pysqlite_Connection, row_factory)},
1925 {"text_factory", T_OBJECT, offsetof(pysqlite_Connection, text_factory)},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001926 {NULL}
1927};
1928
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001929static PyType_Slot connection_slots[] = {
1930 {Py_tp_dealloc, pysqlite_connection_dealloc},
1931 {Py_tp_doc, (void *)connection_doc},
1932 {Py_tp_methods, connection_methods},
1933 {Py_tp_members, connection_members},
1934 {Py_tp_getset, connection_getset},
1935 {Py_tp_new, PyType_GenericNew},
1936 {Py_tp_init, pysqlite_connection_init},
1937 {Py_tp_call, pysqlite_connection_call},
1938 {0, NULL},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001939};
1940
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001941static PyType_Spec connection_spec = {
1942 .name = MODULE_NAME ".Connection",
1943 .basicsize = sizeof(pysqlite_Connection),
1944 .flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
1945 .slots = connection_slots,
1946};
1947
1948PyTypeObject *pysqlite_ConnectionType = NULL;
1949
1950extern int pysqlite_connection_setup_types(PyObject *module)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001951{
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001952 pysqlite_ConnectionType = (PyTypeObject *)PyType_FromModuleAndSpec(module, &connection_spec, NULL);
1953 if (pysqlite_ConnectionType == NULL) {
1954 return -1;
1955 }
1956 return 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001957}