Class: Command::Setting
- Inherits:
-
CommandBase
- Object
- CommandBase
- Command::Setting
- Includes:
- Narou::Eventable
- Defined in:
- lib/command/setting.rb
Defined Under Namespace
Classes: InvalidSelectValue
Constant Summary collapse
- SETTING_TAB_NAMES =
{ general: "一般", detail: "詳細", webui: "WEB UI", global: "Global", default: "default.*", force: "force.*", command: "コマンド", }
- SETTING_TAB_INFO =
{ webui: "WEB UI 専用の設定です", global: "Global な設定はユーザープロファイルに保存され、すべての narou コマンドで使われます", default: "default.* 系の設定は個別の変換設定で未設定の項目の挙動を指定することが出来ます", force: "force.* 系の設定は個別設定、default.* 等の設定を無視して反映されるようになります", command: "default_args.* 系の設定は、各種コマンドのオプションを省略した場合に使用されるオプションを指定出来ます", }
- SETTING_VARIABLES =
{ local: { # 変数名 => { type: 受け付ける型, help: 説明[, invisible: 不可視化フラグ, # select_keys: 選択肢型の時のキー(配列), # select_summaries: 選択肢型の時のキーの概要(配列)] } "device" => { type: :select, help: "変換、送信対象の端末(sendの--help参照)", select_keys: Device::DEVICES.keys, select_summaries: Device::DEVICES.values.map { |d| d::DISPLAY_NAME }, tab: :general }, "hotentry" => { type: :boolean, help: "新着投稿だけをまとめたデータを作る", tab: :general }, "hotentry.auto-mail" => { type: :boolean, help: "hotentryをメールで送る(mail設定済みの場合)", tab: :detail }, "concurrency" => { help: "ダウンロードと変換の同時実行を有効にする。有効にするとログの出力方式が変更される", type: :boolean, tab: :general }, "concurrency.format-queue-text" => { help: "同時実行時の変換キュー表示テキストのフォーマット。CUI専用。" \ "デフォルトは #{Narou::ConcurrencyDefaultLogger::FORMAT_TEXT.inspect.escape}", type: :string, invisible: true # 送信キュー実装時に変わる可能性があるので一旦隠しておく }, "concurrency.format-queue-style" => { help: "同時実行時の変換キュー表示スタイルのフォーマット。CUI専用。" \ "デフォルトは #{Narou::ConcurrencyDefaultLogger::FORMAT_STYLE.inspect.escape}。" \ "left:右寄せする場合に必要な幅。text:表示テキスト。space:半角スペース", type: :string }, "logging" => { help: "ログの保存を有効にする。保存場所は#{Narou.log_dir&.basename}フォルダ。concurrencyが有効な場合、変換ログだけ別ファイルに出力される", type: :boolean, tab: :general }, "logging.format-filename" => { help: "ログファイル名のフォーマット。デフォルトは\"#{Narou::LoggerModule::LOG_FORMAT_FILENAME}\" 。" \ "日付でファイルを分けたくなければ固定ファイル名にする。書式は http://bit.ly/date_format 参照", type: :string, tab: :detail }, "logging.format-timestamp" => { help: "ログ内のタイムスタンプのフォーマット。デフォルトは\"#{Narou::LoggerModule::LOG_FORMAT_TIMESTAMP}\"。タイムスタンプを記録したくなければ $none とだけ入力", type: :string, tab: :detail }, "update.interval" => { type: :float, help: "更新時に各作品間で指定した秒数待機する(処理時間を含む)。最低#{Update::Interval::MIN}秒以上", tab: :general }, "update.strong" => { type: :boolean, help: "改稿日当日の連続更新でも更新漏れが起きないように、中身もチェックして更新を検知する(やや処理が重くなる)", tab: :general }, "update.convert-only-new-arrival" => { type: :boolean, help: "更新時に新着がある場合のみ変換を実行する", tab: :general }, "update.sort-by" => { type: :select, help: "アップデートを指定した項目順で行う\n#{Narou.update_sort_key_summaries(40)}", select_keys: Narou::UPDATE_SORT_KEYS.keys, select_summaries: Narou::UPDATE_SORT_KEYS.values, tab: :general }, "convert.copy-to" => { type: :directory, help: "変換したらこのフォルダにコピーする\n" \ " ※注意:存在しないフォルダだとエラーになる", tab: :general }, "convert.copy-to-grouping" => { type: :multiple, help: "copy-toで指定したフォルダの中で更に指定の各種フォルダにまとめる", select_keys: %w(device site), select_summaries: %w(端末毎にまとめる 掲載サイト毎にまとめる), tab: :general }, "convert.copy_to" => { type: :directory, help: "copy-toの昔の書き方(非推奨)", invisible: true }, "convert.no-epub" => { type: :boolean, help: "EPUB変換を無効にする", invisible: true }, "convert.no-mobi" => { type: :boolean, help: "MOBI変換を無効にする", invisible: true }, "convert.no-strip" => { type: :boolean, help: "MOBIのstripを無効にする\n" \ " ※注意:KDP用のMOBIはstripしないでください", invisible: true }, "convert.no-zip" => { type: :boolean, help: "i文庫用のzipファイル作成を無効にする", invisible: true }, "convert.no-open" => { type: :boolean, help: "変換時に保存フォルダを開かないようにする", tab: :general }, "convert.inspect" => { type: :boolean, help: "常に変換時に調査結果を表示する", tab: :detail }, "convert.multi-device" => { type: :multiple, help: "複数の端末用に同時に変換する。deviceよりも優先される。" \ "端末名をカンマ区切りで入力。ただのEPUBを出力したい場合はepubを指定", select_keys: Device::DEVICES.keys, select_summaries: Device::DEVICES.values.map { |d| d::DISPLAY_NAME }, tab: :general }, "convert.filename-to-ncode" => { type: :boolean, help: "書籍ファイル名をNコードで出力する(ドメイン_Nコードの形式)", tab: :general }, "download.interval" => { type: :float, help: "各話DL時に指定秒数待機する。デフォルト#{Downloader::DEFAULT_INTERVAL_WAIT}秒", tab: :detail }, "download.wait-steps" => { type: :integer, help: "指定した話数ごとに長めのウェイトが入る\n" \ " ※注意:11以上を設定してもなろうの場合は10話ごとにウェイトが入ります", tab: :detail }, "download.use-subdirectory" => { type: :boolean, help: "小説を一定数ごとにサブフォルダへ分けて保存する\n" \ " ※注意:小説を大量に同一フォルダに保存するとパフォーマンスが劣化する回避策", tab: :detail }, "download.choices-of-digest-options" => { type: :string, help: "ダイジェスト化選択肢が出た場合に、自動で項目を選択する。" \ "カンマ区切りで選択したい順番に数字で記入する。" \ "最終的に更新かキャンセルが選択されなかった場合はキャンセル扱いになる\n" \ "#{Downloader.choices_to_string(width: 27)}", tab: :detail }, "send.without-freeze" => { type: :boolean, help: "送信時に凍結された小説は対象外にする", tab: :general }, "send.backup-bookmark" => { type: :boolean, help: "一括送信時に栞データを自動でバックアップする(KindlePW系用)", tab: :detail }, "multiple-delimiter" => { type: :string, help: "--multiple指定時の区切り文字", tab: :detail }, "economy" => { type: :multiple, help: "容量節約に関する設定。カンマ区切りで設定\n" \ "(cleanup_temp:変換後に作業ファイルを削除 send_delete:送信後に書籍ファイルを削除 " \ "nosave_diff:差分ファイルを保存しない nosave_raw:rawデータを保存しない)", select_keys: %w(cleanup_temp send_delete nosave_diff nosave_raw), select_summaries: %w(変換後に作業ファイルを削除 送信後に書籍ファイルを削除 差分ファイルを保存しない rawデータを保存しない), tab: :detail }, "guard-spoiler" => { type: :boolean, help: "ネタバレ防止機能。ダウンロード時の各話タイトルを伏せ字で表示する", tab: :detail }, "normalize-filename" => { type: :boolean, help: "ファイル名の文字列をNFCで正規化する。※既存データとの互換性が無くなる可能性があるので、" \ "バックアップを取った上で機能を理解の上有効にして下さい", tab: :detail, }, "folder-length-limit" => { type: :integer, help: "小説を格納するフォルダ名の長さを制限する。デフォルトは#{Helper::FOLDER_LENGTH_LIMIT}文字", tab: :detail }, "filename-length-limit" => { type: :integer, help: "各話保存時のファイル名の長さを制限する。出力される電子書籍ファイル名の長さを制限する場合は " \ "ebook-filename-length-limit を設定すること。※この設定は既存小説にも影響が出るので" \ "ファイル名の長さでエラーが出ない限り基本的にはいじらないこと。デフォルトは#{Helper::FILENAME_LENGTH_LIMIT}文字", tab: :detail }, "ebook-filename-length-limit" => { type: :integer, help: "出力される電子書籍ファイル名の長さを制限する。ファイルシステムによって長さの最大値が" \ "制限されており、保存時にエラーが出るような場合などに設定する。※デフォルトは無制限" \ "(Kindle端末を使っている場合85以下推奨。Kindle端末の場合長さ制限に引っかかっても" \ "エラーは出ないが読めなくなる)", tab: :detail }, "user-agent" => { type: :string, help: "User-Agent 設定\n未指定時 Mozilla/5.0 (Windows NT 10.0; Win64; x64)", tab: :detail }, "webui.theme" => { type: :select, help: "WEB UI 用テーマ選択", invisible: true, select_keys: Narou.theme_names, select_summaries: Narou.theme_names, tab: :webui }, "webui.table.reload-timing" => { type: :select, help: "小説リストの更新タイミングを選択。未設定時は1作品ごとに更新", invisible: true, select_keys: %w(every queue), select_summaries: %w( 1作品ごとに更新 キューごとに更新 ), tab: :webui }, }, global: { "aozoraepub3dir" => { type: :directory, help: "AozoraEpub3のあるフォルダを指定", invisible: true }, "line-height" => { type: :float, help: "行間サイズ(narou init から指定しないと反映されません)", invisible: true }, "difftool" => { type: :string, help: "diffで使うツールのパスを指定する", tab: :global }, "difftool.arg" => { type: :string, help: "difftoolで使う引数を設定(オプション)", tab: :global }, "no-color" => { type: :boolean, help: "カラー表示を無効にする", tab: :global }, "color-parser" => { type: :select, help: "コンソール上でのANSIカラーを表示する方法の選択(Windowsのみ)。" \ "system: システムに任せる(デフォルト) / self: Narou.rbで処理", select_keys: %w(system self), select_summaries: %w(システムに任せる Narou.rbで処理), tab: :global }, "server-port" => { type: :integer, help: "WEBサーバ起動時のポート。server-port + 1 のポートも WebSocket で使用", tab: :global }, "server-bind" => { type: :string, help: "WEBサーバのホスト制限(未設定時:起動PCのIP)。頻繁にローカルIPが変わってしまう場合は127.0.0.1の指定を推奨", invisible: true, tab: :global }, "server-digest-auth.enable" => { type: :boolean, help: "WEBサーバでDigest認証を使用するかどうか", invisible: true, tab: :global }, "server-digest-auth.user" => { type: :string, help: "WEBサーバでDigest認証をするユーザ名", invisible: true, tab: :global }, "server-digest-auth.password" => { type: :string, help: "WEBサーバのDigest認証のパスワード。hashed-passwordも設定した場合はそちらが優先される", invisible: true, tab: :global }, "server-digest-auth.hashed-password" => { type: :string, help: "WEBサーバのDigest認証のパスワードを、Realmを\"narou.rb\"としてハッシュにしたもの。下記のようなコマンドで生成できる\n" \ "$ ruby -r 'digest/md5' -e 'puts Digest::MD5.hexdigest \"\#{$*[0]}:narou.rb:\#{$*[1]}\"' user password", invisible: true, tab: :global }, "server-ws-add-accepted-domains" => { type: :string, help: "PushServer の accepted_domains に追加するホストのリスト(カンマ区切り)", invisible: true, tab: :global }, "over18" => { type: :boolean, help: "18歳以上かどうか", invisible: true, tab: :global }, } }
Constants included from Narou::Eventable
Narou::Eventable::EVENTS_CONTAINER
Instance Attribute Summary
Attributes inherited from CommandBase
Class Method Summary collapse
- .get_setting_tab_info ⇒ Object
- .get_setting_tab_names ⇒ Object
- .get_setting_variables ⇒ Object
- .oneline_help ⇒ Object
Instance Method Summary collapse
-
#burn_default_settings(argv) ⇒ Object
小説の setting.ini の未設定項目に共通設定を焼き付ける.
-
#casting_variable(name, value) ⇒ Object
値の文字列を設定に基づいた型にキャストして、[scope, value] 形式で返す 不正な設定名もしくは値の場合は例外を吐く.
- #display_variable_list ⇒ Object
- #execute(argv) ⇒ Object
- #get_scope_of_variable_name(name) ⇒ Object
- #get_variable_list_strings(scope) ⇒ Object
-
#initialize ⇒ Setting
constructor
A new instance of Setting.
- #modify_settings(scoped_settings, name, value) ⇒ Object
- #modify_settings_when_device_changed(settings) ⇒ Object
- #output_error(msg, name = nil) ⇒ Object
- #output_setting_list ⇒ Object
- #output_value(name, settings) ⇒ Object
- #sweep_dust_variable(target_name, settings) ⇒ Object
Methods included from Narou::Eventable
#add_event_listener, included, #one, #remove_event_listener, #trigger_event
Methods inherited from CommandBase
#disable_logging, #display_help!, execute!, #execute!, #force_change_settings_function, help, #hook_call, #load_local_settings, #tagname_to_ids
Constructor Details
#initialize ⇒ Setting
Returns a new instance of Setting.
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/command/setting.rb', line 23 def initialize super "[<name>=<value> ...] [options]\n" \ "--burn <target> [<target2> ...]" @opt.separator <<-EOS ・各コマンドの設定の変更が出来ます。 ・Global な設定はユーザープロファイルに保存され、すべての narou コマンドで使われます ・下の一覧は一部です。すべてを確認するには -a オプションを付けて確認して下さい ・default. で始まる設定は、setting.ini で未設定時の項目の挙動を指定することが出来ます ・force. で始まる設定は、setting.ini や default.* 等の指定を全て無視して項目の挙動を強制出来ます Local Variable List: <name> <value> 説明 EOS @opt.separator(get_variable_list_strings(:local)) @opt.separator("\n Global Variable List:") @opt.separator(get_variable_list_strings(:global)) @opt.separator <<-EOS これ以外にも設定出来る項目があります。確認する場合は narou setting -a コマンドを参照して下さい Examples: narou setting --list # 現在の設置値一覧を表示 narou setting convert.no-open=true # 値を設定する narou setting convert.no-epub= # 右辺に何も書かないとその設定を削除出来る narou setting device # 変数名だけ書くと現在の値を確認出来る narou s convert.copy-to=C:/dropbox/mobi # パスにスペースが含まれる場合はダブルクウォーテーションで囲う narou s convert.copy-to="C:\\Documents and Settings\\user\\epub" Options: EOS @opt.on("-l", "--list", "現在の設定値を確認する") { output_setting_list exit 0 } @opt.on("-a", "--all", "設定できる全ての変数名を表示する") { @options["all"] = true display_variable_list exit 0 } @opt.on("--burn", "指定した小説の未設定項目に共通設定を焼き付ける") { @options["burn"] = true } end |
Class Method Details
.get_setting_tab_info ⇒ Object
315 316 317 |
# File 'lib/command/setting.rb', line 315 def self.get_setting_tab_info SETTING_TAB_INFO end |
.get_setting_tab_names ⇒ Object
311 312 313 |
# File 'lib/command/setting.rb', line 311 def self.get_setting_tab_names SETTING_TAB_NAMES end |
.get_setting_variables ⇒ Object
307 308 309 |
# File 'lib/command/setting.rb', line 307 def self.get_setting_variables SETTING_VARIABLES end |
.oneline_help ⇒ Object
19 20 21 |
# File 'lib/command/setting.rb', line 19 def self.oneline_help "各コマンドの設定を変更します" end |
Instance Method Details
#burn_default_settings(argv) ⇒ Object
小説の setting.ini の未設定項目に共通設定を焼き付ける
default.* が設定されているならそれを、なければオリジナル設定を
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 |
# File 'lib/command/setting.rb', line 269 def burn_default_settings(argv) if argv.empty? error "対象小説を指定して下さい" exit Narou::EXIT_ERROR_CODE end msg = "指定された小説のsetting.iniの未項目設定に共通設定を焼き付けます。\n" \ "(共通設定とはsetting.iniの項目が未設定時に使用される default.* 系設定およびNarou.rbオリジナル設定のこと)\n" \ "よろしいですか" return unless Narou::Input.confirm(msg) tagname_to_ids(argv) argv.each do |arg| data = Downloader.get_data_by_target(arg) unless data error "#{arg} は存在しません" next end novel_setting = NovelSetting.new(arg, true, true) # 空っぽの設定を作成 novel_setting.settings = novel_setting.load_setting_ini["global"] original_settings = NovelSetting.get_original_settings default_settings = NovelSetting.load_default_settings original_settings.each do |original| name = original[:name] unless novel_setting.settings.include?(name) if default_settings.include?(name) novel_setting[name] = default_settings[name] else novel_setting[name] = original[:value] end end end novel_setting.save_settings stream_io.puts "#{data["title"]} の設定を保存しました" end end |
#casting_variable(name, value) ⇒ Object
値の文字列を設定に基づいた型にキャストして、[scope, value] 形式で返す 不正な設定名もしくは値の場合は例外を吐く
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 |
# File 'lib/command/setting.rb', line 86 def casting_variable(name, value) scope = get_scope_of_variable_name(name) unless scope raise Helper::InvalidVariableName, "#{name} は不明な名前です" end variable_definition = SETTING_VARIABLES[scope][name] case variable_definition[:type] when :select select_values = variable_definition[:select_keys] unless select_values.include?(value) raise InvalidSelectValue, "不明な値です。#{select_values.join(", ")} の中から指定して下さい" end casted_value = value when :multiple select_values = variable_definition[:select_keys] value.split(",").each do |input_value| unless select_values.include?(input_value) raise InvalidSelectValue, "不明な値です。#{select_values.join(", ")} の中から指定して下さい" end end casted_value = value else casted_value = Helper.string_cast_to_type(value, variable_definition[:type]) end [scope, casted_value] end |
#display_variable_list ⇒ Object
256 257 258 259 260 261 262 |
# File 'lib/command/setting.rb', line 256 def display_variable_list stream_io.puts "Local Variable List:" stream_io.puts get_variable_list_strings(:local).gsub(/^ {4}/, "") stream_io.puts stream_io.puts "Global Variable List:" stream_io.puts get_variable_list_strings(:global).gsub(/^ {4}/, "") end |
#execute(argv) ⇒ Object
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 209 |
# File 'lib/command/setting.rb', line 155 def execute(argv) super if @options["burn"] burn_default_settings(argv) return end display_help! if argv.empty? settings = { local: Inventory.load("local_setting", :local), global: Inventory.load("global_setting", :global) } device = Narou.get_device @error_count = 0 self.extend(device.get_hook_module) if device argv.each do |arg| name, value = arg.split("=", 2).map(&:strip) if name == "" output_error("書式が間違っています。変数名=値 のように書いて下さい") next end if value.nil? output_value(name, settings) next end scope = get_scope_of_variable_name(name) unless scope if value == "" # 定義上ではすでに存在しないが、設定ファイルには残っている古い変数 # を削除できるようにする if sweep_dust_variable(name, settings) stream_io.puts "#{name} の設定を削除しました" else output_error("#{name} という変数は存在しません", name) end else output_error("#{name} という変数は設定出来ません", name) end next end if value == "" hook_call(:modify_settings, settings[scope], name, nil) next end begin scope, casted_value = casting_variable(name, value) rescue Helper::InvalidVariableName, Helper::InvalidVariableType, InvalidSelectValue => e output_error(e., name) next end hook_call(:modify_settings, settings[scope], name, casted_value) end settings[:local].save settings[:global].save exit @error_count if @error_count > 0 end |
#get_scope_of_variable_name(name) ⇒ Object
73 74 75 76 77 78 79 80 |
# File 'lib/command/setting.rb', line 73 def get_scope_of_variable_name(name) [:local, :global].each do |scope| if SETTING_VARIABLES[scope].include?(name) return scope end end nil end |
#get_variable_list_strings(scope) ⇒ Object
244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/command/setting.rb', line 244 def get_variable_list_strings(scope) result = +"" SETTING_VARIABLES[scope].each do |name, info| if @options["all"] || !info[:invisible] raise "変数名「#{name}」のtypeが未設定です" unless info[:type] type_description = Helper.variable_type_to_description(info[:type]) result << " <bold><green>#{name.ljust(18)}</green></bold> #{type_description} #{info[:help]}\n".termcolor end end result end |
#modify_settings(scoped_settings, name, value) ⇒ Object
211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/command/setting.rb', line 211 def modify_settings(scoped_settings, name, value) if value.nil? scoped_settings.delete(name) stream_io.puts "#{name} の設定を削除しました" else scoped_settings[name] = value stream_io.puts "#{name} を #{value} に設定しました" end if name == "device" && value modify_settings_when_device_changed(scoped_settings) end end |
#modify_settings_when_device_changed(settings) ⇒ Object
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/command/setting.rb', line 224 def modify_settings_when_device_changed(settings) device = Device.create(settings["device"]) = StringIO.new device.get_relative_variables.each do |name, value| if value.nil? settings.delete(name) .puts " <bold><red>← #{name} が削除されました</red></bold>".termcolor elsif settings[name].nil? || settings[name] != value settings[name] = value .puts " <bold><green>→ #{name} が #{value} に変更されました</green></bold>".termcolor end end if .length > 0 stream_io.puts "端末を#{device.display_name}に指定したことで、以下の関連設定が変更されました" stream_io.puts .string end rescue Device::UnknownDevice => e output_error("#{e.}\n設定できるのは #{Device::DEVICES.keys.join(", ")} です", "device") end |
#output_error(msg, name = nil) ⇒ Object
129 130 131 132 133 |
# File 'lib/command/setting.rb', line 129 def output_error(msg, name = nil) @error_count += 1 stream_io.error msg trigger(:error, msg, name) end |
#output_setting_list ⇒ Object
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/command/setting.rb', line 113 def output_setting_list settings = { local: Inventory.load("local_setting", :local), global: Inventory.load("global_setting", :global) } settings.each do |scope, scoped_settings| stream_io.puts "[#{scope.capitalize} Variables]" scoped_settings.each do |name, value| if value.to_s =~ / / value = "'#{value}'" end stream_io.puts "<bold><green>#{name}</green></bold>=#{value}".termcolor end end end |
#output_value(name, settings) ⇒ Object
146 147 148 149 150 151 152 153 |
# File 'lib/command/setting.rb', line 146 def output_value(name, settings) scope = get_scope_of_variable_name(name) if scope stream_io.puts settings[scope][name] else output_error("#{name} という変数は存在しません", name) end end |
#sweep_dust_variable(target_name, settings) ⇒ Object
135 136 137 138 139 140 141 142 143 144 |
# File 'lib/command/setting.rb', line 135 def sweep_dust_variable(target_name, settings) deleted = false settings.each_value do |scoped_settings| if scoped_settings.has_key?(target_name) scoped_settings.delete(target_name) deleted = true end end deleted end |