review-peg 0.1.0

data/lib/epubmaker/epubv3.rb

@@ -0,0 +1,222 @@
+# encoding: utf-8
+# = epubv3.rb -- EPUB version 3 producer.
+#
+# Copyright (c) 2010-2015 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 'epubmaker/epubcommon'
+
+module EPUBMaker
+
+  # EPUBv3 is EPUB version 3 producer.
+  class EPUBv3 < EPUBCommon
+    # Construct object with parameter hash +params+ and message resource hash +res+.
+    def initialize(producer)
+      super
+    end
+
+    # Return opf file content.
+    def opf
+      @opf_metainfo = opf_metainfo
+      @opf_manifest = opf_manifest
+      @opf_toc = opf_tocx
+
+      tmplfile = File.expand_path('./opf/epubv3.opf.erb', ReVIEW::Template::TEMPLATE_DIR)
+      tmpl = ReVIEW::Template.load(tmplfile)
+      return tmpl.result(binding)
+    end
+
+    def opf_metainfo
+      s = ""
+      %w[title language date type format source description relation coverage subject rights].each do |item|
+        next if @producer.params[item].nil?
+        if @producer.params[item].instance_of?(Array)
+          @producer.params[item].each_with_index {|v, i|
+            s << %Q[    <dc:#{item} id="#{item}-#{i}">#{CGI.escapeHTML(v.to_s)}</dc:#{item}>\n]
+          }
+        else
+          s << %Q[    <dc:#{item} id="#{item}">#{CGI.escapeHTML(@producer.params[item].to_s)}</dc:#{item}>\n]
+        end
+      end
+
+      s << %Q[    <meta property="dcterms:modified">#{@producer.params["modified"]}</meta>\n]
+
+      # ID
+      if @producer.params["isbn"].nil?
+        s << %Q[    <dc:identifier id="BookId">#{@producer.params["urnid"]}</dc:identifier>\n]
+      else
+        s << %Q[    <dc:identifier id="BookId">#{@producer.params["isbn"]}</dc:identifier>\n]
+      end
+
+      # creator (should be array)
+      %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].each do |role|
+        next if @producer.params[role].nil?
+        @producer.params[role].each_with_index do |v, i|
+          if v.instance_of?(Hash)
+            s << %Q[    <dc:creator id="#{role}-#{i}">#{CGI.escapeHTML(v["name"])}</dc:creator>\n]
+            s << %Q[    <meta refines="##{role}-#{i}" property="role" scheme="marc:relators">#{role.sub('a-', '')}</meta>\n]
+            v.each_pair do |name, val|
+              next if name == "name"
+              s << %Q[    <meta refines="##{role.sub('a-', '')}-#{i}" property="#{name}">#{CGI.escapeHTML(val)}</meta>\n]
+            end
+          else
+            s << %Q[    <dc:creator id="#{role}-#{i}">#{CGI.escapeHTML(v)}</dc:creator>\n]
+            s << %Q[    <meta refines="##{role}-#{i}" property="role" scheme="marc:relators">#{role.sub('a-', '')}</meta>\n]
+          end
+        end
+      end
+
+      # contributor (should be array)
+      %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].each do |role|
+        next if @producer.params[role].nil?
+        @producer.params[role].each_with_index do |v, i|
+          if v.instance_of?(Hash)
+            s << %Q[    <dc:contributor id="#{role}-#{i}">#{CGI.escapeHTML(v["name"])}</dc:contributor>\n]
+            s << %Q[    <meta refines="##{role}-#{i}" property="role" scheme="marc:relators">#{role}</meta>\n]
+            v.each_pair do |name, val|
+              next if name == "name"
+              s << %Q[    <meta refines="##{role}-#{i}" property="#{name}">#{CGI.escapeHTML(val)}</meta>\n]
+            end
+          else
+            s << %Q[    <dc:contributor id="#{role}-#{i}">#{CGI.escapeHTML(v)}</dc:contributor>\n]
+            s << %Q[    <meta refines="##{role}-#{i}" property="role" scheme="marc:relators">#{role}</meta>\n]
+          end
+
+          if role == "prt" || role == "pbl"
+            if v.instance_of?(Hash)
+              s << %Q[    <dc:publisher id="pub-#{role}-#{i}">#{CGI.escapeHTML(v["name"])}</dc:publisher>\n]
+              s << %Q[    <meta refines="#pub-#{role}-#{i}" property="role" scheme="marc:relators">#{role}</meta>\n]
+              v.each_pair do |name, val|
+                next if name == "name"
+                s << %Q[    <meta refines="#pub-#{role}-#{i}" property="#{name}">#{CGI.escapeHTML(val)}</meta>\n]
+              end
+            else
+              s << %Q[    <dc:publisher id="pub-#{role}-#{i}">#{CGI.escapeHTML(v)}</dc:publisher>\n]
+              s << %Q[    <meta refines="#pub-#{role}-#{i}" property="role" scheme="marc:relators">prt</meta>\n]
+            end
+          end
+        end
+      end
+
+      s
+    end
+
+    def opf_manifest
+      s = ""
+      s << <<EOT
+  <manifest>
+    <item properties="nav" id="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}" href="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}" media-type="application/xhtml+xml"/>
+    <item id="#{@producer.params["bookname"]}" href="#{@producer.params["cover"]}" media-type="application/xhtml+xml"/>
+EOT
+
+      if @producer.params["coverimage"]
+        @producer.contents.each do |item|
+          if item.media =~ /\Aimage/ && File.basename(item.file) == @producer.params["coverimage"]
+            s << %Q[    <item properties="cover-image" id="cover-#{item.id}" href="#{item.file}" media-type="#{item.media}"/>\n]
+            item.id = nil
+            break
+          end
+        end
+      end
+
+      @producer.contents.each do |item|
+        next if item.file =~ /#/ || item.id.nil? # skip subgroup, or id=nil (for cover)
+        propstr = ""
+        if item.properties.size > 0
+          propstr = %Q[ properties="#{item.properties.sort.uniq.join(" ")}"]
+        end
+        s << %Q[    <item id="#{item.id}" href="#{item.file}" media-type="#{item.media}"#{propstr}/>\n]
+      end
+      s << %Q[  </manifest>\n]
+
+      s
+    end
+
+    def opf_tocx
+      if @producer.params["epubmaker"]["cover_linear"] && @producer.params["epubmaker"]["cover_linear"] != "no"
+        cover_linear = "yes"
+      else
+        cover_linear = "no"
+      end
+
+      s = ""
+      if @producer.params["direction"]
+        s << %Q[  <spine page-progression-direction="#{@producer.params["direction"]}">\n]
+      else
+        s << %Q[  <spine>\n]
+      end
+      s << %Q[    <itemref idref="#{@producer.params["bookname"]}" linear="#{cover_linear}"/>\n]
+      s << %Q[    <itemref idref="#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}" />\n] if @producer.params["toc"]
+
+      @producer.contents.each do |item|
+        next if item.media !~ /xhtml\+xml/ # skip non XHTML
+        s << %Q[    <itemref idref="#{item.id}"/>\n] if item.notoc.nil?
+      end
+      s << %Q[  </spine>\n]
+
+      s
+    end
+
+    def ncx(indentarray)
+      if @producer.params["epubmaker"]["flattoc"].nil?
+        ncx_main = hierarchy_ncx("ol")
+      else
+        ncx_main = flat_ncx("ol", @producer.params["epubmaker"]["flattocindent"])
+      end
+
+      @body = <<EOT
+  <nav xmlns:epub="http://www.idpf.org/2007/ops" epub:type="toc" id="toc">
+  <h1 class="toc-title">#{@producer.res.v("toctitle")}</h1>
+#{ncx_main}  </nav>
+EOT
+
+      @title = @producer.res.v("toctitle")
+      @language = @producer.params['language']
+      @stylesheets = @producer.params["stylesheet"]
+      tmplfile = File.expand_path('./html/layout-html5.html.erb', ReVIEW::Template::TEMPLATE_DIR)
+      tmpl = ReVIEW::Template.load(tmplfile)
+      return tmpl.result(binding)
+    end
+
+    # Produce EPUB file +epubfile+.
+    # +basedir+ points the directory has contents.
+    # +tmpdir+ defines temporary directory.
+    def produce(epubfile, basedir, tmpdir)
+      produce_write_common(basedir, tmpdir)
+
+      File.open("#{tmpdir}/OEBPS/#{@producer.params["bookname"]}-toc.#{@producer.params["htmlext"]}", "w") {|f| @producer.ncx(f, @producer.params["epubmaker"]["ncxindent"]) }
+
+      @producer.call_hook(@producer.params["epubmaker"]["hook_prepack"], tmpdir)
+      export_zip(tmpdir, epubfile)
+    end
+
+    private
+
+    # Return cover pointer for opf file
+    def cover_in_opf
+      s = ""
+
+      if @producer.params["coverimage"]
+        @producer.contents.each do |item|
+          if item.media =~ /\Aimage/ && item.file =~ /#{@producer.params["coverimage"]}\Z/
+              s << <<EOT
+            <item id="#{item.id}" href="#{item.file}" media-type="#{item.media}"/>
+EOT
+            break
+          end
+        end
+      end
+
+      s << <<EOT
+    <item id="#{@producer.params["bookname"]}" href="#{@producer.params["cover"]}" media-type="application/xhtml+xml"/>
+EOT
+      s
+    end
+
+  end
+end

data/lib/epubmaker/producer.rb

@@ -0,0 +1,330 @@
+# encoding: utf-8
+# = producer.rb -- EPUB producer.
+#
+# Copyright (c) 2010-2015 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 'tmpdir'
+require 'fileutils'
+require 'yaml'
+require 'uuid'
+require 'epubmaker/content'
+require 'epubmaker/epubv2'
+require 'epubmaker/epubv3'
+require 'review/i18n'
+
+module EPUBMaker
+  # EPUBMaker produces EPUB file.
+  class Producer
+    # Array of content objects.
+    attr_accessor :contents
+    # Parameter hash.
+    attr_accessor :params
+    # Message resource object.
+    attr_reader :res
+
+    # Take YAML +file+ and return parameter hash.
+    def Producer.load(file)
+      raise "Can't open #{yamlfile}." if file.nil? || !File.exist?(file)
+      return YAML.load_file(file)
+    end
+
+    # Take YAML +file+ and update parameter hash.
+    def load(file)
+      raise "Can't open #{yamlfile}." if file.nil? || !File.exist?(file)
+      merge_params(@params.merge(YAML.load_file(file)))
+    end
+
+    # Construct producer object.
+    # +params+ takes initial parameter hash. This parameters can be overriden by EPUBMaker#load or EPUBMaker#merge_params.
+    # +version+ takes EPUB version (default is 2).
+    def initialize(params=nil, version=nil)
+      @contents = []
+      @params = {}
+      @epub = nil
+      @params["epubversion"] = version unless version.nil?
+      @res = ReVIEW::I18n
+
+      unless params.nil?
+        merge_params(params)
+      end
+    end
+
+    def coverimage
+      if !params["coverimage"]
+        return nil
+      end
+      @contents.each do |item|
+        if item.media =~ /\Aimage/ && item.file =~ /#{params["coverimage"]}\Z/ # /
+          return item.file
+        end
+      end
+      return nil
+    end
+
+    # Update parameters by merging from new parameter hash +params+.
+    def merge_params(params)
+      @params = @params.merge(params)
+      complement
+
+      unless @params["epubversion"].nil?
+        case @params["epubversion"].to_i
+        when 2
+          @epub = EPUBMaker::EPUBv2.new(self)
+        when 3
+          @epub = EPUBMaker::EPUBv3.new(self)
+        else
+          raise "Invalid EPUB version (#{@params["epubversion"]}.)"
+        end
+      end
+      if params["language"]
+        ReVIEW::I18n.locale = params["language"]
+      end
+      support_legacy_maker
+    end
+
+    # Write mimetype file to IO object +wobj+.
+    def mimetype(wobj)
+      s = @epub.mimetype
+      wobj.print s if !s.nil? && !wobj.nil?
+    end
+
+    # Write opf file to IO object +wobj+.
+    def opf(wobj)
+      s = @epub.opf
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+
+    # Write ncx file to IO object +wobj+. +indentarray+ defines prefix
+    # string for each level.
+    def ncx(wobj, indentarray=[])
+      s = @epub.ncx(indentarray)
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+
+    # Write container file to IO object +wobj+.
+    def container(wobj)
+      s = @epub.container
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+
+    # Write cover file to IO object +wobj+.
+    # If Producer#params["coverimage"] is defined, it will be used for
+    # the cover image.
+    def cover(wobj)
+      type = (@params["epubversion"] >= 3) ? "cover" : nil
+      s = @epub.cover(type)
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+
+    # Write title file (copying) to IO object +wobj+.
+    def titlepage(wobj)
+      s = @epub.titlepage
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+
+    # Write colophon file to IO object +wobj+.
+    def colophon(wobj)
+      s = @epub.colophon
+      wobj.puts s if !s.nil? && !wobj.nil?
+    end
+
+    # Write own toc file to IO object +wobj+.
+    def mytoc(wobj)
+      s = @epub.mytoc
+      wobj.puts s if !s.nil? && !wobj.nil?
+    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 = @params["image_ext"] if allow_exts.nil?
+      Dir.foreach(path) do |f|
+        next if f =~ /\A\./
+        if f =~ /\.(#{allow_exts.join("|")})\Z/i
+          path.chop! if path =~ /\/\Z/
+          if base.nil?
+            @contents.push(EPUBMaker::Content.new({"file" => "#{path}/#{f}"}))
+          else
+            @contents.push(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+.
+    # +basedir+ points the directory has contents (default: current directory.)
+    # +tmpdir+ defines temporary directory.
+    def produce(epubfile, basedir=nil, tmpdir=nil)
+      current = Dir.pwd
+      basedir = current if basedir.nil?
+
+      _tmpdir = tmpdir.nil? ? Dir.mktmpdir : tmpdir
+      epubfile = "#{current}/#{epubfile}" if epubfile !~ /\A\// # /
+
+      # FIXME: error check
+      File.unlink(epubfile) if File.exist?(epubfile)
+
+      begin
+        @epub.produce(epubfile, basedir, _tmpdir)
+      ensure
+        FileUtils.rm_r(_tmpdir) if tmpdir.nil?
+      end
+    end
+
+    def call_hook(filename, *params)
+      if !filename.nil? && 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
+
+    private
+
+    # Complement parameters.
+    def complement
+      @params["htmlext"] = "html" if @params["htmlext"].nil?
+      defaults = {
+        "cover" => "#{@params["bookname"]}.#{@params["htmlext"]}",
+        "title" => @params["booktitle"],
+        "language" => "ja",
+        "date" => Time.now.strftime("%Y-%m-%d"),
+        "modified" => Time.now.strftime("%Y-%02m-%02dT%02H:%02M:%02SZ"),
+        "urnid" => "urn:uid:#{UUID.create}",
+        "isbn" => nil,
+        "toclevel" => 2,
+        "stylesheet" => [],
+        "epubversion" => 2,
+        "htmlversion" => 4,
+        "secnolevel" => 2,
+        "pre_secnolevel" => 0,
+        "post_secnolevel" => 1,
+        "part_secnolevel" => 1,
+        "titlepage" => nil,
+        "titlefile" => nil,
+        "originaltitlefile" => nil,
+        "profile" => nil,
+        "colophon" => nil,
+        "epubmaker" => {
+          "flattoc" => nil,
+          "flattocindent" => true,
+          "ncx_indent" => [],
+          "zip_stage1" => "zip -0Xq",
+          "zip_stage2" => "zip -Xr9Dq",
+          "zip_addpath" => nil,
+          "hook_beforeprocess" => nil,
+          "hook_afterfrontmatter" => nil,
+          "hook_afterbody" => nil,
+          "hook_afterbackmatter" => nil,
+          "hook_aftercopyimage" => nil,
+          "hook_prepack" => nil,
+          "rename_for_legacy" => nil,
+          "verify_target_images" => nil,
+          "force_include_images" => [],
+          "cover_linear" => nil,
+        },
+        "imagedir" => "images",
+        "fontdir" => "fonts",
+        "image_ext" => %w(png gif jpg jpeg svg ttf woff otf),
+        "font_ext" => %w(ttf woff otf),
+      }
+
+      defaults.each_pair do |k, v|
+        if k == "epubmaker" && !@params[k].nil?
+          v.each_pair do |k2, v2|
+            @params[k][k2] = v2 if @params[k][k2].nil?
+          end
+        else
+          @params[k] = v if @params[k].nil?
+        end
+      end
+
+      deprecated_parameters = {
+        "ncxindent" => "epubmaker:ncxindent",
+        "flattoc" => "epubmaker:flattoc",
+        "flattocindent" => "epubmaker:flattocindent",
+        "hook_beforeprocess" => "epubmaker:hook_beforeprocess",
+        "hook_afterfrontmatter" => "epubmaker:hook_afterfrontmatter",
+        "hook_afterbody" => "epubmaker:hook_afterbody",
+        "hook_afterbackmatter" => "epubmaker:hook_afterbackmatter",
+        "hook_aftercopyimage" => "epubmaker:hook_aftercopyimage",
+        "hook_prepack" => "epubmaker:hook_prepack",
+        "rename_for_legacy" => "epubmaker:rename_for_legacy",
+        "zip_stage1" => "epubmaker:zip_stage1",
+        "zip_stage2" => "epubmaker:zip_stage2",
+        "zip_addpath" => "epubmaker:zip_addpath",
+        "verify_target_images" => "epubmaker:verify_target_images",
+        "force_include_images" => "epubmaker:force_include_images",
+        "cover_linear" => "epubmaker:cover_linear",
+      }
+
+      deprecated_parameters.each_pair do |k, v|
+        unless @params[k].nil?
+          sa = v.split(":", 2)
+          warn "Parameter #{k} is deprecated. Use:\n#{sa[0]}:\n  #{sa[1]}: ...\n\n"
+          @params[sa[0]][sa[1]] = @params[k]
+          @params.delete(k)
+        end
+      end
+
+      @params["htmlversion"] = 5 if @params["epubversion"] >= 3
+
+      %w[bookname title].each do |k|
+        raise "Key #{k} must have a value. Abort." if @params[k].nil?
+      end
+      # array
+      %w[subject aut 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-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 adp ann arr art asn aut aqt aft aui ant bkp clb cmm dsr edt ill lyr mdc mus nrt oth pht pbl prt red rev spn ths trc trl stylesheet rights].each do |item|
+        @params[item] = [@params[item]] if !@params[item].nil? && @params[item].instance_of?(String)
+      end
+      # optional
+      # type, format, identifier, source, relation, coverpage, aut
+    end
+
+    def support_legacy_maker
+      # legacy review-epubmaker support
+      if @params["flag_legacy_coverfile"].nil? && !@params["coverfile"].nil? && File.exist?(@params["coverfile"])
+        @params["cover"] = "#{@params["bookname"]}-cover.#{@params["htmlext"]}"
+        @epub.legacy_cover_and_title_file(@params["coverfile"], @params["cover"])
+        @params["flag_legacy_coverfile"] = true
+        warn "Parameter 'coverfile' is obsolete. Please use 'cover' and make complete html file with header and footer."
+      end
+
+      if @params["flag_legacy_titlepagefile"].nil? && !@params["titlepagefile"].nil? && File.exist?(@params["titlepagefile"])
+        @params["titlefile"] = "#{@params["bookname"]}-title.#{@params["htmlext"]}"
+        @params["titlepage"] = true
+        @epub.legacy_cover_and_title_file(@params["titlepagefile"], @params["titlefile"])
+        @params["flag_legacy_titlepagefile"] = true
+        warn "Parameter 'titlepagefile' is obsolete. Please use 'titlefile' and make complete html file with header and footer."
+      end
+
+      if @params["flag_legacy_backcoverfile"].nil? && !@params["backcoverfile"].nil? && File.exist?(@params["backcoverfile"])
+        @params["backcover"] = "#{@params["bookname"]}-backcover.#{@params["htmlext"]}"
+        @epub.legacy_cover_and_title_file(@params["backcoverfile"], @params["backcover"])
+        @params["flag_legacy_backcoverfile"] = true
+        warn "Parameter 'backcoverfile' is obsolete. Please use 'backcover' and make complete html file with header and footer."
+      end
+
+      if @params["flag_legacy_pubhistory"].nil? && !@params["pubhistory"].nil?
+        @params["history"] = [[]]
+        @params["pubhistory"].split("\n").each do |date|
+          @params["history"][0].push(date.sub(/(\d+)年(\d+)月(\d+)日/, '\1-\2-\3'))
+        end
+        @params["flag_legacy_pubhistory"] = true
+        warn "Parameter 'pubhistory' is obsolete. Please use 'history' array."
+      end
+    end
+  end
+end