mirror of
https://github.com/devine-dl/devine.git
synced 2025-04-29 09:39:44 +00:00
106 lines
4.1 KiB
Python
106 lines
4.1 KiB
Python
"""
|
|
AtomicSQL - Race-condition and Threading safe SQL Database Interface.
|
|
Copyright (C) 2020-2023 rlaphoenix
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
"""
|
|
|
|
import os
|
|
import sqlite3
|
|
import time
|
|
from threading import Lock
|
|
from typing import Any, Callable, Union
|
|
|
|
import pymysql.cursors
|
|
|
|
Connections = Union[sqlite3.Connection, pymysql.connections.Connection]
|
|
Cursors = Union[sqlite3.Cursor, pymysql.cursors.Cursor]
|
|
|
|
|
|
class AtomicSQL:
|
|
"""
|
|
Race-condition and Threading safe SQL Database Interface.
|
|
"""
|
|
|
|
def __init__(self) -> None:
|
|
self.master_lock = Lock() # prevents race condition
|
|
self.db: dict[bytes, Connections] = {} # used to hold the database connections and commit changes and such
|
|
self.cursor: dict[bytes, Cursors] = {} # used to execute queries and receive results
|
|
self.session_lock: dict[bytes, Lock] = {} # like master_lock, but per-session
|
|
|
|
def load(self, connection: Connections) -> bytes:
|
|
"""
|
|
Store SQL Connection object and return a reference ticket.
|
|
:param connection: SQLite3 or pymysql Connection object.
|
|
:returns: Session ID in which the database connection is referenced with.
|
|
"""
|
|
self.master_lock.acquire()
|
|
try:
|
|
# obtain a unique cryptographically random session_id
|
|
session_id = None
|
|
while not session_id or session_id in self.db:
|
|
session_id = os.urandom(16)
|
|
self.db[session_id] = connection
|
|
self.cursor[session_id] = self.db[session_id].cursor()
|
|
self.session_lock[session_id] = Lock()
|
|
return session_id
|
|
finally:
|
|
self.master_lock.release()
|
|
|
|
def safe_execute(self, session_id: bytes, action: Callable) -> Any:
|
|
"""
|
|
Execute code on the Database Connection in a race-condition safe way.
|
|
:param session_id: Database Connection's Session ID.
|
|
:param action: Function or lambda in which to execute, it's provided `db` and `cursor` arguments.
|
|
:returns: Whatever `action` returns.
|
|
"""
|
|
if session_id not in self.db:
|
|
raise ValueError(f"Session ID {session_id!r} is invalid.")
|
|
self.master_lock.acquire()
|
|
self.session_lock[session_id].acquire()
|
|
try:
|
|
failures = 0
|
|
while True:
|
|
try:
|
|
action(
|
|
db=self.db[session_id],
|
|
cursor=self.cursor[session_id]
|
|
)
|
|
break
|
|
except sqlite3.OperationalError as e:
|
|
failures += 1
|
|
delay = 3 * failures
|
|
print(f"AtomicSQL.safe_execute failed, {e}, retrying in {delay} seconds...")
|
|
time.sleep(delay)
|
|
if failures == 10:
|
|
raise ValueError("AtomicSQL.safe_execute failed too many time's. Aborting.")
|
|
return self.cursor[session_id]
|
|
finally:
|
|
self.session_lock[session_id].release()
|
|
self.master_lock.release()
|
|
|
|
def commit(self, session_id: bytes) -> bool:
|
|
"""
|
|
Commit changes to the Database Connection immediately.
|
|
This isn't necessary to be run every time you make changes, just ensure it's run
|
|
at least before termination.
|
|
:param session_id: Database Connection's Session ID.
|
|
:returns: True if it committed.
|
|
"""
|
|
self.safe_execute(
|
|
session_id,
|
|
lambda db, cursor: db.commit()
|
|
)
|
|
return True # todo ; actually check if db.commit worked
|