Skip to content

gh-108083: Don't ignore exceptions in sqlite3.Connection.__init__() and .close() #108084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erlend-aasland merged 13 commits into from
Aug 18, 2023
Merged

gh-108083: Don't ignore exceptions in sqlite3.Connection.__init__() and .close() #108084

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0956795
gh-108083: Don't ignore exceptions in sqlite3.Connection.__init__() a…
erlend-aasland Aug 17, 2023
a5f6454
Cast
erlend-aasland Aug 17, 2023
367f192
Pull in main
erlend-aasland Aug 17, 2023
7b3d032
Address review: let connection_close() return a value and the caller …
erlend-aasland Aug 17, 2023
379e64e
Don't log unraisable exceptions in case of interp shutdown
erlend-aasland Aug 17, 2023
3905a88
Pull in main
erlend-aasland Aug 18, 2023
b2d49f3
Assert pre/post state in remove_callbacks()
erlend-aasland Aug 18, 2023
0d4eb8b
Make sure we're not initialized if reinit fails
erlend-aasland Aug 18, 2023
863f5b7
Try to close the database even if ROLLBACK fails
erlend-aasland Aug 18, 2023
ef5418a
Add comment
erlend-aasland Aug 18, 2023
b1b6d24
Pull in main
erlend-aasland Aug 18, 2023
5d308aa
Reduce indent
erlend-aasland Aug 18, 2023
8d57138
Also assert usage after set authorizer
erlend-aasland Aug 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2023-08-17-12-59-35.gh-issue-108083.9J7UcT.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fix bugs in the constructor of :mod:`sqlite3.Connection` and
:meth:`sqlite3.Connection.close` where exceptions could be leaked. Patch by
Erlend E. Aasland.
68 changes: 51 additions & 17 deletions Modules/_sqlite/connection.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self);
static void free_callback_context(callback_context *ctx);
static void set_callback_context(callback_context **ctx_pp,
callback_context *ctx);
static void connection_close(pysqlite_Connection *self);
static int connection_close(pysqlite_Connection *self);
PyObject *_pysqlite_query_execute(pysqlite_Cursor *, int, PyObject *, PyObject *);

static PyObject *
Expand Down Expand Up @@ -249,7 +249,9 @@ pysqlite_connection_init_impl(pysqlite_Connection *self, PyObject *database,
if (self->initialized) {
PyTypeObject *tp = Py_TYPE(self);
tp->tp_clear((PyObject *)self);
connection_close(self);
if (connection_close(self) < 0) {
return -1;
Comment thread
erlend-aasland marked this conversation as resolved.
}
self->initialized = 0;
}

Expand Down Expand Up @@ -334,7 +336,9 @@ pysqlite_connection_init_impl(pysqlite_Connection *self, PyObject *database,
self->initialized = 1;

if (autocommit == AUTOCOMMIT_DISABLED) {
(void)connection_exec_stmt(self, "BEGIN");
if (connection_exec_stmt(self, "BEGIN") < 0) {
return -1;
}
}
return 0;

Expand Down Expand Up @@ -432,48 +436,75 @@ free_callback_contexts(pysqlite_Connection *self)
static void
remove_callbacks(sqlite3 *db)
{
if (db == NULL) {
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
return;
}
sqlite3_trace_v2(db, SQLITE_TRACE_STMT, 0, 0);
sqlite3_progress_handler(db, 0, 0, (void *)0);
(void)sqlite3_set_authorizer(db, NULL, NULL);
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
}

static void
static int
connection_close(pysqlite_Connection *self)
{
if (self->db) {
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
if (self->autocommit == AUTOCOMMIT_DISABLED &&
!sqlite3_get_autocommit(self->db))
{
/* If close is implicitly called as a result of interpreter
* tear-down, we must not call back into Python. */
if (_Py_IsInterpreterFinalizing(PyInterpreterState_Get())) {
remove_callbacks(self->db);
if (connection_exec_stmt(self, "ROLLBACK") < 0) {
return -1;
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
}
(void)connection_exec_stmt(self, "ROLLBACK");
}

free_callback_contexts(self);

sqlite3 *db = self->db;
self->db = NULL;

Py_BEGIN_ALLOW_THREADS
int rc = sqlite3_close_v2(db);
assert(rc == SQLITE_OK), (void)rc;
Py_END_ALLOW_THREADS

free_callback_contexts(self);
}
return 0;
}

static void
connection_dealloc(pysqlite_Connection *self)
connection_finalize(PyObject *self)
{
PyTypeObject *tp = Py_TYPE(self);
PyObject_GC_UnTrack(self);
tp->tp_clear((PyObject *)self);
pysqlite_Connection *con = (pysqlite_Connection *)self;
PyObject *exc = PyErr_GetRaisedException();

/* If close is implicitly called as a result of interpreter
* tear-down, we must not call back into Python. */
PyInterpreterState *interp = PyInterpreterState_Get();
int teardown = _Py_IsInterpreterFinalizing(interp);
if (teardown) {
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
remove_callbacks(con->db);
Comment thread
erlend-aasland marked this conversation as resolved.
}

/* Clean up if user has not called .close() explicitly. */
connection_close(self);
if (connection_close(con) < 0) {
if (teardown) {
PyErr_Clear();
}
else {
PyErr_WriteUnraisable((PyObject *)self);
}
}

PyErr_SetRaisedException(exc);
}

static void
connection_dealloc(PyObject *self)
{
if (PyObject_CallFinalizerFromDealloc(self) < 0) {
return;
}
PyTypeObject *tp = Py_TYPE(self);
PyObject_GC_UnTrack(self);
tp->tp_clear(self);
tp->tp_free(self);
Py_DECREF(tp);
}
Expand Down Expand Up @@ -621,7 +652,9 @@ pysqlite_connection_close_impl(pysqlite_Connection *self)

pysqlite_close_all_blobs(self);
Py_CLEAR(self->statement_cache);
connection_close(self);
if (connection_close(self) < 0) {
return NULL;
}

Py_RETURN_NONE;
}
Expand Down Expand Up @@ -2555,6 +2588,7 @@ static struct PyMemberDef connection_members[] =
};

static PyType_Slot connection_slots[] = {
{Py_tp_finalize, connection_finalize},
{Py_tp_dealloc, connection_dealloc},
{Py_tp_doc, (void *)connection_doc},
{Py_tp_methods, connection_methods},
Expand Down