Class: Downloader

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

Overview

小説サイトからのダウンロード

Defined Under Namespace

Classes: DownloaderNotFoundError, InvalidTarget

Constant Summary collapse

NOVEL_SITE_SETTING_DIR = 
"webnovel/"
SECTION_SAVE_DIR_NAME =

本文を保存するディレクトリ名

"本文"
CACHE_SAVE_DIR_NAME =

差分用キャッシュ保存用ディレクトリ名

"cache"
RAW_DATA_DIR_NAME =

本文の生データを保存するディレクトリ名

"raw"
TOC_FILE_NAME = 
"toc.yaml"
STEPS_WAIT_TIME =

数話ごとにかかるwaitの秒数

5
WAITING_TIME_FOR_503 =

503 のときに待機する秒数

20
RETRY_MAX_FOR_503 =

503 のときに何回再試行するか

5
NOVEL_TYPE_SERIES =

連載

1
NOVEL_TYPE_SS =

短編

2
DISPLAY_LIMIT_DIGITS =

indexの表示桁数限界

4
@@settings = 
load_settings
@@database = 
Database.instance

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(target, options = {}) ⇒ Downloader

Returns a new instance of Downloader.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/downloader.rb', line 42

def initialize(target, options = {})
  id = Downloader.get_id_by_target(target)
  options = {
    force: false, from_download: false,
    stream: $stdout
  }.merge(options)
  setting = Downloader.get_sitesetting_by_target(target)

  unless setting
    case type = Downloader.get_target_type(target)
    when :url, :ncode
      raise InvalidTarget, "対応外の#{type}です(#{target})"
    when :id
      raise InvalidTarget, "指定のID(#{target})は存在しません"
    when :other
      raise InvalidTarget, "指定の小説(#{target})は存在しません"
    end
  end

  initialize_variables(id, setting, options)
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



38
39
40
 
# File 'lib/downloader.rb', line 38

def id
  @id
end

Class Method Details

.create_subdirecotry_name(title) ⇒ Object

サブディレクトリ名を生成



266
267
268
 
# File 'lib/downloader.rb', line 266

def self.create_subdirecotry_name(title)
  title.start_with?("n") ? title[1..2] : title[0..1]
end

.detect_error_message(setting, source) ⇒ Object

HTMLの中から小説が削除されたか非公開なことを示すメッセージを検出する



682
683
684
685
686
 
# File 'lib/downloader.rb', line 682

def self.detect_error_message(setting, source)
  message = setting["error_message"]
  return false unless message
  source.match(message)
end

.get_cache_list(target) ⇒ Object

差分用キャッシュのディレクトリ一覧取得



255
256
257
258
259
260
261
 
# File 'lib/downloader.rb', line 255

def self.get_cache_list(target)
  dir = get_cache_root_dir(target)
  if dir
    return Dir.glob("#{dir}/*")
  end
  nil
end

.get_cache_root_dir(target) ⇒ Object

差分用キャッシュの保存ディレクトリ取得



244
245
246
247
248
249
250
 
# File 'lib/downloader.rb', line 244

def self.get_cache_root_dir(target)
  dir = get_novel_data_dir_by_target(target)
  if dir
    return File.join(dir, SECTION_SAVE_DIR_NAME, CACHE_SAVE_DIR_NAME)
  end
  nil
end

.get_data_by_target(target) ⇒ Object

target からデータベースのデータを取得



147
148
149
150
151
 
# File 'lib/downloader.rb', line 147

def self.get_data_by_target(target)
  target = Narou.alias_to_id(target)
  toc_url = get_toc_url(target) or return nil
  @@database.get_data("toc_url", toc_url)
end

.get_id_by_target(target) ⇒ Object

target のIDを取得



138
139
140
141
142
 
# File 'lib/downloader.rb', line 138

def self.get_id_by_target(target)
  target = Narou.alias_to_id(target)
  toc_url = get_toc_url(target) or return nil
  @@database.get_id("toc_url", toc_url)
end

.get_novel_data_dir_by_target(target) ⇒ Object

指定されたIDとかから小説の保存ディレクトリを取得



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
 
# File 'lib/downloader.rb', line 105

def self.get_novel_data_dir_by_target(target)
  target = Narou.alias_to_id(target)
  type = get_target_type(target)
  data = nil
  case type
  when :url, :ncode
    toc_url = get_toc_url(target)
    data = @@database.get_data("toc_url", toc_url)
  when :other
    data = @@database.get_data("title", target)
  when :id
    data = @@database[target.to_i]
  end
  return nil unless data
  id = data["id"]
  file_title = data["file_title"] || data["title"]   # 互換性維持のための処理
  use_subdirectory = data["use_subdirectory"] || false
  subdirectory = use_subdirectory ? create_subdirecotry_name(file_title) : ""
  path = File.join(Database.archive_root_path, data["sitename"], subdirectory, file_title)
  if File.exist?(path)
    return path
  else
    @@database.delete(id)
    @@database.save_database
    error "#{path} が見つかりません。\n" \
          "保存フォルダが消去されていたため、データベースのインデックスを削除しました。"
    return nil
  end
end

.get_novel_section_save_dir(archive_path) ⇒ Object

本文格納用ディレクトリを取得



79
80
81
 
# File 'lib/downloader.rb', line 79

def self.get_novel_section_save_dir(archive_path)
  File.join(archive_path, SECTION_SAVE_DIR_NAME)
end

.get_sitesetting_by_sitename(sitename) ⇒ Object 



210
211
212
213
214
215
 
# File 'lib/downloader.rb', line 210

def self.get_sitesetting_by_sitename(sitename)
  setting = @@settings.find { |s| s["name"] == sitename }
  return setting if setting
  error "#{sitename} の設定ファイルが見つかりません"
  exit Narou::EXIT_ERROR_CODE
end

.get_sitesetting_by_target(target) ⇒ Object

小説サイト設定を取得する



67
68
69
70
71
72
73
74
 
# File 'lib/downloader.rb', line 67

def self.get_sitesetting_by_target(target)
  toc_url = get_toc_url(target)
  setting = nil
  if toc_url
    setting = @@settings.find { |s| s.multi_match(toc_url, "url") }
  end
  setting
end

.get_target_type(target) ⇒ Object

target の種別を判別する

ncodeの場合、targetを破壊的に変更する



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/downloader.rb', line 88

def self.get_target_type(target)
  case target
  when URI.regexp
    :url
  when /^n\d+[a-z]+$/i
    target.downcase!
    :ncode
  when /^\d+$/, Fixnum
    :id
  else
    :other
  end
end

.get_toc_data(archive_path) ⇒ Object

toc 読込



156
157
158
 
# File 'lib/downloader.rb', line 156

def self.get_toc_data(archive_path)
  YAML.load_file(File.join(archive_path, TOC_FILE_NAME))
end

.get_toc_url(target) ⇒ Object

指定の小説の目次ページのURLを取得する

targetがURLかNコードの場合、実際には小説が存在しないURLが返ってくることがあるのを留意する



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/downloader.rb', line 165

def self.get_toc_url(target)
  target = Narou.alias_to_id(target)
  case get_target_type(target)
  when :url
    setting = @@settings.find { |s| s.multi_match(target, "url") }
    return setting["toc_url"] if setting
  when :ncode
    @@database.each do |_, data|
      if data["toc_url"] =~ %r!#{target}/$!
        return data["toc_url"]
      end
    end
    return "#{@@narou["top_url"]}/#{target}/"
  when :id
    data = @@database[target.to_i]
    return data["toc_url"] if data
  when :other
    data = @@database.get_data("title", target)
    return data["toc_url"] if data
  end
  nil
end

.load_settings ⇒ Object

小説サイトの定義ファイルを全部読み込む



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/downloader.rb', line 220

def self.load_settings
  settings = @@__settings_cache ||= []
  return settings unless settings.empty?
  Dir.glob(File.join(Narou.get_script_dir, NOVEL_SITE_SETTING_DIR, "*.yaml")) do |path|
    setting = SiteSetting.load_file(path)
    if setting["name"] == "小説家になろう"
      @@narou = setting
    end
    settings << setting
  end
  if settings.empty?
    error "小説サイトの定義ファイルがひとつもありません"
    exit Narou::EXIT_ERROR_CODE
  end
  unless @@narou
    error "小説家になろうの定義ファイルが見つかりませんでした"
    exit Narou::EXIT_ERROR_CODE
  end
  settings
end

.novel_exists?(target) ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
191
192
 
# File 'lib/downloader.rb', line 188

def self.novel_exists?(target)
  target = Narou.alias_to_id(target)
  id = get_id_by_target(target) or return nil
  @@database.novel_exists?(id)
end

.remove_novel(target, with_file = false) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/downloader.rb', line 194

def self.remove_novel(target, with_file = false)
  target = Narou.alias_to_id(target)
  data = get_data_by_target(target) or return nil
  data_dir = get_novel_data_dir_by_target(target)
  if with_file
    FileUtils.remove_entry_secure(data_dir, true)
    puts "#{data_dir} を完全に削除しました"
  else
    # TOCは消しておかないと再DL時に古いデータがあると誤認する
    File.delete(File.join(data_dir, TOC_FILE_NAME))
  end
  @@database.delete(data["id"])
  @@database.save_database
  data["title"]
end

Instance Method Details

#__search_index_in_subtitles(subtitles, index) ⇒ Object 



773
774
775
776
777
 
# File 'lib/downloader.rb', line 773

def __search_index_in_subtitles(subtitles, index)
  subtitles.index { |item|
    item["index"] == index
  }
end

#__search_latest_update_time(key, subtitles) ⇒ Object 



541
542
543
544
545
546
547
548
 
# File 'lib/downloader.rb', line 541

def __search_latest_update_time(key, subtitles)
  latest = Time.new(0)
  subtitles.each do |subtitle|
    time = Helper.date_string_to_time(subtitle[key])
    latest = time if latest < time
  end
  latest
end

#__strdate_to_ymd(date) ⇒ Object 



779
780
781
 
# File 'lib/downloader.rb', line 779

def __strdate_to_ymd(date)
  Date.parse(date.to_s.tr("年月日時分秒", "///:::")).strftime("%Y%m%d")
end

#a_section_download(subtitle_info) ⇒ Object

指定された話数の本文をダウンロード



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/downloader.rb', line 1022

def a_section_download(subtitle_info)
  index = subtitle_info["index"]
  return @section_download_cache[index] if @section_download_cache[index]
  sleep_for_download
  href = subtitle_info["href"]
  if @setting["is_narou"]
    subtitle_url = @setting.replace_group_values("txtdownload_url", subtitle_info)
  elsif href[0] == "/"
    subtitle_url = @setting["top_url"] + href
  else
    subtitle_url = @setting["toc_url"] + href
  end
  raw = download_raw_data(subtitle_url)
  if @setting["is_narou"]
    raw = Helper.restor_entity(raw)
    save_raw_data(raw, subtitle_info)
    element = extract_elements_in_section(raw, subtitle_info["subtitle"])
    element["data_type"] = "text"
  else
    save_raw_data(raw, subtitle_info, ".html")
    @setting.multi_match(raw, "body_pattern", "introduction_pattern", "postscript_pattern")
    element = { "data_type" => "html" }
    %w(introduction body postscript).each { |type|
      element[type] = @setting[type] || ""
    }
  end
  subtitle_info["download_time"] = Time.now
  @section_download_cache[index] = element
  element
end

#confirm_over18? ⇒ Boolean

18歳以上か確認する

Returns:

  • (Boolean) 


331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/downloader.rb', line 331

def confirm_over18?
  global_setting = Inventory.load("global_setting", :global)
  if global_setting.include?("over18")
    return global_setting["over18"]
  end
  if Narou::Input.confirm("年齢認証：あなたは18歳以上ですか")
    global_setting["over18"] = true
    global_setting.save
    return true
  else
    return false
  end
end

#create_cache_dir ⇒ Object

差分用キャッシュ保存ディレクトリ作成



526
527
528
529
530
531
532
 
# File 'lib/downloader.rb', line 526

def create_cache_dir
  now = Time.now
  name = now.strftime("%Y.%m.%d@%H.%M.%S")
  cache_dir = File.join(get_novel_data_dir, SECTION_SAVE_DIR_NAME, CACHE_SAVE_DIR_NAME, name)
  FileUtils.mkdir_p(cache_dir)
  cache_dir
end

#create_section_file_path(subtitle_info) ⇒ Object

小説本文の保存パスを生成



1165
1166
1167
1168
 
# File 'lib/downloader.rb', line 1165

def create_section_file_path(subtitle_info)
  filename = "#{subtitle_info["index"]} #{subtitle_info["file_subtitle"]}.yaml"
  File.join(get_novel_data_dir, SECTION_SAVE_DIR_NAME, filename)
end

#create_short_story_subtitles(info) ⇒ Object

短編用の情報を生成



907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/downloader.rb', line 907

def create_short_story_subtitles(info)
  subtitle = {
    "index" => "1",
    "href" => @setting.replace_group_values("href", "index" => "1"),
    "chapter" => "",
    "subtitle" => @setting["title"],
    "file_subtitle" => Helper.replace_filename_special_chars(@setting["title"]),
    "subdate" => info["general_firstup"],
    "subupdate" => info["novelupdated_at"]
  }
  [subtitle]
end

#different_section?(old_relative_path, new_subtitle_info) ⇒ Boolean

すでに保存されている内容とDLした内容が違うかどうか

Returns:

  • (Boolean) 


982
983
984
985
986
987
988
989
 
# File 'lib/downloader.rb', line 982

def different_section?(old_relative_path, new_subtitle_info)
  path = File.join(get_novel_data_dir, old_relative_path)
  if File.exist?(path)
    return YAML.load_file(path)["element"] != new_subtitle_info["element"]
  else
    return true
  end
end

#download_raw_data(url) ⇒ Object

指定したURLからデータをダウンロード



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/downloader.rb', line 1056

def download_raw_data(url)
  raw = nil
  retry_count = RETRY_MAX_FOR_503
  cookie = @setting["cookie"] || ""
  begin
    open(url, "Cookie" => cookie) do |fp|
      raw = Helper.pretreatment_source(fp.read, @setting["encoding"])
    end
  rescue OpenURI::HTTPError => e
    if e.message =~ /^503/
      if retry_count == 0
        @stream.error "上限までリトライしましたがファイルがダウンロード出来ませんでした"
        exit Narou::EXIT_ERROR_CODE
      end
      retry_count -= 1
      @stream.puts
      @stream.warn "server message: #{e.message}"
      @stream.warn "リトライ待機中……"
      @@display_hint_once ||= false
      unless @@display_hint_once
        @stream.warn "ヒント: narou s download.wait-steps=10 とすることで、" \
                     "10話ごとにウェイトをいれられます"
        @@display_hint_once = true
      end
      sleep(WAITING_TIME_FOR_503)
      retry
    else
      raise
    end
  end
  raw
end

#extract_elements_in_section(section, subtitle) ⇒ Object

本文を解析して前書き・本文・後書きの要素に分解する

本文に含まれるタイトルは消す



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/downloader.rb', line 1113

def extract_elements_in_section(section, subtitle)
  lines = section.lstrip.lines.map(&:rstrip)
  introduction = slice_introduction(lines)
  postscript = slice_postscript(lines)
  if lines[0] == subtitle.strip
    if lines[1] == ""
      lines.slice!(0, 2)
    else
      lines.slice!(0, 1)
    end
  end
  {
    "introduction" => introduction,
    "body" => lines.join("\n"),
    "postscript" => postscript
  }
end

#get_file_title ⇒ Object

小説を格納するためのディレクトリ名を取得する



647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/downloader.rb', line 647

def get_file_title
  return @file_title if @file_title
  # すでにデータベースに登録されているならそれを引き続き使うようにする
  if @@database[@id] && @@database[@id]["file_title"]
    @file_title = @@database[@id]["file_title"]
    return @file_title
  end
  @file_title = @setting["ncode"]
  if @setting["append_title_to_folder_name"]
    @file_title += " " + Helper.replace_filename_special_chars(get_title, true).strip
  end
  @file_title
end

#get_general_lastup ⇒ Object

小説の最新掲載日をTime型で取得

小説家になろう、ハーメルンは小説情報ページの最終話掲載日などから取得した日付 その他サイトは一番新しい話の投稿日（更新日ではない）



568
569
570
571
572
573
574
575
 
# File 'lib/downloader.rb', line 568

def get_general_lastup
  info = @setting["info"] || {}
  if info["general_lastup"]
    info["general_lastup"]
  else
    __search_latest_update_time("subdate", @setting["subtitles"])
  end
end

#get_latest_table_of_contents(old_toc, through_error: false) ⇒ Object

目次データを取得する



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/downloader.rb', line 713

def get_latest_table_of_contents(old_toc, through_error: false)
  toc_source = get_toc_source
  return nil unless toc_source
  @setting.multi_match(toc_source, "tcode")
  #if @setting["narou_api_url"]
  if false
    # なろうAPIの出力がおかしいので直るまで使用中止
    info = Narou::API.new(@setting, "t-s-gf-gl-nu-w")
  else
    info = NovelInfo.load(@setting)
  end
  if info
    raise DownloaderNotFoundError unless info["title"]
    @setting["title"] = info["title"]
    @setting["author"] = info["writer"]
    @setting["story"] = info["story"]
  else
    # 小説情報ページがないサイトの場合は目次ページから取得する
    @setting.multi_match(toc_source, "title", "author", "story")
    raise DownloaderNotFoundError unless @setting.matched?("title")
    story_html = HTML.new(@setting["story"])
    story_html.strip_decoration_tag = true
    @setting["story"] = story_html.to_aozora
  end
  @setting["info"] = info

  @setting["title"] = get_title
  if series_novel?
    # 連載小説
    subtitles = get_subtitles(toc_source, old_toc)
  else
    # 短編小説
    subtitles = create_short_story_subtitles(info)
  end
  @setting["subtitles"] = subtitles

  toc_objects = {
    "title" => get_title,
    "author" => @setting["author"],
    "toc_url" => @setting["toc_url"],
    "story" => @setting["story"],
    "subtitles" => subtitles
  }
  toc_objects
rescue OpenURI::HTTPError, Errno::ECONNRESET => e
  raise if through_error   # エラー処理はしなくていいからそのまま例外を受け取りたい時用
  if e.message.include?("404")
    @stream.error "小説が削除されているか非公開な可能性があります"
    if @@database.novel_exists?(@id)
      $stdout.silence do
        Command::Tag.execute!(%W(#{@id} --add 404 --color white))
      end
      Command::Freeze.execute!([@id])
    end
  else
    @stream.error "何らかの理由により目次が取得できませんでした(#{e.message})"
  end
  false
end

#get_novel_data_dir ⇒ Object

小説データの格納ディレクトリパス



1154
1155
1156
1157
1158
1159
1160
 
# File 'lib/downloader.rb', line 1154

def get_novel_data_dir
  return @novel_data_dir if @novel_data_dir
  raise "小説名がまだ設定されていません" unless get_file_title
  subdirectory = @download_use_subdirectory ? Downloader.create_subdirecotry_name(get_file_title) : ""
  @novel_data_dir = File.join(Database.archive_root_path, @setting["name"], subdirectory, get_file_title)
  @novel_data_dir
end

#get_novel_status ⇒ Object 



606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/downloader.rb', line 606

def get_novel_status
  novel_status = if false # @setting["narou_api_url"]
                   Narou::API.new(@setting, "nt-e")
                 else
                   NovelInfo.load(@setting)
                 end
  unless novel_status
    novel_status = {
      "novel_type" => NOVEL_TYPE_SERIES,
      "end" => false
    }
  end
  novel_status
end

#get_novel_type ⇒ Object

小説の種別を取得（連載か短編）



624
625
626
627
 
# File 'lib/downloader.rb', line 624

def get_novel_type
  @novel_status ||= get_novel_status
  @novel_status["novel_type"]
end

#get_novelupdated_at ⇒ Object

小説が更新された日をTime型で取得



553
554
555
556
557
558
559
560
 
# File 'lib/downloader.rb', line 553

def get_novelupdated_at
  info = @setting["info"] || {}
  if info["novelupdated_at"]
    info["novelupdated_at"]
  else
    __search_latest_update_time("subupdate", @setting["subtitles"])
  end
end

#get_raw_dir ⇒ Object 



1089
1090
1091
 
# File 'lib/downloader.rb', line 1089

def get_raw_dir
  @raw_dir ||= File.join(get_novel_data_dir, RAW_DATA_DIR_NAME)
end

#get_section_file_timestamp(old_subtitles_info, latest_subtitles_info) ⇒ Object

対象話数のタイムスタンプを取得



858
859
860
861
862
863
864
865
 
# File 'lib/downloader.rb', line 858

def get_section_file_timestamp(old_subtitles_info, latest_subtitles_info)
  download_time = old_subtitles_info["download_time"]
  unless download_time
    download_time = File.mtime(create_section_file_path(old_subtitles_info))
  end
  latest_subtitles_info["download_time"] = download_time
  download_time
end

#get_subtitles(toc_source, old_toc) ⇒ Object

各話の情報を取得



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/downloader.rb', line 870

def get_subtitles(toc_source, old_toc)
  subtitles = []
  toc_post = toc_source.dup
  old_subtitles = old_toc ? old_toc["subtitles"] : nil
  loop do
    match_data = @setting.multi_match(toc_post, "subtitles")
    break unless match_data
    toc_post = match_data.post_match
    @setting["subtitle"] = @setting["subtitle"].gsub("\t", "")
    subdate = @setting["subdate"].tap { |sd|
      # subdate(初回掲載日)がない場合、最初に取得した時のsubupdateで代用する
      # subdateが取得出来ないのは暁とArcadia
      unless sd
        old_index = old_subtitles ? __search_index_in_subtitles(old_subtitles, @setting["index"]) : nil
        if !old_index || !old_subtitles[old_index]["subdate"]
          break @setting["subupdate"]
        end
        # || 以降は subupdate を取得していない古い(2.4.0以前)toc.yamlがあるためsubdateを使う
        break old_subtitles[old_index]["subupdate"] || old_subtitles[old_index]["subdate"]
      end
    }
    subtitles << {
      "index" => @setting["index"],
      "href" => @setting["href"],
      "chapter" => @setting["chapter"],
      "subtitle" => @setting["subtitle"].gsub("\n", ""),
      "file_subtitle" => Helper.replace_filename_special_chars(@setting["subtitle"]),
      "subdate" => subdate,
      "subupdate" => @setting["subupdate"]
    }
  end
  subtitles
end

#get_title ⇒ Object

小説のタイトルを取得する



664
665
666
667
668
669
670
671
 
# File 'lib/downloader.rb', line 664

def get_title
  return @title if @title
  @title = @setting["title"]
  if @setting["title_strip_pattern"]
    @title = @title.gsub(/#{@setting["title_strip_pattern"]}/, "").gsub(/^[　\s]*(.+?)[　\s]*?$/, "\\1")
  end
  @title
end

#get_toc_source ⇒ Object 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/downloader.rb', line 688

def get_toc_source
  toc_url = @setting["toc_url"]
  return nil unless toc_url
  toc_source = ""
  cookie = @setting["cookie"] || ""
  open(toc_url, "Cookie" => cookie) do |toc_fp|
    if toc_fp.base_uri.to_s != toc_url
      # リダイレクトされた場合。
      # ノクターン・ムーンライトのNコードを ncode.syosetu.com に渡すと、novel18.syosetu.com に飛ばされる
      # 目次の定義が微妙に ncode.syosetu.com と違うので、設定を取得し直す
      s = Downloader.get_sitesetting_by_target(toc_fp.base_uri.to_s)
      raise DownloaderNotFoundError unless s   # 非公開や削除等でトップページへリダイレクトされる場合がある
      @setting.clear   # 今まで使っていたのは一旦クリア
      @setting = s
      toc_url = @setting["toc_url"]
    end
    toc_source = Helper.restor_entity(Helper.pretreatment_source(toc_fp.read, @setting["encoding"]))
    raise DownloaderNotFoundError if Downloader.detect_error_message(@setting, toc_source)
  end
  toc_source
end

#init_novel_dir ⇒ Object

小説データの格納ディレクトリを初期設定する



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/downloader.rb', line 1194

def init_novel_dir
  novel_dir_path = get_novel_data_dir
  file_title = File.basename(novel_dir_path)
  FileUtils.mkdir_p(novel_dir_path) unless File.exist?(novel_dir_path)
  original_settings = NovelSetting.get_original_settings
  default_settings = NovelSetting.load_default_settings
  novel_setting = NovelSetting.new(@id, true, true)
  special_preset_dir = File.join(Narou.get_preset_dir, @setting["domain"], @setting["ncode"])
  exists_special_preset_dir = File.exist?(special_preset_dir)
  templates = [
    [NovelSetting::INI_NAME, NovelSetting::INI_ERB_BINARY_VERSION],
    ["converter.rb", 1.0],
    [NovelSetting::REPLACE_NAME, 1.0]
  ]
  templates.each do |(filename, binary_version)|
    if exists_special_preset_dir
      preset_file_path = File.join(special_preset_dir, filename)
      if File.exist?(preset_file_path)
        unless File.exist?(File.join(novel_dir_path, filename))
          FileUtils.cp(preset_file_path, novel_dir_path)
        end
        next
      end
    end
    Template.write(filename, novel_dir_path, binding, binary_version)
  end
end

#init_raw_dir ⇒ Object 



1093
1094
1095
1096
 
# File 'lib/downloader.rb', line 1093

def init_raw_dir
  path = get_raw_dir
  FileUtils.mkdir_p(path) unless File.exist?(path)
end

#initialize_variables(id, setting, options) ⇒ Object

変数初期化



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/downloader.rb', line 278

def initialize_variables(id, setting, options)
  @title = nil
  @file_title = nil
  @setting = setting
  @force = options[:force]
  @from_download = options[:from_download]
  @stream = options[:stream]
  @cache_dir = nil
  @new_arrivals = false
  @novel_data_dir = nil
  @novel_status = nil
  @id = id || @@database.create_new_id
  @new_novel = @@database[@id].!
  @section_download_cache = {}
  @download_wait_steps = Inventory.load("local_setting", :local)["download.wait-steps"] || 0
  @download_use_subdirectory = use_subdirectory?
  if @setting["is_narou"] && (@download_wait_steps > 10 || @download_wait_steps == 0)
    @download_wait_steps = 10
  end
  initialize_wait_counter
end

#initialize_wait_counter ⇒ Object

ウェイト関係初期化



303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/downloader.rb', line 303

def initialize_wait_counter
  @@__run_once ||= false
  unless @@__run_once
    @@__run_once = true
    @@__wait_counter = 0
    @@__last_download_time = Time.now - 20
  end
  @@interval_sleep_time = Inventory.load("local_setting", :local)["download.interval"] || 0
  @@interval_sleep_time = 0 if @@interval_sleep_time < 0
  @@max_steps_wait_time = [STEPS_WAIT_TIME, @@interval_sleep_time].max
end

#load_novel_data(filename) ⇒ Object

小説データの格納ディレクトリから読み込む



1184
1185
1186
1187
1188
1189
 
# File 'lib/downloader.rb', line 1184

def load_novel_data(filename)
  dir_path = get_novel_data_dir
  YAML.load_file(File.join(dir_path, filename))
rescue Errno::ENOENT
  nil
end

#load_toc_file ⇒ Object 



357
358
359
 
# File 'lib/downloader.rb', line 357

def load_toc_file
  load_novel_data(TOC_FILE_NAME)
end

#move_to_cache_dir(relative_path) ⇒ Object

差分用のキャッシュとして保存



994
995
996
997
998
999
 
# File 'lib/downloader.rb', line 994

def move_to_cache_dir(relative_path)
  path = File.join(get_novel_data_dir, relative_path)
  if File.exist?(path) && @cache_dir
    FileUtils.mv(path, @cache_dir)
  end
end

#novel_end? ⇒ Boolean

小説が完結しているか調べる

Returns:

  • (Boolean) 


632
633
634
635
 
# File 'lib/downloader.rb', line 632

def novel_end?
  @novel_status ||= get_novel_status
  @novel_status["end"]
end

#process_digest(old_toc, latest_toc) ⇒ Object

ダイジェスト化に関する処理

Returns:

  • true = 更新をキャンセル、false = 更新する



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/downloader.rb', line 466

def process_digest(old_toc, latest_toc)
  return false unless old_toc["subtitles"]
  latest_subtitles_count = latest_toc["subtitles"].size
  old_subtitles_count = old_toc["subtitles"].size
  if latest_subtitles_count < old_subtitles_count
    title = latest_toc["title"]
    message = <<-EOS
更新後の話数が保存されている話数より減少していることを検知しました。
ダイジェスト化されている可能性があるので、更新に関しての処理を選択して下さい。

保存済み話数: #{old_subtitles_count}
更新後の話数: #{latest_subtitles_count}

    EOS
    choices = {
      "1" => "このまま更新する",
      "2" => "更新をキャンセル",
      "3" => "更新をキャンセルして小説を凍結する",
      "4" => "バックアップを作成する",
      "5" => "最新のあらすじを表示する",
      "6" => "小説ページをブラウザで開く",
      "7" => "保存フォルダを開く",
      default: "2"
    }
    loop do
      choice = Narou::Input.choose(title, message, choices)
      case choice
      when "1"
        return false
      when "2"
        return true
      when "3"
        Command::Freeze.execute!([latest_toc["toc_url"]])
        return true
      when "4"
        Command::Backup.execute!([latest_toc["toc_url"]])
      when "5"
        if Narou.web?
          message = "あらすじ\n#{latest_toc["story"]}\n"
        else
          puts "あらすじ"
          puts latest_toc["story"]
        end
      when "6"
        Helper.open_browser(latest_toc["toc_url"])
      when "7"
        Helper.open_directory(Downloader.get_novel_data_dir_by_target(latest_toc["toc_url"]))
      end
      unless Narou.web?
        message = ""   # 長いので二度は表示しない
      end
    end
  else
    return false
  end
end

#remove_cache_dir ⇒ Object

差分用キャッシュ保存ディレクトリを削除



537
538
539
 
# File 'lib/downloader.rb', line 537

def remove_cache_dir
  FileUtils.remove_entry_secure(@cache_dir, true) if @cache_dir
end

#run_download ⇒ Object

ダウンロード処理本体



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/downloader.rb', line 364

def run_download
  old_toc = @new_novel ? nil : load_toc_file
  latest_toc = get_latest_table_of_contents(old_toc)
  unless latest_toc
    @stream.error @setting["toc_url"] + " の目次データが取得出来ませんでした"
    return :failed
  end
  if @setting["confirm_over18"]
    unless confirm_over18?
      @stream.puts "18歳以上のみ閲覧出来る小説です。ダウンロードを中止しました"
      return :canceled
    end
  end
  unless old_toc
    init_novel_dir
    old_toc = {}
    @new_arrivals = true
  end
  init_raw_dir
  if old_toc.empty? || @force
    update_subtitles = latest_toc["subtitles"]
  else
    update_subtitles = update_body_check(old_toc["subtitles"], latest_toc["subtitles"])
  end

  if old_toc.empty? && update_subtitles.count == 0
    @stream.error "#{@setting['title']} の目次がありません"
    return :failed
  end

  unless @force
    if process_digest(old_toc, latest_toc)
      return :canceled
    end
  end

  id_and_title = "ID:#{@id}　#{@title}"

  return_status =
    case
    when update_subtitles.size > 0
      @cache_dir = create_cache_dir if old_toc.length > 0
      begin
        sections_download_and_save(update_subtitles)
        if @cache_dir && Dir.glob(File.join(@cache_dir, "*")).count == 0
          remove_cache_dir
        end
      rescue Interrupt
        remove_cache_dir
        @stream.puts "ダウンロードを中断しました"
        exit Narou::EXIT_ERROR_CODE
      end
      update_database
      :ok
    when old_toc["subtitles"].size > latest_toc["subtitles"].size
      # 削除された節がある（かつ更新がない）場合
      @stream.puts "#{id_and_title} は一部の話が削除されています"
      :ok
    when old_toc["title"] != latest_toc["title"]
      # タイトルが更新されている場合
      @stream.puts "#{id_and_title} のタイトルが更新されています"
      update_database
      :ok
    when old_toc["story"] != latest_toc["story"]
      # あらすじが更新されている場合
      @stream.puts "#{id_and_title} のあらすじが更新されています"
      :ok
    else
      :none
    end
  save_novel_data(TOC_FILE_NAME, latest_toc)
  tags = @new_novel ? [] : @@database[@id]["tags"] || []
  if novel_end?
    unless tags.include?("end")
      update_database if update_subtitles.count == 0
      $stdout.silence do
        Command::Tag.execute!([@id, "--add", "end", "--color", "white"])
      end
      msg = old_toc.empty? ? "完結しているようです" : "完結したようです"
      @stream.puts "<cyan>#{id_and_title.escape} は#{msg}</cyan>".termcolor
      return_status = :ok
    end
  else
    if tags.include?("end")
      update_database if update_subtitles.size == 0
      $stdout.silence do
        Command::Tag.execute!([@id, "--delete", "end"])
      end
      @stream.puts "<cyan>#{id_and_title.escape} は連載を再開したようです</cyan>".termcolor
      return_status = :ok
    end
  end
  return_status
ensure
  @setting.clear
end

#save_novel_data(filename, object) ⇒ Object

小説データの格納ディレクトリに保存



1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/downloader.rb', line 1173

def save_novel_data(filename, object)
  path = File.join(get_novel_data_dir, filename)
  dir_path = File.dirname(path)
  unless File.exist?(dir_path)
    FileUtils.mkdir_p(dir_path)
  end
  File.write(path, YAML.dump(object))
end

#save_raw_data(raw_data, subtitle_info, ext = ".txt") ⇒ Object

テキストデータの生データを保存



1101
1102
1103
1104
1105
1106
 
# File 'lib/downloader.rb', line 1101

def save_raw_data(raw_data, subtitle_info, ext = ".txt")
  index = subtitle_info["index"]
  file_subtitle = subtitle_info["file_subtitle"]
  path = File.join(get_raw_dir, "#{index} #{file_subtitle}#{ext}")
  File.write(path, raw_data)
end

#sections_download_and_save(subtitles) ⇒ Object

小説本文をまとめてダウンロードして保存

subtitles にダウンロードしたいものをまとめた subtitle info を渡す



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/downloader.rb', line 925

def sections_download_and_save(subtitles)
  max = subtitles.size
  return if max == 0
  @stream.puts "<bold><green>#{"ID:#{@id}　#{get_title}".escape} のDL開始</green></bold>".termcolor
  save_least_one = false
  subtitles.each_with_index do |subtitle_info, i|
    index, subtitle, file_subtitle, chapter = %w(index subtitle file_subtitle chapter).map { |k|
      subtitle_info[k]
    }
    info = subtitle_info.dup
    info["element"] = a_section_download(subtitle_info)

    unless chapter.empty?
      @stream.puts "#{chapter}"
    end
    if get_novel_type == NOVEL_TYPE_SERIES
      if index.to_s.length <= DISPLAY_LIMIT_DIGITS
        # indexの数字がでかいと見た目がみっともないので特定の桁以内だけ表示する
        @stream.print "第#{index}部分　"
      end
    else
      @stream.print "短編　"
    end
    @stream.print "#{subtitle} (#{i+1}/#{max})"

    section_file_name = "#{index} #{file_subtitle}.yaml"
    section_file_relative_path = File.join(SECTION_SAVE_DIR_NAME, section_file_name)
    section_file_full_path = File.join(get_novel_data_dir, section_file_relative_path)
    if File.exist?(section_file_full_path)
      if @force
        if different_section?(section_file_relative_path, info)
          @stream.print " (更新あり)"
          move_to_cache_dir(section_file_relative_path)
        end
      else
        move_to_cache_dir(section_file_relative_path)
      end
    else
      if !@from_download || (@from_download && @force)
        @stream.print " <bold><magenta>(新着)</magenta></bold>".termcolor
        trigger(:newarrival, {
          id: @id,
          subtitle_info: subtitle_info
        })
      end
      @new_arrivals = true
    end
    save_novel_data(section_file_relative_path, info)
    save_least_one = true
    @stream.puts
  end
  remove_cache_dir unless save_least_one
end

#series_novel? ⇒ Boolean

連載小説かどうか調べる

Returns:

  • (Boolean) 


640
641
642
 
# File 'lib/downloader.rb', line 640

def series_novel?
  get_novel_type == NOVEL_TYPE_SERIES
end

#sleep_for_download ⇒ Object 



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'lib/downloader.rb', line 1001

def sleep_for_download
  if Time.now - @@__last_download_time > @@max_steps_wait_time
    @@__wait_counter = 0
  end
  if @download_wait_steps > 0 && @@__wait_counter % @download_wait_steps == 0 \
    && @@__wait_counter >= @download_wait_steps
    # MEMO:
    # 小説家になろうは連続DL規制があるため、ウェイトを入れる必要がある。
    # 10話ごとに規制が入るため、10話ごとにウェイトを挟む。
    # 1話ごとに1秒待機を10回繰り返そうと、11回目に規制が入るため、ウェイトは必ず必要。
    sleep(@@max_steps_wait_time)
  else
    sleep(@@interval_sleep_time) if @@__wait_counter > 0
  end
  @@__wait_counter += 1
  @@__last_download_time = Time.now
end

#slice_introduction(lines) ⇒ Object 



1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/downloader.rb', line 1131

def slice_introduction(lines)
  lines.each_with_index do |line, lineno|
    if line =~ ConverterBase::AUTHOR_INTRODUCTION_SPLITTER
      lines.slice!(lineno, 1)
      return lines.slice!(0...lineno).join("\n")
    end
  end
  ""
end

#slice_postscript(lines) ⇒ Object 



1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/downloader.rb', line 1141

def slice_postscript(lines)
  lines.each_with_index do |line, lineno|
    if line =~ ConverterBase::AUTHOR_POSTSCRIPT_SPLITTER
      lines.slice!(lineno, 1)
      return lines.slice!(lineno..-1).join("\n")
    end
  end
  ""
end

#start_download ⇒ Object

ダウンロードを処理本体を起動



348
349
350
351
352
353
354
355
 
# File 'lib/downloader.rb', line 348

def start_download
  @status = run_download
  OpenStruct.new(
    :id => @id,
    :new_arrivals => @new_arrivals,
    :status => @status
    ).freeze
end

#update_body_check(old_subtitles, latest_subtitles) ⇒ Object

本文更新チェック

更新された subtitle だけまとまった配列を返す



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/downloader.rb', line 788

def update_body_check(old_subtitles, latest_subtitles)
  strong_update = Inventory.load("local_setting", :local)["update.strong"]
  latest_subtitles.select do |latest|
    index = latest["index"]
    index_in_old_toc = __search_index_in_subtitles(old_subtitles, index)
    next true unless index_in_old_toc
    old = old_subtitles[index_in_old_toc]
    # タイトルチェック
    if old["subtitle"] != latest["subtitle"]
      next true
    end
    # 章チェック
    if old["chapter"] != latest["chapter"]
      next true
    end
    # 更新日チェック
    # subdate : 初稿投稿日
    # subupdate : 改稿日
    old_subdate = old["subdate"]
    latest_subdate = latest["subdate"]
    old_subupdate = old["subupdate"]
    latest_subupdate = latest["subupdate"]
    # oldにsubupdateがなくても、latestのほうにsubupdateがある場合もある
    old_subupdate = old_subdate if latest_subupdate && !old_subupdate
    different_check = nil
    latest["download_time"] = old["download_time"]
    if strong_update
      latest_section_timestamp_ymd = __strdate_to_ymd(get_section_file_timestamp(old, latest))
      section_file_name = "#{index} #{old["file_subtitle"]}.yaml"
      section_file_relative_path = File.join(SECTION_SAVE_DIR_NAME, section_file_name)
      different_check = lambda do
        latest_info_dummy = latest.dup
        latest_info_dummy["element"] = a_section_download(latest)
        deffer = different_section?(section_file_relative_path, latest_info_dummy)
        unless deffer
          # 差分がある場合はこのあと保存されて更新されるので、差分がない場合のみ
          # タイムスタンプを更新しておく
          now = Time.now
          File.utime(now, now, File.join(get_novel_data_dir, section_file_relative_path))
        end
        deffer
      end
    end
    if old_subupdate && latest_subupdate
      if old_subupdate == ""
        next latest_subupdate != ""
      end
      if strong_update
        if __strdate_to_ymd(old_subupdate) == latest_section_timestamp_ymd
          next different_check.call
        end
      end
      latest_subupdate > old_subupdate
    else
      # 古いバージョンだと old_subdate が nil なので判定出来ないため
      next true unless old_subdate

      if strong_update
        if __strdate_to_ymd(old_subdate) == latest_section_timestamp_ymd
          next different_check.call
        end
      end
      latest_subdate > old_subdate
    end
  end
end

#update_database ⇒ Object

データベース更新



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/downloader.rb', line 580

def update_database
  info = @setting["info"] || {}
  data = {
    "id" => @id,
    "author" => @setting["author"],
    "title" => get_title,
    "file_title" => get_file_title,
    "toc_url" => @setting["toc_url"],
    "sitename" => @setting["name"],
    "novel_type" => get_novel_type,
    "end" => novel_end?,
    "last_update" => Time.now,
    "new_arrivals_date" => (@new_arrivals ? Time.now : @@database[@id]["new_arrivals_date"]),
    "use_subdirectory" => @download_use_subdirectory,
    "general_firstup" => info["general_firstup"],
    "novelupdated_at" => get_novelupdated_at,
    "general_lastup" => get_general_lastup,
  }
  if @@database[@id]
    @@database[@id].merge!(data)
  else
    @@database[@id] = data
  end
  @@database.save_database
end

#use_subdirectory? ⇒ Boolean

サブディレクトリに保存してあるかどうか

Returns:

  • (Boolean) 


318
319
320
321
322
323
324
325
326
 
# File 'lib/downloader.rb', line 318

def use_subdirectory?
  if @new_novel
    # 新規DLする小説
    Inventory.load("local_setting", :local)["download.use-subdirectory"] || false
  else
    # すでにDL済みの小説
    @@database[@id]["use_subdirectory"] || false
  end
end