mirror of
https://github.com/moparisthebest/SickRage
synced 2024-08-13 16:53:54 -04:00
0d9fbc1ad7
This version of SickBeard uses both TVDB and TVRage to search and gather it's series data from allowing you to now have access to and download shows that you couldn't before because of being locked into only what TheTVDB had to offer. Also this edition is based off the code we used in our XEM editon so it does come with scene numbering support as well as all the other features our XEM edition has to offer. Please before using this with your existing database (sickbeard.db) please make a backup copy of it and delete any other database files such as cache.db and failed.db if present, we HIGHLY recommend starting out with no database files at all to make this a fresh start but the choice is at your own risk! Enjoy!
477 lines
20 KiB
Python
477 lines
20 KiB
Python
#-*- encoding: utf-8 -*-
|
|
"""
|
|
parser.sql.dbschema module (imdb.parser.sql package).
|
|
|
|
This module provides the schema used to describe the layout of the
|
|
database used by the imdb.parser.sql package; functions to create/drop
|
|
tables and indexes are also provided.
|
|
|
|
Copyright 2005-2012 Davide Alberani <da@erlug.linux.it>
|
|
2006 Giuseppe "Cowo" Corbelli <cowo --> lugbs.linux.it>
|
|
|
|
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 2 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, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
"""
|
|
|
|
import logging
|
|
|
|
_dbschema_logger = logging.getLogger('imdbpy.parser.sql.dbschema')
|
|
|
|
|
|
# Placeholders for column types.
|
|
INTCOL = 1
|
|
UNICODECOL = 2
|
|
STRINGCOL = 3
|
|
_strMap = {1: 'INTCOL', 2: 'UNICODECOL', 3: 'STRINGCOL'}
|
|
|
|
class DBCol(object):
|
|
"""Define column objects."""
|
|
def __init__(self, name, kind, **params):
|
|
self.name = name
|
|
self.kind = kind
|
|
self.index = None
|
|
self.indexLen = None
|
|
# If not None, two notations are accepted: 'TableName'
|
|
# and 'TableName.ColName'; in the first case, 'id' is assumed
|
|
# as the name of the pointed column.
|
|
self.foreignKey = None
|
|
if 'index' in params:
|
|
self.index = params['index']
|
|
del params['index']
|
|
if 'indexLen' in params:
|
|
self.indexLen = params['indexLen']
|
|
del params['indexLen']
|
|
if 'foreignKey' in params:
|
|
self.foreignKey = params['foreignKey']
|
|
del params['foreignKey']
|
|
self.params = params
|
|
|
|
def __str__(self):
|
|
"""Class representation."""
|
|
s = '<DBCol %s %s' % (self.name, _strMap[self.kind])
|
|
if self.index:
|
|
s += ' INDEX'
|
|
if self.indexLen:
|
|
s += '[:%d]' % self.indexLen
|
|
if self.foreignKey:
|
|
s += ' FOREIGN'
|
|
if 'default' in self.params:
|
|
val = self.params['default']
|
|
if val is not None:
|
|
val = '"%s"' % val
|
|
s += ' DEFAULT=%s' % val
|
|
for param in self.params:
|
|
if param == 'default': continue
|
|
s += ' %s' % param.upper()
|
|
s += '>'
|
|
return s
|
|
|
|
def __repr__(self):
|
|
"""Class representation."""
|
|
s = '<DBCol(name="%s", %s' % (self.name, _strMap[self.kind])
|
|
if self.index:
|
|
s += ', index="%s"' % self.index
|
|
if self.indexLen:
|
|
s += ', indexLen=%d' % self.indexLen
|
|
if self.foreignKey:
|
|
s += ', foreignKey="%s"' % self.foreignKey
|
|
for param in self.params:
|
|
val = self.params[param]
|
|
if isinstance(val, (unicode, str)):
|
|
val = u'"%s"' % val
|
|
s += ', %s=%s' % (param, val)
|
|
s += ')>'
|
|
return s
|
|
|
|
|
|
class DBTable(object):
|
|
"""Define table objects."""
|
|
def __init__(self, name, *cols, **kwds):
|
|
self.name = name
|
|
self.cols = cols
|
|
# Default values.
|
|
self.values = kwds.get('values', {})
|
|
|
|
def __str__(self):
|
|
"""Class representation."""
|
|
return '<DBTable %s (%d cols, %d values)>' % (self.name,
|
|
len(self.cols), sum([len(v) for v in self.values.values()]))
|
|
|
|
def __repr__(self):
|
|
"""Class representation."""
|
|
s = '<DBTable(name="%s"' % self.name
|
|
col_s = ', '.join([repr(col).rstrip('>').lstrip('<')
|
|
for col in self.cols])
|
|
if col_s:
|
|
s += ', %s' % col_s
|
|
if self.values:
|
|
s += ', values=%s' % self.values
|
|
s += ')>'
|
|
return s
|
|
|
|
|
|
# Default values to insert in some tables: {'column': (list, of, values, ...)}
|
|
kindTypeDefs = {'kind': ('movie', 'tv series', 'tv movie', 'video movie',
|
|
'tv mini series', 'video game', 'episode')}
|
|
companyTypeDefs = {'kind': ('distributors', 'production companies',
|
|
'special effects companies', 'miscellaneous companies')}
|
|
infoTypeDefs = {'info': ('runtimes', 'color info', 'genres', 'languages',
|
|
'certificates', 'sound mix', 'tech info', 'countries', 'taglines',
|
|
'keywords', 'alternate versions', 'crazy credits', 'goofs',
|
|
'soundtrack', 'quotes', 'release dates', 'trivia', 'locations',
|
|
'mini biography', 'birth notes', 'birth date', 'height',
|
|
'death date', 'spouse', 'other works', 'birth name',
|
|
'salary history', 'nick names', 'books', 'agent address',
|
|
'biographical movies', 'portrayed in', 'where now', 'trade mark',
|
|
'interviews', 'article', 'magazine cover photo', 'pictorial',
|
|
'death notes', 'LD disc format', 'LD year', 'LD digital sound',
|
|
'LD official retail price', 'LD frequency response', 'LD pressing plant',
|
|
'LD length', 'LD language', 'LD review', 'LD spaciality', 'LD release date',
|
|
'LD production country', 'LD contrast', 'LD color rendition',
|
|
'LD picture format', 'LD video noise', 'LD video artifacts',
|
|
'LD release country', 'LD sharpness', 'LD dynamic range',
|
|
'LD audio noise', 'LD color information', 'LD group genre',
|
|
'LD quality program', 'LD close captions-teletext-ld-g',
|
|
'LD category', 'LD analog left', 'LD certification',
|
|
'LD audio quality', 'LD video quality', 'LD aspect ratio',
|
|
'LD analog right', 'LD additional information',
|
|
'LD number of chapter stops', 'LD dialogue intellegibility',
|
|
'LD disc size', 'LD master format', 'LD subtitles',
|
|
'LD status of availablility', 'LD quality of source',
|
|
'LD number of sides', 'LD video standard', 'LD supplement',
|
|
'LD original title', 'LD sound encoding', 'LD number', 'LD label',
|
|
'LD catalog number', 'LD laserdisc title', 'screenplay-teleplay',
|
|
'novel', 'adaption', 'book', 'production process protocol',
|
|
'printed media reviews', 'essays', 'other literature', 'mpaa',
|
|
'plot', 'votes distribution', 'votes', 'rating',
|
|
'production dates', 'copyright holder', 'filming dates', 'budget',
|
|
'weekend gross', 'gross', 'opening weekend', 'rentals',
|
|
'admissions', 'studios', 'top 250 rank', 'bottom 10 rank')}
|
|
compCastTypeDefs = {'kind': ('cast', 'crew', 'complete', 'complete+verified')}
|
|
linkTypeDefs = {'link': ('follows', 'followed by', 'remake of', 'remade as',
|
|
'references', 'referenced in', 'spoofs', 'spoofed in',
|
|
'features', 'featured in', 'spin off from', 'spin off',
|
|
'version of', 'similar to', 'edited into',
|
|
'edited from', 'alternate language version of',
|
|
'unknown link')}
|
|
roleTypeDefs = {'role': ('actor', 'actress', 'producer', 'writer',
|
|
'cinematographer', 'composer', 'costume designer',
|
|
'director', 'editor', 'miscellaneous crew',
|
|
'production designer', 'guest')}
|
|
|
|
# Schema of tables in our database.
|
|
# XXX: Foreign keys can be used to create constrains between tables,
|
|
# but they create indexes in the database, and this
|
|
# means poor performances at insert-time.
|
|
DB_SCHEMA = [
|
|
DBTable('Name',
|
|
# namePcodeCf is the soundex of the name in the canonical format.
|
|
# namePcodeNf is the soundex of the name in the normal format, if
|
|
# different from namePcodeCf.
|
|
# surnamePcode is the soundex of the surname, if different from the
|
|
# other two values.
|
|
|
|
# The 'id' column is simply skipped by SQLObject (it's a default);
|
|
# the alternateID attribute here will be ignored by SQLAlchemy.
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('name', UNICODECOL, notNone=True, index='idx_name', indexLen=6),
|
|
DBCol('imdbIndex', UNICODECOL, length=12, default=None),
|
|
DBCol('imdbID', INTCOL, default=None, index='idx_imdb_id'),
|
|
DBCol('gender', STRINGCOL, length=1, default=None),
|
|
DBCol('namePcodeCf', STRINGCOL, length=5, default=None,
|
|
index='idx_pcodecf'),
|
|
DBCol('namePcodeNf', STRINGCOL, length=5, default=None,
|
|
index='idx_pcodenf'),
|
|
DBCol('surnamePcode', STRINGCOL, length=5, default=None,
|
|
index='idx_pcode'),
|
|
DBCol('md5sum', STRINGCOL, length=32, default=None, index='idx_md5')
|
|
),
|
|
|
|
DBTable('CharName',
|
|
# namePcodeNf is the soundex of the name in the normal format.
|
|
# surnamePcode is the soundex of the surname, if different
|
|
# from namePcodeNf.
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('name', UNICODECOL, notNone=True, index='idx_name', indexLen=6),
|
|
DBCol('imdbIndex', UNICODECOL, length=12, default=None),
|
|
DBCol('imdbID', INTCOL, default=None),
|
|
DBCol('namePcodeNf', STRINGCOL, length=5, default=None,
|
|
index='idx_pcodenf'),
|
|
DBCol('surnamePcode', STRINGCOL, length=5, default=None,
|
|
index='idx_pcode'),
|
|
DBCol('md5sum', STRINGCOL, length=32, default=None, index='idx_md5')
|
|
),
|
|
|
|
DBTable('CompanyName',
|
|
# namePcodeNf is the soundex of the name in the normal format.
|
|
# namePcodeSf is the soundex of the name plus the country code.
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('name', UNICODECOL, notNone=True, index='idx_name', indexLen=6),
|
|
DBCol('countryCode', UNICODECOL, length=255, default=None),
|
|
DBCol('imdbID', INTCOL, default=None),
|
|
DBCol('namePcodeNf', STRINGCOL, length=5, default=None,
|
|
index='idx_pcodenf'),
|
|
DBCol('namePcodeSf', STRINGCOL, length=5, default=None,
|
|
index='idx_pcodesf'),
|
|
DBCol('md5sum', STRINGCOL, length=32, default=None, index='idx_md5')
|
|
),
|
|
|
|
DBTable('KindType',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('kind', STRINGCOL, length=15, default=None, alternateID=True),
|
|
values=kindTypeDefs
|
|
),
|
|
|
|
DBTable('Title',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('title', UNICODECOL, notNone=True,
|
|
index='idx_title', indexLen=10),
|
|
DBCol('imdbIndex', UNICODECOL, length=12, default=None),
|
|
DBCol('kindID', INTCOL, notNone=True, foreignKey='KindType'),
|
|
DBCol('productionYear', INTCOL, default=None),
|
|
DBCol('imdbID', INTCOL, default=None, index="idx_imdb_id"),
|
|
DBCol('phoneticCode', STRINGCOL, length=5, default=None,
|
|
index='idx_pcode'),
|
|
DBCol('episodeOfID', INTCOL, default=None, index='idx_epof',
|
|
foreignKey='Title'),
|
|
DBCol('seasonNr', INTCOL, default=None, index="idx_season_nr"),
|
|
DBCol('episodeNr', INTCOL, default=None, index="idx_episode_nr"),
|
|
# Maximum observed length is 44; 49 can store 5 comma-separated
|
|
# year-year pairs.
|
|
DBCol('seriesYears', STRINGCOL, length=49, default=None),
|
|
DBCol('md5sum', STRINGCOL, length=32, default=None, index='idx_md5')
|
|
),
|
|
|
|
DBTable('CompanyType',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('kind', STRINGCOL, length=32, default=None, alternateID=True),
|
|
values=companyTypeDefs
|
|
),
|
|
|
|
DBTable('AkaName',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('personID', INTCOL, notNone=True, index='idx_person',
|
|
foreignKey='Name'),
|
|
DBCol('name', UNICODECOL, notNone=True),
|
|
DBCol('imdbIndex', UNICODECOL, length=12, default=None),
|
|
DBCol('namePcodeCf', STRINGCOL, length=5, default=None,
|
|
index='idx_pcodecf'),
|
|
DBCol('namePcodeNf', STRINGCOL, length=5, default=None,
|
|
index='idx_pcodenf'),
|
|
DBCol('surnamePcode', STRINGCOL, length=5, default=None,
|
|
index='idx_pcode'),
|
|
DBCol('md5sum', STRINGCOL, length=32, default=None, index='idx_md5')
|
|
),
|
|
|
|
DBTable('AkaTitle',
|
|
# XXX: It's safer to set notNone to False, here.
|
|
# alias for akas are stored completely in the AkaTitle table;
|
|
# this means that episodes will set also a "tv series" alias name.
|
|
# Reading the aka-title.list file it looks like there are
|
|
# episode titles with aliases to different titles for both
|
|
# the episode and the series title, while for just the series
|
|
# there are no aliases.
|
|
# E.g.:
|
|
# aka title original title
|
|
# "Series, The" (2005) {The Episode} "Other Title" (2005) {Other Title}
|
|
# But there is no:
|
|
# "Series, The" (2005) "Other Title" (2005)
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('movieID', INTCOL, notNone=True, index='idx_movieid',
|
|
foreignKey='Title'),
|
|
DBCol('title', UNICODECOL, notNone=True),
|
|
DBCol('imdbIndex', UNICODECOL, length=12, default=None),
|
|
DBCol('kindID', INTCOL, notNone=True, foreignKey='KindType'),
|
|
DBCol('productionYear', INTCOL, default=None),
|
|
DBCol('phoneticCode', STRINGCOL, length=5, default=None,
|
|
index='idx_pcode'),
|
|
DBCol('episodeOfID', INTCOL, default=None, index='idx_epof',
|
|
foreignKey='AkaTitle'),
|
|
DBCol('seasonNr', INTCOL, default=None),
|
|
DBCol('episodeNr', INTCOL, default=None),
|
|
DBCol('note', UNICODECOL, default=None),
|
|
DBCol('md5sum', STRINGCOL, length=32, default=None, index='idx_md5')
|
|
),
|
|
|
|
DBTable('RoleType',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('role', STRINGCOL, length=32, notNone=True, alternateID=True),
|
|
values=roleTypeDefs
|
|
),
|
|
|
|
DBTable('CastInfo',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('personID', INTCOL, notNone=True, index='idx_pid',
|
|
foreignKey='Name'),
|
|
DBCol('movieID', INTCOL, notNone=True, index='idx_mid',
|
|
foreignKey='Title'),
|
|
DBCol('personRoleID', INTCOL, default=None, index='idx_cid',
|
|
foreignKey='CharName'),
|
|
DBCol('note', UNICODECOL, default=None),
|
|
DBCol('nrOrder', INTCOL, default=None),
|
|
DBCol('roleID', INTCOL, notNone=True, foreignKey='RoleType')
|
|
),
|
|
|
|
DBTable('CompCastType',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('kind', STRINGCOL, length=32, notNone=True, alternateID=True),
|
|
values=compCastTypeDefs
|
|
),
|
|
|
|
DBTable('CompleteCast',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('movieID', INTCOL, index='idx_mid', foreignKey='Title'),
|
|
DBCol('subjectID', INTCOL, notNone=True, foreignKey='CompCastType'),
|
|
DBCol('statusID', INTCOL, notNone=True, foreignKey='CompCastType')
|
|
),
|
|
|
|
DBTable('InfoType',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('info', STRINGCOL, length=32, notNone=True, alternateID=True),
|
|
values=infoTypeDefs
|
|
),
|
|
|
|
DBTable('LinkType',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('link', STRINGCOL, length=32, notNone=True, alternateID=True),
|
|
values=linkTypeDefs
|
|
),
|
|
|
|
DBTable('Keyword',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
# XXX: can't use alternateID=True, because it would create
|
|
# a UNIQUE index; unfortunately (at least with a common
|
|
# collation like utf8_unicode_ci) MySQL will consider
|
|
# some different keywords identical - like
|
|
# "fiancée" and "fiancee".
|
|
DBCol('keyword', UNICODECOL, notNone=True,
|
|
index='idx_keyword', indexLen=5),
|
|
DBCol('phoneticCode', STRINGCOL, length=5, default=None,
|
|
index='idx_pcode')
|
|
),
|
|
|
|
DBTable('MovieKeyword',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('movieID', INTCOL, notNone=True, index='idx_mid',
|
|
foreignKey='Title'),
|
|
DBCol('keywordID', INTCOL, notNone=True, index='idx_keywordid',
|
|
foreignKey='Keyword')
|
|
),
|
|
|
|
DBTable('MovieLink',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('movieID', INTCOL, notNone=True, index='idx_mid',
|
|
foreignKey='Title'),
|
|
DBCol('linkedMovieID', INTCOL, notNone=True, foreignKey='Title'),
|
|
DBCol('linkTypeID', INTCOL, notNone=True, foreignKey='LinkType')
|
|
),
|
|
|
|
DBTable('MovieInfo',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('movieID', INTCOL, notNone=True, index='idx_mid',
|
|
foreignKey='Title'),
|
|
DBCol('infoTypeID', INTCOL, notNone=True, foreignKey='InfoType'),
|
|
DBCol('info', UNICODECOL, notNone=True),
|
|
DBCol('note', UNICODECOL, default=None)
|
|
),
|
|
|
|
# This table is identical to MovieInfo, except that both 'infoTypeID'
|
|
# and 'info' are indexed.
|
|
DBTable('MovieInfoIdx',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('movieID', INTCOL, notNone=True, index='idx_mid',
|
|
foreignKey='Title'),
|
|
DBCol('infoTypeID', INTCOL, notNone=True, index='idx_infotypeid',
|
|
foreignKey='InfoType'),
|
|
DBCol('info', UNICODECOL, notNone=True, index='idx_info', indexLen=10),
|
|
DBCol('note', UNICODECOL, default=None)
|
|
),
|
|
|
|
DBTable('MovieCompanies',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('movieID', INTCOL, notNone=True, index='idx_mid',
|
|
foreignKey='Title'),
|
|
DBCol('companyID', INTCOL, notNone=True, index='idx_cid',
|
|
foreignKey='CompanyName'),
|
|
DBCol('companyTypeID', INTCOL, notNone=True, foreignKey='CompanyType'),
|
|
DBCol('note', UNICODECOL, default=None)
|
|
),
|
|
|
|
DBTable('PersonInfo',
|
|
DBCol('id', INTCOL, notNone=True, alternateID=True),
|
|
DBCol('personID', INTCOL, notNone=True, index='idx_pid',
|
|
foreignKey='Name'),
|
|
DBCol('infoTypeID', INTCOL, notNone=True, foreignKey='InfoType'),
|
|
DBCol('info', UNICODECOL, notNone=True),
|
|
DBCol('note', UNICODECOL, default=None)
|
|
)
|
|
]
|
|
|
|
|
|
# Functions to manage tables.
|
|
def dropTables(tables, ifExists=True):
|
|
"""Drop the tables."""
|
|
# In reverse order (useful to avoid errors about foreign keys).
|
|
DB_TABLES_DROP = list(tables)
|
|
DB_TABLES_DROP.reverse()
|
|
for table in DB_TABLES_DROP:
|
|
_dbschema_logger.info('dropping table %s', table._imdbpyName)
|
|
table.dropTable(ifExists)
|
|
|
|
def createTables(tables, ifNotExists=True):
|
|
"""Create the tables and insert default values."""
|
|
for table in tables:
|
|
# Create the table.
|
|
_dbschema_logger.info('creating table %s', table._imdbpyName)
|
|
table.createTable(ifNotExists)
|
|
# Insert default values, if any.
|
|
if table._imdbpySchema.values:
|
|
_dbschema_logger.info('inserting values into table %s',
|
|
table._imdbpyName)
|
|
for key in table._imdbpySchema.values:
|
|
for value in table._imdbpySchema.values[key]:
|
|
table(**{key: unicode(value)})
|
|
|
|
def createIndexes(tables, ifNotExists=True):
|
|
"""Create the indexes in the database.
|
|
Return a list of errors, if any."""
|
|
errors = []
|
|
for table in tables:
|
|
_dbschema_logger.info('creating indexes for table %s',
|
|
table._imdbpyName)
|
|
try:
|
|
table.addIndexes(ifNotExists)
|
|
except Exception, e:
|
|
errors.append(e)
|
|
continue
|
|
return errors
|
|
|
|
def createForeignKeys(tables, ifNotExists=True):
|
|
"""Create Foreign Keys.
|
|
Return a list of errors, if any."""
|
|
errors = []
|
|
mapTables = {}
|
|
for table in tables:
|
|
mapTables[table._imdbpyName] = table
|
|
for table in tables:
|
|
_dbschema_logger.info('creating foreign keys for table %s',
|
|
table._imdbpyName)
|
|
try:
|
|
table.addForeignKeys(mapTables, ifNotExists)
|
|
except Exception, e:
|
|
errors.append(e)
|
|
continue
|
|
return errors
|
|
|