m_librarian/db.py

   1 #! /usr/bin/env python
   2
   3 from __future__ import print_function
   4 import os
   5 from sqlobject import SQLObject, StringCol, UnicodeCol, IntCol, BoolCol, \
   6     ForeignKey, DateCol, DatabaseIndex, RelatedJoin, \
   7     connectionForURI, sqlhub, SQLObjectNotFound, dberrors
   8 from .compat import string_type
   9 from .config import get_config
  10
  11 __all__ = ['Author', 'Book', 'Extension', 'Genre', 'Language',
  12            'AuthorBook', 'BookGenre', 'open_db', 'init_db',
  13            'insert_name', 'insert_author', 'update_counters',
  14            ]
  15
  16
  17 class Author(SQLObject):
  18     surname = UnicodeCol(notNull=True)
  19     name = UnicodeCol(notNull=True)
  20     misc_name = UnicodeCol(notNull=True)
  21     count = IntCol(notNull=True)
  22     books = RelatedJoin('Book', otherColumn='book_id',
  23                         intermediateTable='author_book',
  24                         createRelatedTable=False)
  25
  26     @property
  27     def fullname(self):
  28         fullnames = filter(None, (self.surname, self.name, self.misc_name))
  29         return ' '.join(fullnames)
  30
  31     full_name_idx = DatabaseIndex(surname, name, misc_name, unique=True)
  32     count_idx = DatabaseIndex(count)
  33
  34
  35 class AuthorBook(SQLObject):
  36     class sqlmeta:
  37         table = "author_book"
  38     author = ForeignKey('Author', notNull=True, cascade=True)
  39     book = ForeignKey('Book', notNull=True, cascade=True)
  40     author_idx = DatabaseIndex(author)
  41     book_idx = DatabaseIndex(book)
  42     main_idx = DatabaseIndex(author, book, unique=True)
  43
  44
  45 class Book(SQLObject):
  46     authors = RelatedJoin('Author',
  47                           intermediateTable='author_book',
  48                           createRelatedTable=False)
  49     genres = RelatedJoin('Genre',
  50                          intermediateTable='book_genre',
  51                          createRelatedTable=False)
  52     title = UnicodeCol(notNull=True)
  53     series = UnicodeCol(notNull=True)
  54     ser_no = IntCol()
  55     archive = StringCol(notNull=True)
  56     file = UnicodeCol(notNull=True)
  57     size = IntCol(notNull=True)
  58     lib_id = StringCol(notNull=True)
  59     deleted = BoolCol(notNull=True)
  60     extension = ForeignKey('Extension', notNull=True)
  61     date = DateCol(notNull=True)
  62     language = ForeignKey('Language')
  63     title_idx = DatabaseIndex(title)
  64     series_idx = DatabaseIndex(series)
  65     ser_no_idx = DatabaseIndex(ser_no)
  66     archive_idx = DatabaseIndex(archive)
  67     archive_file_idx = DatabaseIndex(archive, file, unique=True)
  68     file_idx = DatabaseIndex(file)
  69     size_idx = DatabaseIndex(size)
  70     deleted_idx = DatabaseIndex(deleted)
  71     extension_idx = DatabaseIndex(extension)
  72     date_idx = DatabaseIndex(date)
  73     language_idx = DatabaseIndex(language)
  74
  75     @property
  76     def author1(self):
  77         return self.authors[0].fullname
  78
  79     @property
  80     def author_list(self):
  81         return u', '.join([a.fullname for a in self.authors])
  82
  83     @property
  84     def genre1name(self):
  85         return self.genres[0].name
  86
  87     @property
  88     def genre1title(self):
  89         return self.genres[0].title
  90
  91     @property
  92     def genre_name_list(self):
  93         return u', '.join([g.name for g in self.genres])
  94
  95     @property
  96     def genre_title_list(self):
  97         return u', '.join([g.title for g in self.genres])
  98
  99
 100 class BookGenre(SQLObject):
 101     class sqlmeta:
 102         table = "book_genre"
 103     book = ForeignKey('Book', notNull=True, cascade=True)
 104     genre = ForeignKey('Genre', notNull=True, cascade=True)
 105     book_idx = DatabaseIndex(book)
 106     genre_idx = DatabaseIndex(genre)
 107     main_idx = DatabaseIndex(book, genre, unique=True)
 108
 109
 110 class Extension(SQLObject):
 111     name = UnicodeCol(notNull=True, unique=True)
 112     count = IntCol(notNull=True)
 113     count_idx = DatabaseIndex(count)
 114
 115
 116 class Genre(SQLObject):
 117     name = UnicodeCol(notNull=True, unique=True)
 118     title = UnicodeCol(notNull=True)
 119     count = IntCol(notNull=True)
 120     books = RelatedJoin('Book', otherColumn='book_id',
 121                         intermediateTable='book_genre',
 122                         createRelatedTable=False)
 123     title_idx = DatabaseIndex(title)
 124     count_idx = DatabaseIndex(count)
 125
 126
 127 class Language(SQLObject):
 128     name = UnicodeCol(notNull=True, unique=True)
 129     count = IntCol(notNull=True)
 130     count_idx = DatabaseIndex(count)
 131
 132
 133 def _find_sqlite_db_dirs_posix():
 134     db_dirs = []
 135     if 'XDG_CACHE_HOME' in os.environ:
 136         db_dirs.append(os.environ['XDG_CACHE_HOME'])
 137     home_cache = os.path.expanduser('~/.cache')
 138     if home_cache not in db_dirs:
 139         db_dirs.append(home_cache)
 140     return db_dirs
 141
 142
 143 def find_sqlite_db_dirs():
 144     if os.name == 'posix':
 145         return _find_sqlite_db_dirs_posix()
 146     raise OSError("Unknow OS")
 147
 148
 149 def find_sqlite_dburi(db_dirs=None):
 150     if db_dirs is None:
 151         db_dirs = find_sqlite_db_dirs()
 152     for d in db_dirs:
 153         db_file = os.path.join(d, 'm_librarian.sqlite')
 154         if os.path.exists(db_file):
 155             break
 156     else:
 157         # octal; -rw-------;
 158         # make the database file/directory readable/writeable only by the user
 159         os.umask(0o66)
 160         db_dir = db_dirs[0]
 161         try:
 162             os.makedirs(db_dir)
 163         except OSError:  # Perhaps already exists
 164             pass
 165         db_file = os.path.join(db_dir, 'm_librarian.sqlite')
 166
 167     return 'sqlite://%s' % db_file.replace(os.sep, '/')
 168
 169
 170 def open_db(db_uri=None):
 171     if db_uri is None:
 172         db_uri = get_config().get('database', 'URI') or find_sqlite_dburi()
 173
 174     if '://' not in db_uri:
 175         db_uri = 'sqlite://' + os.path.abspath(db_uri).replace(os.sep, '/')
 176
 177     sqlhub.processConnection = connection = connectionForURI(db_uri)
 178
 179     if connection.dbName == 'sqlite':
 180         def lower(s):
 181             if isinstance(s, string_type):
 182                 return s.lower()
 183             return s
 184
 185         sqlite = connection.module
 186
 187         class MLConnection(sqlite.Connection):
 188             def __init__(self, *args, **kwargs):
 189                 super(MLConnection, self).__init__(*args, **kwargs)
 190                 self.create_function('lower', 1, lower)
 191
 192         # This hack must be done at the very beginning, before the first query
 193         connection._connOptions['factory'] = MLConnection
 194
 195         # Speedup SQLite connection
 196         connection.query("PRAGMA synchronous=OFF")
 197         connection.query("PRAGMA count_changes=OFF")
 198         connection.query("PRAGMA journal_mode=MEMORY")
 199         connection.query("PRAGMA temp_store=MEMORY")
 200
 201
 202 def init_db():
 203     try:
 204         Book.select()[0]
 205     except IndexError:  # Table exists but is empty
 206         return
 207     except dberrors.Error:
 208         for table in Author, Extension, Genre, Language, Book, \
 209                 AuthorBook, BookGenre:
 210             table.createTable()
 211     else:
 212         return
 213
 214
 215 def insert_name(table, name, **kw):
 216     try:
 217         return table.byName(name)
 218     except SQLObjectNotFound:
 219         return table(name=name, count=0, **kw)
 220
 221
 222 def insert_author(surname, name, misc_name):
 223     try:
 224         return Author.full_name_idx.get(
 225             surname=surname, name=name, misc_name=misc_name)
 226     except SQLObjectNotFound:
 227         return Author(surname=surname, name=name, misc_name=misc_name, count=0)
 228
 229
 230 def update_counters(pbar_cb=None):
 231     if pbar_cb:
 232         count = 0
 233         for table in Author, Extension, Genre, Language:
 234             count += table.select().count()
 235         pbar_cb.set_max(count)
 236
 237     if pbar_cb:
 238         count = 0
 239
 240     for author in Author.select():
 241         author.count = AuthorBook.select(AuthorBook.q.author == author).count()
 242         if pbar_cb:
 243             count += 1
 244             pbar_cb.display(count)
 245
 246     for ext in Extension.select():
 247         ext.count = Book.select(Book.q.extension == ext.id).count()
 248         if pbar_cb:
 249             count += 1
 250             pbar_cb.display(count)
 251
 252     for genre in Genre.select():
 253         genre.count = BookGenre.select(BookGenre.q.genre == genre).count()
 254         if pbar_cb:
 255             count += 1
 256             pbar_cb.display(count)
 257
 258     for language in Language.select():
 259         language.count = Book.select(Book.q.language == language.id).count()
 260         if pbar_cb:
 261             count += 1
 262             pbar_cb.display(count)
 263
 264     if pbar_cb:
 265         pbar_cb.close()
 266
 267
 268 def test():
 269     db_dirs = find_sqlite_db_dirs()
 270     print("DB dirs:", db_dirs)
 271     print("DB URI:", find_sqlite_dburi())
 272
 273
 274 if __name__ == '__main__':
 275     test()