review 5.0.0 → 5.3.0

data/lib/review/epubmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2020 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2021 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -13,47 +13,35 @@ require 'review/book'
 require 'review/configure'
 require 'review/converter'
 require 'review/latexbuilder'
-require 'review/yamlloader'
 require 'review/version'
 require 'review/htmltoc'
 require 'review/htmlbuilder'
+require 'review/img_math'
 
 require 'rexml/document'
 require 'rexml/streamlistener'
-require 'epubmaker'
+require 'review/call_hook'
+require 'review/epubmaker/producer'
+require 'review/epubmaker/content'
+require 'review/epubmaker/epubv2'
+require 'review/epubmaker/epubv3'
 require 'review/epubmaker/reviewheaderlistener'
 require 'review/makerhelper'
+require 'review/loggable'
 
 module ReVIEW
   class EPUBMaker
-    include ::EPUBMaker
-    include REXML
     include MakerHelper
+    include Loggable
+    include ReVIEW::CallHook
 
     def initialize
       @producer = nil
       @htmltoc = nil
       @buildlogtxt = 'build-log.txt'
       @logger = ReVIEW.logger
-    end
-
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
-    end
-
-    def log(msg)
-      @logger.debug(msg)
-    end
-
-    def load_yaml(yamlfile)
-      @producer = Producer.new(@config)
-      @producer.load(yamlfile)
-      @config = @producer.config
+      @img_math = nil
+      @basedir = nil
     end
 
     def self.execute(*args)
@@ -85,22 +73,28 @@ module ReVIEW
 
     def execute(*args)
       cmd_config, yamlfile, exportfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
       @config = ReVIEW::Configure.create(maker: 'epubmaker',
                                          yamlfile: yamlfile,
                                          config: cmd_config)
-      load_yaml(yamlfile)
+      @producer = ReVIEW::EPUBMaker::Producer.new(@config)
       update_log_level
-      log("Loaded yaml file (#{yamlfile}).")
+      debug("Loaded yaml file (#{yamlfile}).")
+      @basedir = File.absolute_path(File.dirname(yamlfile))
 
       produce(yamlfile, exportfile)
     end
 
     def update_log_level
       if @config['debug']
-        @logger.level = Logger::DEBUG
-      else
+        if @logger.ttylogger?
+          ReVIEW.logger = nil
+          @logger = ReVIEW.logger(level: 'debug')
+        else
+          @logger.level = Logger::DEBUG
+        end
+      elsif !@logger.ttylogger?
         @logger.level = Logger::INFO
       end
     end
@@ -123,43 +117,43 @@ module ReVIEW
       bookname ||= @config['bookname']
       booktmpname = "#{bookname}-epub"
 
+      @img_math = ReVIEW::ImgMath.new(@config)
       begin
-        @config.check_version(ReVIEW::VERSION)
+        @config.check_version(ReVIEW::VERSION, exception: true)
       rescue ReVIEW::ConfigError => e
         warn e.message
       end
-      log("#{bookname}.epub will be created.")
+      debug("#{bookname}.epub will be created.")
 
       FileUtils.rm_f("#{bookname}.epub")
       if @config['debug']
         FileUtils.rm_rf(booktmpname)
       end
 
-      cleanup_mathimg
+      @img_math.cleanup_mathimg
 
       basetmpdir = build_path
       begin
-        log("Created first temporary directory as #{basetmpdir}.")
+        debug("Created first temporary directory as #{basetmpdir}.")
 
-        call_hook('hook_beforeprocess', basetmpdir)
+        call_hook('hook_beforeprocess', basetmpdir, base_dir: @basedir)
 
         @htmltoc = ReVIEW::HTMLToc.new(basetmpdir)
         ## copy all files into basetmpdir
         copy_stylesheet(basetmpdir)
 
         copy_frontmatter(basetmpdir)
-        call_hook('hook_afterfrontmatter', basetmpdir)
+        call_hook('hook_afterfrontmatter', basetmpdir, base_dir: @basedir)
 
         build_body(basetmpdir, yamlfile)
-        call_hook('hook_afterbody', basetmpdir)
+        call_hook('hook_afterbody', basetmpdir, base_dir: @basedir)
 
         copy_backmatter(basetmpdir)
 
-        math_dir = "./#{@config['imagedir']}/_review_math"
-        if @config['imgmath'] && File.exist?(File.join(math_dir, '__IMGMATH_BODY__.map'))
-          make_math_images(math_dir)
+        if @config['math_format'] == 'imgmath'
+          @img_math.make_math_images
         end
-        call_hook('hook_afterbackmatter', basetmpdir)
+        call_hook('hook_afterbackmatter', basetmpdir, base_dir: @basedir)
 
         ## push contents in basetmpdir into @producer
         push_contents(basetmpdir)
@@ -175,7 +169,7 @@ module ReVIEW
         copy_resources('adv', File.join(basetmpdir, @config['imagedir']))
         copy_resources(@config['fontdir'], File.join(basetmpdir, 'fonts'), @config['font_ext'])
 
-        call_hook('hook_aftercopyimage', basetmpdir)
+        call_hook('hook_aftercopyimage', basetmpdir, base_dir: @basedir)
 
         @producer.import_imageinfo(File.join(basetmpdir, @config['imagedir']), basetmpdir)
         @producer.import_imageinfo(File.join(basetmpdir, 'fonts'), basetmpdir, @config['font_ext'])
@@ -187,35 +181,25 @@ module ReVIEW
           epubtmpdir = File.join(basetmpdir, booktmpname)
           Dir.mkdir(epubtmpdir)
         end
-        log('Call ePUB producer.')
-        @producer.produce("#{bookname}.epub", basetmpdir, epubtmpdir)
-        log('Finished.')
+        debug('Call ePUB producer.')
+        @producer.produce("#{bookname}.epub", basetmpdir, epubtmpdir, base_dir: @basedir)
+        debug('Finished.')
+        @logger.success("built #{bookname}.epub")
       rescue ApplicationError => e
         raise if @config['debug']
-        error(e.message)
+
+        error! e.message
       ensure
         FileUtils.remove_entry_secure(basetmpdir) unless @config['debug']
       end
     end
 
-    def call_hook(hook_name, *params)
-      filename = @config['epubmaker'][hook_name]
-      log("Call #{hook_name}. (#{filename})")
-      if filename.present? && File.exist?(filename) && FileTest.executable?(filename)
-        if ENV['REVIEW_SAFE_MODE'].to_i & 1 > 0
-          warn 'hook is prohibited in safe mode. ignored.'
-        else
-          system(filename, *params)
-        end
-      end
-    end
-
     def verify_target_images(basetmpdir)
       @producer.contents.each do |content|
         case content.media
         when 'application/xhtml+xml'
           File.open("#{basetmpdir}/#{content.file}") do |f|
-            Document.new(File.new(f)).each_element('//img') do |e|
+            REXML::Document.new(File.new(f)).each_element('//img') do |e|
               @config['epubmaker']['force_include_images'].push(e.attributes['src'])
               if e.attributes['src'] =~ /svg\Z/i
                 content.properties.push('svg')
@@ -237,6 +221,7 @@ module ReVIEW
 
     def copy_images(resdir, destdir, allow_exts = nil)
       return nil unless File.exist?(resdir)
+
       allow_exts ||= @config['image_ext']
       FileUtils.mkdir_p(destdir)
       if @config['epubmaker']['verify_target_images'].present?
@@ -249,8 +234,8 @@ module ReVIEW
           end
           basedir = File.dirname(file)
           FileUtils.mkdir_p(File.join(destdir, basedir))
-          log("Copy #{file} to the temporary directory.")
-          FileUtils.cp(file, File.join(destdir, basedir))
+          debug("Copy #{file} to the temporary directory.")
+          FileUtils.cp(file, File.join(destdir, basedir), preserve: true)
         end
       else
         recursive_copy_files(resdir, destdir, allow_exts)
@@ -259,6 +244,7 @@ module ReVIEW
 
     def copy_resources(resdir, destdir, allow_exts = nil)
       return nil unless File.exist?(resdir)
+
       allow_exts ||= @config['image_ext']
       FileUtils.mkdir_p(destdir)
       recursive_copy_files(resdir, destdir, allow_exts)
@@ -268,12 +254,13 @@ module ReVIEW
       Dir.open(resdir) do |dir|
         dir.each do |fname|
           next if fname.start_with?('.')
+
           if FileTest.directory?(File.join(resdir, fname))
             recursive_copy_files(File.join(resdir, fname), File.join(destdir, fname), allow_exts)
           elsif fname =~ /\.(#{allow_exts.join('|')})\Z/i
             FileUtils.mkdir_p(destdir)
-            log("Copy #{resdir}/#{fname} to the temporary directory.")
-            FileUtils.cp(File.join(resdir, fname), destdir)
+            debug("Copy #{resdir}/#{fname} to the temporary directory.")
+            FileUtils.cp(File.join(resdir, fname), destdir, preserve: true)
           end
         end
       end
@@ -282,8 +269,7 @@ module ReVIEW
     def check_compile_status
       return unless @compile_errors
 
-      $stderr.puts 'compile error, No EPUB file output.'
-      exit 1
+      error! 'compile error, No EPUB file output.'
     end
 
     def build_body(basetmpdir, yamlfile)
@@ -298,7 +284,7 @@ module ReVIEW
       basedir = File.dirname(yamlfile)
       base_path = Pathname.new(basedir)
       book = ReVIEW::Book::Base.new(basedir, config: @config)
-      @converter = ReVIEW::Converter.new(book, ReVIEW::HTMLBuilder.new)
+      @converter = ReVIEW::Converter.new(book, ReVIEW::HTMLBuilder.new(img_math: @img_math))
       @compile_errors = nil
 
       book.parts.each do |part|
@@ -325,21 +311,15 @@ module ReVIEW
     end
 
     def build_part(part, basetmpdir, htmlfile)
-      log("Create #{htmlfile} from a template.")
+      debug("Create #{htmlfile} from a template.")
       File.open(File.join(basetmpdir, htmlfile), 'w') do |f|
-        @body = ''
-        @body << %Q(<div class="part">\n)
-        @body << %Q(<h1 class="part-number">#{h(ReVIEW::I18n.t('part', part.number))}</h1>\n)
-        if part.name.strip.present?
-          @body << %Q(<h2 class="part-title">#{h(part.name.strip)}</h2>\n)
-        end
-        @body << %Q(</div>\n)
+        @part_number = part.number
+        @part_title = part.name.strip
+        @body = ReVIEW::Template.generate(path: 'html/_part_body.html.erb', binding: binding)
 
         @language = @producer.config['language']
         @stylesheets = @producer.config['stylesheet']
-        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        tmpl = ReVIEW::Template.load(tmplfile)
-        f.write tmpl.result(binding)
+        f.write ReVIEW::Template.generate(path: template_name, binding: binding)
       end
     end
 
@@ -392,7 +372,7 @@ module ReVIEW
 
       htmlfile = "#{id}.#{@config['htmlext']}"
       write_buildlogtxt(basetmpdir, htmlfile, filename)
-      log("Create #{htmlfile} from #{filename}.")
+      debug("Create #{htmlfile} from #{filename}.")
 
       if @config['params'].present?
         warn %Q('params:' in config.yml is obsoleted.)
@@ -406,8 +386,8 @@ module ReVIEW
         remove_hidden_title(basetmpdir, htmlfile)
       rescue => e
         @compile_errors = true
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
 
@@ -436,12 +416,19 @@ module ReVIEW
       properties
     end
 
-    def write_info_body(basetmpdir, _id, filename, ispart = nil, chaptype = nil)
+    def parse_headlines(path)
       headlines = []
+
+      File.open(path) do |htmlio|
+        REXML::Document.parse_stream(htmlio, ReVIEWHeaderListener.new(headlines))
+      end
+
+      headlines
+    end
+
+    def write_info_body(basetmpdir, _id, filename, ispart = nil, chaptype = nil)
       path = File.join(basetmpdir, filename)
-      htmlio = File.new(path)
-      Document.parse_stream(htmlio, ReVIEWHeaderListener.new(headlines))
-      htmlio.close
+      headlines = parse_headlines(path)
 
       if headlines.empty?
         warn "#{filename} is discarded because there is no heading. Use `=[notoc]' or `=[nodisp]' to exclude headlines from the table of contents."
@@ -480,70 +467,77 @@ module ReVIEW
     def push_contents(_basetmpdir)
       @htmltoc.each_item do |level, file, title, args|
         next if level.to_i > @config['toclevel'] && args[:force_include].nil?
-        log("Push #{file} to ePUB contents.")
 
-        hash = { 'file' => file,
-                 'level' => level.to_i,
-                 'title' => title,
-                 'chaptype' => args[:chaptype] }
+        debug("Push #{file} to ePUB contents.")
+
+        params = { file: file,
+                   level: level.to_i,
+                   title: title,
+                   chaptype: args[:chaptype] }
         if args[:id].present?
-          hash['id'] = args[:id]
+          params[:id] = args[:id]
         end
         if args[:properties].present?
-          hash['properties'] = args[:properties].split(' ')
+          params[:properties] = args[:properties].split(' ') # rubocop:disable Style/RedundantArgument
         end
         if args[:notoc].present?
-          hash['notoc'] = args[:notoc]
+          params[:notoc] = args[:notoc]
         end
-        @producer.contents.push(Content.new(hash))
+        @producer.contents.push(ReVIEW::EPUBMaker::Content.new(**params))
       end
     end
 
     def copy_stylesheet(basetmpdir)
       return if @config['stylesheet'].empty?
+
       @config['stylesheet'].each do |sfile|
         unless File.exist?(sfile)
-          error "#{sfile} is not found."
+          error! "stylesheet: #{sfile} is not found."
         end
-        FileUtils.cp(sfile, basetmpdir)
-        @producer.contents.push(Content.new('file' => sfile))
+        FileUtils.cp(sfile, basetmpdir, preserve: true)
+        @producer.contents.push(ReVIEW::EPUBMaker::Content.new(file: sfile))
+      end
+    end
+
+    def copy_static_file(configname, destdir, destfilename: nil)
+      destfilename ||= @config[configname]
+      unless File.exist?(@config[configname])
+        error! "#{configname}: #{@config[configname]} is not found."
       end
+      FileUtils.cp(@config[configname],
+                   File.join(destdir, destfilename), preserve: true)
     end
 
     def copy_frontmatter(basetmpdir)
       if @config['cover'].present? && File.exist?(@config['cover'])
-        FileUtils.cp(@config['cover'],
-                     File.join(basetmpdir, File.basename(@config['cover'])))
+        copy_static_file('cover', basetmpdir)
       end
 
       if @config['titlepage']
         if @config['titlefile'].nil?
           build_titlepage(basetmpdir, "titlepage.#{@config['htmlext']}")
         else
-          FileUtils.cp(@config['titlefile'],
-                       File.join(basetmpdir, "titlepage.#{@config['htmlext']}"))
+          copy_static_file('titlefile', basetmpdir, destfilename: "titlepage.#{@config['htmlext']}")
         end
         @htmltoc.add_item(1,
                           "titlepage.#{@config['htmlext']}",
-                          @producer.res.v('titlepagetitle'),
+                          ReVIEW::I18n.t('titlepagetitle'),
                           chaptype: 'pre')
       end
 
-      if @config['originaltitlefile'].present? && File.exist?(@config['originaltitlefile'])
-        FileUtils.cp(@config['originaltitlefile'],
-                     File.join(basetmpdir, File.basename(@config['originaltitlefile'])))
+      if @config['originaltitlefile'].present?
+        copy_static_file('originaltitlefile', basetmpdir)
         @htmltoc.add_item(1,
                           File.basename(@config['originaltitlefile']),
-                          @producer.res.v('originaltitle'),
+                          ReVIEW::I18n.t('originaltitle'),
                           chaptype: 'pre')
       end
 
-      if @config['creditfile'].present? && File.exist?(@config['creditfile'])
-        FileUtils.cp(@config['creditfile'],
-                     File.join(basetmpdir, File.basename(@config['creditfile'])))
+      if @config['creditfile'].present?
+        copy_static_file('creditfile', basetmpdir)
         @htmltoc.add_item(1,
                           File.basename(@config['creditfile']),
-                          @producer.res.v('credittitle'),
+                          ReVIEW::I18n.t('credittitle'),
                           chaptype: 'pre')
       end
 
@@ -570,53 +564,42 @@ module ReVIEW
 
         @language = @producer.config['language']
         @stylesheets = @producer.config['stylesheet']
-        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        tmpl = ReVIEW::Template.load(tmplfile)
-        f.write tmpl.result(binding)
+        f.write ReVIEW::Template.generate(path: template_name, binding: binding)
       end
     end
 
     def copy_backmatter(basetmpdir)
       if @config['profile']
-        FileUtils.cp(@config['profile'],
-                     File.join(basetmpdir, File.basename(@config['profile'])))
+        copy_static_file('profile', basetmpdir)
         @htmltoc.add_item(1,
                           File.basename(@config['profile']),
-                          @producer.res.v('profiletitle'),
+                          ReVIEW::I18n.t('profiletitle'),
                           chaptype: 'post')
       end
 
       if @config['advfile']
-        FileUtils.cp(@config['advfile'],
-                     File.join(basetmpdir, File.basename(@config['advfile'])))
+        copy_static_file('advfile', basetmpdir)
         @htmltoc.add_item(1,
                           File.basename(@config['advfile']),
-                          @producer.res.v('advtitle'),
+                          ReVIEW::I18n.t('advtitle'),
                           chaptype: 'post')
       end
 
       if @config['colophon']
-        if @config['colophon'].is_a?(String) # FIXME: should let obsolete this style?
-          FileUtils.cp(@config['colophon'],
-                       File.join(basetmpdir, "colophon.#{@config['htmlext']}"))
-        else
-          filename = File.join(basetmpdir, "colophon.#{@config['htmlext']}")
-          File.open(filename, 'w') do |f|
-            @producer.colophon(f)
-          end
+        if @config['colophon'].is_a?(String)
+          copy_static_file('colophon', basetmpdir, destfilename: "colophon.#{@config['htmlext']}") # override pre-built colophon
         end
         @htmltoc.add_item(1,
                           "colophon.#{@config['htmlext']}",
-                          @producer.res.v('colophontitle'),
+                          ReVIEW::I18n.t('colophontitle'),
                           chaptype: 'post')
       end
 
       if @config['backcover']
-        FileUtils.cp(@config['backcover'],
-                     File.join(basetmpdir, File.basename(@config['backcover'])))
+        copy_static_file('backcover', basetmpdir)
         @htmltoc.add_item(1,
                           File.basename(@config['backcover']),
-                          @producer.res.v('backcovertitle'),
+                          ReVIEW::I18n.t('backcovertitle'),
                           chaptype: 'post')
       end
 
@@ -642,8 +625,10 @@ module ReVIEW
       extre = Regexp.new(pat, Regexp::IGNORECASE)
       Find.find(basetmpdir) do |fname|
         next unless fname.match(extre)
+
         img = ImageSize.path(fname)
         next if img.width.nil? || img.width * img.height <= maxpixels
+
         h = Math.sqrt(img.height * maxpixels / img.width)
         w = maxpixels / h
         fname.sub!("#{basetmpdir}/", '')

data/lib/review/exception.rb

@@ -10,10 +10,23 @@
 
 module ReVIEW
   class Error < ::StandardError; end
+
   class ApplicationError < Error; end
+
   class ConfigError < ApplicationError; end
+
   class CompileError < ApplicationError; end
+
   class SyntaxError < CompileError; end
+
   class FileNotFound < ApplicationError; end
+
   class KeyError < CompileError; end
+
+  class BuildError < ApplicationError
+    def initialize(msg, location: nil)
+      @location = location
+      super(msg)
+    end
+  end
 end