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