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