scripts/ml-search.py

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