blob: 46717acf7c7d97fa6e17aedb1453b4c8264d0ec6 [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();
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +0100578 cur_py_value = Py_NewRef(Py_None);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000579 }
580 break;
581 case SQLITE_BLOB:
582 buflen = sqlite3_value_bytes(cur_value);
Christian Heimes72b710a2008-05-26 13:28:38 +0000583 cur_py_value = PyBytes_FromStringAndSize(
Guido van Rossumbae07c92007-10-08 02:46:15 +0000584 sqlite3_value_blob(cur_value), buflen);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000585 break;
586 case SQLITE_NULL:
587 default:
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +0100588 cur_py_value = Py_NewRef(Py_None);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000589 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000590
591 if (!cur_py_value) {
592 Py_DECREF(args);
593 return NULL;
594 }
595
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000596 PyTuple_SetItem(args, i, cur_py_value);
597
598 }
599
600 return args;
601}
602
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000603void _pysqlite_func_callback(sqlite3_context* context, int argc, sqlite3_value** argv)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000604{
605 PyObject* args;
606 PyObject* py_func;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000607 PyObject* py_retval = NULL;
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200608 int ok;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000609
610 PyGILState_STATE threadstate;
611
612 threadstate = PyGILState_Ensure();
613
614 py_func = (PyObject*)sqlite3_user_data(context);
615
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000616 args = _pysqlite_build_py_params(context, argc, argv);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000617 if (args) {
618 py_retval = PyObject_CallObject(py_func, args);
619 Py_DECREF(args);
620 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000621
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200622 ok = 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000623 if (py_retval) {
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200624 ok = _pysqlite_set_result(context, py_retval) == 0;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000625 Py_DECREF(py_retval);
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200626 }
627 if (!ok) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700628 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000629 PyErr_Print();
630 } else {
631 PyErr_Clear();
632 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200633 sqlite3_result_error(context, "user-defined function raised exception", -1);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000634 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000635
636 PyGILState_Release(threadstate);
637}
638
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000639static void _pysqlite_step_callback(sqlite3_context *context, int argc, sqlite3_value** params)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000640{
641 PyObject* args;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000642 PyObject* function_result = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000643 PyObject* aggregate_class;
644 PyObject** aggregate_instance;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000645 PyObject* stepmethod = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000646
647 PyGILState_STATE threadstate;
648
649 threadstate = PyGILState_Ensure();
650
651 aggregate_class = (PyObject*)sqlite3_user_data(context);
652
653 aggregate_instance = (PyObject**)sqlite3_aggregate_context(context, sizeof(PyObject*));
654
Serhiy Storchaka0b3ec192017-03-23 17:53:47 +0200655 if (*aggregate_instance == NULL) {
Victor Stinner070c4d72016-12-09 12:29:18 +0100656 *aggregate_instance = _PyObject_CallNoArg(aggregate_class);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000657
Thomas Wouters477c8d52006-05-27 19:21:47 +0000658 if (PyErr_Occurred()) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000659 *aggregate_instance = 0;
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700660 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000661 PyErr_Print();
662 } else {
663 PyErr_Clear();
664 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200665 sqlite3_result_error(context, "user-defined aggregate's '__init__' method raised error", -1);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000666 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000667 }
668 }
669
670 stepmethod = PyObject_GetAttrString(*aggregate_instance, "step");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000671 if (!stepmethod) {
672 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000673 }
674
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000675 args = _pysqlite_build_py_params(context, argc, params);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000676 if (!args) {
677 goto error;
678 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000679
680 function_result = PyObject_CallObject(stepmethod, args);
681 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000682
Thomas Wouters477c8d52006-05-27 19:21:47 +0000683 if (!function_result) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700684 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000685 PyErr_Print();
686 } else {
687 PyErr_Clear();
688 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200689 sqlite3_result_error(context, "user-defined aggregate's 'step' method raised error", -1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000690 }
691
Thomas Wouters477c8d52006-05-27 19:21:47 +0000692error:
693 Py_XDECREF(stepmethod);
694 Py_XDECREF(function_result);
695
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000696 PyGILState_Release(threadstate);
697}
698
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000699void _pysqlite_final_callback(sqlite3_context* context)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000700{
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200701 PyObject* function_result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000702 PyObject** aggregate_instance;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200703 _Py_IDENTIFIER(finalize);
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200704 int ok;
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200705 PyObject *exception, *value, *tb;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000706
707 PyGILState_STATE threadstate;
708
709 threadstate = PyGILState_Ensure();
710
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000711 aggregate_instance = (PyObject**)sqlite3_aggregate_context(context, sizeof(PyObject*));
712 if (!*aggregate_instance) {
713 /* this branch is executed if there was an exception in the aggregate's
714 * __init__ */
715
Thomas Wouters477c8d52006-05-27 19:21:47 +0000716 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000717 }
718
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200719 /* Keep the exception (if any) of the last call to step() */
720 PyErr_Fetch(&exception, &value, &tb);
721
Jeroen Demeyer762f93f2019-07-08 10:19:25 +0200722 function_result = _PyObject_CallMethodIdNoArgs(*aggregate_instance, &PyId_finalize);
Victor Stinnere9af4cf2013-07-18 01:42:04 +0200723
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +0200724 Py_DECREF(*aggregate_instance);
725
726 ok = 0;
727 if (function_result) {
728 ok = _pysqlite_set_result(context, function_result) == 0;
729 Py_DECREF(function_result);
730 }
731 if (!ok) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700732 if (_pysqlite_enable_callback_tracebacks) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000733 PyErr_Print();
734 } else {
735 PyErr_Clear();
736 }
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200737 sqlite3_result_error(context, "user-defined aggregate's 'finalize' method raised error", -1);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000738 }
739
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200740 /* Restore the exception (if any) of the last call to step(),
741 but clear also the current exception if finalize() failed */
742 PyErr_Restore(exception, value, tb);
Victor Stinner3a857322013-07-22 08:34:32 +0200743
Thomas Wouters477c8d52006-05-27 19:21:47 +0000744error:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000745 PyGILState_Release(threadstate);
746}
747
Gerhard Häringf9cee222010-03-05 15:20:03 +0000748static void _pysqlite_drop_unused_statement_references(pysqlite_Connection* self)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000749{
750 PyObject* new_list;
751 PyObject* weakref;
752 int i;
753
754 /* we only need to do this once in a while */
755 if (self->created_statements++ < 200) {
756 return;
757 }
758
759 self->created_statements = 0;
760
761 new_list = PyList_New(0);
762 if (!new_list) {
763 return;
764 }
765
766 for (i = 0; i < PyList_Size(self->statements); i++) {
767 weakref = PyList_GetItem(self->statements, i);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000768 if (PyWeakref_GetObject(weakref) != Py_None) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000769 if (PyList_Append(new_list, weakref) != 0) {
770 Py_DECREF(new_list);
771 return;
772 }
773 }
774 }
775
Serhiy Storchaka57a01d32016-04-10 18:05:40 +0300776 Py_SETREF(self->statements, new_list);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000777}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000778
Gerhard Häringf9cee222010-03-05 15:20:03 +0000779static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self)
780{
781 PyObject* new_list;
782 PyObject* weakref;
783 int i;
784
785 /* we only need to do this once in a while */
786 if (self->created_cursors++ < 200) {
787 return;
788 }
789
790 self->created_cursors = 0;
791
792 new_list = PyList_New(0);
793 if (!new_list) {
794 return;
795 }
796
797 for (i = 0; i < PyList_Size(self->cursors); i++) {
798 weakref = PyList_GetItem(self->cursors, i);
799 if (PyWeakref_GetObject(weakref) != Py_None) {
800 if (PyList_Append(new_list, weakref) != 0) {
801 Py_DECREF(new_list);
802 return;
803 }
804 }
805 }
806
Serhiy Storchaka57a01d32016-04-10 18:05:40 +0300807 Py_SETREF(self->cursors, new_list);
Gerhard Häringf9cee222010-03-05 15:20:03 +0000808}
809
gescheitb9a03762019-07-13 06:15:49 +0300810static void _destructor(void* args)
811{
812 Py_DECREF((PyObject*)args);
813}
814
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100815/*[clinic input]
816_sqlite3.Connection.create_function as pysqlite_connection_create_function
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000817
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100818 name: str
819 narg: int
820 func: object
821 *
822 deterministic: bool = False
823
824Creates a new function. Non-standard.
825[clinic start generated code]*/
826
827static PyObject *
828pysqlite_connection_create_function_impl(pysqlite_Connection *self,
829 const char *name, int narg,
830 PyObject *func, int deterministic)
831/*[clinic end generated code: output=07d1877dd98c0308 input=f2edcf073e815beb]*/
832{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000833 int rc;
Sergey Fedoseev08308582018-07-08 12:09:20 +0500834 int flags = SQLITE_UTF8;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000835
Gerhard Häringf9cee222010-03-05 15:20:03 +0000836 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
837 return NULL;
838 }
839
Sergey Fedoseev08308582018-07-08 12:09:20 +0500840 if (deterministic) {
841#if SQLITE_VERSION_NUMBER < 3008003
842 PyErr_SetString(pysqlite_NotSupportedError,
843 "deterministic=True requires SQLite 3.8.3 or higher");
844 return NULL;
845#else
846 if (sqlite3_libversion_number() < 3008003) {
847 PyErr_SetString(pysqlite_NotSupportedError,
848 "deterministic=True requires SQLite 3.8.3 or higher");
849 return NULL;
850 }
851 flags |= SQLITE_DETERMINISTIC;
852#endif
853 }
gescheitb9a03762019-07-13 06:15:49 +0300854 rc = sqlite3_create_function_v2(self->db,
855 name,
856 narg,
857 flags,
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +0100858 (void*)Py_NewRef(func),
gescheitb9a03762019-07-13 06:15:49 +0300859 _pysqlite_func_callback,
860 NULL,
861 NULL,
862 &_destructor); // will decref func
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000863
Thomas Wouters477c8d52006-05-27 19:21:47 +0000864 if (rc != SQLITE_OK) {
865 /* Workaround for SQLite bug: no error code or string is available here */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000866 PyErr_SetString(pysqlite_OperationalError, "Error creating function");
Thomas Wouters477c8d52006-05-27 19:21:47 +0000867 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000868 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +0500869 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000870}
871
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100872/*[clinic input]
873_sqlite3.Connection.create_aggregate as pysqlite_connection_create_aggregate
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000874
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +0100875 name: str
876 n_arg: int
877 aggregate_class: object
878
879Creates a new aggregate. Non-standard.
880[clinic start generated code]*/
881
882static PyObject *
883pysqlite_connection_create_aggregate_impl(pysqlite_Connection *self,
884 const char *name, int n_arg,
885 PyObject *aggregate_class)
886/*[clinic end generated code: output=fbb2f858cfa4d8db input=c2e13bbf234500a5]*/
887{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000888 int rc;
889
Gerhard Häringf9cee222010-03-05 15:20:03 +0000890 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
891 return NULL;
892 }
893
gescheitb9a03762019-07-13 06:15:49 +0300894 Py_INCREF(aggregate_class);
895 rc = sqlite3_create_function_v2(self->db,
896 name,
897 n_arg,
898 SQLITE_UTF8,
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +0100899 (void*)Py_NewRef(aggregate_class),
gescheitb9a03762019-07-13 06:15:49 +0300900 0,
901 &_pysqlite_step_callback,
902 &_pysqlite_final_callback,
903 &_destructor); // will decref func
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000904 if (rc != SQLITE_OK) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000905 /* Workaround for SQLite bug: no error code or string is available here */
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000906 PyErr_SetString(pysqlite_OperationalError, "Error creating aggregate");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000907 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000908 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +0500909 Py_RETURN_NONE;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000910}
911
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000912static 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 +0000913{
914 PyObject *ret;
915 int rc;
916 PyGILState_STATE gilstate;
917
918 gilstate = PyGILState_Ensure();
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000919
Victor Stinnerd4095d92013-07-26 22:23:33 +0200920 ret = PyObject_CallFunction((PyObject*)user_arg, "issss", action, arg1, arg2, dbname, access_attempt_source);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000921
Victor Stinnerd4095d92013-07-26 22:23:33 +0200922 if (ret == NULL) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700923 if (_pysqlite_enable_callback_tracebacks)
Victor Stinnerd4095d92013-07-26 22:23:33 +0200924 PyErr_Print();
925 else
926 PyErr_Clear();
Victor Stinner41801f52013-07-21 13:05:38 +0200927
Victor Stinnerd4095d92013-07-26 22:23:33 +0200928 rc = SQLITE_DENY;
Victor Stinner41801f52013-07-21 13:05:38 +0200929 }
930 else {
Victor Stinnerd4095d92013-07-26 22:23:33 +0200931 if (PyLong_Check(ret)) {
932 rc = _PyLong_AsInt(ret);
933 if (rc == -1 && PyErr_Occurred()) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700934 if (_pysqlite_enable_callback_tracebacks)
Victor Stinnerd4095d92013-07-26 22:23:33 +0200935 PyErr_Print();
936 else
937 PyErr_Clear();
938 rc = SQLITE_DENY;
939 }
940 }
941 else {
942 rc = SQLITE_DENY;
943 }
944 Py_DECREF(ret);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000945 }
946
947 PyGILState_Release(gilstate);
948 return rc;
949}
950
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000951static int _progress_handler(void* user_arg)
952{
953 int rc;
954 PyObject *ret;
955 PyGILState_STATE gilstate;
956
957 gilstate = PyGILState_Ensure();
Victor Stinner070c4d72016-12-09 12:29:18 +0100958 ret = _PyObject_CallNoArg((PyObject*)user_arg);
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000959
960 if (!ret) {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -0700961 if (_pysqlite_enable_callback_tracebacks) {
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000962 PyErr_Print();
963 } else {
964 PyErr_Clear();
965 }
966
Mark Dickinson934896d2009-02-21 20:59:32 +0000967 /* abort query if error occurred */
Victor Stinner86999502010-05-19 01:27:23 +0000968 rc = 1;
Gerhard Häringe7ea7452008-03-29 00:45:29 +0000969 } else {
970 rc = (int)PyObject_IsTrue(ret);
971 Py_DECREF(ret);
972 }
973
974 PyGILState_Release(gilstate);
975 return rc;
976}
977
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +0200978#ifdef HAVE_TRACE_V2
979/*
980 * From https://sqlite.org/c3ref/trace_v2.html:
981 * The integer return value from the callback is currently ignored, though this
982 * may change in future releases. Callback implementations should return zero
983 * to ensure future compatibility.
984 */
985static int _trace_callback(unsigned int type, void* user_arg, void* prepared_statement, void* statement_string)
986#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +0200987static void _trace_callback(void* user_arg, const char* statement_string)
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +0200988#endif
Antoine Pitrou5bfa0622011-04-04 00:12:04 +0200989{
990 PyObject *py_statement = NULL;
991 PyObject *ret = NULL;
992
Antoine Pitrou5bfa0622011-04-04 00:12:04 +0200993 PyGILState_STATE gilstate;
994
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +0200995#ifdef HAVE_TRACE_V2
996 if (type != SQLITE_TRACE_STMT) {
997 return 0;
998 }
999#endif
1000
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001001 gilstate = PyGILState_Ensure();
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001002 py_statement = PyUnicode_DecodeUTF8(statement_string,
1003 strlen(statement_string), "replace");
1004 if (py_statement) {
Petr Viktorinffd97532020-02-11 17:46:57 +01001005 ret = PyObject_CallOneArg((PyObject*)user_arg, py_statement);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001006 Py_DECREF(py_statement);
1007 }
1008
1009 if (ret) {
1010 Py_DECREF(ret);
1011 } else {
Benjamin Peterson7762e4d2018-07-09 21:20:23 -07001012 if (_pysqlite_enable_callback_tracebacks) {
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001013 PyErr_Print();
1014 } else {
1015 PyErr_Clear();
1016 }
1017 }
1018
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001019 PyGILState_Release(gilstate);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001020#ifdef HAVE_TRACE_V2
1021 return 0;
1022#endif
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001023}
1024
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001025/*[clinic input]
1026_sqlite3.Connection.set_authorizer as pysqlite_connection_set_authorizer
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001027
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001028 authorizer_callback as authorizer_cb: object
1029
1030Sets authorizer callback. Non-standard.
1031[clinic start generated code]*/
1032
1033static PyObject *
1034pysqlite_connection_set_authorizer_impl(pysqlite_Connection *self,
1035 PyObject *authorizer_cb)
1036/*[clinic end generated code: output=f18ba575d788b35c input=df079724c020d2f2]*/
1037{
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001038 int rc;
1039
Gerhard Häringf9cee222010-03-05 15:20:03 +00001040 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1041 return NULL;
1042 }
1043
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001044 rc = sqlite3_set_authorizer(self->db, _authorizer_callback, (void*)authorizer_cb);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001045 if (rc != SQLITE_OK) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001046 PyErr_SetString(pysqlite_OperationalError, "Error setting authorizer callback");
gescheitb9a03762019-07-13 06:15:49 +03001047 Py_XSETREF(self->function_pinboard_authorizer_cb, NULL);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001048 return NULL;
gescheitb9a03762019-07-13 06:15:49 +03001049 } else {
1050 Py_INCREF(authorizer_cb);
1051 Py_XSETREF(self->function_pinboard_authorizer_cb, authorizer_cb);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001052 }
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +05001053 Py_RETURN_NONE;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001054}
1055
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001056/*[clinic input]
1057_sqlite3.Connection.set_progress_handler as pysqlite_connection_set_progress_handler
1058
1059 progress_handler: object
1060 n: int
1061
1062Sets progress handler callback. Non-standard.
1063[clinic start generated code]*/
1064
1065static PyObject *
1066pysqlite_connection_set_progress_handler_impl(pysqlite_Connection *self,
1067 PyObject *progress_handler,
1068 int n)
1069/*[clinic end generated code: output=35a7c10364cb1b04 input=857696c25f964c64]*/
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001070{
Gerhard Häringf9cee222010-03-05 15:20:03 +00001071 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1072 return NULL;
1073 }
1074
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001075 if (progress_handler == Py_None) {
1076 /* None clears the progress handler previously set */
1077 sqlite3_progress_handler(self->db, 0, 0, (void*)0);
gescheitb9a03762019-07-13 06:15:49 +03001078 Py_XSETREF(self->function_pinboard_progress_handler, NULL);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001079 } else {
Sergey Fedoseev5b25f1d2018-12-05 22:50:26 +05001080 sqlite3_progress_handler(self->db, n, _progress_handler, progress_handler);
gescheitb9a03762019-07-13 06:15:49 +03001081 Py_INCREF(progress_handler);
1082 Py_XSETREF(self->function_pinboard_progress_handler, progress_handler);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001083 }
Berker Peksagfe21de92016-04-09 07:34:39 +03001084 Py_RETURN_NONE;
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001085}
1086
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001087/*[clinic input]
1088_sqlite3.Connection.set_trace_callback as pysqlite_connection_set_trace_callback
1089
1090 trace_callback: object
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001091
1092Sets a trace callback called for each SQL statement (passed as unicode).
1093
1094Non-standard.
1095[clinic start generated code]*/
1096
1097static PyObject *
Dong-hee Na21793492020-12-19 00:41:33 +09001098pysqlite_connection_set_trace_callback_impl(pysqlite_Connection *self,
1099 PyObject *trace_callback)
1100/*[clinic end generated code: output=fb0e307b9924d454 input=56d60fd38d763679]*/
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001101{
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001102 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1103 return NULL;
1104 }
1105
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001106 if (trace_callback == Py_None) {
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001107 /*
1108 * None clears the trace callback previously set
1109 *
1110 * Ref.
1111 * - https://sqlite.org/c3ref/c_trace.html
1112 * - https://sqlite.org/c3ref/trace_v2.html
1113 */
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001114#ifdef HAVE_TRACE_V2
1115 sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, 0, 0);
1116#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001117 sqlite3_trace(self->db, 0, (void*)0);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001118#endif
gescheitb9a03762019-07-13 06:15:49 +03001119 Py_XSETREF(self->function_pinboard_trace_callback, NULL);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001120 } else {
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001121#ifdef HAVE_TRACE_V2
1122 sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, _trace_callback, trace_callback);
1123#else
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001124 sqlite3_trace(self->db, _trace_callback, trace_callback);
Erlend Egeberg Aasland7f331c82020-09-05 22:43:31 +02001125#endif
gescheitb9a03762019-07-13 06:15:49 +03001126 Py_INCREF(trace_callback);
1127 Py_XSETREF(self->function_pinboard_trace_callback, trace_callback);
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001128 }
1129
Berker Peksagfe21de92016-04-09 07:34:39 +03001130 Py_RETURN_NONE;
Antoine Pitrou5bfa0622011-04-04 00:12:04 +02001131}
1132
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +02001133#ifndef SQLITE_OMIT_LOAD_EXTENSION
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001134/*[clinic input]
1135_sqlite3.Connection.enable_load_extension as pysqlite_connection_enable_load_extension
1136
Dong-hee Na21793492020-12-19 00:41:33 +09001137 enable as onoff: bool(accept={int})
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001138 /
1139
1140Enable dynamic loading of SQLite extension modules. Non-standard.
1141[clinic start generated code]*/
1142
1143static PyObject *
1144pysqlite_connection_enable_load_extension_impl(pysqlite_Connection *self,
1145 int onoff)
Dong-hee Na21793492020-12-19 00:41:33 +09001146/*[clinic end generated code: output=9cac37190d388baf input=5c0da5b121121cbc]*/
Gerhard Häringf9cee222010-03-05 15:20:03 +00001147{
1148 int rc;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001149
1150 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1151 return NULL;
1152 }
1153
Gerhard Häringf9cee222010-03-05 15:20:03 +00001154 rc = sqlite3_enable_load_extension(self->db, onoff);
1155
1156 if (rc != SQLITE_OK) {
1157 PyErr_SetString(pysqlite_OperationalError, "Error enabling load extension");
1158 return NULL;
1159 } else {
Berker Peksagfe21de92016-04-09 07:34:39 +03001160 Py_RETURN_NONE;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001161 }
1162}
1163
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001164/*[clinic input]
1165_sqlite3.Connection.load_extension as pysqlite_connection_load_extension
1166
1167 name as extension_name: str
1168 /
1169
1170Load SQLite extension module. Non-standard.
1171[clinic start generated code]*/
1172
1173static PyObject *
1174pysqlite_connection_load_extension_impl(pysqlite_Connection *self,
1175 const char *extension_name)
1176/*[clinic end generated code: output=47eb1d7312bc97a7 input=0b711574560db9fc]*/
Gerhard Häringf9cee222010-03-05 15:20:03 +00001177{
1178 int rc;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001179 char* errmsg;
1180
1181 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1182 return NULL;
1183 }
1184
Gerhard Häringf9cee222010-03-05 15:20:03 +00001185 rc = sqlite3_load_extension(self->db, extension_name, 0, &errmsg);
1186 if (rc != 0) {
1187 PyErr_SetString(pysqlite_OperationalError, errmsg);
1188 return NULL;
1189 } else {
Berker Peksagfe21de92016-04-09 07:34:39 +03001190 Py_RETURN_NONE;
Gerhard Häringf9cee222010-03-05 15:20:03 +00001191 }
1192}
1193#endif
1194
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001195int pysqlite_check_thread(pysqlite_Connection* self)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001196{
1197 if (self->check_same_thread) {
1198 if (PyThread_get_thread_ident() != self->thread_ident) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001199 PyErr_Format(pysqlite_ProgrammingError,
Takuya Akiba030345c2018-03-27 00:14:00 +09001200 "SQLite objects created in a thread can only be used in that same thread. "
1201 "The object was created in thread id %lu and this is thread id %lu.",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001202 self->thread_ident, PyThread_get_thread_ident());
1203 return 0;
1204 }
1205
1206 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001207 return 1;
1208}
1209
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001210static PyObject* pysqlite_connection_get_isolation_level(pysqlite_Connection* self, void* unused)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001211{
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001212 return Py_NewRef(self->isolation_level);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001213}
1214
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001215static PyObject* pysqlite_connection_get_total_changes(pysqlite_Connection* self, void* unused)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001216{
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001217 if (!pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001218 return NULL;
1219 } else {
1220 return Py_BuildValue("i", sqlite3_total_changes(self->db));
1221 }
1222}
1223
Berker Peksag59da4b32016-09-12 07:16:43 +03001224static PyObject* pysqlite_connection_get_in_transaction(pysqlite_Connection* self, void* unused)
1225{
1226 if (!pysqlite_check_connection(self)) {
1227 return NULL;
1228 }
1229 if (!sqlite3_get_autocommit(self->db)) {
1230 Py_RETURN_TRUE;
1231 }
1232 Py_RETURN_FALSE;
1233}
1234
Serhiy Storchakad4f9cf52018-11-27 19:34:35 +02001235static int
1236pysqlite_connection_set_isolation_level(pysqlite_Connection* self, PyObject* isolation_level, void *Py_UNUSED(ignored))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001237{
Zackery Spytz842acaa2018-12-17 07:52:45 -07001238 if (isolation_level == NULL) {
1239 PyErr_SetString(PyExc_AttributeError, "cannot delete attribute");
1240 return -1;
1241 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001242 if (isolation_level == Py_None) {
Serhiy Storchaka28914922016-09-01 22:18:03 +03001243 PyObject *res = pysqlite_connection_commit(self, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001244 if (!res) {
1245 return -1;
1246 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001247 Py_DECREF(res);
1248
Serhiy Storchaka28914922016-09-01 22:18:03 +03001249 self->begin_statement = NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001250 } else {
Serhiy Storchaka28914922016-09-01 22:18:03 +03001251 const char * const *candidate;
1252 PyObject *uppercase_level;
1253 _Py_IDENTIFIER(upper);
Neal Norwitzefee9f52007-10-27 02:50:52 +00001254
Serhiy Storchaka28914922016-09-01 22:18:03 +03001255 if (!PyUnicode_Check(isolation_level)) {
1256 PyErr_Format(PyExc_TypeError,
1257 "isolation_level must be a string or None, not %.100s",
1258 Py_TYPE(isolation_level)->tp_name);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001259 return -1;
1260 }
1261
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001262 uppercase_level = _PyObject_CallMethodIdOneArg(
Serhiy Storchaka28914922016-09-01 22:18:03 +03001263 (PyObject *)&PyUnicode_Type, &PyId_upper,
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001264 isolation_level);
Serhiy Storchaka28914922016-09-01 22:18:03 +03001265 if (!uppercase_level) {
Georg Brandl3dbca812008-07-23 16:10:53 +00001266 return -1;
1267 }
Serhiy Storchaka28914922016-09-01 22:18:03 +03001268 for (candidate = begin_statements; *candidate; candidate++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001269 if (_PyUnicode_EqualToASCIIString(uppercase_level, *candidate + 6))
Serhiy Storchaka28914922016-09-01 22:18:03 +03001270 break;
1271 }
1272 Py_DECREF(uppercase_level);
1273 if (!*candidate) {
1274 PyErr_SetString(PyExc_ValueError,
1275 "invalid value for isolation_level");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001276 return -1;
1277 }
Serhiy Storchaka28914922016-09-01 22:18:03 +03001278 self->begin_statement = *candidate;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001279 }
1280
Serhiy Storchaka28914922016-09-01 22:18:03 +03001281 Py_INCREF(isolation_level);
1282 Py_XSETREF(self->isolation_level, isolation_level);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001283 return 0;
1284}
1285
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001286PyObject* pysqlite_connection_call(pysqlite_Connection* self, PyObject* args, PyObject* kwargs)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001287{
1288 PyObject* sql;
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001289 pysqlite_Statement* statement;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001290 PyObject* weakref;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001291 int rc;
1292
Gerhard Häringf9cee222010-03-05 15:20:03 +00001293 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1294 return NULL;
1295 }
1296
Serhiy Storchaka6cca5c82017-06-08 14:41:19 +03001297 if (!_PyArg_NoKeywords(MODULE_NAME ".Connection", kwargs))
Larry Hastings3b12e952015-05-08 07:45:10 -07001298 return NULL;
1299
Victor Stinnerc6a23202019-06-26 03:16:24 +02001300 if (!PyArg_ParseTuple(args, "U", &sql))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001301 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001302
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001303 _pysqlite_drop_unused_statement_references(self);
Thomas Wouters477c8d52006-05-27 19:21:47 +00001304
Erlend Egeberg Aasland9031bd42020-10-01 15:24:31 +02001305 statement = PyObject_New(pysqlite_Statement, pysqlite_StatementType);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001306 if (!statement) {
1307 return NULL;
1308 }
1309
Victor Stinner0201f442010-03-13 03:28:34 +00001310 statement->db = NULL;
1311 statement->st = NULL;
1312 statement->sql = NULL;
1313 statement->in_use = 0;
1314 statement->in_weakreflist = NULL;
1315
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001316 rc = pysqlite_statement_create(statement, self, sql);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001317 if (rc != SQLITE_OK) {
1318 if (rc == PYSQLITE_TOO_MUCH_SQL) {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001319 PyErr_SetString(pysqlite_Warning, "You can only execute one statement at a time.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001320 } else if (rc == PYSQLITE_SQL_WRONG_TYPE) {
Serhiy Storchaka42d67af2014-09-11 13:29:05 +03001321 if (PyErr_ExceptionMatches(PyExc_TypeError))
1322 PyErr_SetString(pysqlite_Warning, "SQL is of wrong type. Must be string.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001323 } else {
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001324 (void)pysqlite_statement_reset(statement);
1325 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001326 }
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001327 goto error;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001328 }
1329
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001330 weakref = PyWeakref_NewRef((PyObject*)statement, NULL);
1331 if (weakref == NULL)
1332 goto error;
1333 if (PyList_Append(self->statements, weakref) != 0) {
1334 Py_DECREF(weakref);
1335 goto error;
1336 }
1337 Py_DECREF(weakref);
1338
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001339 return (PyObject*)statement;
Victor Stinnerb3e1ef12013-11-05 14:46:13 +01001340
1341error:
1342 Py_DECREF(statement);
1343 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001344}
1345
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001346/*[clinic input]
1347_sqlite3.Connection.execute as pysqlite_connection_execute
1348
1349 sql: unicode
1350 parameters: object = NULL
1351 /
1352
1353Executes a SQL statement. Non-standard.
1354[clinic start generated code]*/
1355
1356static PyObject *
1357pysqlite_connection_execute_impl(pysqlite_Connection *self, PyObject *sql,
1358 PyObject *parameters)
1359/*[clinic end generated code: output=5be05ae01ee17ee4 input=fbd17c75c7140271]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001360{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001361 _Py_IDENTIFIER(execute);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001362 PyObject* cursor = 0;
1363 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001364
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001365 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001366 if (!cursor) {
1367 goto error;
1368 }
1369
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001370 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_execute, sql, parameters, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001371 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001372 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001373 }
1374
1375error:
1376 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001377
1378 return cursor;
1379}
1380
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001381/*[clinic input]
1382_sqlite3.Connection.executemany as pysqlite_connection_executemany
1383
1384 sql: unicode
1385 parameters: object
1386 /
1387
1388Repeatedly executes a SQL statement. Non-standard.
1389[clinic start generated code]*/
1390
1391static PyObject *
1392pysqlite_connection_executemany_impl(pysqlite_Connection *self,
1393 PyObject *sql, PyObject *parameters)
1394/*[clinic end generated code: output=776cd2fd20bfe71f input=4feab80659ffc82b]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001395{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001396 _Py_IDENTIFIER(executemany);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001397 PyObject* cursor = 0;
1398 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001399
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001400 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001401 if (!cursor) {
1402 goto error;
1403 }
1404
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001405 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_executemany, sql,
1406 parameters, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001407 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001408 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001409 }
1410
1411error:
1412 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001413
1414 return cursor;
1415}
1416
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001417/*[clinic input]
1418_sqlite3.Connection.executescript as pysqlite_connection_executescript
1419
1420 sql_script as script_obj: object
1421 /
1422
1423Executes a multiple SQL statements at once. Non-standard.
1424[clinic start generated code]*/
1425
1426static PyObject *
1427pysqlite_connection_executescript(pysqlite_Connection *self,
1428 PyObject *script_obj)
1429/*[clinic end generated code: output=4c4f9d77aa0ae37d input=c0b14695aa6c81d9]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001430{
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001431 _Py_IDENTIFIER(executescript);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001432 PyObject* cursor = 0;
1433 PyObject* result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001434
Jeroen Demeyer762f93f2019-07-08 10:19:25 +02001435 cursor = _PyObject_CallMethodIdNoArgs((PyObject*)self, &PyId_cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001436 if (!cursor) {
1437 goto error;
1438 }
1439
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001440 result = _PyObject_CallMethodIdObjArgs(cursor, &PyId_executescript,
1441 script_obj, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001442 if (!result) {
Alexandre Vassalotti1839bac2008-07-13 21:57:48 +00001443 Py_CLEAR(cursor);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001444 }
1445
1446error:
1447 Py_XDECREF(result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001448
1449 return cursor;
1450}
1451
1452/* ------------------------- COLLATION CODE ------------------------ */
1453
1454static int
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001455pysqlite_collation_callback(
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001456 void* context,
1457 int text1_length, const void* text1_data,
1458 int text2_length, const void* text2_data)
1459{
1460 PyObject* callback = (PyObject*)context;
1461 PyObject* string1 = 0;
1462 PyObject* string2 = 0;
1463 PyGILState_STATE gilstate;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001464 PyObject* retval = NULL;
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001465 long longval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001466 int result = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001467 gilstate = PyGILState_Ensure();
1468
1469 if (PyErr_Occurred()) {
1470 goto finally;
1471 }
1472
Guido van Rossum98297ee2007-11-06 21:34:58 +00001473 string1 = PyUnicode_FromStringAndSize((const char*)text1_data, text1_length);
1474 string2 = PyUnicode_FromStringAndSize((const char*)text2_data, text2_length);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001475
1476 if (!string1 || !string2) {
1477 goto finally; /* failed to allocate strings */
1478 }
1479
1480 retval = PyObject_CallFunctionObjArgs(callback, string1, string2, NULL);
1481
1482 if (!retval) {
1483 /* execution failed */
1484 goto finally;
1485 }
1486
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001487 longval = PyLong_AsLongAndOverflow(retval, &result);
1488 if (longval == -1 && PyErr_Occurred()) {
1489 PyErr_Clear();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001490 result = 0;
1491 }
Serhiy Storchaka3cf96ac2013-02-07 17:01:47 +02001492 else if (!result) {
1493 if (longval > 0)
1494 result = 1;
1495 else if (longval < 0)
1496 result = -1;
1497 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001498
1499finally:
1500 Py_XDECREF(string1);
1501 Py_XDECREF(string2);
1502 Py_XDECREF(retval);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001503 PyGILState_Release(gilstate);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001504 return result;
1505}
1506
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001507/*[clinic input]
1508_sqlite3.Connection.interrupt as pysqlite_connection_interrupt
1509
1510Abort any pending database operation. Non-standard.
1511[clinic start generated code]*/
1512
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001513static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001514pysqlite_connection_interrupt_impl(pysqlite_Connection *self)
1515/*[clinic end generated code: output=f193204bc9e70b47 input=4bd0ad083cf93aa7]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001516{
1517 PyObject* retval = NULL;
1518
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001519 if (!pysqlite_check_connection(self)) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001520 goto finally;
1521 }
1522
1523 sqlite3_interrupt(self->db);
1524
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001525 retval = Py_NewRef(Py_None);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001526
1527finally:
1528 return retval;
1529}
1530
Christian Heimesbbe741d2008-03-28 10:53:29 +00001531/* Function author: Paul Kippes <kippesp@gmail.com>
1532 * Class method of Connection to call the Python function _iterdump
1533 * of the sqlite3 module.
1534 */
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001535/*[clinic input]
1536_sqlite3.Connection.iterdump as pysqlite_connection_iterdump
1537
1538Returns iterator to the dump of the database in an SQL text format.
1539
1540Non-standard.
1541[clinic start generated code]*/
1542
Christian Heimesbbe741d2008-03-28 10:53:29 +00001543static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001544pysqlite_connection_iterdump_impl(pysqlite_Connection *self)
1545/*[clinic end generated code: output=586997aaf9808768 input=53bc907cb5eedb85]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001546{
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001547 _Py_IDENTIFIER(_iterdump);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001548 PyObject* retval = NULL;
1549 PyObject* module = NULL;
1550 PyObject* module_dict;
1551 PyObject* pyfn_iterdump;
1552
1553 if (!pysqlite_check_connection(self)) {
1554 goto finally;
1555 }
1556
1557 module = PyImport_ImportModule(MODULE_NAME ".dump");
1558 if (!module) {
1559 goto finally;
1560 }
1561
1562 module_dict = PyModule_GetDict(module);
1563 if (!module_dict) {
1564 goto finally;
1565 }
1566
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001567 pyfn_iterdump = _PyDict_GetItemIdWithError(module_dict, &PyId__iterdump);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001568 if (!pyfn_iterdump) {
Serhiy Storchakafc662ac2018-12-10 16:06:08 +02001569 if (!PyErr_Occurred()) {
1570 PyErr_SetString(pysqlite_OperationalError,
1571 "Failed to obtain _iterdump() reference");
1572 }
Christian Heimesbbe741d2008-03-28 10:53:29 +00001573 goto finally;
1574 }
1575
Petr Viktorinffd97532020-02-11 17:46:57 +01001576 retval = PyObject_CallOneArg(pyfn_iterdump, (PyObject *)self);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001577
1578finally:
Christian Heimesbbe741d2008-03-28 10:53:29 +00001579 Py_XDECREF(module);
1580 return retval;
1581}
1582
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001583/*[clinic input]
1584_sqlite3.Connection.backup as pysqlite_connection_backup
1585
1586 target: object(type='pysqlite_Connection *', subclass_of='pysqlite_ConnectionType') = NULL
1587 *
1588 pages: int = -1
1589 progress: object = None
1590 name: str = "main"
1591 sleep: double = 0.250
1592
1593Makes a backup of the database. Non-standard.
1594[clinic start generated code]*/
1595
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001596static PyObject *
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001597pysqlite_connection_backup_impl(pysqlite_Connection *self,
1598 pysqlite_Connection *target, int pages,
1599 PyObject *progress, const char *name,
1600 double sleep)
1601/*[clinic end generated code: output=306a3e6a38c36334 input=2f3497ea530144b1]*/
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001602{
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001603 int rc;
1604 int callback_error = 0;
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001605 int sleep_ms = sleep * 1000.0;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001606 sqlite3 *bck_conn;
1607 sqlite3_backup *bck_handle;
Victor Stinnerca405012018-04-30 12:22:17 +02001608
Peter McCormickbfee9fa2020-09-19 23:40:46 -04001609 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
1610 return NULL;
1611 }
1612
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001613 if (!pysqlite_check_connection(target)) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001614 return NULL;
1615 }
1616
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001617 if (target == self) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001618 PyErr_SetString(PyExc_ValueError, "target cannot be the same connection instance");
1619 return NULL;
1620 }
1621
Aviv Palivodabbf7bb72018-03-18 02:48:55 +02001622#if SQLITE_VERSION_NUMBER < 3008008
1623 /* Since 3.8.8 this is already done, per commit
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001624 https://www.sqlite.org/src/info/169b5505498c0a7e */
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001625 if (!sqlite3_get_autocommit(target->db)) {
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001626 PyErr_SetString(pysqlite_OperationalError, "target is in transaction");
1627 return NULL;
1628 }
1629#endif
1630
1631 if (progress != Py_None && !PyCallable_Check(progress)) {
1632 PyErr_SetString(PyExc_TypeError, "progress argument must be a callable");
1633 return NULL;
1634 }
1635
1636 if (pages == 0) {
1637 pages = -1;
1638 }
1639
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001640 bck_conn = target->db;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001641
1642 Py_BEGIN_ALLOW_THREADS
1643 bck_handle = sqlite3_backup_init(bck_conn, "main", self->db, name);
1644 Py_END_ALLOW_THREADS
1645
1646 if (bck_handle) {
1647 do {
1648 Py_BEGIN_ALLOW_THREADS
1649 rc = sqlite3_backup_step(bck_handle, pages);
1650 Py_END_ALLOW_THREADS
1651
1652 if (progress != Py_None) {
1653 PyObject *res;
1654
1655 res = PyObject_CallFunction(progress, "iii", rc,
1656 sqlite3_backup_remaining(bck_handle),
1657 sqlite3_backup_pagecount(bck_handle));
1658 if (res == NULL) {
1659 /* User's callback raised an error: interrupt the loop and
1660 propagate it. */
1661 callback_error = 1;
1662 rc = -1;
1663 } else {
1664 Py_DECREF(res);
1665 }
1666 }
1667
1668 /* Sleep for a while if there are still further pages to copy and
1669 the engine could not make any progress */
1670 if (rc == SQLITE_BUSY || rc == SQLITE_LOCKED) {
1671 Py_BEGIN_ALLOW_THREADS
Victor Stinnerca405012018-04-30 12:22:17 +02001672 sqlite3_sleep(sleep_ms);
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001673 Py_END_ALLOW_THREADS
1674 }
1675 } while (rc == SQLITE_OK || rc == SQLITE_BUSY || rc == SQLITE_LOCKED);
1676
1677 Py_BEGIN_ALLOW_THREADS
1678 rc = sqlite3_backup_finish(bck_handle);
1679 Py_END_ALLOW_THREADS
1680 } else {
1681 rc = _pysqlite_seterror(bck_conn, NULL);
1682 }
1683
1684 if (!callback_error && rc != SQLITE_OK) {
1685 /* We cannot use _pysqlite_seterror() here because the backup APIs do
1686 not set the error status on the connection object, but rather on
1687 the backup handle. */
1688 if (rc == SQLITE_NOMEM) {
1689 (void)PyErr_NoMemory();
1690 } else {
1691#if SQLITE_VERSION_NUMBER > 3007015
1692 PyErr_SetString(pysqlite_OperationalError, sqlite3_errstr(rc));
1693#else
1694 switch (rc) {
Berker Peksagb10a64d2018-09-20 14:14:33 +03001695 case SQLITE_ERROR:
1696 /* Description of SQLITE_ERROR in SQLite 3.7.14 and older
1697 releases. */
1698 PyErr_SetString(pysqlite_OperationalError,
1699 "SQL logic error or missing database");
1700 break;
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001701 case SQLITE_READONLY:
1702 PyErr_SetString(pysqlite_OperationalError,
1703 "attempt to write a readonly database");
1704 break;
1705 case SQLITE_BUSY:
1706 PyErr_SetString(pysqlite_OperationalError, "database is locked");
1707 break;
1708 case SQLITE_LOCKED:
1709 PyErr_SetString(pysqlite_OperationalError,
1710 "database table is locked");
1711 break;
1712 default:
1713 PyErr_Format(pysqlite_OperationalError,
1714 "unrecognized error code: %d", rc);
1715 break;
1716 }
1717#endif
1718 }
1719 }
1720
1721 if (!callback_error && rc == SQLITE_OK) {
1722 Py_RETURN_NONE;
1723 } else {
1724 return NULL;
1725 }
1726}
Emanuele Gaifasd7aed412018-03-10 23:08:31 +01001727
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001728/*[clinic input]
1729_sqlite3.Connection.create_collation as pysqlite_connection_create_collation
1730
1731 name: unicode
1732 callback as callable: object
1733 /
1734
1735Creates a collation function. Non-standard.
1736[clinic start generated code]*/
1737
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001738static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001739pysqlite_connection_create_collation_impl(pysqlite_Connection *self,
1740 PyObject *name, PyObject *callable)
1741/*[clinic end generated code: output=0f63b8995565ae22 input=5c3898813a776cf2]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001742{
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001743 PyObject* uppercase_name = 0;
Victor Stinner35466c52010-04-22 11:23:23 +00001744 Py_ssize_t i, len;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001745 _Py_IDENTIFIER(upper);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001746 const char *uppercase_name_str;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001747 int rc;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001748 unsigned int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +03001749 const void *data;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001750
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001751 if (!pysqlite_check_thread(self) || !pysqlite_check_connection(self)) {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001752 goto finally;
1753 }
1754
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02001755 uppercase_name = _PyObject_CallMethodIdOneArg((PyObject *)&PyUnicode_Type,
1756 &PyId_upper, name);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001757 if (!uppercase_name) {
1758 goto finally;
1759 }
1760
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001761 if (PyUnicode_READY(uppercase_name))
1762 goto finally;
1763 len = PyUnicode_GET_LENGTH(uppercase_name);
1764 kind = PyUnicode_KIND(uppercase_name);
1765 data = PyUnicode_DATA(uppercase_name);
1766 for (i=0; i<len; i++) {
1767 Py_UCS4 ch = PyUnicode_READ(kind, data, i);
1768 if ((ch >= '0' && ch <= '9')
1769 || (ch >= 'A' && ch <= 'Z')
1770 || (ch == '_'))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001771 {
Victor Stinner35466c52010-04-22 11:23:23 +00001772 continue;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001773 } else {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001774 PyErr_SetString(pysqlite_ProgrammingError, "invalid character in collation name");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001775 goto finally;
1776 }
1777 }
1778
Serhiy Storchaka06515832016-11-20 09:13:07 +02001779 uppercase_name_str = PyUnicode_AsUTF8(uppercase_name);
Victor Stinner35466c52010-04-22 11:23:23 +00001780 if (!uppercase_name_str)
1781 goto finally;
1782
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001783 if (callable != Py_None && !PyCallable_Check(callable)) {
1784 PyErr_SetString(PyExc_TypeError, "parameter must be callable");
1785 goto finally;
1786 }
1787
1788 if (callable != Py_None) {
Gerhard Häringf9cee222010-03-05 15:20:03 +00001789 if (PyDict_SetItem(self->collations, uppercase_name, callable) == -1)
1790 goto finally;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001791 } else {
Gerhard Häringf9cee222010-03-05 15:20:03 +00001792 if (PyDict_DelItem(self->collations, uppercase_name) == -1)
1793 goto finally;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001794 }
1795
1796 rc = sqlite3_create_collation(self->db,
Victor Stinner35466c52010-04-22 11:23:23 +00001797 uppercase_name_str,
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001798 SQLITE_UTF8,
1799 (callable != Py_None) ? callable : NULL,
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001800 (callable != Py_None) ? pysqlite_collation_callback : NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001801 if (rc != SQLITE_OK) {
1802 PyDict_DelItem(self->collations, uppercase_name);
Gerhard Häringe7ea7452008-03-29 00:45:29 +00001803 _pysqlite_seterror(self->db, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001804 goto finally;
1805 }
1806
1807finally:
1808 Py_XDECREF(uppercase_name);
1809
1810 if (PyErr_Occurred()) {
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001811 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001812 }
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001813 return Py_NewRef(Py_None);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001814}
1815
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001816/*[clinic input]
1817_sqlite3.Connection.__enter__ as pysqlite_connection_enter
1818
1819Called when the connection is used as a context manager.
1820
1821Returns itself as a convenience to the caller.
1822[clinic start generated code]*/
1823
Christian Heimesbbe741d2008-03-28 10:53:29 +00001824static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001825pysqlite_connection_enter_impl(pysqlite_Connection *self)
1826/*[clinic end generated code: output=457b09726d3e9dcd input=127d7a4f17e86d8f]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001827{
Erlend Egeberg Aaslandbf64d902020-12-27 12:05:33 +01001828 return Py_NewRef((PyObject *)self);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001829}
1830
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001831/*[clinic input]
1832_sqlite3.Connection.__exit__ as pysqlite_connection_exit
1833
1834 type as exc_type: object
1835 value as exc_value: object
1836 traceback as exc_tb: object
1837 /
1838
1839Called when the connection is used as a context manager.
1840
1841If there was any exception, a rollback takes place; otherwise we commit.
1842[clinic start generated code]*/
1843
Christian Heimesbbe741d2008-03-28 10:53:29 +00001844static PyObject *
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001845pysqlite_connection_exit_impl(pysqlite_Connection *self, PyObject *exc_type,
1846 PyObject *exc_value, PyObject *exc_tb)
1847/*[clinic end generated code: output=0705200e9321202a input=bd66f1532c9c54a7]*/
Christian Heimesbbe741d2008-03-28 10:53:29 +00001848{
Serhiy Storchakae2f92de2017-11-11 13:06:26 +02001849 const char* method_name;
Christian Heimesbbe741d2008-03-28 10:53:29 +00001850 PyObject* result;
1851
Christian Heimesbbe741d2008-03-28 10:53:29 +00001852 if (exc_type == Py_None && exc_value == Py_None && exc_tb == Py_None) {
1853 method_name = "commit";
1854 } else {
1855 method_name = "rollback";
1856 }
1857
Victor Stinner3466bde2016-09-05 18:16:01 -07001858 result = PyObject_CallMethod((PyObject*)self, method_name, NULL);
Christian Heimesbbe741d2008-03-28 10:53:29 +00001859 if (!result) {
1860 return NULL;
1861 }
1862 Py_DECREF(result);
1863
1864 Py_RETURN_FALSE;
1865}
1866
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02001867static const char connection_doc[] =
Thomas Wouters477c8d52006-05-27 19:21:47 +00001868PyDoc_STR("SQLite database connection object.");
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001869
1870static PyGetSetDef connection_getset[] = {
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001871 {"isolation_level", (getter)pysqlite_connection_get_isolation_level, (setter)pysqlite_connection_set_isolation_level},
1872 {"total_changes", (getter)pysqlite_connection_get_total_changes, (setter)0},
Berker Peksag59da4b32016-09-12 07:16:43 +03001873 {"in_transaction", (getter)pysqlite_connection_get_in_transaction, (setter)0},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001874 {NULL}
1875};
1876
1877static PyMethodDef connection_methods[] = {
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001878 PYSQLITE_CONNECTION_BACKUP_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001879 PYSQLITE_CONNECTION_CLOSE_METHODDEF
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001880 PYSQLITE_CONNECTION_COMMIT_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001881 PYSQLITE_CONNECTION_CREATE_AGGREGATE_METHODDEF
1882 PYSQLITE_CONNECTION_CREATE_COLLATION_METHODDEF
1883 PYSQLITE_CONNECTION_CREATE_FUNCTION_METHODDEF
1884 PYSQLITE_CONNECTION_CURSOR_METHODDEF
1885 PYSQLITE_CONNECTION_ENABLE_LOAD_EXTENSION_METHODDEF
1886 PYSQLITE_CONNECTION_ENTER_METHODDEF
Erlend Egeberg Aasland3ccef1c2020-12-27 09:32:18 +01001887 PYSQLITE_CONNECTION_EXECUTEMANY_METHODDEF
1888 PYSQLITE_CONNECTION_EXECUTESCRIPT_METHODDEF
1889 PYSQLITE_CONNECTION_EXECUTE_METHODDEF
Erlend Egeberg Aasland1ba82bb2020-12-18 15:25:35 +01001890 PYSQLITE_CONNECTION_EXIT_METHODDEF
1891 PYSQLITE_CONNECTION_INTERRUPT_METHODDEF
1892 PYSQLITE_CONNECTION_ITERDUMP_METHODDEF
1893 PYSQLITE_CONNECTION_LOAD_EXTENSION_METHODDEF
1894 PYSQLITE_CONNECTION_ROLLBACK_METHODDEF
1895 PYSQLITE_CONNECTION_SET_AUTHORIZER_METHODDEF
1896 PYSQLITE_CONNECTION_SET_PROGRESS_HANDLER_METHODDEF
1897 PYSQLITE_CONNECTION_SET_TRACE_CALLBACK_METHODDEF
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001898 {NULL, NULL}
1899};
1900
1901static struct PyMemberDef connection_members[] =
1902{
Guido van Rossum10f07c42007-08-11 15:32:55 +00001903 {"Warning", T_OBJECT, offsetof(pysqlite_Connection, Warning), READONLY},
1904 {"Error", T_OBJECT, offsetof(pysqlite_Connection, Error), READONLY},
1905 {"InterfaceError", T_OBJECT, offsetof(pysqlite_Connection, InterfaceError), READONLY},
1906 {"DatabaseError", T_OBJECT, offsetof(pysqlite_Connection, DatabaseError), READONLY},
1907 {"DataError", T_OBJECT, offsetof(pysqlite_Connection, DataError), READONLY},
1908 {"OperationalError", T_OBJECT, offsetof(pysqlite_Connection, OperationalError), READONLY},
1909 {"IntegrityError", T_OBJECT, offsetof(pysqlite_Connection, IntegrityError), READONLY},
1910 {"InternalError", T_OBJECT, offsetof(pysqlite_Connection, InternalError), READONLY},
1911 {"ProgrammingError", T_OBJECT, offsetof(pysqlite_Connection, ProgrammingError), READONLY},
1912 {"NotSupportedError", T_OBJECT, offsetof(pysqlite_Connection, NotSupportedError), READONLY},
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001913 {"row_factory", T_OBJECT, offsetof(pysqlite_Connection, row_factory)},
1914 {"text_factory", T_OBJECT, offsetof(pysqlite_Connection, text_factory)},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001915 {NULL}
1916};
1917
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001918static PyType_Slot connection_slots[] = {
1919 {Py_tp_dealloc, pysqlite_connection_dealloc},
1920 {Py_tp_doc, (void *)connection_doc},
1921 {Py_tp_methods, connection_methods},
1922 {Py_tp_members, connection_members},
1923 {Py_tp_getset, connection_getset},
1924 {Py_tp_new, PyType_GenericNew},
1925 {Py_tp_init, pysqlite_connection_init},
1926 {Py_tp_call, pysqlite_connection_call},
1927 {0, NULL},
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001928};
1929
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001930static PyType_Spec connection_spec = {
1931 .name = MODULE_NAME ".Connection",
1932 .basicsize = sizeof(pysqlite_Connection),
1933 .flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
1934 .slots = connection_slots,
1935};
1936
1937PyTypeObject *pysqlite_ConnectionType = NULL;
1938
1939extern int pysqlite_connection_setup_types(PyObject *module)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001940{
Erlend Egeberg Aasland256e54a2020-10-01 16:03:21 +02001941 pysqlite_ConnectionType = (PyTypeObject *)PyType_FromModuleAndSpec(module, &connection_spec, NULL);
1942 if (pysqlite_ConnectionType == NULL) {
1943 return -1;
1944 }
1945 return 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001946}