blob: 64610393ec1c35f294be903dcb51230fff94b60e [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
Erlend Egeberg Aaslandbf838a62021-02-21 01:29:19 +010060static int
61pysqlite_connection_init(pysqlite_Connection *self, PyObject *args,
62 PyObject *kwargs)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000063{
Antoine Pitrou902fc8b2013-02-10 00:02:44 +010064 static char *kwlist[] = {
65 "database", "timeout", "detect_types", "isolation_level",
66 "check_same_thread", "factory", "cached_statements", "uri",
67 NULL
68 };
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000069
Serhiy Storchaka8f87eef2020-04-12 14:58:27 +030070 const char* database;
Anders Lorentsena22a1272017-11-07 01:47:43 +010071 PyObject* database_obj;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000072 int detect_types = 0;
73 PyObject* isolation_level = NULL;
74 PyObject* factory = NULL;
75 int check_same_thread = 1;
76 int cached_statements = 100;
Antoine Pitrou902fc8b2013-02-10 00:02:44 +010077 int uri = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078 double timeout = 5.0;
79 int rc;
80
Anders Lorentsena22a1272017-11-07 01:47:43 +010081 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O&|diOiOip", kwlist,
82 PyUnicode_FSConverter, &database_obj, &timeout, &detect_types,
Antoine Pitrou902fc8b2013-02-10 00:02:44 +010083 &isolation_level, &check_same_thread,
84 &factory, &cached_statements, &uri))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000085 {
Gerhard Häringe7ea7452008-03-29 00:45:29 +000086 return -1;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000087 }
88
Erlend Egeberg Aaslandc96cc082021-05-02 23:25:17 +020089 if (PySys_Audit("sqlite3.connect", "O", database_obj) < 0) {
Erlend Egeberg Aaslandaa6dd542021-09-13 05:16:01 +020090 Py_DECREF(database_obj);
Erlend Egeberg Aaslandc96cc082021-05-02 23:25:17 +020091 return -1;
92 }
93
Anders Lorentsena22a1272017-11-07 01:47:43 +010094 database = PyBytes_AsString(database_obj);
95
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000096 self->begin_statement = NULL;
97
Oren Milman93c5a5d2017-10-10 22:27:46 +030098 Py_CLEAR(self->statement_cache);
99 Py_CLEAR(self->statements);
100 Py_CLEAR(self->cursors);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000101
102 Py_INCREF(Py_None);
Oren Milman93c5a5d2017-10-10 22:27:46 +0300103 Py_XSETREF(self->row_factory, Py_None);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000104
105 Py_INCREF(&PyUnicode_Type);
Oren Milman93c5a5d2017-10-10 22:27:46 +0300106 Py_XSETREF(self->text_factory, (PyObject*)&PyUnicode_Type);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000107
Antoine Pitrou902fc8b2013-02-10 00:02:44 +0100108 Py_BEGIN_ALLOW_THREADS
109 rc = sqlite3_open_v2(database, &self->db,
110 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
111 (uri ? SQLITE_OPEN_URI : 0), NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000112 Py_END_ALLOW_THREADS
113
Anders Lorentsena22a1272017-11-07 01:47:43 +0100114 Py_DECREF(database_obj);
115
Łukasz Langa7e2c0a12021-10-29 22:54:07 +0200116 if (self->db == NULL && rc == SQLITE_NOMEM) {
117 PyErr_NoMemory();
118 return -1;
119 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000120 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000121 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000122 return -1;
123 }
124
125 if (!isolation_level) {
Neal Norwitzefee9f52007-10-27 02:50:52 +0000126 isolation_level = PyUnicode_FromString("");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000127 if (!isolation_level) {
128 return -1;
129 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000130 } else {
131 Py_INCREF(isolation_level);
132 }
Oren Milman93c5a5d2017-10-10 22:27:46 +0300133 Py_CLEAR(self->isolation_level);
Erlend Egeberg Aasland0cb470e2021-07-30 14:01:22 +0200134 if (pysqlite_connection_set_isolation_level(self, isolation_level, NULL) != 0) {
Victor Stinnercb1f74e2013-12-19 16:38:03 +0100135 Py_DECREF(isolation_level);
136 return -1;
137 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000138 Py_DECREF(isolation_level);
139
Erlend Egeberg Aaslanda937ab42020-09-27 14:14:50 +0200140 self->statement_cache = (pysqlite_Cache*)PyObject_CallFunction((PyObject*)pysqlite_CacheType, "Oi", self, cached_statements);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000141 if (PyErr_Occurred()) {
142 return -1;
143 }
144
Gerhard Häringf9cee222010-03-05 15:20:03 +0000145 self->created_statements = 0;
146 self->created_cursors = 0;
147
148 /* Create lists of weak references to statements/cursors */
Thomas Wouters477c8d52006-05-27 19:21:47 +0000149 self->statements = PyList_New(0);
Gerhard Häringf9cee222010-03-05 15:20:03 +0000150 self->cursors = PyList_New(0);
151 if (!self->statements || !self->cursors) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000152 return -1;
153 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000154
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000155 /* By default, the Cache class INCREFs the factory in its initializer, and
156 * decrefs it in its deallocator method. Since this would create a circular
157 * reference here, we're breaking it by decrementing self, and telling the
158 * cache class to not decref the factory (self) in its deallocator.
159 */
160 self->statement_cache->decref_factory = 0;
161 Py_DECREF(self);
162
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000163 self->detect_types = detect_types;
164 self->timeout = timeout;
165 (void)sqlite3_busy_timeout(self->db, (int)(timeout*1000));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000166 self->thread_ident = PyThread_get_thread_ident();
167 self->check_same_thread = check_same_thread;
168
gescheitb9a03762019-07-13 06:15:49 +0300169 self->function_pinboard_trace_callback = NULL;
170 self->function_pinboard_progress_handler = NULL;
171 self->function_pinboard_authorizer_cb = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000172
Oren Milman93c5a5d2017-10-10 22:27:46 +0300173 Py_XSETREF(self->collations, PyDict_New());
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000174 if (!self->collations) {
175 return -1;
176 }
177
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000178 self->Warning = pysqlite_Warning;
179 self->Error = pysqlite_Error;
180 self->InterfaceError = pysqlite_InterfaceError;
181 self->DatabaseError = pysqlite_DatabaseError;
182 self->DataError = pysqlite_DataError;
183 self->OperationalError = pysqlite_OperationalError;
184 self->IntegrityError = pysqlite_IntegrityError;
185 self->InternalError = pysqlite_InternalError;
186 self->ProgrammingError = pysqlite_ProgrammingError;
187 self->NotSupportedError = pysqlite_NotSupportedError;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000188
Erlend Egeberg Aaslandc96cc082021-05-02 23:25:17 +0200189 if (PySys_Audit("sqlite3.connect/handle", "O", self) < 0) {
190 return -1;
191 }
192
Erlend Egeberg Aasland0cb470e2021-07-30 14:01:22 +0200193 self->initialized = 1;
194
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000195 return 0;
196}
197
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000198/* action in (ACTION_RESET, ACTION_FINALIZE) */
Erlend Egeberg Aaslandbf838a62021-02-21 01:29:19 +0100199static void
200pysqlite_do_all_statements(pysqlite_Connection *self, int action,
201 int reset_cursors)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000202{
Thomas Wouters477c8d52006-05-27 19:21:47 +0000203 int i;
204 PyObject* weakref;
205 PyObject* statement;
Gerhard Häringf9cee222010-03-05 15:20:03 +0000206 pysqlite_Cursor* cursor;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000207
Thomas Wouters477c8d52006-05-27 19:21:47 +0000208 for (i = 0; i < PyList_Size(self->statements); i++) {
209 weakref = PyList_GetItem(self->statements, i);
210 statement = PyWeakref_GetObject(weakref);
211 if (statement != Py_None) {
Benjamin Peterson5c2b09e2011-05-31 21:31:37 -0500212 Py_INCREF(statement);
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000213 if (action == ACTION_RESET) {
214 (void)pysqlite_statement_reset((pysqlite_Statement*)statement);
215 } else {
216 (void)pysqlite_statement_finalize((pysqlite_Statement*)statement);
217 }
Benjamin Peterson5c2b09e2011-05-31 21:31:37 -0500218 Py_DECREF(statement);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000219 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000220 }
Gerhard Häringf9cee222010-03-05 15:20:03 +0000221
222 if (reset_cursors) {
223 for (i = 0; i < PyList_Size(self->cursors); i++) {
224 weakref = PyList_GetItem(self->cursors, i);
225 cursor = (pysqlite_Cursor*)PyWeakref_GetObject(weakref);
226 if ((PyObject*)cursor != Py_None) {
227 cursor->reset = 1;
228 }
229 }
230 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000231}
232
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700233static int
234connection_traverse(pysqlite_Connection *self, visitproc visit, void *arg)
235{
Miss Islington (bot)ff359d72021-05-31 02:12:27 -0700236 Py_VISIT(Py_TYPE(self));
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700237 Py_VISIT(self->isolation_level);
Miss Islington (bot)ff359d72021-05-31 02:12:27 -0700238 Py_VISIT(self->statement_cache);
239 Py_VISIT(self->statements);
240 Py_VISIT(self->cursors);
241 Py_VISIT(self->row_factory);
242 Py_VISIT(self->text_factory);
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700243 Py_VISIT(self->function_pinboard_trace_callback);
244 Py_VISIT(self->function_pinboard_progress_handler);
245 Py_VISIT(self->function_pinboard_authorizer_cb);
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700246 Py_VISIT(self->collations);
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700247 return 0;
248}
249
250static int
251connection_clear(pysqlite_Connection *self)
252{
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700253 Py_CLEAR(self->isolation_level);
Miss Islington (bot)ff359d72021-05-31 02:12:27 -0700254 Py_CLEAR(self->statement_cache);
255 Py_CLEAR(self->statements);
256 Py_CLEAR(self->cursors);
257 Py_CLEAR(self->row_factory);
258 Py_CLEAR(self->text_factory);
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700259 Py_CLEAR(self->function_pinboard_trace_callback);
260 Py_CLEAR(self->function_pinboard_progress_handler);
261 Py_CLEAR(self->function_pinboard_authorizer_cb);
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700262 Py_CLEAR(self->collations);
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700263 return 0;
264}
265
Erlend Egeberg Aaslandbf838a62021-02-21 01:29:19 +0100266static void
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700267connection_dealloc(pysqlite_Connection *self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000268{
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200269 PyTypeObject *tp = Py_TYPE(self);
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -0700270 PyObject_GC_UnTrack(self);
271 tp->tp_clear((PyObject *)self);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000272
273 /* Clean up if user has not called .close() explicitly. */
274 if (self->db) {
Erlend Egeberg Aaslandcf0b2392021-01-06 01:02:43 +0100275 sqlite3_close_v2(self->db);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000276 }
277
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200278 tp->tp_free(self);
279 Py_DECREF(tp);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000280}
281
Gerhard Häringf9cee222010-03-05 15:20:03 +0000282/*
283 * Registers a cursor with the connection.
284 *
285 * 0 => error; 1 => ok
286 */
287int pysqlite_connection_register_cursor(pysqlite_Connection* connection, PyObject* cursor)
288{
289 PyObject* weakref;
290
291 weakref = PyWeakref_NewRef((PyObject*)cursor, NULL);
292 if (!weakref) {
293 goto error;
294 }
295
296 if (PyList_Append(connection->cursors, weakref) != 0) {
297 Py_CLEAR(weakref);
298 goto error;
299 }
300
301 Py_DECREF(weakref);
302
303 return 1;
304error:
305 return 0;
306}
307
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100308/*[clinic input]
309_sqlite3.Connection.cursor as pysqlite_connection_cursor
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000310
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100311 factory: object = NULL
312
313Return a cursor for the connection.
314[clinic start generated code]*/
315
316static PyObject *
317pysqlite_connection_cursor_impl(pysqlite_Connection *self, PyObject *factory)
318/*[clinic end generated code: output=562432a9e6af2aa1 input=4127345aa091b650]*/
319{
320 PyObject* cursor;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000321
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000322 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000323 return NULL;
324 }
325
326 if (factory == NULL) {
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200327 factory = (PyObject*)pysqlite_CursorType;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000328 }
329
Petr Viktorinffd97532020-02-11 17:46:57 +0100330 cursor = PyObject_CallOneArg(factory, (PyObject *)self);
Serhiy Storchakaef113cd2016-08-29 14:29:55 +0300331 if (cursor == NULL)
332 return NULL;
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +0200333 if (!PyObject_TypeCheck(cursor, pysqlite_CursorType)) {
Serhiy Storchakaef113cd2016-08-29 14:29:55 +0300334 PyErr_Format(PyExc_TypeError,
335 "factory must return a cursor, not %.100s",
336 Py_TYPE(cursor)->tp_name);
337 Py_DECREF(cursor);
338 return NULL;
339 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000340
Gerhard Häringf9cee222010-03-05 15:20:03 +0000341 _pysqlite_drop_unused_cursor_references(self);
342
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000343 if (cursor && self->row_factory != Py_None) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000344 Py_INCREF(self->row_factory);
Serhiy Storchaka48842712016-04-06 09:45:48 +0300345 Py_XSETREF(((pysqlite_Cursor *)cursor)->row_factory, self->row_factory);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000346 }
347
348 return cursor;
349}
350
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100351/*[clinic input]
352_sqlite3.Connection.close as pysqlite_connection_close
353
354Closes the connection.
355[clinic start generated code]*/
356
357static PyObject *
358pysqlite_connection_close_impl(pysqlite_Connection *self)
359/*[clinic end generated code: output=a546a0da212c9b97 input=3d58064bbffaa3d3]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000360{
361 int rc;
362
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000363 if (!pysqlite_check_thread(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000364 return NULL;
365 }
366
Erlend Egeberg Aasland0cb470e2021-07-30 14:01:22 +0200367 if (!self->initialized) {
368 PyErr_SetString(pysqlite_ProgrammingError,
369 "Base Connection.__init__ not called.");
370 return NULL;
371 }
372
Gerhard Häringf9cee222010-03-05 15:20:03 +0000373 pysqlite_do_all_statements(self, ACTION_FINALIZE, 1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000374
375 if (self->db) {
Erlend Egeberg Aaslandcf0b2392021-01-06 01:02:43 +0100376 rc = sqlite3_close_v2(self->db);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000377
378 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000379 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000380 return NULL;
381 } else {
382 self->db = NULL;
383 }
384 }
385
Berker Peksagfe21de92016-04-09 07:34:39 +0300386 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000387}
388
389/*
390 * Checks if a connection object is usable (i. e. not closed).
391 *
392 * 0 => error; 1 => ok
393 */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000394int pysqlite_check_connection(pysqlite_Connection* con)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000395{
Gerhard Häringf9cee222010-03-05 15:20:03 +0000396 if (!con->initialized) {
397 PyErr_SetString(pysqlite_ProgrammingError, "Base Connection.__init__ not called.");
398 return 0;
399 }
400
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000401 if (!con->db) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000402 PyErr_SetString(pysqlite_ProgrammingError, "Cannot operate on a closed database.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000403 return 0;
404 } else {
405 return 1;
406 }
407}
408
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000409PyObject* _pysqlite_connection_begin(pysqlite_Connection* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000410{
411 int rc;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000412 sqlite3_stmt* statement;
413
414 Py_BEGIN_ALLOW_THREADS
Erlend Egeberg Aasland5e48e832021-02-26 15:30:22 +0100415 rc = sqlite3_prepare_v2(self->db, self->begin_statement, -1, &statement,
416 NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000417 Py_END_ALLOW_THREADS
418
419 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000420 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000421 goto error;
422 }
423
Benjamin Petersond7b03282008-09-13 15:58:53 +0000424 rc = pysqlite_step(statement, self);
Berker Peksag59da4b32016-09-12 07:16:43 +0300425 if (rc != SQLITE_DONE) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000426 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000427 }
428
429 Py_BEGIN_ALLOW_THREADS
430 rc = sqlite3_finalize(statement);
431 Py_END_ALLOW_THREADS
432
433 if (rc != SQLITE_OK && !PyErr_Occurred()) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000434 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000435 }
436
437error:
438 if (PyErr_Occurred()) {
439 return NULL;
440 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200441 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000442 }
443}
444
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +0100445/*[clinic input]
446_sqlite3.Connection.commit as pysqlite_connection_commit
447
448Commit the current transaction.
449[clinic start generated code]*/
450
451static PyObject *
452pysqlite_connection_commit_impl(pysqlite_Connection *self)
453/*[clinic end generated code: output=3da45579e89407f2 input=39c12c04dda276a8]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000454{
455 int rc;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000456 sqlite3_stmt* statement;
457
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000458 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000459 return NULL;
460 }
461
Berker Peksag59da4b32016-09-12 07:16:43 +0300462 if (!sqlite3_get_autocommit(self->db)) {
Gerhard Häringf9cee222010-03-05 15:20:03 +0000463
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000464 Py_BEGIN_ALLOW_THREADS
Erlend Egeberg Aasland5e48e832021-02-26 15:30:22 +0100465 rc = sqlite3_prepare_v2(self->db, "COMMIT", -1, &statement, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000466 Py_END_ALLOW_THREADS
467 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000468 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000469 goto error;
470 }
471
Benjamin Petersond7b03282008-09-13 15:58:53 +0000472 rc = pysqlite_step(statement, self);
Berker Peksag59da4b32016-09-12 07:16:43 +0300473 if (rc != SQLITE_DONE) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000474 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000475 }
476
477 Py_BEGIN_ALLOW_THREADS
478 rc = sqlite3_finalize(statement);
479 Py_END_ALLOW_THREADS
480 if (rc != SQLITE_OK && !PyErr_Occurred()) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000481 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000482 }
483
484 }
485
486error:
487 if (PyErr_Occurred()) {
488 return NULL;
489 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200490 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000491 }
492}
493
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100494/*[clinic input]
495_sqlite3.Connection.rollback as pysqlite_connection_rollback
496
497Roll back the current transaction.
498[clinic start generated code]*/
499
500static PyObject *
501pysqlite_connection_rollback_impl(pysqlite_Connection *self)
502/*[clinic end generated code: output=b66fa0d43e7ef305 input=12d4e8d068942830]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000503{
504 int rc;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000505 sqlite3_stmt* statement;
506
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000507 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000508 return NULL;
509 }
510
Berker Peksag59da4b32016-09-12 07:16:43 +0300511 if (!sqlite3_get_autocommit(self->db)) {
Gerhard Häringf9cee222010-03-05 15:20:03 +0000512 pysqlite_do_all_statements(self, ACTION_RESET, 1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000513
514 Py_BEGIN_ALLOW_THREADS
Erlend Egeberg Aasland5e48e832021-02-26 15:30:22 +0100515 rc = sqlite3_prepare_v2(self->db, "ROLLBACK", -1, &statement, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000516 Py_END_ALLOW_THREADS
517 if (rc != SQLITE_OK) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000518 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000519 goto error;
520 }
521
Benjamin Petersond7b03282008-09-13 15:58:53 +0000522 rc = pysqlite_step(statement, self);
Berker Peksag59da4b32016-09-12 07:16:43 +0300523 if (rc != SQLITE_DONE) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000524 _pysqlite_seterror(self->db, statement);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000525 }
526
527 Py_BEGIN_ALLOW_THREADS
528 rc = sqlite3_finalize(statement);
529 Py_END_ALLOW_THREADS
530 if (rc != SQLITE_OK && !PyErr_Occurred()) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000531 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000532 }
533
534 }
535
536error:
537 if (PyErr_Occurred()) {
538 return NULL;
539 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200540 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000541 }
542}
543
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200544static int
545_pysqlite_set_result(sqlite3_context* context, PyObject* py_val)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000546{
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200547 if (py_val == Py_None) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000548 sqlite3_result_null(context);
Christian Heimes217cfd12007-12-02 14:31:20 +0000549 } else if (PyLong_Check(py_val)) {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200550 sqlite_int64 value = _pysqlite_long_as_int64(py_val);
551 if (value == -1 && PyErr_Occurred())
552 return -1;
553 sqlite3_result_int64(context, value);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000554 } else if (PyFloat_Check(py_val)) {
555 sqlite3_result_double(context, PyFloat_AsDouble(py_val));
Guido van Rossumbae07c92007-10-08 02:46:15 +0000556 } else if (PyUnicode_Check(py_val)) {
Miss Islington (bot)2b1e7132021-08-06 10:59:51 -0700557 Py_ssize_t sz;
558 const char *str = PyUnicode_AsUTF8AndSize(py_val, &sz);
559 if (str == NULL) {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200560 return -1;
Miss Islington (bot)2b1e7132021-08-06 10:59:51 -0700561 }
562 if (sz > INT_MAX) {
563 PyErr_SetString(PyExc_OverflowError,
564 "string is longer than INT_MAX bytes");
565 return -1;
566 }
567 sqlite3_result_text(context, str, (int)sz, SQLITE_TRANSIENT);
Guido van Rossumbae07c92007-10-08 02:46:15 +0000568 } else if (PyObject_CheckBuffer(py_val)) {
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200569 Py_buffer view;
570 if (PyObject_GetBuffer(py_val, &view, PyBUF_SIMPLE) != 0) {
Victor Stinner83ed42b2013-11-18 01:24:31 +0100571 PyErr_SetString(PyExc_ValueError,
572 "could not convert BLOB to buffer");
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200573 return -1;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000574 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200575 if (view.len > INT_MAX) {
Victor Stinner83ed42b2013-11-18 01:24:31 +0100576 PyErr_SetString(PyExc_OverflowError,
577 "BLOB longer than INT_MAX bytes");
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200578 PyBuffer_Release(&view);
Victor Stinner83ed42b2013-11-18 01:24:31 +0100579 return -1;
580 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200581 sqlite3_result_blob(context, view.buf, (int)view.len, SQLITE_TRANSIENT);
582 PyBuffer_Release(&view);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000583 } else {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200584 return -1;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000585 }
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200586 return 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000587}
588
Erlend Egeberg Aaslandbf838a62021-02-21 01:29:19 +0100589static PyObject *
590_pysqlite_build_py_params(sqlite3_context *context, int argc,
591 sqlite3_value **argv)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000592{
593 PyObject* args;
594 int i;
595 sqlite3_value* cur_value;
596 PyObject* cur_py_value;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000597
598 args = PyTuple_New(argc);
599 if (!args) {
600 return NULL;
601 }
602
603 for (i = 0; i < argc; i++) {
604 cur_value = argv[i];
605 switch (sqlite3_value_type(argv[i])) {
606 case SQLITE_INTEGER:
Sergey Fedoseevb6f5b9d2019-10-23 13:09:01 +0500607 cur_py_value = PyLong_FromLongLong(sqlite3_value_int64(cur_value));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000608 break;
609 case SQLITE_FLOAT:
610 cur_py_value = PyFloat_FromDouble(sqlite3_value_double(cur_value));
611 break;
Miss Islington (bot)067d6d42021-06-04 11:54:39 -0700612 case SQLITE_TEXT: {
613 sqlite3 *db = sqlite3_context_db_handle(context);
614 const char *text = (const char *)sqlite3_value_text(cur_value);
615
616 if (text == NULL && sqlite3_errcode(db) == SQLITE_NOMEM) {
617 PyErr_NoMemory();
618 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000619 }
Miss Islington (bot)067d6d42021-06-04 11:54:39 -0700620
621 Py_ssize_t size = sqlite3_value_bytes(cur_value);
622 cur_py_value = PyUnicode_FromStringAndSize(text, size);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000623 break;
Miss Islington (bot)067d6d42021-06-04 11:54:39 -0700624 }
Erlend Egeberg Aasland5cb601f2021-04-14 23:09:11 +0200625 case SQLITE_BLOB: {
626 sqlite3 *db = sqlite3_context_db_handle(context);
627 const void *blob = sqlite3_value_blob(cur_value);
628
629 if (blob == NULL && sqlite3_errcode(db) == SQLITE_NOMEM) {
630 PyErr_NoMemory();
631 goto error;
632 }
633
634 Py_ssize_t size = sqlite3_value_bytes(cur_value);
635 cur_py_value = PyBytes_FromStringAndSize(blob, size);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000636 break;
Erlend Egeberg Aasland5cb601f2021-04-14 23:09:11 +0200637 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000638 case SQLITE_NULL:
639 default:
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +0100640 cur_py_value = Py_NewRef(Py_None);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000641 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000642
643 if (!cur_py_value) {
Erlend Egeberg Aasland5cb601f2021-04-14 23:09:11 +0200644 goto error;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000645 }
646
Erlend Egeberg Aaslande9194ea2021-04-23 13:21:08 +0200647 PyTuple_SET_ITEM(args, i, cur_py_value);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000648 }
649
650 return args;
Erlend Egeberg Aasland5cb601f2021-04-14 23:09:11 +0200651
652error:
653 Py_DECREF(args);
654 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000655}
656
Erlend Egeberg Aasland2bb0bf42021-02-19 12:59:24 +0100657static void
658_pysqlite_func_callback(sqlite3_context *context, int argc, sqlite3_value **argv)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000659{
660 PyObject* args;
661 PyObject* py_func;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000662 PyObject* py_retval = NULL;
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200663 int ok;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000664
665 PyGILState_STATE threadstate;
666
667 threadstate = PyGILState_Ensure();
668
669 py_func = (PyObject*)sqlite3_user_data(context);
670
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000671 args = _pysqlite_build_py_params(context, argc, argv);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000672 if (args) {
673 py_retval = PyObject_CallObject(py_func, args);
674 Py_DECREF(args);
675 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000676
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200677 ok = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000678 if (py_retval) {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200679 ok = _pysqlite_set_result(context, py_retval) == 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000680 Py_DECREF(py_retval);
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200681 }
682 if (!ok) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700683 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000684 PyErr_Print();
685 } else {
686 PyErr_Clear();
687 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200688 sqlite3_result_error(context, "user-defined function raised exception", -1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000689 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000690
691 PyGILState_Release(threadstate);
692}
693
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000694static void _pysqlite_step_callback(sqlite3_context *context, int argc, sqlite3_value** params)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000695{
696 PyObject* args;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000697 PyObject* function_result = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000698 PyObject* aggregate_class;
699 PyObject** aggregate_instance;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000700 PyObject* stepmethod = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000701
702 PyGILState_STATE threadstate;
703
704 threadstate = PyGILState_Ensure();
705
706 aggregate_class = (PyObject*)sqlite3_user_data(context);
707
708 aggregate_instance = (PyObject**)sqlite3_aggregate_context(context, sizeof(PyObject*));
709
Serhiy Storchaka0b3ec192017-03-23 17:53:47 +0200710 if (*aggregate_instance == NULL) {
Victor Stinner070c4d72016-12-09 12:29:18 +0100711 *aggregate_instance = _PyObject_CallNoArg(aggregate_class);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000712
Thomas Wouters477c8d52006-05-27 19:21:47 +0000713 if (PyErr_Occurred()) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000714 *aggregate_instance = 0;
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700715 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000716 PyErr_Print();
717 } else {
718 PyErr_Clear();
719 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200720 sqlite3_result_error(context, "user-defined aggregate's '__init__' method raised error", -1);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000721 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000722 }
723 }
724
725 stepmethod = PyObject_GetAttrString(*aggregate_instance, "step");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000726 if (!stepmethod) {
727 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000728 }
729
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000730 args = _pysqlite_build_py_params(context, argc, params);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000731 if (!args) {
732 goto error;
733 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000734
735 function_result = PyObject_CallObject(stepmethod, args);
736 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000737
Thomas Wouters477c8d52006-05-27 19:21:47 +0000738 if (!function_result) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700739 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000740 PyErr_Print();
741 } else {
742 PyErr_Clear();
743 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200744 sqlite3_result_error(context, "user-defined aggregate's 'step' method raised error", -1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000745 }
746
Thomas Wouters477c8d52006-05-27 19:21:47 +0000747error:
748 Py_XDECREF(stepmethod);
749 Py_XDECREF(function_result);
750
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000751 PyGILState_Release(threadstate);
752}
753
Erlend Egeberg Aasland2bb0bf42021-02-19 12:59:24 +0100754static void
755_pysqlite_final_callback(sqlite3_context *context)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000756{
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200757 PyObject* function_result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000758 PyObject** aggregate_instance;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200759 _Py_IDENTIFIER(finalize);
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200760 int ok;
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200761 PyObject *exception, *value, *tb;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000762
763 PyGILState_STATE threadstate;
764
765 threadstate = PyGILState_Ensure();
766
Erlend Egeberg Aasland979b23c2021-02-19 12:20:32 +0100767 aggregate_instance = (PyObject**)sqlite3_aggregate_context(context, 0);
768 if (aggregate_instance == NULL) {
769 /* No rows matched the query; the step handler was never called. */
770 goto error;
771 }
772 else if (!*aggregate_instance) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000773 /* this branch is executed if there was an exception in the aggregate's
774 * __init__ */
775
Thomas Wouters477c8d52006-05-27 19:21:47 +0000776 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000777 }
778
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200779 /* Keep the exception (if any) of the last call to step() */
780 PyErr_Fetch(&exception, &value, &tb);
781
Jeroen Demeyer762f93f2019-07-08 10:19:25 +0200782 function_result = _PyObject_CallMethodIdNoArgs(*aggregate_instance, &PyId_finalize);
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200783
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200784 Py_DECREF(*aggregate_instance);
785
786 ok = 0;
787 if (function_result) {
788 ok = _pysqlite_set_result(context, function_result) == 0;
789 Py_DECREF(function_result);
790 }
791 if (!ok) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700792 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000793 PyErr_Print();
794 } else {
795 PyErr_Clear();
796 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200797 sqlite3_result_error(context, "user-defined aggregate's 'finalize' method raised error", -1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000798 }
799
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200800 /* Restore the exception (if any) of the last call to step(),
801 but clear also the current exception if finalize() failed */
802 PyErr_Restore(exception, value, tb);
Victor Stinner3a857322013-07-22 08:34:32 +0200803
Thomas Wouters477c8d52006-05-27 19:21:47 +0000804error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000805 PyGILState_Release(threadstate);
806}
807
Gerhard Häringf9cee222010-03-05 15:20:03 +0000808static void _pysqlite_drop_unused_statement_references(pysqlite_Connection* self)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000809{
810 PyObject* new_list;
811 PyObject* weakref;
812 int i;
813
814 /* we only need to do this once in a while */
815 if (self->created_statements++ < 200) {
816 return;
817 }
818
819 self->created_statements = 0;
820
821 new_list = PyList_New(0);
822 if (!new_list) {
823 return;
824 }
825
826 for (i = 0; i < PyList_Size(self->statements); i++) {
827 weakref = PyList_GetItem(self->statements, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000828 if (PyWeakref_GetObject(weakref) != Py_None) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000829 if (PyList_Append(new_list, weakref) != 0) {
830 Py_DECREF(new_list);
831 return;
832 }
833 }
834 }
835
Serhiy Storchaka57a01d32016-04-10 18:05:40 +0300836 Py_SETREF(self->statements, new_list);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000837}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000838
Gerhard Häringf9cee222010-03-05 15:20:03 +0000839static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self)
840{
841 PyObject* new_list;
842 PyObject* weakref;
843 int i;
844
845 /* we only need to do this once in a while */
846 if (self->created_cursors++ < 200) {
847 return;
848 }
849
850 self->created_cursors = 0;
851
852 new_list = PyList_New(0);
853 if (!new_list) {
854 return;
855 }
856
857 for (i = 0; i < PyList_Size(self->cursors); i++) {
858 weakref = PyList_GetItem(self->cursors, i);
859 if (PyWeakref_GetObject(weakref) != Py_None) {
860 if (PyList_Append(new_list, weakref) != 0) {
861 Py_DECREF(new_list);
862 return;
863 }
864 }
865 }
866
Serhiy Storchaka57a01d32016-04-10 18:05:40 +0300867 Py_SETREF(self->cursors, new_list);
Gerhard Häringf9cee222010-03-05 15:20:03 +0000868}
869
gescheitb9a03762019-07-13 06:15:49 +0300870static void _destructor(void* args)
871{
Miss Islington (bot)317e9ed2021-06-05 16:13:27 -0700872 // This function may be called without the GIL held, so we need to ensure
873 // that we destroy 'args' with the GIL
874 PyGILState_STATE gstate;
875 gstate = PyGILState_Ensure();
gescheitb9a03762019-07-13 06:15:49 +0300876 Py_DECREF((PyObject*)args);
Miss Islington (bot)317e9ed2021-06-05 16:13:27 -0700877 PyGILState_Release(gstate);
gescheitb9a03762019-07-13 06:15:49 +0300878}
879
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100880/*[clinic input]
881_sqlite3.Connection.create_function as pysqlite_connection_create_function
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000882
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100883 name: str
884 narg: int
885 func: object
886 *
887 deterministic: bool = False
888
889Creates a new function. Non-standard.
890[clinic start generated code]*/
891
892static PyObject *
893pysqlite_connection_create_function_impl(pysqlite_Connection *self,
894 const char *name, int narg,
895 PyObject *func, int deterministic)
896/*[clinic end generated code: output=07d1877dd98c0308 input=f2edcf073e815beb]*/
897{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000898 int rc;
Sergey Fedoseev08308582018-07-08 12:09:20 +0500899 int flags = SQLITE_UTF8;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000900
Gerhard Häringf9cee222010-03-05 15:20:03 +0000901 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
902 return NULL;
903 }
904
Sergey Fedoseev08308582018-07-08 12:09:20 +0500905 if (deterministic) {
906#if SQLITE_VERSION_NUMBER < 3008003
907 PyErr_SetString(pysqlite_NotSupportedError,
908 "deterministic=True requires SQLite 3.8.3 or higher");
909 return NULL;
910#else
911 if (sqlite3_libversion_number() < 3008003) {
912 PyErr_SetString(pysqlite_NotSupportedError,
913 "deterministic=True requires SQLite 3.8.3 or higher");
914 return NULL;
915 }
916 flags |= SQLITE_DETERMINISTIC;
917#endif
918 }
gescheitb9a03762019-07-13 06:15:49 +0300919 rc = sqlite3_create_function_v2(self->db,
920 name,
921 narg,
922 flags,
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +0100923 (void*)Py_NewRef(func),
gescheitb9a03762019-07-13 06:15:49 +0300924 _pysqlite_func_callback,
925 NULL,
926 NULL,
927 &_destructor); // will decref func
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000928
Thomas Wouters477c8d52006-05-27 19:21:47 +0000929 if (rc != SQLITE_OK) {
930 /* Workaround for SQLite bug: no error code or string is available here */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000931 PyErr_SetString(pysqlite_OperationalError, "Error creating function");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000932 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000933 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +0500934 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000935}
936
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100937/*[clinic input]
938_sqlite3.Connection.create_aggregate as pysqlite_connection_create_aggregate
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000939
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100940 name: str
941 n_arg: int
942 aggregate_class: object
943
944Creates a new aggregate. Non-standard.
945[clinic start generated code]*/
946
947static PyObject *
948pysqlite_connection_create_aggregate_impl(pysqlite_Connection *self,
949 const char *name, int n_arg,
950 PyObject *aggregate_class)
951/*[clinic end generated code: output=fbb2f858cfa4d8db input=c2e13bbf234500a5]*/
952{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000953 int rc;
954
Gerhard Häringf9cee222010-03-05 15:20:03 +0000955 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
956 return NULL;
957 }
958
gescheitb9a03762019-07-13 06:15:49 +0300959 rc = sqlite3_create_function_v2(self->db,
960 name,
961 n_arg,
962 SQLITE_UTF8,
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +0100963 (void*)Py_NewRef(aggregate_class),
gescheitb9a03762019-07-13 06:15:49 +0300964 0,
965 &_pysqlite_step_callback,
966 &_pysqlite_final_callback,
967 &_destructor); // will decref func
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000968 if (rc != SQLITE_OK) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000969 /* Workaround for SQLite bug: no error code or string is available here */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000970 PyErr_SetString(pysqlite_OperationalError, "Error creating aggregate");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000971 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000972 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +0500973 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000974}
975
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000976static 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 +0000977{
978 PyObject *ret;
979 int rc;
980 PyGILState_STATE gilstate;
981
982 gilstate = PyGILState_Ensure();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000983
Victor Stinnerd4095d92013-07-26 22:23:33 +0200984 ret = PyObject_CallFunction((PyObject*)user_arg, "issss", action, arg1, arg2, dbname, access_attempt_source);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000985
Victor Stinnerd4095d92013-07-26 22:23:33 +0200986 if (ret == NULL) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700987 if (_pysqlite_enable_callback_tracebacks)
Victor Stinnerd4095d92013-07-26 22:23:33 +0200988 PyErr_Print();
989 else
990 PyErr_Clear();
Victor Stinner41801f52013-07-21 13:05:38 +0200991
Victor Stinnerd4095d92013-07-26 22:23:33 +0200992 rc = SQLITE_DENY;
Victor Stinner41801f52013-07-21 13:05:38 +0200993 }
994 else {
Victor Stinnerd4095d92013-07-26 22:23:33 +0200995 if (PyLong_Check(ret)) {
996 rc = _PyLong_AsInt(ret);
997 if (rc == -1 && PyErr_Occurred()) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700998 if (_pysqlite_enable_callback_tracebacks)
Victor Stinnerd4095d92013-07-26 22:23:33 +0200999 PyErr_Print();
1000 else
1001 PyErr_Clear();
1002 rc = SQLITE_DENY;
1003 }
1004 }
1005 else {
1006 rc = SQLITE_DENY;
1007 }
1008 Py_DECREF(ret);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001009 }
1010
1011 PyGILState_Release(gilstate);
1012 return rc;
1013}
1014
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001015static int _progress_handler(void* user_arg)
1016{
1017 int rc;
1018 PyObject *ret;
1019 PyGILState_STATE gilstate;
1020
1021 gilstate = PyGILState_Ensure();
Victor Stinner070c4d72016-12-09 12:29:18 +01001022 ret = _PyObject_CallNoArg((PyObject*)user_arg);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001023
1024 if (!ret) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -07001025 if (_pysqlite_enable_callback_tracebacks) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001026 PyErr_Print();
1027 } else {
1028 PyErr_Clear();
1029 }
1030
Mark Dickinson934896d2009-02-21 20:59:32 +00001031 /* abort query if error occurred */
Victor Stinner86999502010-05-19 01:27:23 +00001032 rc = 1;
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001033 } else {
1034 rc = (int)PyObject_IsTrue(ret);
1035 Py_DECREF(ret);
1036 }
1037
1038 PyGILState_Release(gilstate);
1039 return rc;
1040}
1041
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001042#ifdef HAVE_TRACE_V2
1043/*
1044 * From https://sqlite.org/c3ref/trace_v2.html:
1045 * The integer return value from the callback is currently ignored, though this
1046 * may change in future releases. Callback implementations should return zero
1047 * to ensure future compatibility.
1048 */
1049static int _trace_callback(unsigned int type, void* user_arg, void* prepared_statement, void* statement_string)
1050#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001051static void _trace_callback(void* user_arg, const char* statement_string)
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001052#endif
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001053{
1054 PyObject *py_statement = NULL;
1055 PyObject *ret = NULL;
1056
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001057 PyGILState_STATE gilstate;
1058
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001059#ifdef HAVE_TRACE_V2
1060 if (type != SQLITE_TRACE_STMT) {
1061 return 0;
1062 }
1063#endif
1064
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001065 gilstate = PyGILState_Ensure();
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001066 py_statement = PyUnicode_DecodeUTF8(statement_string,
1067 strlen(statement_string), "replace");
1068 if (py_statement) {
Petr Viktorinffd97532020-02-11 17:46:57 +01001069 ret = PyObject_CallOneArg((PyObject*)user_arg, py_statement);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001070 Py_DECREF(py_statement);
1071 }
1072
1073 if (ret) {
1074 Py_DECREF(ret);
1075 } else {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -07001076 if (_pysqlite_enable_callback_tracebacks) {
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001077 PyErr_Print();
1078 } else {
1079 PyErr_Clear();
1080 }
1081 }
1082
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001083 PyGILState_Release(gilstate);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001084#ifdef HAVE_TRACE_V2
1085 return 0;
1086#endif
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001087}
1088
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001089/*[clinic input]
1090_sqlite3.Connection.set_authorizer as pysqlite_connection_set_authorizer
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001091
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001092 authorizer_callback as authorizer_cb: object
1093
1094Sets authorizer callback. Non-standard.
1095[clinic start generated code]*/
1096
1097static PyObject *
1098pysqlite_connection_set_authorizer_impl(pysqlite_Connection *self,
1099 PyObject *authorizer_cb)
1100/*[clinic end generated code: output=f18ba575d788b35c input=df079724c020d2f2]*/
1101{
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001102 int rc;
1103
Gerhard Häringf9cee222010-03-05 15:20:03 +00001104 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1105 return NULL;
1106 }
1107
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001108 rc = sqlite3_set_authorizer(self->db, _authorizer_callback, (void*)authorizer_cb);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001109 if (rc != SQLITE_OK) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001110 PyErr_SetString(pysqlite_OperationalError, "Error setting authorizer callback");
gescheitb9a03762019-07-13 06:15:49 +03001111 Py_XSETREF(self->function_pinboard_authorizer_cb, NULL);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001112 return NULL;
gescheitb9a03762019-07-13 06:15:49 +03001113 } else {
1114 Py_INCREF(authorizer_cb);
1115 Py_XSETREF(self->function_pinboard_authorizer_cb, authorizer_cb);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001116 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +05001117 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001118}
1119
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001120/*[clinic input]
1121_sqlite3.Connection.set_progress_handler as pysqlite_connection_set_progress_handler
1122
1123 progress_handler: object
1124 n: int
1125
1126Sets progress handler callback. Non-standard.
1127[clinic start generated code]*/
1128
1129static PyObject *
1130pysqlite_connection_set_progress_handler_impl(pysqlite_Connection *self,
1131 PyObject *progress_handler,
1132 int n)
1133/*[clinic end generated code: output=35a7c10364cb1b04 input=857696c25f964c64]*/
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001134{
Gerhard Häringf9cee222010-03-05 15:20:03 +00001135 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1136 return NULL;
1137 }
1138
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001139 if (progress_handler == Py_None) {
1140 /* None clears the progress handler previously set */
1141 sqlite3_progress_handler(self->db, 0, 0, (void*)0);
gescheitb9a03762019-07-13 06:15:49 +03001142 Py_XSETREF(self->function_pinboard_progress_handler, NULL);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001143 } else {
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +05001144 sqlite3_progress_handler(self->db, n, _progress_handler, progress_handler);
gescheitb9a03762019-07-13 06:15:49 +03001145 Py_INCREF(progress_handler);
1146 Py_XSETREF(self->function_pinboard_progress_handler, progress_handler);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001147 }
Berker Peksagfe21de92016-04-09 07:34:39 +03001148 Py_RETURN_NONE;
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001149}
1150
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001151/*[clinic input]
1152_sqlite3.Connection.set_trace_callback as pysqlite_connection_set_trace_callback
1153
1154 trace_callback: object
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001155
1156Sets a trace callback called for each SQL statement (passed as unicode).
1157
1158Non-standard.
1159[clinic start generated code]*/
1160
1161static PyObject *
Dong-hee Na21793492020-12-19 00:41:33 +09001162pysqlite_connection_set_trace_callback_impl(pysqlite_Connection *self,
1163 PyObject *trace_callback)
1164/*[clinic end generated code: output=fb0e307b9924d454 input=56d60fd38d763679]*/
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001165{
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001166 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1167 return NULL;
1168 }
1169
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001170 if (trace_callback == Py_None) {
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001171 /*
1172 * None clears the trace callback previously set
1173 *
1174 * Ref.
1175 * - https://sqlite.org/c3ref/c_trace.html
1176 * - https://sqlite.org/c3ref/trace_v2.html
1177 */
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001178#ifdef HAVE_TRACE_V2
1179 sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, 0, 0);
1180#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001181 sqlite3_trace(self->db, 0, (void*)0);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001182#endif
gescheitb9a03762019-07-13 06:15:49 +03001183 Py_XSETREF(self->function_pinboard_trace_callback, NULL);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001184 } else {
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001185#ifdef HAVE_TRACE_V2
1186 sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, _trace_callback, trace_callback);
1187#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001188 sqlite3_trace(self->db, _trace_callback, trace_callback);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001189#endif
gescheitb9a03762019-07-13 06:15:49 +03001190 Py_INCREF(trace_callback);
1191 Py_XSETREF(self->function_pinboard_trace_callback, trace_callback);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001192 }
1193
Berker Peksagfe21de92016-04-09 07:34:39 +03001194 Py_RETURN_NONE;
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001195}
1196
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +02001197#ifndef SQLITE_OMIT_LOAD_EXTENSION
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001198/*[clinic input]
1199_sqlite3.Connection.enable_load_extension as pysqlite_connection_enable_load_extension
1200
Dong-hee Na21793492020-12-19 00:41:33 +09001201 enable as onoff: bool(accept={int})
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001202 /
1203
1204Enable dynamic loading of SQLite extension modules. Non-standard.
1205[clinic start generated code]*/
1206
1207static PyObject *
1208pysqlite_connection_enable_load_extension_impl(pysqlite_Connection *self,
1209 int onoff)
Dong-hee Na21793492020-12-19 00:41:33 +09001210/*[clinic end generated code: output=9cac37190d388baf input=5c0da5b121121cbc]*/
Gerhard Häringf9cee222010-03-05 15:20:03 +00001211{
1212 int rc;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001213
Erlend Egeberg Aasland7244c002021-04-27 01:16:46 +02001214 if (PySys_Audit("sqlite3.enable_load_extension",
1215 "OO", self, onoff ? Py_True : Py_False) < 0) {
1216 return NULL;
1217 }
1218
Gerhard Häringf9cee222010-03-05 15:20:03 +00001219 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1220 return NULL;
1221 }
1222
Gerhard Häringf9cee222010-03-05 15:20:03 +00001223 rc = sqlite3_enable_load_extension(self->db, onoff);
1224
1225 if (rc != SQLITE_OK) {
1226 PyErr_SetString(pysqlite_OperationalError, "Error enabling load extension");
1227 return NULL;
1228 } else {
Berker Peksagfe21de92016-04-09 07:34:39 +03001229 Py_RETURN_NONE;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001230 }
1231}
1232
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001233/*[clinic input]
1234_sqlite3.Connection.load_extension as pysqlite_connection_load_extension
1235
1236 name as extension_name: str
1237 /
1238
1239Load SQLite extension module. Non-standard.
1240[clinic start generated code]*/
1241
1242static PyObject *
1243pysqlite_connection_load_extension_impl(pysqlite_Connection *self,
1244 const char *extension_name)
1245/*[clinic end generated code: output=47eb1d7312bc97a7 input=0b711574560db9fc]*/
Gerhard Häringf9cee222010-03-05 15:20:03 +00001246{
1247 int rc;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001248 char* errmsg;
1249
Erlend Egeberg Aasland7244c002021-04-27 01:16:46 +02001250 if (PySys_Audit("sqlite3.load_extension", "Os", self, extension_name) < 0) {
1251 return NULL;
1252 }
1253
Gerhard Häringf9cee222010-03-05 15:20:03 +00001254 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1255 return NULL;
1256 }
1257
Gerhard Häringf9cee222010-03-05 15:20:03 +00001258 rc = sqlite3_load_extension(self->db, extension_name, 0, &errmsg);
1259 if (rc != 0) {
1260 PyErr_SetString(pysqlite_OperationalError, errmsg);
1261 return NULL;
1262 } else {
Berker Peksagfe21de92016-04-09 07:34:39 +03001263 Py_RETURN_NONE;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001264 }
1265}
1266#endif
1267
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001268int pysqlite_check_thread(pysqlite_Connection* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001269{
1270 if (self->check_same_thread) {
1271 if (PyThread_get_thread_ident() != self->thread_ident) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001272 PyErr_Format(pysqlite_ProgrammingError,
Takuya Akiba030345c2018-03-27 00:14:00 +09001273 "SQLite objects created in a thread can only be used in that same thread. "
1274 "The object was created in thread id %lu and this is thread id %lu.",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001275 self->thread_ident, PyThread_get_thread_ident());
1276 return 0;
1277 }
1278
1279 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001280 return 1;
1281}
1282
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001283static PyObject* pysqlite_connection_get_isolation_level(pysqlite_Connection* self, void* unused)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001284{
Erlend Egeberg Aasland0cb470e2021-07-30 14:01:22 +02001285 if (!pysqlite_check_connection(self)) {
1286 return NULL;
1287 }
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001288 return Py_NewRef(self->isolation_level);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001289}
1290
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001291static PyObject* pysqlite_connection_get_total_changes(pysqlite_Connection* self, void* unused)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001292{
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001293 if (!pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001294 return NULL;
1295 } else {
1296 return Py_BuildValue("i", sqlite3_total_changes(self->db));
1297 }
1298}
1299
Berker Peksag59da4b32016-09-12 07:16:43 +03001300static PyObject* pysqlite_connection_get_in_transaction(pysqlite_Connection* self, void* unused)
1301{
1302 if (!pysqlite_check_connection(self)) {
1303 return NULL;
1304 }
1305 if (!sqlite3_get_autocommit(self->db)) {
1306 Py_RETURN_TRUE;
1307 }
1308 Py_RETURN_FALSE;
1309}
1310
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001311static int
1312pysqlite_connection_set_isolation_level(pysqlite_Connection* self, PyObject* isolation_level, void *Py_UNUSED(ignored))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001313{
Zackery Spytz842acaa2018-12-17 07:52:45 -07001314 if (isolation_level == NULL) {
1315 PyErr_SetString(PyExc_AttributeError, "cannot delete attribute");
1316 return -1;
1317 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001318 if (isolation_level == Py_None) {
Erlend Egeberg Aasland0cb470e2021-07-30 14:01:22 +02001319 /* We might get called during connection init, so we cannot use
1320 * pysqlite_connection_commit() here. */
1321 if (self->db && !sqlite3_get_autocommit(self->db)) {
1322 int rc;
1323 Py_BEGIN_ALLOW_THREADS
1324 rc = sqlite3_exec(self->db, "COMMIT", NULL, NULL, NULL);
1325 Py_END_ALLOW_THREADS
1326 if (rc != SQLITE_OK) {
1327 return _pysqlite_seterror(self->db, NULL);
1328 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001329 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001330
Serhiy Storchaka28914922016-09-01 22:18:03 +03001331 self->begin_statement = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001332 } else {
Serhiy Storchaka28914922016-09-01 22:18:03 +03001333 const char * const *candidate;
1334 PyObject *uppercase_level;
1335 _Py_IDENTIFIER(upper);
Neal Norwitzefee9f52007-10-27 02:50:52 +00001336
Serhiy Storchaka28914922016-09-01 22:18:03 +03001337 if (!PyUnicode_Check(isolation_level)) {
1338 PyErr_Format(PyExc_TypeError,
1339 "isolation_level must be a string or None, not %.100s",
1340 Py_TYPE(isolation_level)->tp_name);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001341 return -1;
1342 }
1343
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001344 uppercase_level = _PyObject_CallMethodIdOneArg(
Serhiy Storchaka28914922016-09-01 22:18:03 +03001345 (PyObject *)&PyUnicode_Type, &PyId_upper,
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001346 isolation_level);
Serhiy Storchaka28914922016-09-01 22:18:03 +03001347 if (!uppercase_level) {
Georg Brandl3dbca812008-07-23 16:10:53 +00001348 return -1;
1349 }
Serhiy Storchaka28914922016-09-01 22:18:03 +03001350 for (candidate = begin_statements; *candidate; candidate++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001351 if (_PyUnicode_EqualToASCIIString(uppercase_level, *candidate + 6))
Serhiy Storchaka28914922016-09-01 22:18:03 +03001352 break;
1353 }
1354 Py_DECREF(uppercase_level);
1355 if (!*candidate) {
1356 PyErr_SetString(PyExc_ValueError,
1357 "invalid value for isolation_level");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001358 return -1;
1359 }
Serhiy Storchaka28914922016-09-01 22:18:03 +03001360 self->begin_statement = *candidate;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001361 }
1362
Serhiy Storchaka28914922016-09-01 22:18:03 +03001363 Py_INCREF(isolation_level);
1364 Py_XSETREF(self->isolation_level, isolation_level);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001365 return 0;
1366}
1367
Erlend Egeberg Aaslandbf838a62021-02-21 01:29:19 +01001368static PyObject *
1369pysqlite_connection_call(pysqlite_Connection *self, PyObject *args,
1370 PyObject *kwargs)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001371{
1372 PyObject* sql;
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001373 pysqlite_Statement* statement;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001374 PyObject* weakref;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001375
Gerhard Häringf9cee222010-03-05 15:20:03 +00001376 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1377 return NULL;
1378 }
1379
Serhiy Storchaka6cca5c82017-06-08 14:41:19 +03001380 if (!_PyArg_NoKeywords(MODULE_NAME ".Connection", kwargs))
Larry Hastings3b12e952015-05-08 07:45:10 -07001381 return NULL;
1382
Victor Stinnerc6a23202019-06-26 03:16:24 +02001383 if (!PyArg_ParseTuple(args, "U", &sql))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001384 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001385
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001386 _pysqlite_drop_unused_statement_references(self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001387
Erlend Egeberg Aasland84d80f52021-06-03 18:38:09 +02001388 statement = pysqlite_statement_create(self, sql);
1389 if (statement == NULL) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001390 return NULL;
1391 }
1392
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001393 weakref = PyWeakref_NewRef((PyObject*)statement, NULL);
1394 if (weakref == NULL)
1395 goto error;
1396 if (PyList_Append(self->statements, weakref) != 0) {
1397 Py_DECREF(weakref);
1398 goto error;
1399 }
1400 Py_DECREF(weakref);
1401
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001402 return (PyObject*)statement;
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001403
1404error:
1405 Py_DECREF(statement);
1406 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001407}
1408
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001409/*[clinic input]
1410_sqlite3.Connection.execute as pysqlite_connection_execute
1411
1412 sql: unicode
1413 parameters: object = NULL
1414 /
1415
1416Executes a SQL statement. Non-standard.
1417[clinic start generated code]*/
1418
1419static PyObject *
1420pysqlite_connection_execute_impl(pysqlite_Connection *self, PyObject *sql,
1421 PyObject *parameters)
1422/*[clinic end generated code: output=5be05ae01ee17ee4 input=fbd17c75c7140271]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001423{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001424 _Py_IDENTIFIER(execute);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001425 PyObject* cursor = 0;
1426 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001427
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001428 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001429 if (!cursor) {
1430 goto error;
1431 }
1432
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001433 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_execute, sql, parameters, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001434 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001435 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001436 }
1437
1438error:
1439 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001440
1441 return cursor;
1442}
1443
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001444/*[clinic input]
1445_sqlite3.Connection.executemany as pysqlite_connection_executemany
1446
1447 sql: unicode
1448 parameters: object
1449 /
1450
1451Repeatedly executes a SQL statement. Non-standard.
1452[clinic start generated code]*/
1453
1454static PyObject *
1455pysqlite_connection_executemany_impl(pysqlite_Connection *self,
1456 PyObject *sql, PyObject *parameters)
1457/*[clinic end generated code: output=776cd2fd20bfe71f input=4feab80659ffc82b]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001458{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001459 _Py_IDENTIFIER(executemany);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001460 PyObject* cursor = 0;
1461 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001462
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001463 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001464 if (!cursor) {
1465 goto error;
1466 }
1467
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001468 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_executemany, sql,
1469 parameters, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001470 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001471 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001472 }
1473
1474error:
1475 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001476
1477 return cursor;
1478}
1479
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001480/*[clinic input]
1481_sqlite3.Connection.executescript as pysqlite_connection_executescript
1482
1483 sql_script as script_obj: object
1484 /
1485
Erlend Egeberg Aasland02e4c0c2021-07-15 01:02:01 +02001486Executes multiple SQL statements at once. Non-standard.
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001487[clinic start generated code]*/
1488
1489static PyObject *
1490pysqlite_connection_executescript(pysqlite_Connection *self,
1491 PyObject *script_obj)
Erlend Egeberg Aasland02e4c0c2021-07-15 01:02:01 +02001492/*[clinic end generated code: output=4c4f9d77aa0ae37d input=b27ae5c24ffb8b43]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001493{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001494 _Py_IDENTIFIER(executescript);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001495 PyObject* cursor = 0;
1496 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001497
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001498 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001499 if (!cursor) {
1500 goto error;
1501 }
1502
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001503 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_executescript,
1504 script_obj, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001505 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001506 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001507 }
1508
1509error:
1510 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001511
1512 return cursor;
1513}
1514
1515/* ------------------------- COLLATION CODE ------------------------ */
1516
1517static int
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001518pysqlite_collation_callback(
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001519 void* context,
1520 int text1_length, const void* text1_data,
1521 int text2_length, const void* text2_data)
1522{
1523 PyObject* callback = (PyObject*)context;
1524 PyObject* string1 = 0;
1525 PyObject* string2 = 0;
1526 PyGILState_STATE gilstate;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001527 PyObject* retval = NULL;
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001528 long longval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001529 int result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001530 gilstate = PyGILState_Ensure();
1531
1532 if (PyErr_Occurred()) {
1533 goto finally;
1534 }
1535
Guido van Rossum98297ee2007-11-06 21:34:58 +00001536 string1 = PyUnicode_FromStringAndSize((const char*)text1_data, text1_length);
1537 string2 = PyUnicode_FromStringAndSize((const char*)text2_data, text2_length);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001538
1539 if (!string1 || !string2) {
1540 goto finally; /* failed to allocate strings */
1541 }
1542
1543 retval = PyObject_CallFunctionObjArgs(callback, string1, string2, NULL);
1544
1545 if (!retval) {
1546 /* execution failed */
1547 goto finally;
1548 }
1549
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001550 longval = PyLong_AsLongAndOverflow(retval, &result);
1551 if (longval == -1 && PyErr_Occurred()) {
1552 PyErr_Clear();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001553 result = 0;
1554 }
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001555 else if (!result) {
1556 if (longval > 0)
1557 result = 1;
1558 else if (longval < 0)
1559 result = -1;
1560 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001561
1562finally:
1563 Py_XDECREF(string1);
1564 Py_XDECREF(string2);
1565 Py_XDECREF(retval);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001566 PyGILState_Release(gilstate);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001567 return result;
1568}
1569
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001570/*[clinic input]
1571_sqlite3.Connection.interrupt as pysqlite_connection_interrupt
1572
1573Abort any pending database operation. Non-standard.
1574[clinic start generated code]*/
1575
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001576static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001577pysqlite_connection_interrupt_impl(pysqlite_Connection *self)
1578/*[clinic end generated code: output=f193204bc9e70b47 input=4bd0ad083cf93aa7]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001579{
1580 PyObject* retval = NULL;
1581
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001582 if (!pysqlite_check_connection(self)) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001583 goto finally;
1584 }
1585
1586 sqlite3_interrupt(self->db);
1587
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001588 retval = Py_NewRef(Py_None);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001589
1590finally:
1591 return retval;
1592}
1593
Christian Heimesbbe741d2008-03-28 10:53:29 +00001594/* Function author: Paul Kippes <kippesp@gmail.com>
1595 * Class method of Connection to call the Python function _iterdump
1596 * of the sqlite3 module.
1597 */
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001598/*[clinic input]
1599_sqlite3.Connection.iterdump as pysqlite_connection_iterdump
1600
1601Returns iterator to the dump of the database in an SQL text format.
1602
1603Non-standard.
1604[clinic start generated code]*/
1605
Christian Heimesbbe741d2008-03-28 10:53:29 +00001606static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001607pysqlite_connection_iterdump_impl(pysqlite_Connection *self)
1608/*[clinic end generated code: output=586997aaf9808768 input=53bc907cb5eedb85]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001609{
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001610 _Py_IDENTIFIER(_iterdump);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001611 PyObject* retval = NULL;
1612 PyObject* module = NULL;
1613 PyObject* module_dict;
1614 PyObject* pyfn_iterdump;
1615
1616 if (!pysqlite_check_connection(self)) {
1617 goto finally;
1618 }
1619
1620 module = PyImport_ImportModule(MODULE_NAME ".dump");
1621 if (!module) {
1622 goto finally;
1623 }
1624
1625 module_dict = PyModule_GetDict(module);
1626 if (!module_dict) {
1627 goto finally;
1628 }
1629
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001630 pyfn_iterdump = _PyDict_GetItemIdWithError(module_dict, &PyId__iterdump);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001631 if (!pyfn_iterdump) {
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001632 if (!PyErr_Occurred()) {
1633 PyErr_SetString(pysqlite_OperationalError,
1634 "Failed to obtain _iterdump() reference");
1635 }
Christian Heimesbbe741d2008-03-28 10:53:29 +00001636 goto finally;
1637 }
1638
Petr Viktorinffd97532020-02-11 17:46:57 +01001639 retval = PyObject_CallOneArg(pyfn_iterdump, (PyObject *)self);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001640
1641finally:
Christian Heimesbbe741d2008-03-28 10:53:29 +00001642 Py_XDECREF(module);
1643 return retval;
1644}
1645
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001646/*[clinic input]
1647_sqlite3.Connection.backup as pysqlite_connection_backup
1648
Erlend Egeberg Aaslandea465792021-02-11 00:04:02 +01001649 target: object(type='pysqlite_Connection *', subclass_of='pysqlite_ConnectionType')
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001650 *
1651 pages: int = -1
1652 progress: object = None
1653 name: str = "main"
1654 sleep: double = 0.250
1655
1656Makes a backup of the database. Non-standard.
1657[clinic start generated code]*/
1658
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001659static PyObject *
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001660pysqlite_connection_backup_impl(pysqlite_Connection *self,
1661 pysqlite_Connection *target, int pages,
1662 PyObject *progress, const char *name,
1663 double sleep)
Erlend Egeberg Aaslandea465792021-02-11 00:04:02 +01001664/*[clinic end generated code: output=306a3e6a38c36334 input=30ae45fc420bfd3b]*/
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001665{
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001666 int rc;
Pablo Galindoa6d63a22020-12-29 00:28:09 +00001667 int sleep_ms = (int)(sleep * 1000.0);
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001668 sqlite3 *bck_conn;
1669 sqlite3_backup *bck_handle;
Victor Stinnerca405012018-04-30 12:22:17 +02001670
Peter McCormickbfee9fa2020-09-19 23:40:46 -04001671 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1672 return NULL;
1673 }
1674
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001675 if (!pysqlite_check_connection(target)) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001676 return NULL;
1677 }
1678
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001679 if (target == self) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001680 PyErr_SetString(PyExc_ValueError, "target cannot be the same connection instance");
1681 return NULL;
1682 }
1683
Aviv Palivodabbf7bb72018-03-18 02:48:55 +02001684#if SQLITE_VERSION_NUMBER < 3008008
1685 /* Since 3.8.8 this is already done, per commit
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001686 https://www.sqlite.org/src/info/169b5505498c0a7e */
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001687 if (!sqlite3_get_autocommit(target->db)) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001688 PyErr_SetString(pysqlite_OperationalError, "target is in transaction");
1689 return NULL;
1690 }
1691#endif
1692
1693 if (progress != Py_None && !PyCallable_Check(progress)) {
1694 PyErr_SetString(PyExc_TypeError, "progress argument must be a callable");
1695 return NULL;
1696 }
1697
1698 if (pages == 0) {
1699 pages = -1;
1700 }
1701
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001702 bck_conn = target->db;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001703
1704 Py_BEGIN_ALLOW_THREADS
1705 bck_handle = sqlite3_backup_init(bck_conn, "main", self->db, name);
1706 Py_END_ALLOW_THREADS
1707
Erlend Egeberg Aaslandc1ae7412021-04-14 13:45:49 +02001708 if (bck_handle == NULL) {
1709 _pysqlite_seterror(bck_conn, NULL);
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001710 return NULL;
1711 }
Erlend Egeberg Aaslandc1ae7412021-04-14 13:45:49 +02001712
1713 do {
1714 Py_BEGIN_ALLOW_THREADS
1715 rc = sqlite3_backup_step(bck_handle, pages);
1716 Py_END_ALLOW_THREADS
1717
1718 if (progress != Py_None) {
1719 int remaining = sqlite3_backup_remaining(bck_handle);
1720 int pagecount = sqlite3_backup_pagecount(bck_handle);
1721 PyObject *res = PyObject_CallFunction(progress, "iii", rc,
1722 remaining, pagecount);
1723 if (res == NULL) {
1724 /* Callback failed: abort backup and bail. */
1725 Py_BEGIN_ALLOW_THREADS
1726 sqlite3_backup_finish(bck_handle);
1727 Py_END_ALLOW_THREADS
1728 return NULL;
1729 }
1730 Py_DECREF(res);
1731 }
1732
1733 /* Sleep for a while if there are still further pages to copy and
1734 the engine could not make any progress */
1735 if (rc == SQLITE_BUSY || rc == SQLITE_LOCKED) {
1736 Py_BEGIN_ALLOW_THREADS
1737 sqlite3_sleep(sleep_ms);
1738 Py_END_ALLOW_THREADS
1739 }
1740 } while (rc == SQLITE_OK || rc == SQLITE_BUSY || rc == SQLITE_LOCKED);
1741
1742 Py_BEGIN_ALLOW_THREADS
1743 rc = sqlite3_backup_finish(bck_handle);
1744 Py_END_ALLOW_THREADS
1745
1746 if (rc != SQLITE_OK) {
1747 _pysqlite_seterror(bck_conn, NULL);
1748 return NULL;
1749 }
1750
1751 Py_RETURN_NONE;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001752}
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001753
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001754/*[clinic input]
1755_sqlite3.Connection.create_collation as pysqlite_connection_create_collation
1756
1757 name: unicode
1758 callback as callable: object
1759 /
1760
1761Creates a collation function. Non-standard.
1762[clinic start generated code]*/
1763
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001764static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001765pysqlite_connection_create_collation_impl(pysqlite_Connection *self,
1766 PyObject *name, PyObject *callable)
1767/*[clinic end generated code: output=0f63b8995565ae22 input=5c3898813a776cf2]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001768{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001769 PyObject* uppercase_name = 0;
Victor Stinner35466c52010-04-22 11:23:23 +00001770 Py_ssize_t i, len;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001771 _Py_IDENTIFIER(upper);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001772 const char *uppercase_name_str;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001773 int rc;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001774 unsigned int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +03001775 const void *data;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001776
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001777 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001778 goto finally;
1779 }
1780
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001781 uppercase_name = _PyObject_CallMethodIdOneArg((PyObject *)&PyUnicode_Type,
1782 &PyId_upper, name);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001783 if (!uppercase_name) {
1784 goto finally;
1785 }
1786
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001787 if (PyUnicode_READY(uppercase_name))
1788 goto finally;
1789 len = PyUnicode_GET_LENGTH(uppercase_name);
1790 kind = PyUnicode_KIND(uppercase_name);
1791 data = PyUnicode_DATA(uppercase_name);
1792 for (i=0; i<len; i++) {
1793 Py_UCS4 ch = PyUnicode_READ(kind, data, i);
1794 if ((ch >= '0' && ch <= '9')
1795 || (ch >= 'A' && ch <= 'Z')
1796 || (ch == '_'))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001797 {
Victor Stinner35466c52010-04-22 11:23:23 +00001798 continue;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001799 } else {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001800 PyErr_SetString(pysqlite_ProgrammingError, "invalid character in collation name");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001801 goto finally;
1802 }
1803 }
1804
Serhiy Storchaka06515832016-11-20 09:13:07 +02001805 uppercase_name_str = PyUnicode_AsUTF8(uppercase_name);
Victor Stinner35466c52010-04-22 11:23:23 +00001806 if (!uppercase_name_str)
1807 goto finally;
1808
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001809 if (callable != Py_None && !PyCallable_Check(callable)) {
1810 PyErr_SetString(PyExc_TypeError, "parameter must be callable");
1811 goto finally;
1812 }
1813
1814 if (callable != Py_None) {
Gerhard Häringf9cee222010-03-05 15:20:03 +00001815 if (PyDict_SetItem(self->collations, uppercase_name, callable) == -1)
1816 goto finally;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001817 } else {
Gerhard Häringf9cee222010-03-05 15:20:03 +00001818 if (PyDict_DelItem(self->collations, uppercase_name) == -1)
1819 goto finally;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001820 }
1821
1822 rc = sqlite3_create_collation(self->db,
Victor Stinner35466c52010-04-22 11:23:23 +00001823 uppercase_name_str,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001824 SQLITE_UTF8,
1825 (callable != Py_None) ? callable : NULL,
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001826 (callable != Py_None) ? pysqlite_collation_callback : NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001827 if (rc != SQLITE_OK) {
Serhiy Storchaka90731802021-01-31 17:42:38 +02001828 if (callable != Py_None) {
1829 if (PyDict_DelItem(self->collations, uppercase_name) < 0) {
1830 PyErr_Clear();
1831 }
1832 }
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001833 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001834 goto finally;
1835 }
1836
1837finally:
1838 Py_XDECREF(uppercase_name);
1839
1840 if (PyErr_Occurred()) {
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001841 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001842 }
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001843 return Py_NewRef(Py_None);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001844}
1845
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001846/*[clinic input]
1847_sqlite3.Connection.__enter__ as pysqlite_connection_enter
1848
1849Called when the connection is used as a context manager.
1850
1851Returns itself as a convenience to the caller.
1852[clinic start generated code]*/
1853
Christian Heimesbbe741d2008-03-28 10:53:29 +00001854static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001855pysqlite_connection_enter_impl(pysqlite_Connection *self)
1856/*[clinic end generated code: output=457b09726d3e9dcd input=127d7a4f17e86d8f]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001857{
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001858 return Py_NewRef((PyObject *)self);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001859}
1860
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001861/*[clinic input]
1862_sqlite3.Connection.__exit__ as pysqlite_connection_exit
1863
1864 type as exc_type: object
1865 value as exc_value: object
1866 traceback as exc_tb: object
1867 /
1868
1869Called when the connection is used as a context manager.
1870
1871If there was any exception, a rollback takes place; otherwise we commit.
1872[clinic start generated code]*/
1873
Christian Heimesbbe741d2008-03-28 10:53:29 +00001874static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001875pysqlite_connection_exit_impl(pysqlite_Connection *self, PyObject *exc_type,
1876 PyObject *exc_value, PyObject *exc_tb)
1877/*[clinic end generated code: output=0705200e9321202a input=bd66f1532c9c54a7]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001878{
Erlend Egeberg Aasland2a808932021-08-28 20:26:00 +02001879 int commit = 0;
Christian Heimesbbe741d2008-03-28 10:53:29 +00001880 PyObject* result;
1881
Christian Heimesbbe741d2008-03-28 10:53:29 +00001882 if (exc_type == Py_None && exc_value == Py_None && exc_tb == Py_None) {
Erlend Egeberg Aasland2a808932021-08-28 20:26:00 +02001883 commit = 1;
1884 result = pysqlite_connection_commit_impl(self);
1885 }
1886 else {
1887 result = pysqlite_connection_rollback_impl(self);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001888 }
1889
Erlend Egeberg Aasland2a808932021-08-28 20:26:00 +02001890 if (result == NULL) {
1891 if (commit) {
1892 /* Commit failed; try to rollback in order to unlock the database.
1893 * If rollback also fails, chain the exceptions. */
1894 PyObject *exc, *val, *tb;
1895 PyErr_Fetch(&exc, &val, &tb);
1896 result = pysqlite_connection_rollback_impl(self);
1897 if (result == NULL) {
1898 _PyErr_ChainExceptions(exc, val, tb);
1899 }
1900 else {
1901 Py_DECREF(result);
1902 PyErr_Restore(exc, val, tb);
1903 }
1904 }
Christian Heimesbbe741d2008-03-28 10:53:29 +00001905 return NULL;
1906 }
1907 Py_DECREF(result);
1908
1909 Py_RETURN_FALSE;
1910}
1911
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02001912static const char connection_doc[] =
Thomas Wouters477c8d52006-05-27 19:21:47 +00001913PyDoc_STR("SQLite database connection object.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001914
1915static PyGetSetDef connection_getset[] = {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001916 {"isolation_level", (getter)pysqlite_connection_get_isolation_level, (setter)pysqlite_connection_set_isolation_level},
1917 {"total_changes", (getter)pysqlite_connection_get_total_changes, (setter)0},
Berker Peksag59da4b32016-09-12 07:16:43 +03001918 {"in_transaction", (getter)pysqlite_connection_get_in_transaction, (setter)0},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001919 {NULL}
1920};
1921
1922static PyMethodDef connection_methods[] = {
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001923 PYSQLITE_CONNECTION_BACKUP_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001924 PYSQLITE_CONNECTION_CLOSE_METHODDEF
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001925 PYSQLITE_CONNECTION_COMMIT_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001926 PYSQLITE_CONNECTION_CREATE_AGGREGATE_METHODDEF
1927 PYSQLITE_CONNECTION_CREATE_COLLATION_METHODDEF
1928 PYSQLITE_CONNECTION_CREATE_FUNCTION_METHODDEF
1929 PYSQLITE_CONNECTION_CURSOR_METHODDEF
1930 PYSQLITE_CONNECTION_ENABLE_LOAD_EXTENSION_METHODDEF
1931 PYSQLITE_CONNECTION_ENTER_METHODDEF
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001932 PYSQLITE_CONNECTION_EXECUTEMANY_METHODDEF
1933 PYSQLITE_CONNECTION_EXECUTESCRIPT_METHODDEF
1934 PYSQLITE_CONNECTION_EXECUTE_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001935 PYSQLITE_CONNECTION_EXIT_METHODDEF
1936 PYSQLITE_CONNECTION_INTERRUPT_METHODDEF
1937 PYSQLITE_CONNECTION_ITERDUMP_METHODDEF
1938 PYSQLITE_CONNECTION_LOAD_EXTENSION_METHODDEF
1939 PYSQLITE_CONNECTION_ROLLBACK_METHODDEF
1940 PYSQLITE_CONNECTION_SET_AUTHORIZER_METHODDEF
1941 PYSQLITE_CONNECTION_SET_PROGRESS_HANDLER_METHODDEF
1942 PYSQLITE_CONNECTION_SET_TRACE_CALLBACK_METHODDEF
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001943 {NULL, NULL}
1944};
1945
1946static struct PyMemberDef connection_members[] =
1947{
Guido van Rossum10f07c42007-08-11 15:32:55 +00001948 {"Warning", T_OBJECT, offsetof(pysqlite_Connection, Warning), READONLY},
1949 {"Error", T_OBJECT, offsetof(pysqlite_Connection, Error), READONLY},
1950 {"InterfaceError", T_OBJECT, offsetof(pysqlite_Connection, InterfaceError), READONLY},
1951 {"DatabaseError", T_OBJECT, offsetof(pysqlite_Connection, DatabaseError), READONLY},
1952 {"DataError", T_OBJECT, offsetof(pysqlite_Connection, DataError), READONLY},
1953 {"OperationalError", T_OBJECT, offsetof(pysqlite_Connection, OperationalError), READONLY},
1954 {"IntegrityError", T_OBJECT, offsetof(pysqlite_Connection, IntegrityError), READONLY},
1955 {"InternalError", T_OBJECT, offsetof(pysqlite_Connection, InternalError), READONLY},
1956 {"ProgrammingError", T_OBJECT, offsetof(pysqlite_Connection, ProgrammingError), READONLY},
1957 {"NotSupportedError", T_OBJECT, offsetof(pysqlite_Connection, NotSupportedError), READONLY},
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001958 {"row_factory", T_OBJECT, offsetof(pysqlite_Connection, row_factory)},
1959 {"text_factory", T_OBJECT, offsetof(pysqlite_Connection, text_factory)},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001960 {NULL}
1961};
1962
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001963static PyType_Slot connection_slots[] = {
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -07001964 {Py_tp_dealloc, connection_dealloc},
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001965 {Py_tp_doc, (void *)connection_doc},
1966 {Py_tp_methods, connection_methods},
1967 {Py_tp_members, connection_members},
1968 {Py_tp_getset, connection_getset},
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001969 {Py_tp_init, pysqlite_connection_init},
1970 {Py_tp_call, pysqlite_connection_call},
Miss Islington (bot)e8d9df02021-05-25 11:08:39 -07001971 {Py_tp_traverse, connection_traverse},
1972 {Py_tp_clear, connection_clear},
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001973 {0, NULL},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001974};
1975
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001976static PyType_Spec connection_spec = {
1977 .name = MODULE_NAME ".Connection",
1978 .basicsize = sizeof(pysqlite_Connection),
Miss Islington (bot)7297d742021-06-17 03:19:44 -07001979 .flags = (Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
1980 Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_IMMUTABLETYPE),
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001981 .slots = connection_slots,
1982};
1983
1984PyTypeObject *pysqlite_ConnectionType = NULL;
1985
Erlend Egeberg Aasland38b6c2a2021-02-21 11:07:49 +01001986int
1987pysqlite_connection_setup_types(PyObject *module)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001988{
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001989 pysqlite_ConnectionType = (PyTypeObject *)PyType_FromModuleAndSpec(module, &connection_spec, NULL);
1990 if (pysqlite_ConnectionType == NULL) {
1991 return -1;
1992 }
1993 return 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001994}