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