scripts/ml-search.py

   1 #! /usr/bin/env python
   2
   3 from __future__ import print_function
   4 import argparse
   5 import sys
   6 from sqlobject.sqlbuilder import CONCAT
   7
   8 from m_lib.defenc import default_encoding
   9 from m_librarian.compat import string_type
  10 from m_librarian.config import get_config
  11 from m_librarian.db import Author, Book, Extension, Genre, Language, open_db
  12 from m_librarian.download import download
  13 from m_librarian.search import mk_search_conditions, \
  14     search_authors, search_books, \
  15     search_extensions, search_genres, search_languages
  16
  17 from m_librarian.translations import translations
  18 _ = translations.ugettext
  19
  20
  21 def _get_values(args, *columns):
  22     values = {}
  23     for column in columns:
  24         value = getattr(args, column)
  25         if value:
  26             if isinstance(value, string_type):
  27                 value = unicode(value, default_encoding)
  28             values[column] = value
  29     return values
  30
  31
  32 def _guess_case_sensitivity(values):
  33     for value in values.values():
  34         if isinstance(value, string_type) and not value.islower():
  35             return True
  36     return False
  37
  38
  39 def print_count(count):
  40     print(_("Found").encode(default_encoding), ":", count)
  41
  42
  43 def _search_authors(case_sensitive, search_type, args):
  44     if (args.surname or args.name or args.misc_name) and args.fullname:
  45         sys.stderr.write(
  46             "Cannot search by names and full name at the same time\n")
  47         main_parser.print_help()
  48         sys.exit(1)
  49     expressions = []
  50     values = _get_values(args, 'surname', 'name', 'misc_name', 'id')
  51     if not values:
  52         value = args.fullname
  53         if value:
  54             expressions.append((
  55                 CONCAT(Author.q.surname, ' ', Author.q.name, ' ',
  56                        Author.q.misc_name),
  57                 unicode(value, default_encoding)
  58             ))
  59     if case_sensitive is None:
  60         case_sensitive = _guess_case_sensitivity(values)
  61     authors = search_authors(search_type, case_sensitive, values, expressions,
  62                              orderBy=('surname', 'name', 'misc_name'))
  63     if args.count:
  64         print_count(authors.count())
  65         return
  66     count = 0
  67     for author in authors:
  68         print(author.fullname.encode(default_encoding),
  69             (u"(%s: %d)" % (_('books'), author.count))
  70             .encode(default_encoding), end='')
  71         if args.verbose >= 1:
  72             print("(id=%d)" % author.id, end='')
  73         print
  74         count += 1
  75     print_count(count)
  76
  77
  78 def _search_books(case_sensitive, search_type, args):
  79     if args.get and args.get_many:
  80         sys.stderr.write(
  81             "Cannot get one book and many books at the same time\n")
  82         main_parser.print_help()
  83         sys.exit(1)
  84     join_expressions = []
  85     values = _get_values(args, 'title', 'series', 'archive', 'file', 'id')
  86     if case_sensitive is None:
  87         test_values = values.copy()
  88         test_values.update(_get_values(args, 'surname', 'name', 'misc_name',
  89                                        'fullname', 'ext', 'gname', 'gtitle',
  90                                        'lang'))
  91         case_sensitive = _guess_case_sensitivity(test_values)
  92     avalues = _get_values(args, 'surname', 'name', 'misc_name', 'fullname')
  93     if args.aid:
  94         avalues['id'] = args.aid
  95     if avalues:
  96         if (args.surname or args.name or args.misc_name) and args.fullname:
  97             sys.stderr.write(
  98                 "Cannot search by names and full name at the same time\n")
  99             main_parser.print_help()
 100             sys.exit(1)
 101         expressions = []
 102         join_expressions.append(Book.j.authors)
 103         value = args.fullname
 104         if value:
 105             expressions.append((
 106                 CONCAT(Author.q.surname, ' ', Author.q.name, ' ',
 107                        Author.q.misc_name),
 108                 unicode(value, default_encoding)
 109             ))
 110         conditions = mk_search_conditions(
 111             Author, search_type, case_sensitive, avalues, expressions)
 112         join_expressions.extend(conditions)
 113     evalues = {}
 114     if args.ext:
 115         evalues['name'] = args.ext
 116     if args.eid:
 117         evalues['id'] = args.eid
 118     if evalues:
 119         join_expressions.append(Book.j.extension)
 120         conditions = mk_search_conditions(
 121             Extension, search_type, case_sensitive, evalues)
 122         join_expressions.extend(conditions)
 123     gvalues = {}
 124     for column in 'name', 'title':
 125         value = getattr(args, 'g' + column)
 126         if value:
 127             gvalues[column] = unicode(value, default_encoding)
 128     if args.gid:
 129         gvalues['id'] = args.gid
 130     if gvalues:
 131         join_expressions.append(Book.j.genres)
 132         conditions = mk_search_conditions(
 133             Genre, search_type, case_sensitive, gvalues)
 134         join_expressions.extend(conditions)
 135     lvalues = {}
 136     if args.lang:
 137         lvalues['name'] = args.lang
 138     if args.lid:
 139         lvalues['id'] = args.lid
 140     if lvalues:
 141         join_expressions.append(Book.j.language)
 142         conditions = mk_search_conditions(
 143             Language, search_type, case_sensitive, lvalues)
 144         join_expressions.extend(conditions)
 145     books = search_books(search_type, case_sensitive, values, join_expressions,
 146                          orderBy=('series', 'ser_no', 'title'))
 147     if args.count:
 148         print_count(books.count())
 149         return
 150     if args.get_many:
 151         books = books[:args.get_many]
 152     elif args.get:
 153         count = books.count()
 154         if count != 1:
 155             sys.stderr.write("There must be exactly 1 book for --get; "
 156                              "(found %d).\n" % count)
 157             sys.stderr.write("Use --get-many N to download more than one "
 158                              "book.\n")
 159             sys.exit(1)
 160     count = 0
 161     for book in books:
 162         print(book.title.encode(default_encoding), end='')
 163         if args.verbose >= 1:
 164             print("(id=%d)" % book.id, end='')
 165         print
 166         if args.verbose >= 1:
 167             print(" ", _("Author(s)").encode(default_encoding), ":", end='')
 168             for author in book.authors:
 169                 print(author.fullname.encode(default_encoding), end='')
 170             print
 171             print(" ", _("Genre(s)").encode(default_encoding), ":", end='')
 172             for genre in book.genres:
 173                 print((genre.title or genre.name).encode(default_encoding), end='')
 174             print
 175             if book.series:
 176                 print(" ", _("Series").encode(default_encoding), ":", end='')
 177                 print(book.series.encode(default_encoding),
 178                     "(%d)" % book.ser_no)
 179
 180         if args.verbose >= 2:
 181             print(" ", _("Date").encode(default_encoding), ":", book.date)
 182             print(" ", _("Language").encode(default_encoding), ":",
 183                 book.language.name.encode(default_encoding))
 184
 185         if args.verbose >= 3:
 186             print(" ", _("Archive").encode(default_encoding), ":", book.archive)
 187             print(" ", _("File").encode(default_encoding), ":", book.file)
 188             print(" ", _("Extension").encode(default_encoding), ":",
 189                 book.extension.name.encode(default_encoding))
 190             print(" ", _("Size").encode(default_encoding), ":",
 191                 book.size, _("bytes").encode(default_encoding))
 192             print(" ", _("Deleted").encode(default_encoding), ":",
 193                 _(str(book.deleted)).encode(default_encoding))
 194         if args.get or args.get_many:
 195             download(book, args.path, args.format)
 196         count += 1
 197     print_count(count)
 198
 199
 200 def _search_extensions(case_sensitive, search_type, args):
 201     values = _get_values(args, 'name', 'id')
 202     if case_sensitive is None:
 203         case_sensitive = _guess_case_sensitivity(values)
 204     else:
 205         values = {}
 206     extensions = search_extensions(search_type, case_sensitive, values,
 207                                    orderBy='name')
 208     if args.count:
 209         print_count(extensions.count())
 210         return
 211     count = 0
 212     for ext in extensions:
 213         print(ext.name.encode(default_encoding),
 214             (u"(%s: %d)" % (_('books'), ext.count)).encode(default_encoding),
 215             end='')
 216         if args.verbose >= 1:
 217             print("(id=%d)" % ext.id, end='')
 218         print
 219         count += 1
 220     print_count(count)
 221
 222
 223 def _search_genres(case_sensitive, search_type, args):
 224     values = _get_values(args, 'name', 'title', 'id')
 225     if case_sensitive is None:
 226         case_sensitive = _guess_case_sensitivity(values)
 227     genres = search_genres(search_type, case_sensitive, values, orderBy='name')
 228     if args.count:
 229         print_count(genres.count())
 230         return
 231     count = 0
 232     for genre in genres:
 233         names = filter(None, (genre.name, genre.title))
 234         fullname = u' '.join(names)
 235         print(fullname.encode(default_encoding),
 236             (u"(%s: %d)" % (_('books'), genre.count)).encode(default_encoding),
 237             end='')
 238         if args.verbose >= 1:
 239             print("(id=%d)" % genre.id, end='')
 240         print
 241         count += 1
 242     print_count(count)
 243
 244
 245 def _search_languages(case_sensitive, search_type, args):
 246     values = _get_values(args, 'name', 'id')
 247     if case_sensitive is None:
 248         case_sensitive = _guess_case_sensitivity(values)
 249     else:
 250         values = {}
 251     languages = search_languages(search_type, case_sensitive, values,
 252                                  orderBy='name')
 253     if args.count:
 254         print_count(languages.count())
 255         return
 256     count = 0
 257     for lang in languages:
 258         print(lang.name.encode(default_encoding),
 259             (u"(%s: %d)" % (_('books'), lang.count)).encode(default_encoding),
 260             end='')
 261         if args.verbose >= 1:
 262             print("(id=%d)" % lang.id, end='')
 263         print
 264         count += 1
 265     print_count(count)
 266
 267
 268 if __name__ == '__main__':
 269     main_parser = argparse.ArgumentParser(description='Search')
 270     main_parser.add_argument('-C', '--config', help='configuration file')
 271     main_parser.add_argument('-D', '--database', help='database URI')
 272     main_parser.add_argument('-i', '--ignore-case', action='store_true',
 273                              help='ignore case '
 274                              '(default is to guess)')
 275     main_parser.add_argument('-I', '--case-sensitive', action='store_true',
 276                              help='don\'t ignore case')
 277     main_parser.add_argument('-t', '--start', action='store_true',
 278                              help='search substring at the start '
 279                              '(this is the default)')
 280     main_parser.add_argument('-s', '--substring', action='store_true',
 281                              help='search substring anywhere')
 282     main_parser.add_argument('-f', '--full', action='store_true',
 283                              help='match the entire string')
 284     main_parser.add_argument('-c', '--count', action='store_true',
 285                              help='count instead of output')
 286     main_parser.add_argument('-v', '--verbose', action='count',
 287                              help='output more details about books; '
 288                              'repeat for even more details')
 289     subparsers = main_parser.add_subparsers(help='Commands')
 290
 291     parser = subparsers.add_parser('authors', help='Search authors')
 292     parser.add_argument('-s', '--surname', help='search by surname')
 293     parser.add_argument('-n', '--name', help='search by name')
 294     parser.add_argument('-m', '--misc-name', help='search by misc. name')
 295     parser.add_argument('--id', type=int, help='search by database id')
 296     parser.add_argument('fullname', nargs='?', help='search by full name')
 297     parser.set_defaults(func=_search_authors)
 298
 299     parser = subparsers.add_parser('books', help='Search books')
 300     parser.add_argument('-t', '--title', help='search by title')
 301     parser.add_argument('-s', '--series', help='search by series')
 302     parser.add_argument('-a', '--archive', help='search by archive (zip file)')
 303     parser.add_argument('-f', '--file', help='search by file name')
 304     parser.add_argument('--id', type=int, help='search by database id')
 305     parser.add_argument('--surname', help='search by author\'s surname')
 306     parser.add_argument('--name', help='search by author\'s name')
 307     parser.add_argument('--misc-name', help='search by author\'s misc. name')
 308     parser.add_argument('--fullname', help='search by author\'s full name')
 309     parser.add_argument('--aid', type=int, help='search by author\'s id')
 310     parser.add_argument('-e', '--ext', help='search by file extension')
 311     parser.add_argument('--eid', type=int, help='search by extension\'s id')
 312     parser.add_argument('--gname', help='search by genre\'s name')
 313     parser.add_argument('--gtitle', help='search by genre\'s title')
 314     parser.add_argument('--gid', type=int, help='search by genre\'s id')
 315     parser.add_argument('-l', '--lang', help='search by language')
 316     parser.add_argument('--lid', type=int, help='search by language\'s id')
 317     parser.add_argument('-P', '--path', help='path to the library archives')
 318     parser.add_argument('-F', '--format',
 319                         help='download format, default is %%f')
 320     parser.add_argument('--get', action='store_true',
 321                         help='download exactly one book')
 322     parser.add_argument('--get-many', type=int,
 323                         help='download at most this many books')
 324     parser.set_defaults(func=_search_books)
 325
 326     parser = subparsers.add_parser('ext', help='Search extensions')
 327     parser.add_argument('name', nargs='?', help='search by name')
 328     parser.add_argument('--id', type=int, help='search by database id')
 329     parser.set_defaults(func=_search_extensions)
 330
 331     parser = subparsers.add_parser('genres', help='Search genres')
 332     parser.add_argument('-n', '--name', help='search by name')
 333     parser.add_argument('-t', '--title', help='search by title')
 334     parser.add_argument('--id', type=int, help='search by database id')
 335     parser.set_defaults(func=_search_genres)
 336
 337     parser = subparsers.add_parser('lang', help='Search languages')
 338     parser.add_argument('name', nargs='?', help='search by name')
 339     parser.add_argument('--id', type=int, help='search by database id')
 340     parser.set_defaults(func=_search_languages)
 341
 342     args = main_parser.parse_args()
 343
 344     if args.config:
 345         get_config(args.config)  # Get and cache config file
 346
 347     if args.case_sensitive:
 348         if args.ignore_case:
 349             sys.stderr.write(
 350                 "Cannot search case sensitive and case insensitive "
 351                 "at the same time\n")
 352             main_parser.print_help()
 353             sys.exit(1)
 354         else:
 355             case_sensitive = True
 356     elif args.ignore_case:
 357         case_sensitive = False
 358     else:
 359         case_sensitive = None  # guess case sensitivity
 360
 361     if int(args.start) + int(args.substring) + int(args.full) > 1:
 362         sys.stderr.write(
 363             "Cannot search case sensitive and case insensitive "
 364             "at the same time\n")
 365         main_parser.print_help()
 366         sys.exit(1)
 367     if args.start:
 368         search_type = 'start'
 369     elif args.substring:
 370         search_type = 'substring'
 371     elif args.full:
 372         search_type = 'full'
 373     else:
 374         search_type = 'start'
 375
 376     open_db(args.database)
 377     args.func(case_sensitive, search_type, args)