Class: NovelConverter

Inherits:
Object
  • Object
show all
Includes:
Narou::Eventable
Defined in:
lib/novelconverter.rb

Constant Summary collapse

NOVEL_TEXT_TEMPLATE_NAME = 
"novel.txt"
NOVEL_TEXT_TEMPLATE_NAME_FOR_IBUNKO = 
"ibunko_novel.txt"
@@site_settings = 
Downloader.load_settings

Constants included from Narou::Eventable

Narou::Eventable::EVENTS_CONTAINER

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Narou::Eventable

#add_event_listener, included, #one, #remove_event_listener, #trigger_event

Constructor Details

#initialize(setting, output_filename = nil, display_inspector = false) ⇒ NovelConverter

Returns a new instance of NovelConverter.



316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/novelconverter.rb', line 316

def initialize(setting, output_filename = nil, display_inspector = false)
  @setting = setting
  @novel_id = setting.id
  @novel_author = setting.author
  @novel_title = setting.title
  @output_filename = output_filename
  @inspector = Inspector.new(@setting)
  @illustration = Illustration.new(@setting, @inspector)
  @display_inspector = display_inspector
  @use_dakuten_font = false
  @converter = create_converter
end

Instance Attribute Details

#use_dakuten_font ⇒ Object (readonly)

Returns the value of attribute use_dakuten_font.



26
27
28
 
# File 'lib/novelconverter.rb', line 26

def use_dakuten_font
  @use_dakuten_font
end

Class Method Details

.convert(target, options = {}) ⇒ Object

指定の小説を整形・変換する



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/novelconverter.rb', line 35

def self.convert(target, options = {})
  options = {
    # default paraeters
    output_filename: nil, display_inspector: false,
    ignore_force: false, ignore_default: false
  }.merge(options)
  setting = NovelSetting.load(target, options[:ignore_force], options[:ignore_default])
  if setting
    novel_converter = new(setting, options[:output_filename], options[:display_inspector])
    return {
      converted_txt_path: novel_converter.convert_main,
      use_dakuten_font: novel_converter.use_dakuten_font
    }
  end
  nil
end

.convert_file(filename, options = {}) ⇒ Object

テキストファイルを整形・変換する



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/novelconverter.rb', line 55

def self.convert_file(filename, options = {})
  options = {
    # default parameters
    encoding: nil, output_filename: nil, display_inspector: false,
    ignore_force: false, ignore_default: false
  }.merge(options)
  output_filename = options[:output_filename]
  if output_filename
    archive_path = File.dirname(output_filename) + "/"
  else
    archive_path = File.dirname(filename) + "/"
  end
  setting = NovelSetting.create(archive_path, options[:ignore_force], options[:ignore_default])
  setting.author = ""
  setting.title = File.basename(filename)
  novel_converter = new(setting, output_filename, options[:display_inspector])
  text = open(filename, "r:BOM|UTF-8") { |fp| fp.read }.gsub("\r", "")
  if options[:encoding]
    text.force_encoding(options[:encoding]).encode!(Encoding::UTF_8)
  end
  {
    converted_txt_path: novel_converter.convert_main(text),
    use_dakuten_font: novel_converter.use_dakuten_font
  }
end

.convert_txt_to_ebook_file(txt_path, options) ⇒ Object

変換された整形済みテキストファイルをデバイスに対応した書籍データに変換する



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
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
 
# File 'lib/novelconverter.rb', line 265

def self.convert_txt_to_ebook_file(txt_path, options)
  options = {
    use_dakuten_font: false,
    dst_dir: nil,
    device: nil,
    verbose: false,
    no_epub: false,
    no_mobi: false,
    no_strip: false
  }.merge(options)

  device = options[:device]

  return false if options[:no_epub]
  # epub
  status = NovelConverter.txt_to_epub(txt_path, options[:use_dakuten_font],
                                      options[:dst_dir], device, options[:verbose])
  return nil if status != :success
  if device && device.kobo?
    epub_ext = device.ebook_file_ext
  else
    epub_ext = ".epub"
  end
  epub_path = txt_path.sub(/.txt$/, epub_ext)

  if !device || !device.kindle? || options[:no_mobi]
    puts File.basename(epub_path) + " を出力しました"
    puts "<bold><green>EPUBファイルを出力しました</green></bold>".termcolor
    return epub_path
  end

  # mobi
  status = NovelConverter.epub_to_mobi(epub_path, options[:verbose])
  return nil if status != :success
  mobi_path = epub_path.sub(/\.epub$/, device.ebook_file_ext)

  # strip
  unless options[:no_strip]
    puts "kindlestrip実行中"
    begin
      SectionStripper.strip(mobi_path, nil, false)
    rescue StripException => e
      error "#{e.message}"
    end
  end
  puts File.basename(mobi_path).encode(Encoding::UTF_8) + " を出力しました"
  puts "<bold><green>MOBIファイルを出力しました</green></bold>".termcolor

  return mobi_path
end

.epub_to_mobi(epub_path, verbose = false) ⇒ Object

EPUBファイルをkindlegenでMOBIへ AozoraEpub3.jar と同じ場所に kindlegen が無ければ何もしない

返り値：正常終了 :success、エラー終了 :error、中断終了 :abort



216
217
218
219
220
221
222
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
258
259
260
 
# File 'lib/novelconverter.rb', line 216

def self.epub_to_mobi(epub_path, verbose = false)
  kindlegen_path = File.join(File.dirname(Narou.get_aozoraepub3_path), "kindlegen")
  if Dir.glob(kindlegen_path + "*").empty?
    error "kindlegenが見つかりませんでした。AozoraEpub3と同じディレクトリにインストールして下さい"
    return :error
  end

  if Helper.os_cygwin?
    epub_path = Helper.convert_to_windows_path(epub_path)
  end
  command = %!"#{kindlegen_path}" -locale ja "#{epub_path}"!
  if Helper.os_windows?
    command.encode!(Encoding::Windows_31J)
  end
  print "kindlegen実行中"
  res = Helper::AsyncCommand.exec(command) do
    print "."
  end
  stdout_capture, _, proccess_status = res
  stdout_capture.force_encoding(Encoding::UTF_8)

  if verbose
    puts
    puts "==== kindlegen stdout capture " + "=" * 49
    puts stdout_capture.gsub("\n\n", "\n").strip
    puts "=" * 79
  end

  if proccess_status.exited?
    if proccess_status.exitstatus == 2
      puts ""
      error "kindlegen実行中にエラーが発生したため、MOBIが出力出来ませんでした"
      if stdout_capture.scan(/(エラー\(.+?\):\w+?:.+)$/)
        error $1
      end
      return :error
    end
  else
    puts ""
    error "kindlegenが中断させられたぽいのでMOBIは出力出来ませんでした"
    return :abort
  end
  puts "変換しました"
  :success
end

.get_cover_filename(archive_path) ⇒ Object

表紙用の画像名取得



415
416
417
418
419
420
421
422
423
424
 
# File 'lib/novelconverter.rb', line 415

def self.get_cover_filename(archive_path)
  [".jpg", ".png", ".jpeg"].each do |ext|
    filename = "cover#{ext}"
    cover_path = File.join(archive_path, filename)
    if File.exist?(cover_path)
      return filename
    end
  end
  nil
end

.stash_aozora_fonts_directory ⇒ Object 



81
82
83
84
85
 
# File 'lib/novelconverter.rb', line 81

def self.stash_aozora_fonts_directory
  fonts_path = File.join(File.dirname(Narou.get_aozoraepub3_path), "template/OPS/fonts")
  return unless File.exist?(fonts_path)
  FileUtils.mv(fonts_path, fonts_path + "_hide")
end

.txt_to_epub(filename, use_dakuten_font = false, dst_dir = nil, device = nil, verbose = false) ⇒ Object

AozoraEpub3でEPUBファイル作成

AozoraEpub3は.jarがあるところがカレントディレクトリじゃないとうまく動かない MEMO: 逆にカレントディレクトリにAozoraEpub3の必須ファイルを置いて手を加えることで、 テンプレート等の差し替えが容易になる

返り値：正常終了 :success、エラー終了 :error、AozoraEpub3が見つからなかった nil



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/novelconverter.rb', line 103

def self.txt_to_epub(filename, use_dakuten_font = false, dst_dir = nil, device = nil, verbose = false)
  abs_srcpath = File.expand_path(filename)
  src_dir = File.dirname(abs_srcpath)

  cover_option = ""
  # MEMO: 外部実行からだと -c FILENAME, -c 1 オプションはぬるぽが出て動かない
  cover_filename = get_cover_filename(src_dir)
  if cover_filename
    cover_option = "-c 0"   # 先頭の挿絵を表紙として利用
  end

  dst_option = ""
  if dst_dir
    dst_option = %!-dst "#{File.expand_path(dst_dir)}"!
  end

  ext_option = ""
  device_option = ""
  if device
    case device.name
    when "Kobo"
      ext_option = "-ext " + device.ebook_file_ext
    when "Kindle"
      device_option = "-device kindle"
    end
  end

  pwd = Dir.pwd

  aozoraepub3_path = Narou.get_aozoraepub3_path
  unless aozoraepub3_path
    error "AozoraEpub3が見つからなかったのでEPUBが出力出来ませんでした。" +
          "narou initでAozoraEpub3の設定を行なって下さい"
    return nil
  end
  aozoraepub3_basename = File.basename(aozoraepub3_path)
  aozoraepub3_dir = File.dirname(aozoraepub3_path)

  java_encoding = "-Dfile.encoding=UTF-8"

  if Helper.os_cygwin?
    abs_srcpath = Helper.convert_to_windows_path(abs_srcpath)
  end
  Dir.chdir(aozoraepub3_dir)
  command = %!java #{java_encoding} -cp #{aozoraepub3_basename} AozoraEpub3 -enc UTF-8 -of #{device_option} ! +
            %!#{cover_option} #{dst_option} #{ext_option} "#{abs_srcpath}"!
  if Helper.os_windows?
    command = "cmd /c " + command.encode(Encoding::Windows_31J)
  end
  stash_aozora_fonts_directory unless use_dakuten_font
  print "AozoraEpub3でEPUBに変換しています"
  begin
    res = Helper::AsyncCommand.exec(command) do
      print "."
    end
  ensure
    visible_aozora_fonts_directory unless use_dakuten_font
    Dir.chdir(pwd)
  end

  # AozoraEpub3はエラーだとしてもexitコードは0なので、
  # 失敗した場合はjavaが実行できない場合と確定できる
  unless res[2].success?
    puts
    puts res
    error "JavaがインストールされていないかAozoraEpub3実行時にエラーが発生しました。EPUBを作成出来ませんでした"
    return :error
  end

  stdout_capture = res[0]

  # Javaの実行環境に由来するであろうエラー
  if stdout_capture =~ /Error occurred during initialization of VM/
    puts
    warn stdout_capture.strip
    warn "-" * 70
    error "Javaの実行エラーが発生しました。EPUBを作成出来ませんでした\n" \
          "Hint: 複数のJava環境が混じっていると起きやすいエラーのようです"
    return :error
  end

  if verbose
    puts
    puts "==== AozoraEpub3 stdout capture " + "=" * 47
    puts stdout_capture.strip
    puts "=" * 79
  end

  error_list = stdout_capture.scan(/^(?:\[ERROR\]|エラーが発生しました :).+$/)
  warn_list = stdout_capture.scan(/^\[WARN\].+$/)
  info_list = stdout_capture.scan(/^\[INFO\].+$/)
  if !error_list.empty? || !warn_list.empty? || !info_list.empty?
    puts
    puts error_list, warn_list, info_list
    unless error_list.empty?
      # AozoraEpub3 のエラーにはEPUBが出力されないエラーとEPUBが出力されるエラーの2種類ある。
      # EPUBが出力される場合は「変換完了」という文字があるのでそれを検出する
      if stdout_capture !~ /^変換完了/
        error "AozoraEpub3実行中にエラーが発生したため、EPUBが出力出来ませんでした"
        return :error
      end
    end
  end
  puts "変換しました"
  :success
end

.visible_aozora_fonts_directory ⇒ Object 



87
88
89
90
91
 
# File 'lib/novelconverter.rb', line 87

def self.visible_aozora_fonts_directory
  fonts_path = File.join(File.dirname(Narou.get_aozoraepub3_path), "template/OPS/fonts")
  return unless File.exist?(fonts_path + "_hide")
  FileUtils.mv(fonts_path + "_hide", fonts_path)
end

Instance Method Details

#convert_main(text = nil) ⇒ Object

変換処理メインループ



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/novelconverter.rb', line 332

def convert_main(text = nil)
  display_header
  initialize_event

  if text
    converted_text = convert_main_for_text(text)
  else
    converted_text = convert_main_for_novel
    update_latest_convert_novel
  end

  inspect_novel(converted_text)

  output_path = create_output_path(text, converted_text)
  File.write(output_path, converted_text)

  display_footer

  output_path
end

#convert_main_for_novel(subtitles = nil, is_hotentry = false) ⇒ Object

管理小説変換時の実質的なメイン処理

引数 subtitles にデータを渡した場合はそれを直接使う is_hotentry を有効にすると出力されるテキストファイルにあらすじや作品タイトル等が含まれなくなる



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/novelconverter.rb', line 498

def convert_main_for_novel(subtitles = nil, is_hotentry = false)
  toc = Downloader.get_toc_data(@setting.archive_path)
  toc["story"] = @converter.convert(toc["story"], "story")
  html = HTML.new
  html.strip_decoration_tag = @setting.enable_strip_decoration_tag
  site_setting = find_site_setting(toc["toc_url"])
  html.set_illust_setting({current_url: site_setting["illust_current_url"],
                           grep_pattern: site_setting["illust_grep_pattern"]})

  subtitles ||= toc["subtitles"]
  sections = subtitles_to_sections(subtitles, html)
  converted_text = create_novel_text_by_template(sections, toc, is_hotentry)

  converted_text
end

#convert_main_for_text(text) ⇒ Object

テキストファイル変換時の実質的なメイン処理



477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/novelconverter.rb', line 477

def convert_main_for_text(text)
  result = @converter.convert(text, "textfile")
  unless @setting.enable_enchant_midashi
    @inspector.info "テキストファイルの処理を実行しましたが、改行直後の見出し付与は有効になっていません。" +
                    "setting.ini の enable_enchant_midashi を true にすることをお薦めします。"
  end
  splited = result.split("\n", 3)
  # 表紙の挿絵注記を3行目に挟み込む
  converted_text = [splited[0], splited[1], create_cover_chuki, splited[2]].join("\n")

  @use_dakuten_font = @converter.use_dakuten_font

  converted_text
end

#create_converter ⇒ Object

各小説用の converter.rb 変換オブジェクトを生成



448
449
450
 
# File 'lib/novelconverter.rb', line 448

def create_converter
  load_converter(@novel_title, @setting.archive_path).new(@setting, @inspector, @illustration)
end

#create_cover_chuki ⇒ Object

表紙用挿絵注記作成



429
430
431
432
433
434
435
436
 
# File 'lib/novelconverter.rb', line 429

def create_cover_chuki
  cover_filename = self.class.get_cover_filename(@setting.archive_path)
  if cover_filename
    "［＃挿絵（#{cover_filename}）入る］"
  else
    ""
  end
end

#create_novel_text_by_template(sections, toc, is_hotentry = false) ⇒ Object

is_hotentry を有効にすると、テンプレートで作成するテキストファイルに あらすじ、作品タイトル、本の読み終わり表示が付与されなくなる



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/novelconverter.rb', line 384

def create_novel_text_by_template(sections, toc, is_hotentry = false)
  cover_chuki = create_cover_chuki
  device = Narou.get_device
  setting = @setting
  processed_title = toc["title"]
  data = Database.instance.get_data("id", @novel_id)
  # タイトルに新着更新日を付加する
  if @setting.enable_add_date_to_title
    new_arrivals_date = data[@setting.title_date_target] || Time.now
    date_str = new_arrivals_date.strftime(@setting.title_date_format)
    if @setting.title_date_align == "left"
      processed_title = date_str + processed_title
    else  # right
      processed_title += date_str
    end
  end
  # タイトルに完結したかどうかを付加する
  tags = data["tags"] || []
  if tags.include?("end")
    processed_title += " (完結)"
  end
  # タイトルがルビ化されてしまうのを抑制
  processed_title = processed_title.gsub("《", "※［＃始め二重山括弧］")
                                   .gsub("》", "※［＃終わり二重山括弧］")
  tempalte_name = (device && device.ibunko? ? NOVEL_TEXT_TEMPLATE_NAME_FOR_IBUNKO : NOVEL_TEXT_TEMPLATE_NAME)
  Template.get(tempalte_name, binding, 1.1)
end

#create_output_path(is_text_file_mode, converted_text) ⇒ Object

最終的に出力するパスを生成



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/novelconverter.rb', line 455

def create_output_path(is_text_file_mode, converted_text)
  output_path = ""
  if @output_filename
    output_path = File.join(@setting.archive_path, File.basename(@output_filename))
  else
    if is_text_file_mode
      info = get_title_and_author_by_text(converted_text)
    else
      info = { "author" => @novel_author, "title" => @novel_title }
    end
    filename = Narou.create_novel_filename(info)
    output_path = File.join(@setting.archive_path, filename)
    if output_path !~ /\.\w+$/
      output_path += ".txt"
    end
  end
  output_path
end

#display_footer ⇒ Object 



372
373
374
 
# File 'lib/novelconverter.rb', line 372

def display_footer
  puts "縦書用の変換が終了しました"
end

#display_header ⇒ Object 



367
368
369
370
 
# File 'lib/novelconverter.rb', line 367

def display_header
  print "ID:#{@novel_id}　" if @novel_id
  puts "#{@novel_title} の変換を開始"
end

#find_site_setting(toc_url) ⇒ Object

目次情報からサイト設定を取得



441
442
443
 
# File 'lib/novelconverter.rb', line 441

def find_site_setting(toc_url)
  @@site_settings.find { |s| s.multi_match(toc_url, "url") }
end

#get_title_and_author_by_text(text) ⇒ Object

テキストデータ先頭二行からタイトルと作者名を取得



549
550
551
552
 
# File 'lib/novelconverter.rb', line 549

def get_title_and_author_by_text(text)
  title, author = text.split("\n", 3)
  { "title" => title, "author" => author }
end

#initialize_event ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/novelconverter.rb', line 353

def initialize_event
  progressbar = nil

  one(:"convert_main.init") do |subtitles|
    progressbar = ProgressBar.new(subtitles.size)
  end
  on(:"convert_main.loop") do |i|
    progressbar.output(i)
  end
  one(:"convert_main.finish") do
    progressbar.clear
  end
end

#inspect_novel(text) ⇒ Object 



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/novelconverter.rb', line 554

def inspect_novel(text)
  if @setting.enable_inspect
    @inspector.inspect_end_touten_conditions(text)   # 行末読点の現在状況を調査する
    @inspector.countup_return_in_brackets(text)      # カギ括弧内の改行状況を調査する
  end

  if !@display_inspector
    unless @inspector.empty?
      puts "小説状態の調査結果を #{Inspector::INSPECT_LOG_NAME} に出力しました"
    end
  else
    # 小説の監視・検査状況を表示する
    if @inspector.error? || @inspector.warning?
      puts "<bold><yellow>―――― 小説にエラーもしくは警告が存在します ――――</yellow></bold>".termcolor
      puts ""
      @inspector.display(Inspector::ERROR | Inspector::WARNING)
      puts ""
    end
    if @inspector.info?
      puts "<bold><yellow>―――― 小説の検査状況を表示します ――――</yellow></bold>".termcolor
      puts ""
      @inspector.display(Inspector::INFO)
      puts ""
    end
  end

  @inspector.save
end

#load_novel_section(subtitle_info, section_save_dir) ⇒ Object 



376
377
378
379
380
 
# File 'lib/novelconverter.rb', line 376

def load_novel_section(subtitle_info, section_save_dir)
  file_subtitle = subtitle_info["file_subtitle"] || subtitle_info["subtitle"]   # 互換性維持のため
  path = File.join(section_save_dir, "#{subtitle_info["index"]} #{file_subtitle}.yaml")
  YAML.load_file(path)
end

#subtitles_to_sections(subtitles, html) ⇒ Object

subtitle info から変換処理をする



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/novelconverter.rb', line 517

def subtitles_to_sections(subtitles, html)
  sections = []
  section_save_dir = Downloader.get_novel_section_save_dir(@setting.archive_path)

  trigger(:"convert_main.init", subtitles)
  subtitles.each_with_index do |subinfo, i|
    trigger(:"convert_main.loop", i)
    section = load_novel_section(subinfo, section_save_dir)
    if section["chapter"].length > 0
      section["chapter"] = @converter.convert(section["chapter"], "chapter")
    end
    @inspector.subtitle = section["subtitle"]
    element = section["element"]
    data_type = element.delete("data_type") || "text"
    element.each do |text_type, elm_text|
      if data_type == "html"
        html.string = elm_text
        elm_text = html.to_aozora
      end
      element[text_type] = @converter.convert(elm_text, text_type)
    end
    section["subtitle"] = @converter.convert(section["subtitle"], "subtitle")
    sections << section
  end
  trigger(:"convert_main.finish")
  @use_dakuten_font = @converter.use_dakuten_font
  sections
end

#update_latest_convert_novel ⇒ Object

最近変換した小説IDを記録更新



586
587
588
589
590
591
592
 
# File 'lib/novelconverter.rb', line 586

def update_latest_convert_novel
  id = Downloader.get_id_by_target(@novel_title)
  Inventory.load("latest_convert", :local).tap { |inv|
    inv["id"] = id
    inv.save
  }
end