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