review 5.0.0 → 5.3.0

data/lib/review/epubmaker/epubv3.rb

@@ -0,0 +1,231 @@
+# = epubv3.rb -- EPUB version 3 producer.
+#
+# Copyright (c) 2010-2017 Kenshi Muto
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+
+require 'review/epubmaker/epubcommon'
+require 'review/epubmaker/zip_exporter'
+require 'review/call_hook'
+
+module ReVIEW
+  class EPUBMaker
+    # EPUBv3 is EPUB version 3 producer.
+    class EPUBv3 < EPUBCommon
+      include ReVIEW::CallHook
+
+      DC_ITEMS = %w[title language date type format source description relation coverage subject rights]
+      CREATOR_ATTRIBUTES = %w[a-adp a-ann a-arr a-art a-asn a-aqt a-aft a-aui a-ant a-bkp a-clb a-cmm a-csl a-dsr a-edt a-ill a-lyr a-mdc a-mus a-nrt a-oth a-pht a-prt a-red a-rev a-spn a-ths a-trc a-trl aut]
+      CONTRIBUTER_ATTRIBUTES = %w[adp ann arr art asn aqt aft aui ant bkp clb cmm csl dsr edt ill lyr mdc mus nrt oth pbd pbl pht prt red rev spn ths trc trl]
+
+      # Construct object with parameter hash +config+ and message resource hash +res+.
+      def initialize(producer)
+        super
+        @opf_prefix = {}
+        if config['opf_prefix'].present?
+          config['opf_prefix'].each { |k, v| @opf_prefix[k] = v }
+        end
+      end
+
+      # Return opf file content.
+      def opf
+        @opf_metainfo = opf_metainfo
+        @opf_coverimage = opf_coverimage
+        @opf_manifest = opf_manifest
+        @opf_toc = opf_tocx
+        @package_attrs = ''
+
+        if @opf_prefix && @opf_prefix.size > 0
+          prefixes_str = @opf_prefix.map { |k, v| %Q(#{k}: #{v}) }.join(' ')
+          @package_attrs << %Q( prefix="#{prefixes_str}")
+        end
+
+        ReVIEW::Template.generate(path: './opf/epubv3.opf.erb', binding: binding)
+      end
+
+      def opf_metainfo
+        @dc_items = opf_dc_items
+
+        # creator (should be array)
+        @creators = opf_creators
+
+        # contributor (should be array)
+        @contributers = opf_contributers
+
+        ReVIEW::Template.generate(path: './opf/opf_metainfo_epubv3.opf.erb', binding: binding)
+      end
+
+      def opf_dc_items
+        DC_ITEMS.map do |item|
+          next unless config[item]
+
+          case config[item]
+          when Array
+            config[item].map.with_index do |v, i|
+              if v.is_a?(Hash)
+                { tag: "dc:#{item}",
+                  id: "#{item}-#{i}",
+                  val: v['name'],
+                  refines: v.map { |name, val| { name: name, val: val } }.delete_if { |h| h[:name] == 'name' } }
+              else
+                { tag: "dc:#{item}", id: "#{item}-#{i}", val: v.to_s, refines: [] }
+              end
+            end
+          when Hash
+            { tag: "dc:#{item}",
+              id: item.to_s,
+              val: config[item]['name'],
+              refines: config[item].map { |name, val| { name: name, val: val } }.delete_if { |h| h[:name] == 'name' } }
+          else
+            { tag: "dc:#{item}",
+              id: item.to_s,
+              val: config[item].to_s,
+              refines: [] }
+          end
+        end.flatten.compact
+      end
+
+      def opf_creators
+        CREATOR_ATTRIBUTES.map do |role|
+          next unless config[role]
+
+          config[role].map.with_index do |v, i|
+            case v
+            when Hash
+              refines = v.map { |name, val| { id: "#{role.sub('a-', '')}-#{i}", property: name.to_s, scheme: nil, val: val } }.delete_if { |h| h[:property] == 'name' }
+
+              {
+                id: "#{role}-#{i}",
+                val: v['name'],
+                refines: [
+                  { id: "#{role}-#{i}", property: 'role', scheme: 'marc:relators', val: role.sub('a-', '') }
+                ].concat(refines)
+              }
+            else
+              {
+                id: "#{role}-#{i}",
+                val: v,
+                refines: [
+                  { id: "#{role}-#{i}", property: 'role', scheme: 'marc:relators', val: role.sub('a-', '') }
+                ]
+              }
+            end
+          end
+        end.flatten.compact
+      end
+
+      def opf_contributers
+        CONTRIBUTER_ATTRIBUTES.map do |role|
+          next unless config[role]
+
+          config[role].map.with_index do |v, i|
+            case v
+            when Hash
+              refines = v.map { |name, val| { id: "#{role}-#{i}", property: name, scheme: nil, val: val } }.delete_if { |h| h[:property] == 'name' }
+              contributer = {
+                id: "#{role}-#{i}",
+                val: v['name'],
+                refines: [
+                  { id: "#{role}-#{i}", property: 'role', scheme: 'marc:relators', val: role }
+                ].concat(refines)
+              }
+            else
+              contributer = {
+                id: "#{role}-#{i}",
+                val: v,
+                refines: [
+                  { id: "#{role}-#{i}", property: 'role', scheme: 'marc:relators', val: role }
+                ]
+              }
+            end
+            if %w[prt pbl].include?(role)
+              contributer[:pub_id] = "pub-#{role}-#{i}"
+              case v
+              when Hash
+                contributer[:pub_val] = v['name']
+                pub_refines = v.map { |name, val| { id: "pub-#{role}-#{i}", property: name, scheme: nil, val: val } }.delete_if { |h| h[:property] == 'name' }
+                contributer[:pub_refines] = [
+                  { id: "pub-#{role}-#{i}", property: 'role', scheme: 'marc:relators', val: role }
+                ].concat(pub_refines)
+              else
+                contributer[:pub_val] = v
+                contributer[:pub_refines] = [
+                  { id: "pub-#{role}-#{i}", property: 'role', scheme: 'marc:relators', val: 'prt' }
+                ]
+              end
+            end
+
+            contributer
+          end
+        end.flatten.compact
+      end
+
+      def opf_manifest
+        if config['coverimage']
+          @coverimage = contents.find { |content| content.coverimage?(config['coverimage']) } # @coverimage can be nil
+        end
+        @items = if @coverimage
+                   contents.find_all { |content| content.file !~ /#/ && content.id != @coverimage.id } # skip subgroup, or @coverimage
+                 else
+                   contents.find_all { |content| content.file !~ /#/ }
+                 end
+
+        ReVIEW::Template.generate(path: './opf/opf_manifest_epubv3.opf.erb', binding: binding)
+      end
+
+      def opf_tocx
+        @cover_linear = if config['epubmaker']['cover_linear'] && config['epubmaker']['cover_linear'] != 'no'
+                          'yes'
+                        else
+                          'no'
+                        end
+        @tocx_contents = []
+        toc = nil
+        contents.each do |item|
+          next if item.media !~ /xhtml\+xml/ # skip non XHTML
+
+          @tocx_contents << item
+        end
+
+        ReVIEW::Template.generate(path: './opf/opf_tocx_epubv3.opf.erb', binding: binding)
+      end
+
+      def ncx(indentarray)
+        ncx_main = if config['epubmaker']['flattoc'].nil?
+                     hierarchy_ncx('ol')
+                   else
+                     flat_ncx('ol', config['epubmaker']['flattocindent'])
+                   end
+
+        @body = <<-EOT
+  <nav xmlns:epub="http://www.idpf.org/2007/ops" epub:type="toc" id="toc">
+  <h1 class="toc-title">#{h(ReVIEW::I18n.t('toctitle'))}</h1>
+#{ncx_main}  </nav>
+      EOT
+
+        @title = h(ReVIEW::I18n.t('toctitle'))
+        @language = config['language']
+        @stylesheets = config['stylesheet']
+        ReVIEW::Template.generate(path: './html/layout-html5.html.erb', binding: binding)
+      end
+
+      # Produce EPUB file +epubfile+.
+      # +work_dir+ points the directory has contents.
+      # +tmpdir+ defines temporary directory.
+      def produce(epubfile, work_dir, tmpdir, base_dir:)
+        produce_write_common(work_dir, tmpdir)
+
+        toc_file = "#{tmpdir}/OEBPS/#{config['bookname']}-toc.#{config['htmlext']}"
+        File.write(toc_file, ncx(config['epubmaker']['ncxindent']))
+
+        call_hook('hook_prepack', tmpdir, base_dir: base_dir)
+        expoter = ReVIEW::EPUBMaker::ZipExporter.new(tmpdir, config)
+        expoter.export_zip(epubfile)
+      end
+    end
+  end
+end

data/lib/review/epubmaker/producer.rb

@@ -0,0 +1,167 @@
+# = producer.rb -- EPUB producer.
+#
+# Copyright (c) 2010-2021 Kenshi Muto
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+# == Quick usage
+#  require 'review/epubmaker'
+#  producer = ReVIEW::EPUBMaker::Producer.new(config)
+#  producer.contents.push(ReVIEW::EPUBMaker::Content.new(file: 'ch01.xhtml'))
+#  producer.contents.push(ReVIEW::EPUBMaker::Content.new(file: 'ch02.xhtml'))
+#   ...
+#  producer.import_imageinfo('images')
+#  producer.produce(epub_filename)
+
+require 'tmpdir'
+require 'fileutils'
+require 'review/yamlloader'
+require 'review/epubmaker/content'
+require 'review/epubmaker/epubv2'
+require 'review/epubmaker/epubv3'
+require 'review/i18n'
+require 'review/configure'
+require 'review/extentions/hash'
+require 'review/loggable'
+
+module ReVIEW
+  class EPUBMaker
+    # EPUBMaker produces EPUB file.
+    class Producer
+      include Loggable
+
+      # Array of content objects.
+      attr_accessor :contents
+      # Parameter hash.
+      attr_accessor :config
+      # Message resource object.
+      attr_reader :res
+
+      # Construct producer object.
+      # +config+ takes initial parameter hash.
+      def initialize(config)
+        @contents = []
+        @config = config
+        @config.maker = 'epubmaker'
+        @epub = nil
+        @res = ReVIEW::I18n
+        @logger = ReVIEW.logger
+        modify_config
+      end
+
+      # Modify parameters for EPUB specific.
+      def modify_config
+        if @config['epubversion'] >= 3
+          @config['htmlversion'] = 5
+        end
+
+        @config['title'] ||= @config['booktitle']
+        @config['cover'] ||= "#{@config['bookname']}.#{@config['htmlext']}"
+
+        %w[bookname title].each do |k|
+          unless @config[k]
+            raise "Key #{k} must have a value. Abort."
+          end
+        end
+
+        case @config['epubversion'].to_i
+        when 2
+          @epub = ReVIEW::EPUBMaker::EPUBv2.new(self)
+        when 3
+          @epub = ReVIEW::EPUBMaker::EPUBv3.new(self)
+        else
+          raise "Invalid EPUB version (#{@config['epubversion']}.)"
+        end
+
+        ReVIEW::I18n.locale = @config['language']
+        support_legacy_maker
+      end
+
+      # Add informations of figure files in +path+ to contents array.
+      # +base+ defines a string to remove from path name.
+      def import_imageinfo(path, base = nil, allow_exts = nil)
+        return nil unless File.exist?(path)
+
+        allow_exts ||= @config['image_ext']
+        Dir.foreach(path) do |f|
+          next if f.start_with?('.')
+
+          if f =~ /\.(#{allow_exts.join('|')})\Z/i
+            path.chop! if path =~ %r{/\Z}
+            if base.nil?
+              @contents.push(ReVIEW::EPUBMaker::Content.new(file: "#{path}/#{f}"))
+            else
+              @contents.push(ReVIEW::EPUBMaker::Content.new(file: "#{path.sub(base + '/', '')}/#{f}"))
+            end
+          end
+          if FileTest.directory?("#{path}/#{f}")
+            import_imageinfo("#{path}/#{f}", base)
+          end
+        end
+      end
+
+      alias_method :importImageInfo, :import_imageinfo
+
+      # Produce EPUB file +epubfile+.
+      # +work_dir+ points the directory has contents (default: current directory.)
+      # +tmpdir+ defines temporary directory.
+      # +base_dir+ is original root dir.
+      def produce(epubfile, work_dir, tmpdir = nil, base_dir: nil)
+        current = Dir.pwd
+        base_dir ||= current
+
+        # use Dir to solve a path for Windows (see #1011)
+        new_tmpdir = Dir[File.join(tmpdir.nil? ? Dir.mktmpdir : tmpdir)][0]
+        if epubfile !~ %r{\A/}
+          epubfile = "#{current}/#{epubfile}"
+        end
+
+        # FIXME: error check
+        File.unlink(epubfile) if File.exist?(epubfile)
+
+        begin
+          @epub.produce(epubfile, work_dir, new_tmpdir, base_dir: base_dir)
+        ensure
+          FileUtils.rm_r(new_tmpdir) if tmpdir.nil?
+        end
+      end
+
+      private
+
+      def support_legacy_maker
+        # legacy review-epubmaker support
+        if @config['flag_legacy_coverfile'].nil? && !@config['coverfile'].nil? && File.exist?(@config['coverfile'])
+          @config['cover'] = "#{@config['bookname']}-cover.#{@config['htmlext']}"
+          @epub.legacy_cover_and_title_file(@config['coverfile'], @config['cover'])
+          @config['flag_legacy_coverfile'] = true
+          warn %Q(Parameter 'coverfile' is obsolete. Please use 'cover' and make complete html file with header and footer.)
+        end
+
+        if @config['flag_legacy_titlepagefile'].nil? && !@config['titlepagefile'].nil? && File.exist?(@config['titlepagefile'])
+          @config['titlefile'] = "#{@config['bookname']}-title.#{@config['htmlext']}"
+          @config['titlepage'] = true
+          @epub.legacy_cover_and_title_file(@config['titlepagefile'], @config['titlefile'])
+          @config['flag_legacy_titlepagefile'] = true
+          warn %Q(Parameter 'titlepagefile' is obsolete. Please use 'titlefile' and make complete html file with header and footer.)
+        end
+
+        if @config['flag_legacy_backcoverfile'].nil? && !@config['backcoverfile'].nil? && File.exist?(@config['backcoverfile'])
+          @config['backcover'] = "#{@config['bookname']}-backcover.#{@config['htmlext']}"
+          @epub.legacy_cover_and_title_file(@config['backcoverfile'], @config['backcover'])
+          @config['flag_legacy_backcoverfile'] = true
+          warn %Q(Parameter 'backcoverfile' is obsolete. Please use 'backcover' and make complete html file with header and footer.)
+        end
+
+        if @config['flag_legacy_pubhistory'].nil? && @config['pubhistory']
+          @config['history'] = [[]]
+          @config['pubhistory'].split("\n").each { |date| @config['history'][0].push(date.sub(/(\d+)年(\d+)月(\d+)日/, '\1-\2-\3')) }
+          @config['flag_legacy_pubhistory'] = true
+          warn %Q(Parameter 'pubhistory' is obsolete. Please use 'history' array.)
+        end
+      end
+    end
+  end
+end

data/lib/review/epubmaker/reviewheaderlistener.rb

@@ -7,6 +7,15 @@
 #
 module ReVIEW
   class EPUBMaker
+    # Listener class to scan HTML and get heading information
+    #
+    # The heading information this listener will retrieve is as follows:
+    #
+    # * level: Heading level (1..6)
+    # * id: HTMl ID attribute. Basically the `id` attribute of the h(1-6) element, but if there is an `a` element within the h(1-6) element, it will be its `id` attribute.
+    # * title: The title string of the headline. Usually, it is the text within the h(1-6) element, but if there is an `img` element, it will be the text with its `alt` attribute.
+    # * notoc: The `notoc` attribute of the headline element.
+    #
     class ReVIEWHeaderListener
       include REXML::StreamListener
       def initialize(headlines)
@@ -18,10 +27,11 @@ module ReVIEW
       def tag_start(name, attrs)
         if name =~ /\Ah(\d+)/
           raise "#{name}, #{attrs}" if @level.present?
+
           @level = $1.to_i
           @id = attrs['id'] if attrs['id'].present?
           @notoc = attrs['notoc'] if attrs['notoc'].present?
-        elsif !@level.nil?
+        elsif @level.present? # if in <hN> tag
           if name == 'img' && attrs['alt'].present?
             @content << attrs['alt']
           elsif name == 'a' && attrs['id'].present?
@@ -49,7 +59,7 @@ module ReVIEW
 
       def text(text)
         if @level.present?
-          @content << text.gsub("\t", '　')
+          @content << text.tr("\t", '　')
         end
       end
     end

data/lib/review/epubmaker/zip_exporter.rb

@@ -0,0 +1,84 @@
+# Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+
+require 'pathname'
+begin
+  require 'zip'
+rescue LoadError
+  ## I cannot find rubyzip library, so I use external zip command.
+  warn 'rubyzip not found, so use external zip command'
+end
+
+module ReVIEW
+  class EPUBMaker
+    ##
+    # Export into zip file for EPUB producer.
+    #
+    class ZipExporter
+      attr_reader :tmpdir
+
+      def initialize(tmpdir, config)
+        @tmpdir = tmpdir
+        @config = config
+      end
+
+      def export_zip(epubfile)
+        if defined?(Zip)
+          export_zip_rubyzip(epubfile)
+        else
+          export_zip_extcmd(epubfile)
+        end
+      end
+
+      def export_zip_extcmd(epubfile)
+        stage1 = @config['epubmaker']['zip_stage1'].to_s.split
+        path1 = stage1[0] || 'zip'
+        opt1 = stage1[1] || '-0Xq'
+        stage2 = @config['epubmaker']['zip_stage2'].to_s.split
+        path2 = stage2[0] || 'zip'
+        opt2 = stage2[1] || '-Xr9Dq'
+
+        Dir.chdir(tmpdir) do
+          system(path1, opt1, epubfile, 'mimetype')
+          addpath = @config['epubmaker']['zip_addpath']
+          if addpath
+            system(path2, opt2, epubfile, 'META-INF', 'OEBPS', addpath)
+          else
+            system(path2, opt2, epubfile, 'META-INF', 'OEBPS')
+          end
+        end
+      end
+
+      def export_zip_rubyzip(epubfile)
+        Dir.chdir(tmpdir) do
+          Zip::OutputStream.open(epubfile) do |epub|
+            root_pathname = Pathname.new(tmpdir)
+            epub.put_next_entry('mimetype', nil, nil, Zip::Entry::STORED)
+            epub << 'application/epub+zip'
+
+            export_zip_rubyzip_addpath(epub, File.join(tmpdir, 'META-INF'), root_pathname)
+            export_zip_rubyzip_addpath(epub, File.join(tmpdir, 'OEBPS'), root_pathname)
+            if @config['zip_addpath'].present?
+              export_zip_rubyzip_addpath(epub, File.join(tmpdir, @config['zip_addpath']), root_pathname)
+            end
+          end
+        end
+      end
+
+      def export_zip_rubyzip_addpath(epub, dirname, rootdir)
+        Dir[File.join(dirname, '**', '**')].each do |path|
+          next if File.directory?(path)
+
+          relpath = Pathname.new(path).relative_path_from(rootdir)
+          epub.put_next_entry(relpath)
+          epub << File.binread(path)
+        end
+      end
+    end
+  end
+end