procon_bypass_man 0.1.17 → 0.1.20

data/lib/procon_bypass_man/procon/macro_registry.rb

@@ -1,25 +1,4 @@
 class ProconBypassMan::Procon::MacroRegistry
-  class Macro
-    attr_accessor :name, :steps
-
-    def initialize(name: , steps: )
-      self.name = name
-      self.steps = steps
-    end
-
-    def next_step
-      steps.shift
-    end
-
-    def finished?
-      steps.empty?
-    end
-
-    def ongoing?
-      !finished?
-    end
-  end
-
   PRESETS = {
     null: [],
   }
@@ -30,13 +9,13 @@ class ProconBypassMan::Procon::MacroRegistry
     end
 
     plugins[klass.to_s.to_sym] = ->{
-      ProconBypassMan::Procon::ButtonCollection.normalize(steps || klass.steps)
+      ProconBypassMan::Procon::MacroBuilder.new(steps || klass.steps).build
     }
   end
 
   def self.load(name)
     steps = PRESETS[name] || plugins[name].call || raise("unknown macro")
-    Macro.new(name: name, steps: steps.dup)
+    ProconBypassMan::Procon::Macro.new(name: name, steps: steps.dup)
   end
 
   def self.reset!

data/lib/procon_bypass_man/procon/user_operation.rb

@@ -33,9 +33,23 @@ class ProconBypassMan::Procon::UserOperation
     binary.write_as_press_button(button)
   end
 
-  # @param [Symbol] button
+  # @param [Symbol, Array<Symbol>] button
   def press_button_only(button)
-    binary.write_as_press_button_only(button)
+    if button.is_a?(Array)
+      binary.set_no_action!
+      button.uniq.each do |b|
+        unless ProconBypassMan::Procon::MacroBuilder::RESERVED_WORD_NONE == b
+          binary.write_as_press_button(b)
+        end
+      end
+      return
+    end
+
+    if ProconBypassMan::Procon::MacroBuilder::RESERVED_WORD_NONE == button
+      binary.set_no_action!
+    else
+      binary.write_as_press_button_only(button)
+    end
   end
 
   # @return [void]

data/lib/procon_bypass_man/procon.rb

@@ -1,7 +1,9 @@
 class ProconBypassMan::Procon
   require "procon_bypass_man/procon/consts"
   require "procon_bypass_man/procon/mode_registry"
+  require "procon_bypass_man/procon/macro"
   require "procon_bypass_man/procon/macro_registry"
+  require "procon_bypass_man/procon/macro_builder"
   require "procon_bypass_man/procon/layer_changer"
   require "procon_bypass_man/procon/button_collection"
   require "procon_bypass_man/procon/user_operation"

data/lib/procon_bypass_man/remote_pbm_action/reboot_os_action.rb

@@ -10,6 +10,7 @@ module ProconBypassMan
       private
 
       def before_action_callback
+        ProconBypassMan::ReportStartRebootJob.perform
         be_processed
       end
 

data/lib/procon_bypass_man/remote_pbm_action/restore_pbm_setting.rb

@@ -6,9 +6,16 @@ module ProconBypassMan
         require "pbmenv"
         ProconBypassMan.logger.info "execute RestorePbmSettingAction!"
         setting = args.dig("setting") or raise(ProconBypassMan::RemotePbmAction::NeedPbmVersionError, "settingが必要です, #{args.inspect}")
-        File.write(
+
+        # 復元に失敗したら戻せるように退避する
+        FileUtils.copy(
           ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path,
-          setting.to_yaml,
+          ProconBypassMan.fallback_setting_path,
+        )
+
+        ProconBypassMan::YamlWriter.write(
+          path: ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path,
+          content: setting,
         )
         ProconBypassMan.hot_reload!
       end

data/lib/procon_bypass_man/runner.rb

@@ -27,7 +27,7 @@ class ProconBypassMan::Runner
     loop do
       $will_terminate_token = false
       # NOTE メインプロセスではThreadをいくつか起動しているので念のためパフォーマンスを優先するためにforkしていく
-      main_loop_pid = Kernel.fork { ProconBypassMan::BypassCommand.new(gadget: @gadget, procon: @procon).execute }
+      child_pid = Kernel.fork { ProconBypassMan::BypassCommand.new(gadget: @gadget, procon: @procon).execute }
 
       begin
         # TODO 小プロセスが消滅した時に、メインプロセスは生き続けてしまい、何もできなくなる問題がある
@@ -37,25 +37,25 @@ class ProconBypassMan::Runner
         end
       rescue InterruptForRestart
         $will_terminate_token = true
-        Process.kill("TERM", main_loop_pid)
+        Process.kill("TERM", child_pid)
         Process.wait
         ProconBypassMan::PrintMessageCommand.execute(text: "Reloading config file")
         begin
           ProconBypassMan::ButtonsSettingConfiguration::Loader.reload_setting
           ProconBypassMan::SendReloadConfigEventCommand.execute
-        rescue ProconBypassMan::CouldNotLoadConfigError
+        rescue ProconBypassMan::CouldNotLoadConfigError => error
           ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。再読み込みができませんでした")
+          ProconBypassMan::ReportErrorReloadConfigJob.perform_async(error.message)
         end
         ProconBypassMan::PrintMessageCommand.execute(text: "バイパス処理を再開します")
       rescue Interrupt
         $will_terminate_token = true
-        Process.kill("TERM", main_loop_pid)
+        Process.kill("TERM", child_pid)
         Process.wait
+        ProconBypassMan::PrintMessageCommand.execute(text: "処理を終了します")
         @gadget&.close
         @procon&.close
-        FileUtils.rm_rf(ProconBypassMan.pid_path)
-        FileUtils.rm_rf(ProconBypassMan.digest_path)
-        exit 1
+        break
       end
     end
   end

data/lib/procon_bypass_man/support/yaml_writer.rb

@@ -0,0 +1,16 @@
+class ProconBypassMan::YamlWriter
+  # @return [void]
+  def self.write(path: , content: )
+    File.write(
+      path,
+      content.transform_values { |x|
+        case x
+        when String
+          x.gsub("\r\n", "\n")
+        else
+          x
+        end
+      }.to_yaml
+    )
+  end
+end

data/lib/procon_bypass_man/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProconBypassMan
-  VERSION = "0.1.17"
+  VERSION = "0.1.20"
 end

data/lib/procon_bypass_man.rb

@@ -7,11 +7,13 @@ require "securerandom"
 require 'em/pure_ruby'
 require "action_cable_client"
 require "ext/em_pure_ruby"
+require "ext/module"
 
 require_relative "procon_bypass_man/version"
 require_relative "procon_bypass_man/remote_pbm_action"
 require_relative "procon_bypass_man/support/signal_handler"
 require_relative "procon_bypass_man/support/callbacks"
+require_relative "procon_bypass_man/support/yaml_writer"
 require_relative "procon_bypass_man/support/safe_timeout"
 require_relative "procon_bypass_man/support/compress_array"
 require_relative "procon_bypass_man/support/uptime"
@@ -25,7 +27,9 @@ require_relative "procon_bypass_man/background"
 require_relative "procon_bypass_man/commands"
 require_relative "procon_bypass_man/bypass"
 require_relative "procon_bypass_man/domains"
+require_relative "procon_bypass_man/never_exit_accidentally"
 require_relative "procon_bypass_man/device_connector"
+require_relative "procon_bypass_man/device_procon_finder"
 require_relative "procon_bypass_man/device_status"
 require_relative "procon_bypass_man/runner"
 require_relative "procon_bypass_man/processor"
@@ -44,25 +48,13 @@ require_relative "procon_bypass_man/websocket/pbm_job_client"
 STDOUT.sync = true
 Thread.abort_on_exception = true
 
-# pluginの定数を握りつぶす
-class Module
-  def const_missing(id)
-    if self.name =~ /^ProconBypassMan::Plugin/
-      parent_const = Object.const_get("#{self.name}")
-      parent_const.const_set(id, Module.new)
-      Object.const_get("#{self.name}::#{id}")
-    else
-      super
-    end
-  end
-end
-
 module ProconBypassMan
   extend ProconBypassMan::Configuration::ClassMethods
+  extend ProconBypassMan::NeverExitAccidentally
 
   class CouldNotLoadConfigError < StandardError; end
-  class NotFoundProconError < StandardError; end
   class ConnectionError < StandardError; end
+  class NotFoundRequiredFilesError < StandardError; end
   class FirstConnectionError < ConnectionError; end
   class EternalConnectionError < ConnectionError; end
 
@@ -73,22 +65,31 @@ module ProconBypassMan
     ProconBypassMan::Websocket::PbmJobClient.start!
 
     ProconBypassMan::PrintMessageCommand.execute(text: "PBMを起動しています")
-    ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
     initialize_pbm
+    ProconBypassMan::ButtonsSettingConfiguration::Loader.load(setting_path: setting_path)
     gadget, procon = ProconBypassMan::ConnectDeviceCommand.execute!
-    Runner.new(gadget: gadget, procon: procon).run
-  rescue ProconBypassMan::CouldNotLoadConfigError
-    ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
-    ProconBypassMan::DeviceStatus.change_to_setting_syntax_error_and_shutdown!
+    Runner.new(gadget: gadget, procon: procon).run # ここでblockingする
     FileUtils.rm_rf(ProconBypassMan.pid_path)
     FileUtils.rm_rf(ProconBypassMan.digest_path)
-    exit 1
-  rescue ProconBypassMan::NotFoundProconError
-    ProconBypassMan::SendErrorCommand.execute(error: "プロコンが見つかりませんでした。終了します。")
-    ProconBypassMan::DeviceStatus.change_to_procon_not_found_error!
+  rescue ProconBypassMan::NotFoundRequiredFilesError
+    ProconBypassMan::SendErrorCommand.execute(error: "/sys/kernel/config/usb_gadget/proconディレクトリがありませんでした。処理を終了します。")
     FileUtils.rm_rf(ProconBypassMan.pid_path)
     FileUtils.rm_rf(ProconBypassMan.digest_path)
-    exit 1
+    exit 1 # 前提条件を満たしていないので絶対に落とす
+  rescue ProconBypassMan::CouldNotLoadConfigError
+    ProconBypassMan::SendErrorCommand.execute(error: "設定ファイルが不正です。設定ファイルの読み込みに失敗しました")
+    ProconBypassMan::DeviceStatus.change_to_setting_syntax_error_and_shutdown!
+    ProconBypassMan.exit_if_allow(1) do
+      FileUtils.rm_rf(ProconBypassMan.pid_path)
+      FileUtils.rm_rf(ProconBypassMan.digest_path)
+    end
+  rescue ProconBypassMan::ConnectDeviceCommand::NotFoundProconError
+    ProconBypassMan::SendErrorCommand.execute(error: "プロコンが見つかりませんでした。")
+    ProconBypassMan::DeviceStatus.change_to_procon_not_found_error!
+    ProconBypassMan.exit_if_allow(1) do
+      FileUtils.rm_rf(ProconBypassMan.pid_path)
+      FileUtils.rm_rf(ProconBypassMan.digest_path)
+    end
   rescue ProconBypassMan::ConnectionError
     begin
       raise

data/procon_bypass_man.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["jiikko"]
   spec.email         = ["n905i.1214@gmail.com"]
 
-  spec.summary       = "An extension for Nintendo Switch Pro Controller"
+  spec.summary       = "A programmable converter for Nintendo Switch Pro Controller"
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/splaplapla/procon_bypass_man"
   spec.license       = "MIT"

data/project_template/app.rb

@@ -5,15 +5,18 @@ require 'bundler/inline'
 gemfile do
   source 'https://rubygems.org'
   git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-  gem 'procon_bypass_man', '0.1.17'
+  gem 'procon_bypass_man', '0.1.20'
 end
 
 ProconBypassMan.configure do |config|
   config.root = File.expand_path(__dir__)
   config.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
   config.logger.level = :debug
-  # config.api_servers = ['https://...']
+  # webからProconBypassManを操作できるwebサービス
+  # config.api_servers = ['https://pbm-cloud.herokuapp.com']
   config.enable_critical_error_logging = true
+  # pbm-cloudで使う場合はnever_exitにtrueをセットしてください. trueがセットされている場合、不慮の事故が発生してもプロセスが終了しなくなります
+  config.never_exit_accidentally = true
 end
 
 ProconBypassMan.run(setting_path: "/usr/share/pbm/current/setting.yml")

data/project_template/setting.yml

@@ -1,35 +1,19 @@
 version: 1.0
 setting: |-
-  fast_return = ProconBypassMan::Plugin::Splatoon2::Macro::FastReturn
-  guruguru = ProconBypassMan::Plugin::Splatoon2::Mode::Guruguru
-
-  install_macro_plugin fast_return
-  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey
-  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey
-  install_macro_plugin ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey
-  install_mode_plugin guruguru
-
   prefix_keys_for_changing_layer [:zr, :zl, :l]
 
-  layer :up, mode: :manual do
-    # flip :zr, if_pressed: :zr, force_neutral: :zl
+  layer :up do
     flip :zr, if_pressed: :zr, force_neutral: :zl
-    flip :zl, if_pressed: [:y, :b, :zl]
     flip :a, if_pressed: [:a]
     flip :down, if_pressed: :down
-    macro fast_return.name, if_pressed: [:y, :b, :down]
-    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToUpKey, if_pressed: [:y, :b, :up]
-    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToRightKey, if_pressed: [:y, :b, :right]
-    macro ProconBypassMan::Plugin::Splatoon2::Macro::JumpToLeftKey, if_pressed: [:y, :b, :left]
     remap :l, to: :zr
   end
-  layer :right, mode: guruguru.name
+
+  layer :right do
+  end
+
   layer :left do
-  # flip :zr, if_pressed: :zr, force_neutral: :zl
-    remap :l, to: :zr
   end
+
   layer :down do
-    # flip :zl
-    # flip :zr, if_pressed: :zr, force_neutral: :zl, flip_interval: "1F"
-    remap :l, to: :zr
   end

data/sig/main.rbs

@@ -185,10 +185,13 @@ class ProconBypassMan::Configuration
     def cache: () -> ProconBypassMan::OnMemoryCache
 
     def config: () -> ProconBypassMan::Configuration
+
+    def never_exit_accidentally: () -> bool
   end
 
   attr_reader api_server: untyped
   attr_reader api_servers: untyped
+  attr_writer never_exit_accidentally: bool
 
   attr_accessor enable_critical_error_logging: bool
 
@@ -226,6 +229,8 @@ class ProconBypassMan::Configuration
   def raw_setting: () -> untyped
 
   def verbose_bypass_log: () -> bool
+
+  def never_exit_accidentally: () -> bool
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procon_bypass_man
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.20
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pbmenv
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: An extension for Nintendo Switch Pro Controller
+description: A programmable converter for Nintendo Switch Pro Controller
 email:
 - n905i.1214@gmail.com
 executables: []
@@ -76,12 +76,17 @@ files:
 - bin/console
 - bin/dev_api_server.rb
 - bin/setup
+- docs/getting_started.md
 - docs/how_to_connect_procon.md
 - docs/setting/left-analogstick-cap.md
+- docs/setting/splatoon2_macro_sokuwari_bubble.md
+- docs/setting/splatoon2_recommended_setting.md
 - docs/setup_raspi.md
 - docs/setup_raspi.mitamae.rb
 - docs/setup_raspi_by_mitamae.md
+- docs/upgrade_pbm.md
 - lib/ext/em_pure_ruby.rb
+- lib/ext/module.rb
 - lib/procon_bypass_man.rb
 - lib/procon_bypass_man/background.rb
 - lib/procon_bypass_man/background/job_performer.rb
@@ -92,10 +97,12 @@ files:
 - lib/procon_bypass_man/background/jobs/concerns/job_runnable.rb
 - lib/procon_bypass_man/background/jobs/report_boot_job.rb
 - lib/procon_bypass_man/background/jobs/report_error_job.rb
+- lib/procon_bypass_man/background/jobs/report_error_reload_config_job.rb
 - lib/procon_bypass_man/background/jobs/report_event_base_job.rb
 - lib/procon_bypass_man/background/jobs/report_load_config_job.rb
 - lib/procon_bypass_man/background/jobs/report_pressed_buttons_job.rb
 - lib/procon_bypass_man/background/jobs/report_reload_config_job.rb
+- lib/procon_bypass_man/background/jobs/report_start_reboot_job.rb
 - lib/procon_bypass_man/background/jobs/sync_device_stats_job.rb
 - lib/procon_bypass_man/buttons_setting_configuration.rb
 - lib/procon_bypass_man/buttons_setting_configuration/layer.rb
@@ -115,6 +122,7 @@ files:
 - lib/procon_bypass_man/commands/write_session_id_command.rb
 - lib/procon_bypass_man/configuration.rb
 - lib/procon_bypass_man/device_connector.rb
+- lib/procon_bypass_man/device_procon_finder.rb
 - lib/procon_bypass_man/device_status.rb
 - lib/procon_bypass_man/domains.rb
 - lib/procon_bypass_man/domains/binary/base.rb
@@ -123,10 +131,12 @@ files:
 - lib/procon_bypass_man/domains/binary/inbound_procon_binary.rb
 - lib/procon_bypass_man/domains/binary/processing_procon_binary.rb
 - lib/procon_bypass_man/io_monitor.rb
+- lib/procon_bypass_man/never_exit_accidentally.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/fast_return.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_left_key.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_right_key.rb
 - lib/procon_bypass_man/plugin/splatoon2/macro/jump_to_up_key.rb
+- lib/procon_bypass_man/plugin/splatoon2/macro/sokuwari_for_splash_bomb.rb
 - lib/procon_bypass_man/plugin/splatoon2/mode/guruguru.rb
 - lib/procon_bypass_man/plugin/splatoon2/version.rb
 - lib/procon_bypass_man/plugins.rb
@@ -138,6 +148,8 @@ files:
 - lib/procon_bypass_man/procon/consts.rb
 - lib/procon_bypass_man/procon/flip_cache.rb
 - lib/procon_bypass_man/procon/layer_changer.rb
+- lib/procon_bypass_man/procon/macro.rb
+- lib/procon_bypass_man/procon/macro_builder.rb
 - lib/procon_bypass_man/procon/macro_registry.rb
 - lib/procon_bypass_man/procon/mode_registry.rb
 - lib/procon_bypass_man/procon/press_button_aware.rb
@@ -165,6 +177,7 @@ files:
 - lib/procon_bypass_man/support/signal_handler.rb
 - lib/procon_bypass_man/support/update_remote_pbm_action_status_http_client.rb
 - lib/procon_bypass_man/support/uptime.rb
+- lib/procon_bypass_man/support/yaml_writer.rb
 - lib/procon_bypass_man/version.rb
 - lib/procon_bypass_man/websocket/pbm_job_client.rb
 - procon_bypass_man.gemspec
@@ -202,5 +215,5 @@ requirements: []
 rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
-summary: An extension for Nintendo Switch Pro Controller
+summary: A programmable converter for Nintendo Switch Pro Controller
 test_files: []