mirror of
https://github.com/SickGear/SickGear.git
synced 2025-01-07 10:33:38 +00:00
cec4ed573d
Switched out sqlite3 libs in favour of SQLAlchemy v0.9, will gradually migrate dialects and scheme to be fully SQLAlchemy compliant for using there ORM with sessions instead of direct. Fixed getEpisode function to stop making unrequired scene number conversions on already converted data thats available now from cache.
297 lines
11 KiB
Python
297 lines
11 KiB
Python
# Author: Nic Wolfe <nic@wolfeden.ca>
|
|
# URL: http://code.google.com/p/sickbeard/
|
|
#
|
|
# This file is part of SickRage.
|
|
#
|
|
# SickRage 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.
|
|
#
|
|
# SickRage 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 SickRage. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from __future__ import with_statement
|
|
|
|
import os.path
|
|
import re
|
|
import time
|
|
import threading
|
|
|
|
import sickbeard
|
|
|
|
from sqlalchemy import create_engine, exc
|
|
from sqlalchemy.orm import sessionmaker
|
|
|
|
from sickbeard import encodingKludge as ek
|
|
from sickbeard import logger
|
|
from sickbeard.exceptions import ex
|
|
from sickbeard.common import cpu_presets
|
|
|
|
db_lock = threading.Lock()
|
|
|
|
|
|
def dbFilename(filename="sickbeard.db", suffix=None):
|
|
"""
|
|
@param filename: The sqlite database filename to use. If not specified,
|
|
will be made to be sickbeard.db
|
|
@param suffix: The suffix to append to the filename. A '.' will be added
|
|
automatically, i.e. suffix='v0' will make dbfile.db.v0
|
|
@return: the correct location of the database file.
|
|
"""
|
|
if suffix:
|
|
filename = "%s.%s" % (filename, suffix)
|
|
return ek.ek(os.path.join, sickbeard.DATA_DIR, filename)
|
|
|
|
|
|
class DBConnection:
|
|
def __init__(self, filename="sickbeard.db", suffix=None, row_type=None):
|
|
|
|
self.filename = filename
|
|
|
|
engine = create_engine('sqlite:///' + dbFilename(filename))
|
|
self.connection = engine.connect()
|
|
|
|
def checkDBVersion(self):
|
|
result = None
|
|
|
|
try:
|
|
result = self.select("SELECT db_version FROM db_version")
|
|
except exc.OperationalError, e:
|
|
if "no such table: db_version" in e.args[0]:
|
|
return 0
|
|
|
|
if result:
|
|
return int(result[0]["db_version"])
|
|
else:
|
|
return 0
|
|
|
|
def fetch(self, query, args=None):
|
|
|
|
with db_lock:
|
|
|
|
if query == None:
|
|
return
|
|
|
|
sqlResult = None
|
|
attempt = 0
|
|
|
|
while attempt < 5:
|
|
try:
|
|
if args == None:
|
|
logger.log(self.filename + ": " + query, logger.DB)
|
|
cursor = self.connection.cursor()
|
|
cursor.execute(query)
|
|
sqlResult = cursor.fetchone()[0]
|
|
else:
|
|
logger.log(self.filename + ": " + query + " with args " + str(args), logger.DB)
|
|
cursor = self.connection.cursor()
|
|
cursor.execute(query, args)
|
|
sqlResult = cursor.fetchone()[0]
|
|
|
|
# get out of the connection attempt loop since we were successful
|
|
break
|
|
except exc.OperationalError, e:
|
|
if "unable to open database file" in e.args[0] or "database is locked" in e.args[0]:
|
|
logger.log(u"DB error: " + ex(e), logger.WARNING)
|
|
attempt += 1
|
|
#time.sleep(cpu_presets[sickbeard.CPU_PRESET])
|
|
else:
|
|
logger.log(u"DB error: " + ex(e), logger.ERROR)
|
|
raise
|
|
except exc.DatabaseError, e:
|
|
logger.log(u"Fatal error executing query: " + ex(e), logger.ERROR)
|
|
raise
|
|
|
|
return sqlResult
|
|
|
|
def mass_action(self, querylist, logTransaction=False):
|
|
|
|
with db_lock:
|
|
# remove None types
|
|
querylist = [i for i in querylist if i != None]
|
|
|
|
if querylist == None:
|
|
return
|
|
|
|
sqlResult = []
|
|
attempt = 0
|
|
|
|
while attempt < 5:
|
|
try:
|
|
|
|
with self.connection.begin() as trans:
|
|
for qu in querylist:
|
|
if len(qu) == 1:
|
|
if logTransaction:
|
|
logger.log(qu[0], logger.DEBUG)
|
|
sqlResult.append(self.connection.execute(qu[0]))
|
|
elif len(qu) > 1:
|
|
if logTransaction:
|
|
logger.log(qu[0] + " with args " + str(qu[1]), logger.DEBUG)
|
|
sqlResult.append(self.connection.execute(qu[0], qu[1]))
|
|
|
|
logger.log(u"Transaction with " + str(len(querylist)) + u" queries executed", logger.DEBUG)
|
|
return sqlResult
|
|
except exc.OperationalError, e:
|
|
sqlResult = []
|
|
if trans.connection:
|
|
trans.rollback()
|
|
if "unable to open database file" in e.args[0] or "database is locked" in e.args[0]:
|
|
logger.log(u"DB error: " + ex(e), logger.WARNING)
|
|
attempt += 1
|
|
#time.sleep(cpu_presets[sickbeard.CPU_PRESET])
|
|
else:
|
|
logger.log(u"DB error: " + ex(e), logger.ERROR)
|
|
raise
|
|
except exc.DatabaseError, e:
|
|
sqlResult = []
|
|
if trans.connection:
|
|
trans.rollback()
|
|
logger.log(u"Fatal error executing query: " + ex(e), logger.ERROR)
|
|
raise
|
|
|
|
return sqlResult
|
|
|
|
def action(self, query, args=None):
|
|
|
|
with db_lock:
|
|
|
|
if query == None:
|
|
return
|
|
|
|
sqlResult = None
|
|
attempt = 0
|
|
|
|
while attempt < 5:
|
|
try:
|
|
if args == None:
|
|
logger.log(self.filename + ": " + query, logger.DB)
|
|
sqlResult = self.connection.execute(query)
|
|
else:
|
|
logger.log(self.filename + ": " + query + " with args " + str(args), logger.DB)
|
|
sqlResult = self.connection.execute(query, args)
|
|
# get out of the connection attempt loop since we were successful
|
|
break
|
|
except exc.OperationalError, e:
|
|
if "unable to open database file" in e.args[0] or "database is locked" in e.args[0]:
|
|
logger.log(u"DB error: " + ex(e), logger.WARNING)
|
|
attempt += 1
|
|
#time.sleep(cpu_presets[sickbeard.CPU_PRESET])
|
|
else:
|
|
logger.log(u"DB error: " + ex(e), logger.ERROR)
|
|
raise
|
|
except exc.DatabaseError, e:
|
|
logger.log(u"Fatal error executing query: " + ex(e), logger.ERROR)
|
|
raise
|
|
|
|
return sqlResult
|
|
|
|
|
|
def select(self, query, args=None):
|
|
|
|
sqlResults = self.action(query, args).fetchall()
|
|
|
|
if sqlResults == None:
|
|
return []
|
|
|
|
return sqlResults
|
|
|
|
def upsert(self, tableName, valueDict, keyDict):
|
|
|
|
genParams = lambda myDict: [x + " = ?" for x in myDict.keys()]
|
|
|
|
query = "UPDATE " + tableName + " SET " + ", ".join(genParams(valueDict)) + " WHERE " + " AND ".join(
|
|
genParams(keyDict))
|
|
|
|
result = self.action(query, valueDict.values() + keyDict.values())
|
|
|
|
if not result.rowcount > 0:
|
|
query = "INSERT INTO " + tableName + " (" + ", ".join(valueDict.keys() + keyDict.keys()) + ")" + \
|
|
" VALUES (" + ", ".join(["?"] * len(valueDict.keys() + keyDict.keys())) + ")"
|
|
self.action(query, valueDict.values() + keyDict.values())
|
|
|
|
def tableInfo(self, tableName):
|
|
# FIXME ? binding is not supported here, but I cannot find a way to escape a string manually
|
|
cursor = self.connection.execute("PRAGMA table_info(%s)" % tableName)
|
|
columns = {}
|
|
for column in cursor:
|
|
columns[column['name']] = {'type': column['type']}
|
|
return columns
|
|
|
|
def hasTable(self, tableName):
|
|
return len(self.action("SELECT 1 FROM sqlite_master WHERE name = ?;", (tableName, )).fetchall()) > 0
|
|
|
|
def sanityCheckDatabase(connection, sanity_check):
|
|
sanity_check(connection).check()
|
|
|
|
|
|
class DBSanityCheck(object):
|
|
def __init__(self, connection):
|
|
self.connection = connection
|
|
|
|
def check(self):
|
|
pass
|
|
|
|
# ===============
|
|
# = Upgrade API =
|
|
# ===============
|
|
|
|
def upgradeDatabase(connection, schema):
|
|
logger.log(u"Checking database structure...", logger.MESSAGE)
|
|
_processUpgrade(connection, schema)
|
|
|
|
|
|
def prettyName(class_name):
|
|
return ' '.join([x.group() for x in re.finditer("([A-Z])([a-z0-9]+)", class_name)])
|
|
|
|
|
|
def _processUpgrade(connection, upgradeClass):
|
|
instance = upgradeClass(connection)
|
|
logger.log(u"Checking " + prettyName(upgradeClass.__name__) + " database upgrade", logger.DEBUG)
|
|
if not instance.test():
|
|
logger.log(u"Database upgrade required: " + prettyName(upgradeClass.__name__), logger.MESSAGE)
|
|
try:
|
|
instance.execute()
|
|
except exc.DatabaseError, e:
|
|
print "Error in " + str(upgradeClass.__name__) + ": " + ex(e)
|
|
raise
|
|
logger.log(upgradeClass.__name__ + " upgrade completed", logger.DEBUG)
|
|
else:
|
|
logger.log(upgradeClass.__name__ + " upgrade not required", logger.DEBUG)
|
|
|
|
for upgradeSubClass in upgradeClass.__subclasses__():
|
|
_processUpgrade(connection, upgradeSubClass)
|
|
|
|
|
|
# Base migration class. All future DB changes should be subclassed from this class
|
|
class SchemaUpgrade(object):
|
|
def __init__(self, connection):
|
|
self.connection = connection
|
|
|
|
def hasTable(self, tableName):
|
|
return len(self.connection.action("SELECT 1 FROM sqlite_master WHERE name = ?;", (tableName, )).fetchall()) > 0
|
|
|
|
def hasColumn(self, tableName, column):
|
|
return column in self.connection.tableInfo(tableName)
|
|
|
|
def addColumn(self, table, column, type="NUMERIC", default=0):
|
|
self.connection.action("ALTER TABLE %s ADD %s %s" % (table, column, type))
|
|
self.connection.action("UPDATE %s SET %s = ?" % (table, column), (default,))
|
|
|
|
def checkDBVersion(self):
|
|
result = self.connection.select("SELECT db_version FROM db_version")
|
|
if result:
|
|
return int(result[0]["db_version"])
|
|
else:
|
|
return 0
|
|
|
|
def incDBVersion(self):
|
|
new_version = self.checkDBVersion() + 1
|
|
self.connection.action("UPDATE db_version SET db_version = ?", [new_version])
|
|
return new_version
|