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             if isinstance(value, basestring):
  24                 value = unicode(value, default_encoding)
  25             values[column] = value
  26     return values
  27
  28
  29 def _guess_case_sensitivity(values):
  30     for value in values.values():
  31         if isinstance(value, basestring) and not value.islower():
  32             return True
  33     return False
  34
  35
  36 def print_count(count):
  37     print _("Found").encode(default_encoding), ":", count
  38
  39
  40 def _search_authors(case_sensitive, search_type, args):
  41     if (args.surname or args.name or args.misc_name) and args.fullname:
  42         sys.stderr.write(
  43             "Cannot search by names and full name at the same time\n")
  44         main_parser.print_help()
  45         sys.exit(1)
  46     expressions = []
  47     values = _get_values(args, 'surname', 'name', 'misc_name', 'id')
  48     if not values:
  49         value = args.fullname
  50         if value:
  51             expressions.append((
  52                 CONCAT(Author.q.surname, ' ', Author.q.name, ' ',
  53                        Author.q.misc_name),
  54                 unicode(value, default_encoding)
  55             ))
  56     if case_sensitive is None:
  57         case_sensitive = _guess_case_sensitivity(values)
  58     authors = search_authors(search_type, case_sensitive, values, expressions,
  59                              orderBy=('surname', 'name', 'misc_name'))
  60     if args.count:
  61         print_count(authors.count())
  62         return
  63     count = 0
  64     for author in authors:
  65         print author.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, args.path)
 150         return
 151     count = 0
 152     for book in books:
 153         print book.title.encode(default_encoding),
 154         if args.verbose >= 1:
 155             print "(id=%d)" % book.id,
 156         print
 157         if args.verbose >= 1:
 158             print " ", _("Author(s)").encode(default_encoding), ":",
 159             for author in book.authors:
 160                 print author.fullname.encode(default_encoding),
 161             print
 162             print " ", _("Genre(s)").encode(default_encoding), ":",
 163             for genre in book.genres:
 164                 print (genre.title or genre.name).encode(default_encoding),
 165             print
 166             if book.series:
 167                 print " ", _("Series").encode(default_encoding), ":",
 168                 print book.series.encode(default_encoding), \
 169                     "(%d)" % book.ser_no
 170
 171         if args.verbose >= 2:
 172             print " ", _("Date").encode(default_encoding), ":", book.date
 173             print " ", _("Language").encode(default_encoding), ":", \
 174                 book.language.name.encode(default_encoding)
 175
 176         if args.verbose >= 3:
 177             print " ", _("Archive").encode(default_encoding), ":", book.archive
 178             print " ", _("File").encode(default_encoding), ":", book.file
 179             print " ", _("Extension").encode(default_encoding), ":", \
 180                 book.extension.name.encode(default_encoding)
 181             print " ", _("Size").encode(default_encoding), ":", \
 182                 book.size, _("bytes").encode(default_encoding)
 183             print " ", _("Deleted").encode(default_encoding), ":", \
 184                 _(str(book.deleted)).encode(default_encoding)
 185         count += 1
 186     print_count(count)
 187
 188
 189 def _search_extensions(case_sensitive, search_type, args):
 190     values = _get_values(args, 'name', 'id')
 191     if case_sensitive is None:
 192         case_sensitive = _guess_case_sensitivity(values)
 193     else:
 194         values = {}
 195     extensions = search_extensions(search_type, case_sensitive, values,
 196                                    orderBy='name')
 197     if args.count:
 198         print_count(extensions.count())
 199         return
 200     count = 0
 201     for ext in extensions:
 202         print ext.name.encode(default_encoding), \
 203             (u"(%s: %d)" % (_('books'), ext.count)).encode(default_encoding),
 204         if args.verbose >= 1:
 205             print "(id=%d)" % ext.id,
 206         print
 207         count += 1
 208     print_count(count)
 209
 210
 211 def _search_genres(case_sensitive, search_type, args):
 212     values = _get_values(args, 'name', 'title', 'id')
 213     if case_sensitive is None:
 214         case_sensitive = _guess_case_sensitivity(values)
 215     genres = search_genres(search_type, case_sensitive, values, orderBy='name')
 216     if args.count:
 217         print_count(genres.count())
 218         return
 219     count = 0
 220     for genre in genres:
 221         names = filter(None, (genre.name, genre.title))
 222         fullname = u' '.join(names)
 223         print fullname.encode(default_encoding), \
 224             (u"(%s: %d)" % (_('books'), genre.count)).encode(default_encoding),
 225         if args.verbose >= 1:
 226             print "(id=%d)" % genre.id,
 227         print
 228         count += 1
 229     print_count(count)
 230
 231
 232 def _search_languages(case_sensitive, search_type, args):
 233     values = _get_values(args, 'name', 'id')
 234     if case_sensitive is None:
 235         case_sensitive = _guess_case_sensitivity(values)
 236     else:
 237         values = {}
 238     languages = search_languages(search_type, case_sensitive, values,
 239                                  orderBy='name')
 240     if args.count:
 241         print_count(languages.count())
 242         return
 243     count = 0
 244     for lang in languages:
 245         print lang.name.encode(default_encoding), \
 246             (u"(%s: %d)" % (_('books'), lang.count)).encode(default_encoding),
 247         if args.verbose >= 1:
 248             print "(id=%d)" % lang.id,
 249         print
 250         count += 1
 251     print_count(count)
 252
 253
 254 if __name__ == '__main__':
 255     main_parser = argparse.ArgumentParser(description='Search')
 256     main_parser.add_argument('-d', '--database', help='database URI')
 257     main_parser.add_argument('-i', '--ignore-case', action='store_true',
 258                              help='ignore case '
 259                              '(default is to guess)')
 260     main_parser.add_argument('-I', '--case-sensitive', action='store_true',
 261                              help='don\'t ignore case')
 262     main_parser.add_argument('-t', '--start', action='store_true',
 263                              help='search substring at the start '
 264                              '(this is the default)')
 265     main_parser.add_argument('-s', '--substring', action='store_true',
 266                              help='search substring anywhere')
 267     main_parser.add_argument('-f', '--full', action='store_true',
 268                              help='match the entire string')
 269     main_parser.add_argument('-c', '--count', action='store_true',
 270                              help='count instead of output')
 271     main_parser.add_argument('-v', '--verbose', action='count',
 272                              help='output more details about books; '
 273                              'repeat for even more details')
 274     subparsers = main_parser.add_subparsers(help='Commands')
 275
 276     parser = subparsers.add_parser('authors', help='Search authors')
 277     parser.add_argument('-s', '--surname', help='search by surname')
 278     parser.add_argument('-n', '--name', help='search by name')
 279     parser.add_argument('-m', '--misc-name', help='search by misc. name')
 280     parser.add_argument('--id', type=int, help='search by database id')
 281     parser.add_argument('fullname', nargs='?', help='search by full name')
 282     parser.set_defaults(func=_search_authors)
 283
 284     parser = subparsers.add_parser('books', help='Search books')
 285     parser.add_argument('-t', '--title', help='search by title')
 286     parser.add_argument('-s', '--series', help='search by series')
 287     parser.add_argument('-a', '--archive', help='search by archive (zip file)')
 288     parser.add_argument('-f', '--file', help='search by file name')
 289     parser.add_argument('-p', '--path', help='path to the library archives')
 290     parser.add_argument('--get', action='store_true',
 291                         help='download exactly one book')
 292     parser.add_argument('--id', type=int, help='search by database id')
 293     parser.add_argument('--surname', help='search by author\'s surname')
 294     parser.add_argument('--name', help='search by author\'s name')
 295     parser.add_argument('--misc-name', help='search by author\'s misc. name')
 296     parser.add_argument('--fullname', help='search by author\'s full name')
 297     parser.add_argument('--aid', type=int, help='search by author\'s id')
 298     parser.add_argument('-e', '--ext', help='search by file extension')
 299     parser.add_argument('--eid', type=int, help='search by extension\'s id')
 300     parser.add_argument('--gname', help='search by genre\'s name')
 301     parser.add_argument('--gtitle', help='search by genre\'s title')
 302     parser.add_argument('--gid', type=int, help='search by genre\'s id')
 303     parser.add_argument('-l', '--lang', help='search by language')
 304     parser.add_argument('--lid', type=int, help='search by language\'s id')
 305     parser.set_defaults(func=_search_books)
 306
 307     parser = subparsers.add_parser('ext', help='Search extensions')
 308     parser.add_argument('name', nargs='?', help='search by name')
 309     parser.add_argument('--id', type=int, help='search by database id')
 310     parser.set_defaults(func=_search_extensions)
 311
 312     parser = subparsers.add_parser('genres', help='Search genres')
 313     parser.add_argument('-n', '--name', help='search by name')
 314     parser.add_argument('-t', '--title', help='search by title')
 315     parser.add_argument('--id', type=int, help='search by database id')
 316     parser.set_defaults(func=_search_genres)
 317
 318     parser = subparsers.add_parser('lang', help='Search languages')
 319     parser.add_argument('name', nargs='?', help='search by name')
 320     parser.add_argument('--id', type=int, help='search by database id')
 321     parser.set_defaults(func=_search_languages)
 322
 323     args = main_parser.parse_args()
 324
 325     if args.case_sensitive:
 326         if args.ignore_case:
 327             sys.stderr.write(
 328                 "Cannot search case sensitive and case insensitive "
 329                 "at the same time\n")
 330             main_parser.print_help()
 331             sys.exit(1)
 332         else:
 333             case_sensitive = True
 334     elif args.ignore_case:
 335         case_sensitive = False
 336     else:
 337         case_sensitive = None  # guess case sensitivity
 338
 339     if int(args.start) + int(args.substring) + int(args.full) > 1:
 340         sys.stderr.write(
 341             "Cannot search case sensitive and case insensitive "
 342             "at the same time\n")
 343         main_parser.print_help()
 344         sys.exit(1)
 345     if args.start:
 346         search_type = 'start'
 347     elif args.substring:
 348         search_type = 'substring'
 349     elif args.full:
 350         search_type = 'full'
 351     else:
 352         search_type = 'start'
 353
 354     open_db(args.database)
 355     args.func(case_sensitive, search_type, args)