procon_bypass_man 0.1.17 → 0.1.20

data/lib/procon_bypass_man/background.rb

@@ -6,7 +6,9 @@ require "procon_bypass_man/background/job_performer"
 require "procon_bypass_man/background/jobs/base_job"
 require "procon_bypass_man/background/jobs/report_event_base_job"
 require "procon_bypass_man/background/jobs/report_boot_job"
+require "procon_bypass_man/background/jobs/report_start_reboot_job"
 require "procon_bypass_man/background/jobs/report_reload_config_job"
+require "procon_bypass_man/background/jobs/report_error_reload_config_job"
 require "procon_bypass_man/background/jobs/report_load_config_job"
 require "procon_bypass_man/background/jobs/report_error_job"
 require "procon_bypass_man/background/jobs/report_pressed_buttons_job"

data/lib/procon_bypass_man/buttons_setting_configuration/loader.rb

@@ -5,6 +5,8 @@ module ProconBypassMan
 
       # @return [ProconBypassMan::ButtonsSettingConfiguration]
       def self.load(setting_path: )
+        ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path = setting_path
+
         ProconBypassMan::ButtonsSettingConfiguration.switch_new_context(:validation) do |new_instance|
           yaml = YAML.load_file(setting_path) or raise "読み込みに失敗しました"
           new_instance.instance_eval(yaml["setting"])
@@ -12,15 +14,19 @@ module ProconBypassMan
           if validator.valid?
             next
           else
-            raise ProconBypassMan::CouldNotLoadConfigError, validator.errors
+            raise ProconBypassMan::CouldNotLoadConfigError, validator.errors_to_s
           end
         rescue SyntaxError
-          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyのシンタックスエラーです"
+          fallback_setting_if_has_backup(current_setting_path: setting_path)
+          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトのシンタックスエラーです"
+        rescue NoMethodError
+          fallback_setting_if_has_backup(current_setting_path: setting_path)
+          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトに未定義の定数・変数があります"
         rescue Psych::SyntaxError
+          fallback_setting_if_has_backup(current_setting_path: setting_path)
           raise ProconBypassMan::CouldNotLoadConfigError, "yamlのシンタックスエラーです"
         end
 
-        ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path = setting_path
         ProconBypassMan::ButtonsSettingConfiguration.instance.reset!
         ProconBypassMan.reset!
 
@@ -36,12 +42,27 @@ module ProconBypassMan
 
         File.write(ProconBypassMan.digest_path, Digest::MD5.hexdigest(yaml["setting"]))
 
+        if File.exist?(ProconBypassMan.fallback_setting_path)
+          FileUtils.rm_rf(ProconBypassMan.fallback_setting_path)
+        end
+
         ProconBypassMan::ButtonsSettingConfiguration.instance
       end
 
       def self.reload_setting
         self.load(setting_path: ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path)
       end
+
+      def self.fallback_setting_if_has_backup(current_setting_path: )
+        return unless File.exist?(ProconBypassMan.fallback_setting_path)
+        return if current_setting_path.nil?
+
+        FileUtils.copy(
+          ProconBypassMan.fallback_setting_path,
+          current_setting_path,
+        )
+        FileUtils.rm_rf(ProconBypassMan.fallback_setting_path)
+      end
     end
   end
 end

data/lib/procon_bypass_man/buttons_setting_configuration/validator.rb

@@ -32,6 +32,16 @@ module ProconBypassMan
         @errors ||= Hash.new {|h,k| h[k] = [] }
       end
 
+      # @return [Array<String>]
+      def errors_to_s
+        errors.map { |_x, message|
+          value = <<~EOH
+            #{message.map { |m| "layer #{m}" }.join("\n")}
+          EOH
+          value.chomp
+        }.join("\n")
+      end
+
       private
 
       def validate_config_of_button_lonely
@@ -100,7 +110,7 @@ module ProconBypassMan
           end
 
           if(const = Module.const_get(key.to_s))
-            if not const.respond_to?(:binaries) && mode.call
+            if not (const.respond_to?(:binaries) && mode.call)
               @errors[:mode] << "モード #{key}を読み込めませんでした。"
             end
           end
@@ -116,7 +126,7 @@ module ProconBypassMan
           end
 
           if(const = Module.const_get(key.to_s))
-            if not const.respond_to?(:steps) && macro.call
+            if not (const.respond_to?(:steps) && macro.call)
               @errors[:macro] << "マクロ #{key}を読み込めませんでした。"
             end
           end

data/lib/procon_bypass_man/buttons_setting_configuration.rb

@@ -10,8 +10,6 @@ module ProconBypassMan
       :setting_path,
       :mode_plugins,
       :macro_plugins,
-      :context,
-      :current_context_key,
       :neutral_position
 
     def self.instance
@@ -27,22 +25,22 @@ module ProconBypassMan
       @@context[current_context_key] = val
     end
 
-    def self.switch_new_context(key)
-      @@context[key] = new
+    def self.switch_new_context(new_context_key)
+      @@context[new_context_key] = new
       previous_key = current_context_key
       if block_given?
-        @@current_context_key = key
-        value = yield(@@context[key])
-        @@current_context_key = previous_key
+        @@current_context_key = new_context_key
+        value = yield(@@context[new_context_key])
         return value
       else
-        @@current_context_key = key
+        @@current_context_key = new_context_key
       end
+    ensure
+      @@current_context_key = previous_key
     end
 
     def initialize
       reset!
-      self.class.instance = self
     end
 
     module ManualMode
@@ -103,6 +101,8 @@ module ProconBypassMan
     def reset!
       @prefix_keys_for_changing_layer = []
       self.mode_plugins = {}
+      # プロセスを一度起動するとsetting_pathは変わらない、という想定なので適当に扱う. resetでは初期化しない
+      # self.setting_path = nil
       self.macro_plugins = {}
       self.layers = {
         up: Layer.new,

data/lib/procon_bypass_man/bypass.rb

@@ -5,6 +5,7 @@ class ProconBypassMan::Bypass
 
   class BypassValue < Struct.new(:binary, :sent)
     def to_text
+      return unless binary
       "#{binary.unpack.first} #{'x' unless sent}"
     end
   end
@@ -31,16 +32,16 @@ class ProconBypassMan::Bypass
         self.bypass_value.binary = ProconBypassMan::Domains::InboundProconBinary.new(binary: input)
       rescue IO::EAGAINWaitReadable
         monitor.record(:eagain_wait_readable_on_read)
-        sleep(0.001)
-        retry
       end
 
-      begin
-        self.procon.write_nonblock(input)
-        self.bypass_value.sent = true
-      rescue IO::EAGAINWaitReadable
-        monitor.record(:eagain_wait_readable_on_write)
-        break
+      if input
+        begin
+          self.procon.write_nonblock(input)
+          self.bypass_value.sent = true
+        rescue IO::EAGAINWaitReadable
+          monitor.record(:eagain_wait_readable_on_write)
+          break
+        end
       end
     end
 

data/lib/procon_bypass_man/commands/bypass_command.rb

@@ -28,19 +28,12 @@ class ProconBypassMan::BypassCommand
     monitor2 = ProconBypassMan::IOMonitor.new(label: "procon -> switch")
     ProconBypassMan.logger.info "Thread1を起動します"
     t1 = Thread.new do
-      timer = ProconBypassMan::SafeTimeout.new(timeout: Time.now + 10)
       bypass = ProconBypassMan::Bypass.new(gadget: @gadget, procon: @procon, monitor: monitor1)
       loop do
         break if $will_terminate_token
-        timer.throw_if_timeout!
         bypass.send_gadget_to_procon!
-        sleep(0.005)
-      rescue ProconBypassMan::SafeTimeout::Timeout
-        ProconBypassMan.logger.info "10秒経過したのでThread1を終了します"
-        monitor1.shutdown
-        puts "10秒経過したのでThread1を終了します"
-        break
-      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+        sleep(0.02)
+      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError, Errno::ESHUTDOWN => e
         ProconBypassMan::SendErrorCommand.execute(error: "Switchとの切断されました.終了処理を開始します. #{e.full_message}")
         Process.kill "TERM", Process.ppid
       rescue Errno::ETIMEDOUT => e
@@ -62,7 +55,7 @@ class ProconBypassMan::BypassCommand
       rescue EOFError => e
         ProconBypassMan::SendErrorCommand.execute(error: "Proconが切断されました。終了処理を開始します. #{e.full_message}")
         Process.kill "TERM", Process.ppid
-      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError, Errno::ESHUTDOWN => e
         ProconBypassMan::SendErrorCommand.execute(error: "Proconが切断されました。終了処理を開始します2. #{e.full_message}")
         Process.kill "TERM", Process.ppid
       end
@@ -80,7 +73,7 @@ class ProconBypassMan::BypassCommand
       [t1, t2].each(&:join)
       @gadget&.close
       @procon&.close
-      exit 1
+      exit 1 # child processなのでexitしていい
     end
   end
 end

data/lib/procon_bypass_man/commands/connect_device_command.rb

@@ -1,16 +1,28 @@
 class ProconBypassMan::ConnectDeviceCommand
+  class NotFoundProconError < StandardError; end
+
   # @return [void]
   def self.execute!
-    gadget, procon = ProconBypassMan::DeviceConnector.connect
-  rescue ProconBypassMan::DeviceConnector::NotFoundProconError => e
-    ProconBypassMan.logger.error e
-    gadget&.close
-    procon&.close
-    raise ProconBypassMan::NotFoundProconError
-  rescue ProconBypassMan::SafeTimeout::Timeout
-    ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
-    gadget&.close
-    procon&.close
-    raise ::ProconBypassMan::EternalConnectionError
+    unless has_required_files?
+      raise ProconBypassMan::NotFoundRequiredFilesError, "there is not /sys/kernel/config/usb_gadget/procon"
+    end
+
+    begin
+      gadget, procon = ProconBypassMan::DeviceConnector.connect
+    rescue ProconBypassMan::DeviceConnector::NotFoundProconError => e
+      ProconBypassMan.logger.error e
+      gadget&.close
+      procon&.close
+      raise ProconBypassMan::ConnectDeviceCommand::NotFoundProconError
+    rescue ProconBypassMan::SafeTimeout::Timeout
+      ProconBypassMan.logger.error "デバイスとの通信でタイムアウトが起きて接続ができませんでした。"
+      gadget&.close
+      procon&.close
+      raise ProconBypassMan::EternalConnectionError
+    end
+  end
+
+  def self.has_required_files?
+    Dir.exist?("/sys/kernel/config/usb_gadget/procon")
   end
 end

data/lib/procon_bypass_man/configuration.rb

@@ -38,10 +38,19 @@ class ProconBypassMan::Configuration
     def device_id
       ENV["DEBUG_DEVICE_ID"] || ProconBypassMan::WriteDeviceIdCommand.execute
     end
+
+    # @return [Boolean]
+    def never_exit_accidentally
+      config.never_exit_accidentally
+    end
+
+    def fallback_setting_path
+      "/tmp/procon_bypass_man_fallback_setting.yaml"
+    end
   end
 
   attr_accessor :enable_critical_error_logging
-  attr_writer :verbose_bypass_log, :raw_setting, :enable_reporting_pressed_buttons
+  attr_writer :verbose_bypass_log, :raw_setting, :enable_reporting_pressed_buttons, :never_exit_accidentally
 
   def root=(path)
     @root = path
@@ -158,4 +167,9 @@ class ProconBypassMan::Configuration
   def enable_reporting_pressed_buttons
     @enable_reporting_pressed_buttons ||= false
   end
+
+  # @return [Boolean]
+  def never_exit_accidentally
+    @never_exit_accidentally || false
+  end
 end

data/lib/procon_bypass_man/device_connector.rb

@@ -263,46 +263,19 @@ class ProconBypassMan::DeviceConnector
     @procon
   end
 
-  def is_available_device?(path)
-    return false if !File.exist?(path)
-
-    system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
-    system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
-    sleep 0.5
-
-    file = File.open(path, "w+")
-    begin
-      file.read_nonblock(64)
-    rescue EOFError
-      file.close
-      return false
-    rescue IO::EAGAINWaitReadable
-      file.close
-      return true
-    end
-  end
-
-  def to_bin(string)
-    string.unpack "H*"
-  end
-
   def init_devices
     if @initialized_devices
       return
     end
 
-    case
-    when is_available_device?(PROCON_PATH)
-      ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON_PATH}を使います"
-      @procon = File.open(PROCON_PATH, "w+b")
-      @gadget = File.open('/dev/hidg0', "w+b")
-    when is_available_device?(PROCON2_PATH)
-      ProconBypassMan.logger.info "proconのデバイスファイルは#{PROCON2_PATH}を使います"
-      @procon = File.open(PROCON2_PATH, "w+b")
-      @gadget = File.open('/dev/hidg0', "w+b")
+    if path = ProconBypassMan::DeviceProconFinder.find
+      @procon = File.open(path, "w+b")
+      ProconBypassMan.logger.info "proconのデバイスファイルは#{path}を使います"
     else
-      raise NotFoundProconError, "/dev/hidraw0, /dev/hidraw1の両方見つかりませんでした"
+      raise(ProconBypassMan::DeviceConnector::NotFoundProconError)
     end
+    @gadget = File.open('/dev/hidg0', "w+b")
+
     system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
     system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
     sleep 0.5

data/lib/procon_bypass_man/device_procon_finder.rb

@@ -0,0 +1,65 @@
+class ProconBypassMan::DeviceProconFinder
+  HID_NAME = "Nintendo Co., Ltd. Pro Controller"
+
+  def self.find
+    new.find
+  end
+
+  # @return [String, NilClass]
+  def find
+    find_device_path
+  end
+
+  private
+
+  # @return [String , NilClass]
+  def find_device_path
+    if(line = device_from_shell) && (hidraw_name = line.match(/(hidraw\d+)\s+/)[1])
+      "/dev/#{hidraw_name}"
+    end
+  end
+
+  # @return [String , NilClass]
+  def device_from_shell
+    shell_output.split("\n").detect { |o| o.include?(HID_NAME) }
+  end
+
+  # @return [String]
+  def shell_output
+    `bash -c '#{get_list_shell}'`
+  end
+
+  def get_list_shell
+    <<~SHELL
+      #!/bin/bash
+
+      FILES=/dev/hidraw*
+      for f in $FILES
+      do
+        FILE=${f##*/}
+        DEVICE="$(cat /sys/class/hidraw/${FILE}/device/uevent | grep HID_NAME | cut -d '=' -f2)"
+        printf "%s   %s\n" $FILE "$DEVICE"
+      done
+    SHELL
+  end
+
+  # これいる？
+  def is_available_device?(path)
+    return false if !File.exist?(path)
+
+    system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
+    system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
+    sleep 0.5
+
+    file = File.open(path, "w+")
+    begin
+      file.read_nonblock(64)
+    rescue EOFError
+      file.close
+      return false
+    rescue IO::EAGAINWaitReadable
+      file.close
+      return true
+    end
+  end
+end

data/lib/procon_bypass_man/never_exit_accidentally.rb

@@ -0,0 +1,12 @@
+module ProconBypassMan
+  module NeverExitAccidentally
+    def exit_if_allow(status)
+      if ProconBypassMan.never_exit_accidentally
+        eternal_sleep
+      else
+        yield if block_given?
+        exit(status)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/plugin/splatoon2/macro/sokuwari_for_splash_bomb.rb

@@ -0,0 +1,22 @@
+module ProconBypassMan
+  module Plugin
+    module Splatoon2
+      module Macro
+        module SokuwariForSplashBomb
+          def self.display_name
+            :sokuwari_for_splash_bomb
+          end
+
+          # procon_bypass_man: 0.1.18以上が必要
+          def self.steps
+            [ :toggle_r_for_0_2sec,
+              :toggle_thumbr_for_0_14sec,
+              :toggle_thumbr_and_toggle_zr_for_0_34sec,
+              :toggle_r_for_1sec,
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/plugins.rb

@@ -3,6 +3,7 @@ require_relative "plugin/splatoon2/macro/fast_return"
 require_relative "plugin/splatoon2/macro/jump_to_right_key"
 require_relative "plugin/splatoon2/macro/jump_to_up_key"
 require_relative "plugin/splatoon2/macro/jump_to_left_key"
+require_relative "plugin/splatoon2/macro/sokuwari_for_splash_bomb"
 require_relative "plugin/splatoon2/mode/guruguru"
 
 module ProconBypassMan

data/lib/procon_bypass_man/procon/button.rb

@@ -4,7 +4,7 @@ class ProconBypassMan::Procon::Button
   attr_accessor :byte_position, :bit_position
 
   def initialize(key)
-    b = ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP[key] or raise(UnknownButtonFoundError, '定義にないボタンです')
+    b = ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP[key] or raise(UnknownButtonFoundError, "#{key}は定義にないボタンです")
     self.byte_position = b[:byte_position]
     self.bit_position = b[:bit_position]
   end

data/lib/procon_bypass_man/procon/macro.rb

@@ -0,0 +1,89 @@
+class ProconBypassMan::Procon::Macro
+  class NestedStep
+    def initialize(value)
+      @hash = value
+      unless @hash[:end_at]
+        @hash[:end_at] = (Time.now + @hash[:continue_for]).round(4)
+      end
+    end
+
+    def over_end_at?
+      (@hash[:end_at] < Time.now).tap do |result|
+        if result
+          ProconBypassMan.logger.debug { "[Macro] nested step is finished(#{@hash})" }
+        end
+      end
+    end
+
+    def next_step
+      incr_step_index!
+
+      debug_incr_called_count!
+      if step = current_step
+        return step
+      else
+        reset_step_index!
+        return current_step
+      end
+    end
+
+    private
+
+    def current_step
+      @hash[:steps][step_index]
+    end
+
+    def step_index
+      @hash[:step_index]
+    end
+
+    def incr_step_index!
+      if step_index
+        @hash[:step_index] += 1
+      else
+        @hash[:step_index] = 0
+      end
+    end
+
+    def reset_step_index!
+      @hash[:step_index] = 0
+    end
+
+    def debug_incr_called_count!
+      @hash[:debug_called_count] ||= 0
+      @hash[:debug_called_count] += 1
+    end
+  end
+
+  attr_accessor :name, :steps
+
+  def initialize(name: , steps: )
+    self.name = name
+    self.steps = steps
+  end
+
+  def next_step
+    step = steps.first
+    if step.is_a?(Symbol)
+      return steps.shift
+    end
+
+    if step.is_a?(Hash)
+      nested_step = NestedStep.new(step)
+      if nested_step.over_end_at?
+        steps.shift # NestedStepを破棄する
+        return next_step
+      else
+        return nested_step.next_step
+      end
+    end
+  end
+
+  def finished?
+    steps.empty?
+  end
+
+  def ongoing?
+    !finished?
+  end
+end

data/lib/procon_bypass_man/procon/macro_builder.rb

@@ -0,0 +1,123 @@
+class ProconBypassMan::Procon::MacroBuilder
+  class SubjectMerger
+    def self.merge(subjects)
+      if subjects.size == 1
+        return subjects.first.to_steps
+      end
+
+      base = subjects.first
+      remain = subjects[1..-1]
+      remain.map { |x| base.to_steps.zip(x.to_steps) }.first
+    end
+  end
+
+  class Subject
+    def initialize(value)
+      @button =
+        if match = value.match(/_(\w+)\z/)
+          match[1]
+        else
+          :unknown
+        end
+      @type =
+        if value.start_with?("toggle_")
+          :toggle
+        else
+          :pressing
+        end
+    end
+
+    def toggle?
+      @type == :toggle
+    end
+
+    def pressing?
+      not toggle?
+    end
+
+    def to_steps
+      case @type
+      when :toggle
+        [@button.to_sym, :none]
+      when :pressing
+        [@button.to_sym, @button.to_sym]
+      end
+    end
+  end
+
+  RESERVED_WORD_NONE = :none
+  RESERVED_WORDS = {
+    RESERVED_WORD_NONE => true,
+  }
+
+  def initialize(steps)
+    @steps = steps.map(&:to_s)
+  end
+
+  # @return [Arary<Symbol>]
+  def build
+    steps = @steps.map { |step|
+      if is_reserved?(step: step) || v1_format?(step: step)
+        step.to_sym
+      elsif value = build_if_v2_format?(step: step)
+        value
+      else
+        nil
+      end
+    }
+    steps.compact.flatten
+  end
+
+  private
+
+  def is_reserved?(step: )
+    RESERVED_WORDS[step.to_sym]
+  end
+
+  def v1_format?(step: )
+    if is_button(step)
+      step
+    end
+  end
+
+  def build_if_v2_format?(step: )
+    # 時間指定なし
+    if(match = step.match(%r!\Atoggle_(\w+)\z!)) && (button_candidate = match[1]) && is_button(button_candidate)
+      button = button_candidate
+      return [button.to_sym, :none]
+    end
+
+    # 時間指定あり
+    if %r!^(pressing_|toggle_)! =~ step && (subjects = step.scan(%r!pressing_[^_]+|toggle_[^_]+!)) && (match = step.match(%r!_for_([\d_]+)(sec)?\z!))
+      sec = match[1]
+      return [
+        { continue_for: to_num(sec),
+          steps: SubjectMerger.merge(subjects.map { |x| Subject.new(x) }),
+        }
+      ]
+    end
+
+    # no-op command
+    if(match = step.match(%r!wait_for_([\d_]+)(sec)?\z!))
+      sec = match[1]
+      return [
+        { continue_for: to_num(sec),
+          steps: [:none],
+        }
+      ]
+    end
+  end
+
+  # @return [Boolean]
+  def is_button(step)
+    !!ProconBypassMan::Procon::ButtonCollection::BUTTONS_MAP[step.to_sym]
+  end
+
+  def to_num(value)
+    if value.include?("_")
+      value.sub("_", ".").to_f
+    else
+      value.to_i
+    end
+  end
+end