librarian/book2anything.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
   5 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   6 #
   7 from collections import namedtuple
   8 import os.path
   9 import optparse
  10
  11 from librarian import DirDocProvider, ParseError
  12 from librarian.parser import WLDocument
  13
  14
  15 class Option(object):
  16     """Option for optparse. Use it like `optparse.OptionParser.add_option`."""
  17     def __init__(self, *names, **options):
  18         self.names = names
  19         self.options = options
  20
  21     def add(self, parser):
  22         parser.add_option(*self.names, **self.options)
  23
  24     def name(self):
  25         return self.options['dest']
  26
  27     def value(self, options):
  28         return getattr(options, self.name())
  29
  30
  31 class Book2Anything(object):
  32     """A class for creating book2... scripts.
  33
  34     Subclass it for any format you want to convert to.
  35     """
  36     format_name = None # Set format name, like "PDF".
  37     ext = None # Set file extension, like "pdf".
  38     uses_cover = False # Can it add a cover?
  39     cover_optional = True # Only relevant if uses_cover
  40     uses_provider = False # Does it need a DocProvider?
  41     transform = None # Transform method. Uses WLDocument.as_{ext} by default.
  42     parser_options = [] # List of Option objects for additional parser args.
  43     transform_options = [] # List of Option objects for additional transform args.
  44     transform_flags = [] # List of Option objects for supported transform flags.
  45
  46
  47     @classmethod
  48     def run(cls):
  49         # Parse commandline arguments
  50         usage = """Usage: %%prog [options] SOURCE [SOURCE...]
  51         Convert SOURCE files to %s format.""" % cls.format_name
  52
  53         parser = optparse.OptionParser(usage=usage)
  54
  55         parser.add_option('-v', '--verbose',
  56                 action='store_true', dest='verbose', default=False,
  57                 help='print status messages to stdout')
  58         parser.add_option('-d', '--make-dir',
  59                 action='store_true', dest='make_dir', default=False,
  60                 help='create a directory for author and put the output file in it')
  61         parser.add_option('-o', '--output-file',
  62                 dest='output_file', metavar='FILE',
  63                 help='specifies the output file')
  64         parser.add_option('-O', '--output-dir',
  65                 dest='output_dir', metavar='DIR',
  66                 help='specifies the directory for output')
  67         if cls.uses_cover:
  68             if cls.cover_optional:
  69                 parser.add_option('-c', '--with-cover',
  70                         action='store_true', dest='with_cover', default=False,
  71                         help='create default cover')
  72             parser.add_option('-C', '--image-cache',
  73                     dest='image_cache', metavar='URL',
  74                     help='prefix for image download cache' +
  75                         (' (implies --with-cover)' if cls.cover_optional else ''))
  76         for option in cls.parser_options + cls.transform_options + cls.transform_flags:
  77             option.add(parser)
  78
  79         options, input_filenames = parser.parse_args()
  80
  81         if len(input_filenames) < 1:
  82             parser.print_help()
  83             return(1)
  84
  85         # Prepare additional args for parser.
  86         parser_args = {}
  87         for option in cls.parser_options:
  88             parser_args[option.name()] = option.value(options)
  89         # Prepare additional args for transform method.
  90         transform_args = {"verbose": options.verbose}
  91         for option in cls.transform_options:
  92             transform_args[option.name()] = option.value(options)
  93         # Add flags to transform_args, if any.
  94         transform_flags = [flag.name() for flag in cls.transform_flags
  95                     if flag.value(options)]
  96         if transform_flags:
  97             transform_args['flags'] = transform_flags
  98         # Add cover support, if any.
  99         if cls.uses_cover:
 100             from librarian.styles.wolnelektury.cover import WLCover
 101             if options.image_cache:
 102                 def cover_class(*args, **kwargs):
 103                     return WLCover(image_cache=options.image_cache, *args, **kwargs)
 104                 transform_args['cover'] = cover_class
 105             elif not cls.cover_optional or options.with_cover:
 106                 transform_args['cover'] = WLCover
 107
 108
 109         # Do some real work
 110         try:
 111             for main_input in input_filenames:
 112                 if options.verbose:
 113                     print main_input
 114
 115             # Where to find input?
 116             if cls.uses_provider:
 117                 path, fname = os.path.realpath(main_input).rsplit('/', 1)
 118                 provider = DirDocProvider(path)
 119             else:
 120                 provider = None
 121
 122             # Where to write output?
 123             if not (options.output_file or options.output_dir):
 124                 output_file = os.path.splitext(main_input)[0] + '.' + cls.ext
 125             else:
 126                 output_file = None
 127
 128             # Do the transformation.
 129             doc = WLDocument.from_file(main_input, provider=provider, **parser_args)
 130             transform = cls.transform
 131             if transform is None:
 132                 transform = getattr(WLDocument, 'as_%s' % cls.ext)
 133             output = transform(doc, **transform_args)
 134
 135             doc.save_output_file(output,
 136                 output_file, options.output_dir, options.make_dir, cls.ext)
 137
 138         except ParseError, e:
 139             print '%(file)s:%(name)s:%(message)s' % {
 140                 'file': main_input,
 141                 'name': e.__class__.__name__,
 142                 'message': e
 143             }