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