Class: ReVIEW::EPUBMaker

Inherits:
Object show all
Includes:
EPUBMaker, REXML
Defined in:
lib/review/epubmaker.rb

Defined Under Namespace

Classes: ReVIEWHeaderListener

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EPUBMaker

Returns a new instance of EPUBMaker.



31
32
33
34
35
36
 
# File 'lib/review/epubmaker.rb', line 31

def initialize
  @producer = nil
  @htmltoc = nil
  @buildlogtxt = 'build-log.txt'
  @logger = ReVIEW.logger
end

Instance Method Details

#build_body(basetmpdir, yamlfile) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/review/epubmaker.rb', line 223

def build_body(basetmpdir, yamlfile)
  @precount = 0
  @bodycount = 0
  @postcount = 0

  @manifeststr = ''
  @ncxstr = ''
  @tocdesc = []

  basedir = File.dirname(yamlfile)
  base_path = Pathname.new(basedir)
  book = ReVIEW::Book.load(basedir)
  book.config = @config
  @converter = ReVIEW::Converter.new(book, ReVIEW::HTMLBuilder.new)
  @compile_errors = nil
  book.parts.each do |part|
    if part.name.present?
      if part.file?
        build_chap(part, base_path, basetmpdir, true)
      else
        htmlfile = "part_#{part.number}.#{@config['htmlext']}"
        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?
        @htmltoc.add_item(0, htmlfile, title, chaptype: 'part')
        write_buildlogtxt(basetmpdir, htmlfile, '')
      end
    end

    part.chapters.each do |chap|
      build_chap(chap, base_path, basetmpdir, false)
    end
  end
  check_compile_status
end

#build_chap(chap, base_path, basetmpdir, ispart) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/review/epubmaker.rb', line 286

def build_chap(chap, base_path, basetmpdir, ispart)
  chaptype = 'body'
  if ispart
    chaptype = 'part'
  elsif chap.on_predef?
    chaptype = 'pre'
  elsif chap.on_appendix?
    chaptype = 'post'
  end

  filename =
    if ispart.present?
      chap.path
    else
      Pathname.new(chap.path).relative_path_from(base_path).to_s
    end

  id = filename.sub(/\.re\Z/, '')

  if @config['epubmaker']['rename_for_legacy'] && ispart.nil?
    if chap.on_predef?
      @precount += 1
      id = sprintf('pre%02d', @precount)
    elsif chap.on_appendix?
      @postcount += 1
      id = sprintf('post%02d', @postcount)
    else
      @bodycount += 1
      id = sprintf('chap%02d', @bodycount)
    end
  end

  htmlfile = "#{id}.#{@config['htmlext']}"
  write_buildlogtxt(basetmpdir, htmlfile, filename)
  log("Create #{htmlfile} from #{filename}.")

  if @config['params'].present?
    warn %Q('params:' in config.yml is obsoleted.)
    if @config['params'] =~ /stylesheet=/
      warn %Q(stylesheets should be defined in 'stylesheet:', not in 'params:')
    end
  end
  begin
    @converter.convert(filename, File.join(basetmpdir, htmlfile))
    write_info_body(basetmpdir, id, htmlfile, ispart, chaptype)
    remove_hidden_title(basetmpdir, htmlfile)
  rescue => e
    @compile_errors = true
    warn "compile error in #{filename} (#{e.class})"
    warn e.message
  end
end

#build_part(part, basetmpdir, htmlfile) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/review/epubmaker.rb', line 259

def build_part(part, basetmpdir, htmlfile)
  log("Create #{htmlfile} from a template.")
  File.open("#{basetmpdir}/#{htmlfile}", 'w') do |f|
    @body = ''
    @body << %Q(<div class="part">\n)
    @body << %Q(<h1 class="part-number">#{CGI.escapeHTML(ReVIEW::I18n.t('part', part.number))}</h1>\n)
    if part.name.strip.present?
      @body << %Q(<h2 class="part-title">#{CGI.escapeHTML(part.name.strip)}</h2>\n)
    end
    @body << %Q(</div>\n)

    @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)
  end
end

#build_path ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/review/epubmaker.rb', line 60

def build_path
  if @config['debug']
    path = File.expand_path("#{@config['bookname']}-epub", Dir.pwd)
    FileUtils.rm_rf(path, secure: true) if File.exist?(path)
    Dir.mkdir(path)
    path
  else
    Dir.mktmpdir("#{@config['bookname']}-epub-")
  end
end

#build_titlepage(basetmpdir, htmlfile) ⇒ Object 



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/review/epubmaker.rb', line 429

def build_titlepage(basetmpdir, htmlfile)
  # TODO: should be created via epubcommon
  @title = CGI.escapeHTML(@config.name_of('booktitle'))
  File.open("#{basetmpdir}/#{htmlfile}", 'w') do |f|
    @body = ''
    @body << %Q(<div class="titlepage">\n)
    @body << %Q(<h1 class="tp-title">#{CGI.escapeHTML(@config.name_of('booktitle'))}</h1>\n)
    @body << %Q(<h2 class="tp-subtitle">#{CGI.escapeHTML(@config.name_of('subtitle'))}</h2>\n) if @config['subtitle']
    @body << %Q(<h2 class="tp-author">#{CGI.escapeHTML(@config.names_of('aut').join(ReVIEW::I18n.t('names_splitter')))}</h2>\n) if @config['aut']
    @body << %Q(<h3 class="tp-publisher">#{CGI.escapeHTML(@config.names_of('prt').join(ReVIEW::I18n.t('names_splitter')))}</h3>\n) if @config['prt']
    @body << '</div>'

    @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)
  end
end

#call_hook(hook_name, *params) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/review/epubmaker.rb', line 142

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

#check_compile_status ⇒ Object 



216
217
218
219
220
221
 
# File 'lib/review/epubmaker.rb', line 216

def check_compile_status
  return unless @compile_errors

  $stderr.puts 'compile error, No EPUB file output.'
  exit 1
end

#check_image_size(basetmpdir, maxpixels, allow_exts = nil) ⇒ Object 



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/review/epubmaker.rb', line 481

def check_image_size(basetmpdir, maxpixels, allow_exts = nil)
  begin
    require 'image_size'
  rescue LoadError
    return nil
  end
  require 'find'
  allow_exts ||= @config['image_ext']

  extre = Regexp.new('\\.(' + allow_exts.delete_if { |t| %w[ttf woff otf].include?(t) }.join('|') + ')', 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}/", '')
    warn "#{fname}: #{img.width}x#{img.height} exceeds a limit. suggeted value is #{w.to_i}x#{h.to_i}"
  end

  true
end

#copy_backmatter(basetmpdir) ⇒ Object 



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/review/epubmaker.rb', line 449

def copy_backmatter(basetmpdir)
  if @config['profile']
    FileUtils.cp(@config['profile'], "#{basetmpdir}/#{File.basename(@config['profile'])}")
    @htmltoc.add_item(1, File.basename(@config['profile']), @producer.res.v('profiletitle'), chaptype: 'post')
  end

  if @config['advfile']
    FileUtils.cp(@config['advfile'], "#{basetmpdir}/#{File.basename(@config['advfile'])}")
    @htmltoc.add_item(1, File.basename(@config['advfile']), @producer.res.v('advtitle'), chaptype: 'post')
  end

  if @config['colophon']
    if @config['colophon'].is_a?(String) # FIXME: should let obsolete this style?
      FileUtils.cp(@config['colophon'], "#{basetmpdir}/colophon.#{@config['htmlext']}")
    else
      File.open("#{basetmpdir}/colophon.#{@config['htmlext']}", 'w') { |f| @producer.colophon(f) }
    end
    @htmltoc.add_item(1, "colophon.#{@config['htmlext']}", @producer.res.v('colophontitle'), chaptype: 'post')
  end

  if @config['backcover']
    FileUtils.cp(@config['backcover'], "#{basetmpdir}/#{File.basename(@config['backcover'])}")
    @htmltoc.add_item(1, File.basename(@config['backcover']), @producer.res.v('backcovertitle'), chaptype: 'post')
  end

  true
end

#copy_frontmatter(basetmpdir) ⇒ Object 



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/review/epubmaker.rb', line 404

def copy_frontmatter(basetmpdir)
  FileUtils.cp(@config['cover'], "#{basetmpdir}/#{File.basename(@config['cover'])}") if @config['cover'].present? && File.exist?(@config['cover'])

  if @config['titlepage']
    if @config['titlefile'].nil?
      build_titlepage(basetmpdir, "titlepage.#{@config['htmlext']}")
    else
      FileUtils.cp(@config['titlefile'], "#{basetmpdir}/titlepage.#{@config['htmlext']}")
    end
    @htmltoc.add_item(1, "titlepage.#{@config['htmlext']}", @producer.res.v('titlepagetitle'), chaptype: 'pre')
  end

  if @config['originaltitlefile'].present? && File.exist?(@config['originaltitlefile'])
    FileUtils.cp(@config['originaltitlefile'], "#{basetmpdir}/#{File.basename(@config['originaltitlefile'])}")
    @htmltoc.add_item(1, File.basename(@config['originaltitlefile']), @producer.res.v('originaltitle'), chaptype: 'pre')
  end

  if @config['creditfile'].present? && File.exist?(@config['creditfile'])
    FileUtils.cp(@config['creditfile'], "#{basetmpdir}/#{File.basename(@config['creditfile'])}")
    @htmltoc.add_item(1, File.basename(@config['creditfile']), @producer.res.v('credittitle'), chaptype: 'pre')
  end

  true
end

#copy_images(resdir, destdir, allow_exts = nil) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/review/epubmaker.rb', line 174

def copy_images(resdir, destdir, allow_exts = nil)
  return nil unless File.exist?(resdir)
  allow_exts = @config['image_ext'] if allow_exts.nil?
  FileUtils.mkdir_p(destdir)
  if @config['epubmaker']['verify_target_images'].present?
    @config['epubmaker']['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}")
      log("Copy #{file} to the temporary directory.")
      FileUtils.cp(file, "#{destdir}/#{basedir}")
    end
  else
    recursive_copy_files(resdir, destdir, allow_exts)
  end
end

#copy_resources(resdir, destdir, allow_exts = nil) ⇒ Object 



194
195
196
197
198
199
 
# File 'lib/review/epubmaker.rb', line 194

def copy_resources(resdir, destdir, allow_exts = nil)
  return nil unless File.exist?(resdir)
  allow_exts = @config['image_ext'] if allow_exts.nil?
  FileUtils.mkdir_p(destdir)
  recursive_copy_files(resdir, destdir, allow_exts)
end

#copy_stylesheet(basetmpdir) ⇒ Object 



396
397
398
399
400
401
402
 
# File 'lib/review/epubmaker.rb', line 396

def copy_stylesheet(basetmpdir)
  return if @config['stylesheet'].empty?
  @config['stylesheet'].each do |sfile|
    FileUtils.cp(sfile, basetmpdir)
    @producer.contents.push(Content.new('file' => sfile))
  end
end

#detect_properties(path) ⇒ Object 



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/review/epubmaker.rb', line 350

def detect_properties(path)
  properties = []
  File.open(path) do |f|
    doc = REXML::Document.new(f)
    if REXML::XPath.first(doc, '//m:math', 'm' => 'http://www.w3.org/1998/Math/MathML')
      properties << 'mathml'
    end
    if REXML::XPath.first(doc, '//s:svg', 's' => 'http://www.w3.org/2000/svg')
      properties << 'svg'
    end
  end
  properties
end

#error(msg) ⇒ Object 



38
39
40
41
 
# File 'lib/review/epubmaker.rb', line 38

def error(msg)
  @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
  exit 1
end

#load_yaml(yamlfile) ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/review/epubmaker.rb', line 51

def load_yaml(yamlfile)
  loader = ReVIEW::YAMLLoader.new
  @config = ReVIEW::Configure.values.deep_merge(loader.load_file(yamlfile))
  @producer = Producer.new(@config)
  @producer.load(yamlfile)
  @config = @producer.config
  @config.maker = 'epubmaker'
end

#log(s) ⇒ Object 



47
48
49
 
# File 'lib/review/epubmaker.rb', line 47

def log(s)
  puts s if @config['debug'].present?
end

#produce(yamlfile, bookname = nil) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/review/epubmaker.rb', line 71

def produce(yamlfile, bookname = nil)
  load_yaml(yamlfile)
  I18n.setup(@config['language'])
  bookname = @config['bookname'] if bookname.nil?
  booktmpname = "#{bookname}-epub"

  begin
    @config.check_version(ReVIEW::VERSION)
  rescue ReVIEW::ConfigError => e
    warn e.message
  end
  log("Loaded yaml file (#{yamlfile}). I will produce #{bookname}.epub.")

  FileUtils.rm_f("#{bookname}.epub")
  FileUtils.rm_rf(booktmpname) if @config['debug']
  math_dir = "./#{@config['imagedir']}/_review_math"
  FileUtils.rm_rf(math_dir) if @config['imgmath'] && Dir.exist?(math_dir)

  basetmpdir = build_path
  begin
    log("Created first temporary directory as #{basetmpdir}.")

    call_hook('hook_beforeprocess', basetmpdir)

    @htmltoc = ReVIEW::HTMLToc.new(basetmpdir)
    ## copy all files into basetmpdir
    copy_stylesheet(basetmpdir)

    copy_frontmatter(basetmpdir)
    call_hook('hook_afterfrontmatter', basetmpdir)

    build_body(basetmpdir, yamlfile)
    call_hook('hook_afterbody', basetmpdir)

    copy_backmatter(basetmpdir)
    call_hook('hook_afterbackmatter', basetmpdir)

    ## push contents in basetmpdir into @producer
    push_contents(basetmpdir)

    if @config['epubmaker']['verify_target_images'].present?
      verify_target_images(basetmpdir)
      copy_images(@config['imagedir'], basetmpdir)
    else
      copy_images(@config['imagedir'], "#{basetmpdir}/#{@config['imagedir']}")
    end

    copy_resources('covers', "#{basetmpdir}/#{@config['imagedir']}")
    copy_resources('adv', "#{basetmpdir}/#{@config['imagedir']}")
    copy_resources(@config['fontdir'], "#{basetmpdir}/fonts", @config['font_ext'])

    call_hook('hook_aftercopyimage', basetmpdir)

    @producer.import_imageinfo("#{basetmpdir}/#{@config['imagedir']}", basetmpdir)
    @producer.import_imageinfo("#{basetmpdir}/fonts", basetmpdir, @config['font_ext'])

    check_image_size(basetmpdir, @config['image_maxpixels'], @config['image_ext'])

    epubtmpdir = nil
    if @config['debug'].present?
      epubtmpdir = "#{basetmpdir}/#{booktmpname}"
      Dir.mkdir(epubtmpdir)
    end
    log('Call ePUB producer.')
    @producer.produce("#{bookname}.epub", basetmpdir, epubtmpdir)
    log('Finished.')
  ensure
    FileUtils.remove_entry_secure basetmpdir unless @config['debug']
  end
end

#push_contents(_basetmpdir) ⇒ Object 



383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/review/epubmaker.rb', line 383

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] }
    hash['id'] = args[:id] if args[:id].present?
    hash['properties'] = args[:properties].split(' ') if args[:properties].present?
    hash['notoc'] = args[:notoc] if args[:notoc].present?
    @producer.contents.push(Content.new(hash))
  end
end

#recursive_copy_files(resdir, destdir, allow_exts) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/review/epubmaker.rb', line 201

def recursive_copy_files(resdir, destdir, allow_exts)
  Dir.open(resdir) do |dir|
    dir.each do |fname|
      next if fname.start_with?('.')
      if FileTest.directory?("#{resdir}/#{fname}")
        recursive_copy_files("#{resdir}/#{fname}", "#{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("#{resdir}/#{fname}", destdir)
      end
    end
  end
end

#remove_hidden_title(basetmpdir, htmlfile) ⇒ Object 



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/review/epubmaker.rb', line 339

def remove_hidden_title(basetmpdir, htmlfile)
  File.open("#{basetmpdir}/#{htmlfile}", 'r+') do |f|
    body = f.read.
           gsub(%r{<h\d .*?hidden=['"]true['"].*?>.*?</h\d>\n}, '').
           gsub(%r{(<h\d .*?)\s*notoc=['"]true['"]\s*(.*?>.*?</h\d>\n)}, '\1\2')
    f.rewind
    f.print body
    f.truncate(f.tell)
  end
end

#template_name ⇒ Object 



278
279
280
281
282
283
284
 
# File 'lib/review/epubmaker.rb', line 278

def template_name
  if @producer.config['htmlversion'].to_i == 5
    './html/layout-html5.html.erb'
  else
    './html/layout-xhtml1.html.erb'
  end
end

#verify_target_images(basetmpdir) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/review/epubmaker.rb', line 154

def verify_target_images(basetmpdir)
  @producer.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|
          @config['epubmaker']['force_include_images'].push(e.attributes['src'])
          content.properties.push('svg') if e.attributes['src'] =~ /svg\Z/i
        end
      end
    elsif content.media == 'text/css'
      File.open("#{basetmpdir}/#{content.file}") do |f|
        f.each_line do |l|
          l.scan(/url\((.+?)\)/) { |_m| @config['epubmaker']['force_include_images'].push($1.strip) }
        end
      end
    end
  end
  @config['epubmaker']['force_include_images'] = @config['epubmaker']['force_include_images'].compact.sort.uniq
end

#warn(msg) ⇒ Object 



43
44
45
 
# File 'lib/review/epubmaker.rb', line 43

def warn(msg)
  @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
end

#write_buildlogtxt(basetmpdir, htmlfile, reviewfile) ⇒ Object 



477
478
479
 
# File 'lib/review/epubmaker.rb', line 477

def write_buildlogtxt(basetmpdir, htmlfile, reviewfile)
  File.open("#{basetmpdir}/#{@buildlogtxt}", 'a') { |f| f.puts "#{htmlfile},#{reviewfile}" }
end

#write_info_body(basetmpdir, _id, filename, ispart = nil, chaptype = nil) ⇒ Object 



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/review/epubmaker.rb', line 364

def write_info_body(basetmpdir, _id, filename, ispart = nil, chaptype = nil)
  headlines = []
  path = File.join(basetmpdir, filename)
  Document.parse_stream(File.new(path), ReVIEWHeaderListener.new(headlines))
  properties = detect_properties(path)
  prop_str = ''
  prop_str = ',properties=' + properties.join(' ') if properties.present?
  first = true
  headlines.each do |headline|
    headline['level'] = 0 if ispart.present? && headline['level'] == 1
    if first.nil?
      @htmltoc.add_item(headline['level'], filename + '#' + headline['id'], headline['title'], { chaptype: chaptype, notoc: headline['notoc'] })
    else
      @htmltoc.add_item(headline['level'], filename, headline['title'], { force_include: true, chaptype: chaptype + prop_str, notoc: headline['notoc'] })
      first = nil
    end
  end
end