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