review 1.2.0 → 1.3.0

data/lib/review/catalog.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module ReVIEW
+  class Catalog
+    def initialize(file)
+      @yaml = YAML.load(file.read)
+      @yaml ||= {}
+    end
+
+    def predef
+      return "" unless @yaml["PREDEF"]
+      @yaml["PREDEF"].join("\n")
+    end
+
+    def chaps
+      return "" unless @yaml["CHAPS"]
+
+      @yaml["CHAPS"].map {|entry|
+        if entry.is_a? String
+          entry
+        elsif entry.is_a? Hash
+          entry.values # chaps in a part
+        end
+      }.flatten.join("\n")
+    end
+
+    def parts
+      return "" unless @yaml["CHAPS"]
+
+      @yaml["CHAPS"].map {|entry|
+        if entry.is_a? Hash
+          entry.keys
+        end
+      }.flatten.reject{|entry| entry.nil?}.join("\n")
+    end
+
+    def parts_with_chaps
+      return "" unless @yaml["CHAPS"]
+      @yaml["CHAPS"].flatten.reject{|entry| entry.nil?}
+    end
+
+    def postdef
+      return "" unless @yaml["POSTDEF"]
+      @yaml["POSTDEF"].join("\n")
+    end
+  end
+end

data/lib/review/compiler.rb

@@ -35,7 +35,7 @@ module ReVIEW
       end
     end
 
-    alias to_s string
+    alias_method :to_s, :string
   end
 
 
@@ -187,6 +187,7 @@ module ReVIEW
     definline :hd
     definline :href
     definline :recipe
+    definline :column
 
     definline :abbr
     definline :acronym
@@ -293,7 +294,7 @@ module ReVIEW
         @headline_indexs[index] = 0 if @headline_indexs[index].nil?
         @headline_indexs[index] += 1
         close_current_tagged_section(level)
-        if ReVIEW.book.param["hdnumberingmode"]
+        if ReVIEW.book.config["hdnumberingmode"]
           caption = @chapter.on_CHAPS? ? "#{@headline_indexs.join('.')} #{caption}" : caption
           warn "--hdnumberingmode is deprecated. use --level option."
         end

data/lib/review/configure.rb

@@ -1,8 +1,9 @@
 # -*- coding: utf-8 -*-
 module ReVIEW
-  class Configure
+  class Configure < Hash
     def self.values
-      { # These parameters can be overridden by YAML file.
+      Configure[
+        # These parameters can be overridden by YAML file.
         "bookname"=> "example", # it defines epub file name also
         "booktitle" => "Re:VIEW EPUBサンプル",
         "title" => nil,
@@ -32,7 +33,8 @@ module ReVIEW
         "toc" => true, # Use table of contents
         "colophon" => nil, # Use colophon
         "debug" => nil, # debug flag
-      }
+        "catalogfile" => 'catalog.yml',
+      ]
     end
   end
 end

data/lib/review/epubmaker.rb

@@ -20,6 +20,7 @@ module ReVIEW
   def initialize
     @epub = nil
     @tochtmltxt = "toc-html.txt"
+    @buildlogtxt = "build-log.txt"
   end
 
   def log(s)
@@ -36,11 +37,13 @@ module ReVIEW
   def produce(yamlfile, bookname=nil)
     load_yaml(yamlfile)
     bookname = @params["bookname"] if bookname.nil?
+    booktmpname = "#{bookname}-epub"
+
     log("Loaded yaml file (#{yamlfile}). I will produce #{bookname}.epub.")
 
     File.unlink("#{bookname}.epub") if File.exist?("#{bookname}.epub")
-    FileUtils.rm_rf(bookname) if @params["debug"] && File.exist?(bookname)
-    
+    FileUtils.rm_rf(booktmpname) if @params["debug"] && File.exist?(booktmpname)
+
     Dir.mktmpdir(bookname, Dir.pwd) do |basetmpdir|
       log("Created first temporary directory as #{basetmpdir}.")
 
@@ -63,18 +66,25 @@ module ReVIEW
 
       push_contents(basetmpdir)
 
-      copy_images(@params["imagedir"], "#{basetmpdir}/images")
-      copy_images("covers", "#{basetmpdir}/images")
-      copy_images("adv", "#{basetmpdir}/images")
-      copy_images(@params["fontdir"], "#{basetmpdir}/fonts", @params["font_ext"])
+      if !@params["verify_target_images"].nil?
+        verify_target_images(basetmpdir)
+        copy_images(@params["imagedir"], basetmpdir)
+      else
+        copy_images(@params["imagedir"], "#{basetmpdir}/images")
+      end
+
+      copy_resources("covers", "#{basetmpdir}/images")
+      copy_resources("adv", "#{basetmpdir}/images")
+      copy_resources(@params["fontdir"], "#{basetmpdir}/fonts", @params["font_ext"])
+
       log("Call hook_aftercopyimage. (#{@params["hook_aftercopyimage"]})")
       call_hook(@params["hook_aftercopyimage"], basetmpdir)
 
       @epub.import_imageinfo("#{basetmpdir}/images", basetmpdir)
       @epub.import_imageinfo("#{basetmpdir}/fonts", basetmpdir, @params["font_ext"])
 
-      epubtmpdir = @params["debug"].nil? ? nil : "#{Dir.pwd}/#{bookname}"
-      Dir.mkdir(bookname) unless @params["debug"].nil?
+      epubtmpdir = @params["debug"].nil? ? nil : "#{Dir.pwd}/#{booktmpname}"
+      Dir.mkdir(booktmpname) unless @params["debug"].nil?
       log("Call ePUB producer.")
       @epub.produce("#{bookname}.epub", basetmpdir, epubtmpdir)
       log("Finished.")
@@ -84,28 +94,77 @@ module ReVIEW
 
   def call_hook(filename, *params)
     if !filename.nil? && File.exist?(filename) && FileTest.executable?(filename)
-      system(filename, *params)
+      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)
+    @epub.contents.each do |content|
+      if content.media == "application/xhtml+xml"
+
+        File.open("#{basetmpdir}/#{content.file}") do |f|
+          Document.new(File.new(f)).each_element("//img") do |e|
+            @params["force_include_images"].push(e.attributes["src"])
+            if e.attributes["src"] =~ /svg\Z/i
+              content.properties.push("svg")
+            end
+          end
+        end
+      elsif content.media == "text/css"
+        File.open("#{basetmpdir}/#{content.file}") do |f|
+          f.each_line do |l|
+            l.scan(/url\((.+?)\)/) do |m|
+              @params["force_include_images"].push($1.strip)
+            end
+          end
+        end
+      end
+    end
+    @params["force_include_images"] = @params["force_include_images"].sort.uniq
+  end
+
+  def copy_images(resdir, destdir, allow_exts=nil)
+    return nil unless File.exist?(resdir)
+    allow_exts = @params["image_ext"] if allow_exts.nil?
+    FileUtils.mkdir_p(destdir) unless FileTest.directory?(destdir)
+    if !@params["verify_target_images"].nil?
+      @params["force_include_images"].each do |file|
+        unless File.exist?(file)
+          warn "#{file} is not found, skip." if file !~ /\Ahttp[s]?:/
+          next
+        end
+        basedir = File.dirname(file)
+        FileUtils.mkdir_p("#{destdir}/#{basedir}") unless FileTest.directory?("#{destdir}/#{basedir}")
+        log("Copy #{file} to the temporary directory.")
+        FileUtils.cp(file, "#{destdir}/#{basedir}")
+      end
+    else
+      recursive_copy_files(resdir, destdir, allow_exts)
     end
   end
 
-  def copy_images(imagedir, destdir, allow_exts=nil)
-    return nil unless File.exist?(imagedir)
+  def copy_resources(resdir, destdir, allow_exts=nil)
+    return nil unless File.exist?(resdir)
     allow_exts = @params["image_ext"] if allow_exts.nil?
     FileUtils.mkdir_p(destdir) unless FileTest.directory?(destdir)
-    recursive_copy_images(imagedir, destdir, allow_exts)
+    recursive_copy_files(resdir, destdir, allow_exts)
   end
 
-  def recursive_copy_images(imagedir, destdir, allow_exts)
-    Dir.open(imagedir) do |dir|
+  def recursive_copy_files(resdir, destdir, allow_exts)
+    Dir.open(resdir) do |dir|
       dir.each do |fname|
         next if fname =~ /\A\./
-        if FileTest.directory?("#{imagedir}/#{fname}")
-          recursive_copy_images("#{imagedir}/#{fname}", "#{destdir}/#{fname}", allow_exts)
+        if FileTest.directory?("#{resdir}/#{fname}")
+          recursive_copy_files("#{resdir}/#{fname}", "#{destdir}/#{fname}", allow_exts)
         else
           if fname =~ /\.(#{allow_exts.join("|")})\Z/i
             Dir.mkdir(destdir) unless File.exist?(destdir)
-            log("Copy #{imagedir}/#{fname} to the temporary directory.")
-            FileUtils.cp("#{imagedir}/#{fname}", destdir)
+            log("Copy #{resdir}/#{fname} to the temporary directory.")
+            FileUtils.cp("#{resdir}/#{fname}", destdir)
           end
         end
       end
@@ -134,14 +193,15 @@ module ReVIEW
           build_part(part, basetmpdir, htmlfile)
           title = ReVIEW::I18n.t("part", part.number)
           title += ReVIEW::I18n.t("chapter_postfix") + part.name.strip if part.name.strip.present?
-          write_tochtmltxt(basetmpdir, "0\t#{htmlfile}\t#{title}")
+          write_tochtmltxt(basetmpdir, "0\t#{htmlfile}\t#{title}\tchaptype=part")
+          write_buildlogtxt(basetmpdir, htmlfile, "")
         end
       end
 
       part.chapters.each do |chap|
         build_chap(chap, base_path, basetmpdir, yamlfile, nil)
       end
-      
+
     end
   end
 
@@ -158,7 +218,7 @@ EOT
 <h2 class="part-title">#{part.name.strip}</h2>
 EOT
       end
-      
+
       f.puts <<EOT
 </div>
 EOT
@@ -168,6 +228,12 @@ EOT
 
   def build_chap(chap, base_path, basetmpdir, yamlfile, ispart=nil)
     filename = ""
+
+    chaptype = "body"
+    chaptype = "part" unless ispart.nil?
+    chaptype = "pre" if chap.on_PREDEF?
+    chaptype = "post" if chap.on_POSTDEF?
+
     if !ispart.nil?
       filename = chap.path
     else
@@ -189,28 +255,32 @@ EOT
     end
 
     htmlfile = "#{id}.#{@params["htmlext"]}"
+    write_buildlogtxt(basetmpdir, htmlfile, filename)
     log("Create #{htmlfile} from #{filename}.")
 
     level = @params["secnolevel"]
-    
-    if !ispart.nil?
-      level = @params["part_secnolevel"]
-    else
-      level = @params["pre_secnolevel"] if chap.on_PREDEF?
-      level = @params["post_secnolevel"] if chap.on_POSTDEF?
-    end
+
+# TODO: It would be nice if we can modify level in PART, PREDEF, or POSTDEF.
+#        But we have to care about section number reference (@<hd>) also.
+#
+#    if !ispart.nil?
+#      level = @params["part_secnolevel"]
+#    else
+#      level = @params["pre_secnolevel"] if chap.on_PREDEF?
+#      level = @params["post_secnolevel"] if chap.on_POSTDEF?
+#    end
 
     stylesheet = ""
     if @params["stylesheet"].size > 0
       stylesheet = "--stylesheet=#{@params["stylesheet"].join(",")}"
     end
 
-    system("review-compile --yaml=#{yamlfile} --target=html --level=#{level} --htmlversion=#{@params["htmlversion"]} --epubversion=#{@params["epubversion"]} #{stylesheet} #{@params["params"]} #{filename} > \"#{basetmpdir}/#{htmlfile}\"")
+    system("#{ReVIEW::MakerHelper.bindir}/review-compile --yaml=#{yamlfile} --target=html --level=#{level} --htmlversion=#{@params["htmlversion"]} --epubversion=#{@params["epubversion"]} #{stylesheet} #{@params["params"]} #{filename} > \"#{basetmpdir}/#{htmlfile}\"")
 
-    write_info_body(basetmpdir, id, htmlfile, ispart)
+    write_info_body(basetmpdir, id, htmlfile, ispart, chaptype)
   end
 
-  def write_info_body(basetmpdir, id, filename, ispart=nil)
+  def write_info_body(basetmpdir, id, filename, ispart=nil, chaptype=nil)
     headlines = []
     # FIXME:nonumを修正する必要あり
     Document.parse_stream(File.new("#{basetmpdir}/#{filename}"), ReVIEWHeaderListener.new(headlines))
@@ -218,9 +288,9 @@ EOT
     headlines.each do |headline|
       headline["level"] = 0 if !ispart.nil? && headline["level"] == 1
       if first.nil?
-        write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}##{headline["id"]}\t#{headline["title"]}")
+        write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}##{headline["id"]}\t#{headline["title"]}\tchaptype=#{chaptype}")
       else
-        write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}\t#{headline["title"]}\tforce_include=true")
+        write_tochtmltxt(basetmpdir, "#{headline["level"]}\t#{filename}\t#{headline["title"]}\tforce_include=true,chaptype=#{chaptype}")
         first = nil
       end
     end
@@ -231,6 +301,7 @@ EOT
       f.each_line do |l|
         force_include = nil
         customid = nil
+        chaptype = nil
         level, file, title, custom = l.chomp.split("\t")
         unless custom.nil?
           # custom setting
@@ -242,6 +313,8 @@ EOT
               customid = v
             when "force_include"
               force_include = true
+            when "chaptype"
+              chaptype = v
             end
           end
         end
@@ -249,9 +322,9 @@ EOT
         log("Push #{file} to ePUB contents.")
 
         if customid.nil?
-          @epub.contents.push(Content.new("file" => file, "level" => level.to_i, "title" => title))
+          @epub.contents.push(Content.new("file" => file, "level" => level.to_i, "title" => title, "chaptype" => chaptype))
         else
-          @epub.contents.push(Content.new("id" => customid, "file" => file, "level" => level.to_i, "title" => title))
+          @epub.contents.push(Content.new("id" => customid, "file" => file, "level" => level.to_i, "title" => title, "chaptype" => chaptype))
         end
       end
     end
@@ -270,22 +343,22 @@ EOT
     FileUtils.cp(@params["cover"], "#{basetmpdir}/#{File.basename(@params["cover"])}") if !@params["cover"].nil? && File.exist?(@params["cover"])
 
     if @params["titlepage"]
-      if @params["titlepagefile"].nil?
+      if @params["titlefile"].nil?
         build_titlepage(basetmpdir, "titlepage.#{@params["htmlext"]}")
       else
-        FileUtils.cp(@params["titlepagefile"], "titlepage.#{@params["htmlext"]}")
+        FileUtils.cp(@params["titlefile"], "#{basetmpdir}/titlepage.#{@params["htmlext"]}")
       end
-      write_tochtmltxt(basetmpdir, "1\ttitlepage.#{@params["htmlext"]}\t#{@epub.res.v("titlepagetitle")}")
+      write_tochtmltxt(basetmpdir, "1\ttitlepage.#{@params["htmlext"]}\t#{@epub.res.v("titlepagetitle")}\tchaptype=pre")
     end
 
     if !@params["originaltitlefile"].nil? && File.exist?(@params["originaltitlefile"])
       FileUtils.cp(@params["originaltitlefile"], "#{basetmpdir}/#{File.basename(@params["originaltitlefile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["originaltitlefile"])}\t#{@epub.res.v("originaltitle")}")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["originaltitlefile"])}\t#{@epub.res.v("originaltitle")}\tchaptype=pre")
     end
 
     if !@params["creditfile"].nil? && File.exist?(@params["creditfile"])
       FileUtils.cp(@params["creditfile"], "#{basetmpdir}/#{File.basename(@params["creditfile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["creditfile"])}\t#{@epub.res.v("credittitle")}")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["creditfile"])}\t#{@epub.res.v("credittitle")}\tchaptype=pre")
     end
   end
 
@@ -318,12 +391,12 @@ EOT
   def copy_backmatter(basetmpdir)
     if @params["profile"]
       FileUtils.cp(@params["profile"], "#{basetmpdir}/#{File.basename(@params["profile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["profile"])}\t#{@epub.res.v("profiletitle")}")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["profile"])}\t#{@epub.res.v("profiletitle")}\tchaptype=post")
     end
 
     if @params["advfile"]
       FileUtils.cp(@params["advfile"], "#{basetmpdir}/#{File.basename(@params["advfile"])}")
-      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["advfile"])}\t#{@epub.res.v("advtitle")}")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["advfile"])}\t#{@epub.res.v("advtitle")}\tchaptype=post")
     end
 
     if @params["colophon"]
@@ -332,7 +405,12 @@ EOT
       else
         File.open("#{basetmpdir}/colophon.#{@params["htmlext"]}", "w") {|f| @epub.colophon(f) }
       end
-      write_tochtmltxt(basetmpdir, "1\tcolophon.#{@params["htmlext"]}\t#{@epub.res.v("colophontitle")}")
+      write_tochtmltxt(basetmpdir, "1\tcolophon.#{@params["htmlext"]}\t#{@epub.res.v("colophontitle")}\tchaptype=post")
+    end
+
+    if @params["backcover"]
+      FileUtils.cp(@params["backcover"], "#{basetmpdir}/#{File.basename(@params["backcover"])}")
+      write_tochtmltxt(basetmpdir, "1\t#{File.basename(@params["backcover"])}\t#{@epub.res.v("backcovertitle")}\tchaptype=post")
     end
   end
 
@@ -342,6 +420,12 @@ EOT
     end
   end
 
+  def write_buildlogtxt(basetmpdir, htmlfile, reviewfile)
+    File.open("#{basetmpdir}/#{@buildlogtxt}", "a") do |f|
+      f.puts "#{htmlfile},#{reviewfile}"
+    end
+  end
+
   def header(title)
     # titleはすでにエスケープ済みと想定
     s = <<EOT
@@ -392,7 +476,7 @@ EOT
       @content = ""
       @headlines = headlines
     end
-    
+
     def tag_start(name, attrs)
       if name =~ /\Ah(\d+)/
         unless @level.nil?
@@ -408,7 +492,7 @@ EOT
         end
       end
     end
-    
+
     def tag_end(name)
       if name =~ /\Ah\d+/
         @headlines.push({"level" => @level, "id" => @id, "title" => @content}) unless @id.nil?
@@ -417,7 +501,7 @@ EOT
         @id = nil
       end
     end
-    
+
     def text(text)
       unless @level.nil?
         @content << text.gsub("\t", "　") # FIXME:区切り文字