procon_bypass_man 0.1.15 → 0.1.18

data/lib/procon_bypass_man/buttons_setting_configuration/layer.rb

@@ -8,9 +8,8 @@ module ProconBypassMan
         self.flips = {}
         self.macros = {}
         self.remaps = {}
-        self.left_analog_stick_caps = {}
+        self.left_analog_stick_caps = []
         self.disables = []
-        instance_eval(&block) if block_given?
       end
 
       # @param [Symbol] button
@@ -50,19 +49,22 @@ module ProconBypassMan
           end
           hash[:flip_interval] = interval
         end
-        if self.flips[button]
-          raise "#{button}への設定をすでに割り当て済みです"
-        else
-          self.flips[button] = hash
-        end
+
+        self.flips[button] = hash
       end
 
+      # @param [String, Class] プラグインのclass
       def macro(name, if_pressed: )
-        if name.respond_to?(:name)
-          macro_name = name.name.to_sym
-        else
-          macro_name = name
-        end
+        macro_name = name.to_s.to_sym
+        self.macros[macro_name] = { if_pressed: if_pressed }
+      end
+
+      # 設定ファイルに直接マクロを打ち込める
+      # @param [String, Class] macroの識別子
+      # @paramh[Array<Symbol>] macroの本体. ボタンの配列
+      def open_macro(name, steps: , if_pressed: )
+        macro_name = name || "OpenMacro-#{steps.join}".to_sym
+        ProconBypassMan::Procon::MacroRegistry.install_plugin(macro_name, steps: steps)
         self.macros[macro_name] = { if_pressed: if_pressed }
       end
 
@@ -92,6 +94,10 @@ module ProconBypassMan
           raise "not support value"
         end
 
+        if if_pressed
+          hash[:if_pressed] = if_pressed
+        end
+
         case force_neutral
         when TrueClass
           raise "ボタンを渡してください"
@@ -105,7 +111,7 @@ module ProconBypassMan
           raise "not support value"
         end
 
-        left_analog_stick_caps[if_pressed] = hash
+        left_analog_stick_caps << hash
       end
 
       def disable(button)
@@ -127,6 +133,22 @@ module ProconBypassMan
       def flip_buttons
         flips
       end
+
+      # @return [String]
+      def to_json(*)
+        to_hash.to_json
+      end
+
+      # @return [Hash]
+      def to_hash
+        { mode: mode,
+          flips: flips,
+          macros: macros,
+          remaps: remaps,
+          disables: disables,
+          left_analog_stick_caps: left_analog_stick_caps,
+        }
+      end
     end
   end
 end

data/lib/procon_bypass_man/buttons_setting_configuration/loader.rb

@@ -3,6 +3,7 @@ module ProconBypassMan
     module Loader
       require 'digest/md5'
 
+      # @return [ProconBypassMan::ButtonsSettingConfiguration]
       def self.load(setting_path: )
         ProconBypassMan::ButtonsSettingConfiguration.switch_new_context(:validation) do |new_instance|
           yaml = YAML.load_file(setting_path) or raise "読み込みに失敗しました"
@@ -14,7 +15,9 @@ module ProconBypassMan
             raise ProconBypassMan::CouldNotLoadConfigError, validator.errors
           end
         rescue SyntaxError
-          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyのシンタックスエラーです"
+          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトのシンタックスエラーです"
+        rescue NoMethodError
+          raise ProconBypassMan::CouldNotLoadConfigError, "Rubyスクリプトに未定義の定数・変数があります"
         rescue Psych::SyntaxError
           raise ProconBypassMan::CouldNotLoadConfigError, "yamlのシンタックスエラーです"
         end

data/lib/procon_bypass_man/buttons_setting_configuration/validator.rb

@@ -2,6 +2,8 @@ module ProconBypassMan
   class ButtonsSettingConfiguration
     class Validator
       def initialize(config)
+        @macro_plugins = config.macro_plugins
+        @mode_plugins = config.mode_plugins
         @layers = config.layers
         @prefix_keys = config.prefix_keys
       end
@@ -14,6 +16,8 @@ module ProconBypassMan
         validate_config_of_button_lonely
         validate_verify_button_existence
         validate_flip_and_remap_are_hate_each_other
+        validate_verify_mode_plugins
+        validate_verify_macro_plugins
 
         @errors.empty?
       end
@@ -86,6 +90,38 @@ module ProconBypassMan
           end
         end
       end
+
+      def validate_verify_mode_plugins
+        @mode_plugins.each do |key, mode|
+          begin
+            Module.const_get(key.to_s)
+          rescue NameError
+            next
+          end
+
+          if(const = Module.const_get(key.to_s))
+            if not const.respond_to?(:binaries) && mode.call
+              @errors[:mode] << "モード #{key}を読み込めませんでした。"
+            end
+          end
+        end
+      end
+
+      def validate_verify_macro_plugins
+        @macro_plugins.each do |key, macro|
+          begin
+            Module.const_get(key.to_s)
+          rescue NameError
+            next
+          end
+
+          if(const = Module.const_get(key.to_s))
+            if not const.respond_to?(:steps) && macro.call
+              @errors[:macro] << "マクロ #{key}を読み込めませんでした。"
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/procon_bypass_man/buttons_setting_configuration.rb

@@ -15,14 +15,21 @@ module ProconBypassMan
       :neutral_position
 
     def self.instance
-      @@current_context_key ||= :main
       @@context ||= {}
-      @@context[@@current_context_key] ||= new
+      @@context[current_context_key] ||= new
+    end
+
+    def self.current_context_key
+      @@current_context_key ||= :main
+    end
+
+    def self.instance=(val)
+      @@context[current_context_key] = val
     end
 
     def self.switch_new_context(key)
       @@context[key] = new
-      previous_key = @@current_context_key
+      previous_key = current_context_key
       if block_given?
         @@current_context_key = key
         value = yield(@@context[key])
@@ -35,23 +42,31 @@ module ProconBypassMan
 
     def initialize
       reset!
+      self.class.instance = self
     end
 
     module ManualMode
       def self.name
-        'manual'
+        :manual
       end
     end
     def layer(direction, mode: ManualMode, &block)
-      mode_name = case mode
-                  when String
-                    mode.to_sym
-                  when Symbol
-                    mode
-                  else
-                    mode.name.to_sym
-                  end
-      unless ([ManualMode.name.to_sym] + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
+      if ProconBypassMan::ButtonsSettingConfiguration::ManualMode == mode
+        mode_name = mode.name
+      else
+        mode_name = case mode
+                    when ProconBypassMan::ButtonsSettingConfiguration::ManualMode
+                      mode.name
+                    when String
+                      mode.to_sym
+                    when Symbol
+                      mode
+                    else
+                      mode.to_s.to_sym
+                    end
+      end
+
+      unless ([ManualMode.name] + ProconBypassMan::Procon::ModeRegistry.plugins.keys).include?(mode_name)
         raise("#{mode_name} mode is unknown")
       end
 

data/lib/procon_bypass_man/bypass/usb_hid_logger.rb

@@ -28,10 +28,12 @@ class ProconBypassMan::Bypass
         end
       end
 
-      ProconBypassMan.cache.fetch key: 'pressed_buttons_reporter', expires_in: 5 do
-        ProconBypassMan::ReportPressedButtonsJob.perform_async(
-          ProconBypassMan::ProconReader.new(binary: bypass_value.binary).to_hash
-        )
+      if ProconBypassMan.config.enable_reporting_pressed_buttons
+        ProconBypassMan.cache.fetch key: 'pressed_buttons_reporter', expires_in: 5 do
+          ProconBypassMan::ReportPressedButtonsJob.perform_async(
+            bypass_value.binary.to_procon_reader.to_hash
+          )
+        end
       end
     end
   end

data/lib/procon_bypass_man/bypass.rb

@@ -5,7 +5,7 @@ class ProconBypassMan::Bypass
 
   class BypassValue < Struct.new(:binary, :sent)
     def to_text
-      "#{binary.unpack("H*").first} #{'x' unless sent}"
+      "#{binary.unpack.first} #{'x' unless sent}"
     end
   end
 
@@ -21,14 +21,14 @@ class ProconBypassMan::Bypass
   def send_gadget_to_procon!
     monitor.record(:start_function)
     input = nil
-    self.bypass_value = BypassValue.new(input, sent = false)
+    self.bypass_value = BypassValue.new(nil, sent = false)
 
     run_callbacks(:send_gadget_to_procon) do
       begin
         break if $will_terminate_token
         # TODO blocking readにしたいが、接続時のフェーズによって長さが違うので厳しい
         input = self.gadget.read_nonblock(64)
-        self.bypass_value.binary = input
+        self.bypass_value.binary = ProconBypassMan::Domains::InboundProconBinary.new(binary: input)
       rescue IO::EAGAINWaitReadable
         monitor.record(:eagain_wait_readable_on_read)
         sleep(0.001)
@@ -50,14 +50,14 @@ class ProconBypassMan::Bypass
   def send_procon_to_gadget!
     monitor.record(:start_function)
     output = nil
-    self.bypass_value = BypassValue.new(output, sent = false)
+    self.bypass_value = BypassValue.new(nil, sent = false)
 
     run_callbacks(:send_procon_to_gadget) do
       begin
         break if $will_terminate_token
         Timeout.timeout(1) do
           output = self.procon.read(64)
-          self.bypass_value.binary = output
+          self.bypass_value.binary = ProconBypassMan::Domains::InboundProconBinary.new(binary: output)
         end
       rescue Timeout::Error
         ProconBypassMan.logger.debug { "read timeout! do sleep. by send_procon_to_gadget!" }
@@ -72,8 +72,15 @@ class ProconBypassMan::Bypass
         retry
       end
 
+      # blocking readをしているのでnilが入ることはないが、雑なテストでnilが通るので分岐を入れる。できれば消したい
+      break if output.nil?
+
       begin
-        self.gadget.write_nonblock(ProconBypassMan::Processor.new(output).process)
+        self.gadget.write_nonblock(
+          ProconBypassMan::Processor.new(
+            ProconBypassMan::Domains::InboundProconBinary.new(binary: output)
+          ).process
+        )
         self.bypass_value.sent = true
       rescue IO::EAGAINWaitReadable
         monitor.record(:eagain_wait_readable_on_write)

data/lib/procon_bypass_man/commands/bypass_command.rb

@@ -40,7 +40,7 @@ class ProconBypassMan::BypassCommand
         monitor1.shutdown
         puts "10秒経過したのでThread1を終了します"
         break
-      rescue Errno::EIO, Errno::ENODEV, Errno::EPROTO, IOError => e
+      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 +62,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

data/lib/procon_bypass_man/commands/print_boot_message_command.rb

@@ -1,7 +1,56 @@
 class ProconBypassMan::PrintBootMessageCommand
+  class BootMessage
+    def initialize
+      @table = {}
+      @table[:ruby_version] = RUBY_VERSION
+      @table[:pbm_version] = ProconBypassMan::VERSION
+      @table[:pid] = $$
+      @table[:root_path] = ProconBypassMan.root
+      @table[:pid_path] = ProconBypassMan.pid_path
+      @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
+      @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
+      @table[:use_pbmenv] = !(!!`which pbmenv`.empty?)
+      @table[:session_id] = ProconBypassMan.session_id
+      @table[:device_id] = ProconBypassMan.device_id
+
+      # 開発中のHEADを取りたかったけど、Gem::Specification経由から取得する必要がありそう
+      # build_version = `git rev-parse --short HEAD`.chomp
+      # if build_version.empty?
+      #   @table[:build_version] = 'release version'
+      # else
+      #   @table[:build_version] = build_version
+      # end
+
+      # build version: #{@table[:build_version]}
+    end
+
+    # @return [String]
+    def to_s
+      booted_message = <<~EOF
+      ----
+      RUBY_VERSION: #{@table[:ruby_version]}
+      ProconBypassMan::VERSION: #{@table[:pbm_version]}
+      pid: #{@table[:pid]}
+      root: #{@table[:root_path]}
+      pid_path: #{@table[:pid_path]}
+      setting_path: #{@table[:setting_path]}
+      uptime from boot: #{@table[:uptime_from_boot]} sec
+      use_pbmenv: #{@table[:use_pbmenv]}
+      session_id: #{ProconBypassMan.session_id}
+      device_id: #{ProconBypassMan.device_id}
+      ----
+      EOF
+    end
+
+    # @return [Hash]
+    def to_hash
+      @table
+    end
+  end
+
   # @return [void]
   def self.execute
-    message = ProconBypassMan::BootMessage.new
+    message = BootMessage.new
     ProconBypassMan::ReportBootJob.perform_async(message.to_hash)
     ProconBypassMan::ReportLoadConfigJob.perform_async(ProconBypassMan.config.raw_setting)
     puts message.to_s

data/lib/procon_bypass_man/commands/print_message_command.rb

@@ -0,0 +1,8 @@
+class ProconBypassMan::PrintMessageCommand
+  # @return [void]
+  # @param [String] text
+  def self.execute(text: )
+    ProconBypassMan.logger.info text
+    puts text
+  end
+end

data/lib/procon_bypass_man/commands/run_remote_pbm_action_dispatch_command.rb

@@ -13,7 +13,7 @@ class ProconBypassMan::RunRemotePbmActionDispatchCommand
     when ProconBypassMan::RemotePbmAction::ACTION_RESTORE_SETTING
       ProconBypassMan::RemotePbmAction::RestorePbmSettingAction.new(pbm_job_uuid: uuid).run!(job_args: job_args)
     else
-      ProconBypassMan::SendErrorCommand.execute(error: "#{action}は対応していないアクションです")
+      raise "#{action}は対応していないアクションです"
     end
   rescue ProconBypassMan::RemotePbmAction::ActionUnexpectedError => e
     ProconBypassMan::SendErrorCommand.execute(error: e)

data/lib/procon_bypass_man/commands/send_reload_config_event_command.rb

@@ -1,8 +1,7 @@
 class ProconBypassMan::SendReloadConfigEventCommand
   # @return [void]
   def self.execute
-    puts "設定ファイルの再読み込みができました"
-    ProconBypassMan.logger.info "設定ファイルの再読み込みができました"
+    ProconBypassMan::PrintMessageCommand.execute(text: "設定ファイルの再読み込みができました")
     ProconBypassMan::ReportReloadConfigJob.perform_async(
       ProconBypassMan.config.raw_setting
     )

data/lib/procon_bypass_man/commands.rb

@@ -1,4 +1,5 @@
 require "procon_bypass_man/commands/print_boot_message_command"
+require "procon_bypass_man/commands/print_message_command"
 require "procon_bypass_man/commands/write_session_id_command"
 require "procon_bypass_man/commands/write_device_id_command"
 require "procon_bypass_man/commands/send_reload_config_event_command"

data/lib/procon_bypass_man/configuration.rb

@@ -41,7 +41,7 @@ class ProconBypassMan::Configuration
   end
 
   attr_accessor :enable_critical_error_logging
-  attr_writer :verbose_bypass_log, :raw_setting
+  attr_writer :verbose_bypass_log, :raw_setting, :enable_reporting_pressed_buttons
 
   def root=(path)
     @root = path
@@ -111,6 +111,33 @@ class ProconBypassMan::Configuration
     @server_pool ||= ProconBypassMan::ServerPool.new(servers: api_servers)
   end
 
+  # @return [String, NilClass]
+  def current_server
+    server_pool.server
+  end
+
+  # @return [String, NilClass]
+  def current_ws_server
+    if (uri = URI.parse(server_pool.server))
+      if uri.port == 443
+        return "ws://#{uri.host}"
+      else
+        return "ws://#{uri.host}:#{uri.port}"
+      end
+    end
+  rescue URI::InvalidURIError
+    nil
+  end
+
+  # @return [String, NilClass]
+  def current_ws_server_url
+    return unless current_ws_server
+    "#{current_ws_server}/websocket/"
+  end
+
+  # @return [Boolean]
+  def enable_ws?; !!current_server; end
+
   # @return [Array<String>]
   def api_servers
     if !!ENV["API_SERVER"]
@@ -127,4 +154,8 @@ class ProconBypassMan::Configuration
   def raw_setting
     @raw_setting ||= {}
   end
+
+  def enable_reporting_pressed_buttons
+    @enable_reporting_pressed_buttons ||= false
+  end
 end

data/lib/procon_bypass_man/domains/binary/base.rb

@@ -0,0 +1,25 @@
+class ProconBypassMan::Domains::Binary::Base
+  # @param [String] binary
+  def initialize(binary: )
+    @binary = binary
+  end
+
+  # @return [String] バイナリ
+  def binary
+    raise NotImplementedError
+  end
+
+  # @return [String]
+  def raw
+    binary
+  end
+
+  def unpack
+    binary.unpack("H*")
+  end
+
+  # @return [ProconBypassMan::ProconReader]
+  def to_procon_reader
+    ProconBypassMan::ProconReader.new(binary: binary)
+  end
+end

data/lib/procon_bypass_man/domains/binary/has_immutable_binary.rb

@@ -0,0 +1,5 @@
+module ProconBypassMan::Domains::HasImmutableBinary
+  def binary
+    @binary.freeze
+  end
+end

data/lib/procon_bypass_man/domains/binary/has_mutable_binary.rb

@@ -0,0 +1,5 @@
+module ProconBypassMan::Domains::HasMutableBinary
+  def binary
+    @binary
+  end
+end

data/lib/procon_bypass_man/domains/binary/inbound_procon_binary.rb

@@ -0,0 +1,9 @@
+# proconから取得したばかりのバイナリ
+class ProconBypassMan::Domains::InboundProconBinary < ProconBypassMan::Domains::Binary::Base
+  include ProconBypassMan::Domains::HasImmutableBinary
+
+  # @return [Boolean]
+  def user_operation_data?
+    binary[0] == "\x30".b
+  end
+end

data/lib/procon_bypass_man/domains/binary/processing_procon_binary.rb

@@ -0,0 +1,66 @@
+# バイナリの書き換えのみをする
+class ProconBypassMan::Domains::ProcessingProconBinary < ProconBypassMan::Domains::Binary::Base
+  include ProconBypassMan::Domains::HasMutableBinary
+
+  ALL_ZERO_BIT = ["0"].pack("H*").freeze
+
+  def set_no_action!
+    binary[3] = ALL_ZERO_BIT
+    binary[4] = ALL_ZERO_BIT
+    binary[5] = ALL_ZERO_BIT
+  end
+
+  # @param [ProconBypassMan::Domains::ProcessingProconBinary]
+  # @return [ProconBypassMan::Domains::ProcessingProconBinary]
+  # アナログスティックは上書きし、ボタンだけマージする
+  def write_as_merge!(target_binary)
+    current_buttons = ProconBypassMan::ProconReader.new(binary: binary).pressing
+    target_buttons = ProconBypassMan::ProconReader.new(binary: target_binary.raw).pressing
+
+    set_no_action!
+    (current_buttons + target_buttons).uniq.each do |button|
+      write_as_press_button(button)
+    end
+
+    # override analog stick
+    tb = [target_binary.raw].pack("H*")
+    binary[6] = tb[6]
+    binary[7] = tb[7]
+    binary[8] = tb[8]
+    binary[9] = tb[9]
+    binary[10] = tb[10]
+    binary[11] = tb[11]
+
+    self
+  end
+
+  # @param [Symbol] button
+  def write_as_press_button(button)
+    raise "already pressing button(#{button})" if ProconBypassMan::PressButtonAware.new(binary).pressing_button?(button)
+
+    button_obj = ProconBypassMan::Procon::Button.new(button)
+    value = binary[button_obj.byte_position].unpack("C").first + (2**button_obj.bit_position)
+    binary[button_obj.byte_position] = ["%02X" % value.to_s].pack("H*")
+  end
+
+  # @param [Symbol] button
+  def write_as_unpress_button(button)
+    raise "not press button(#{button}) yet" if not ProconBypassMan::PressButtonAware.new(binary).pressing_button?(button)
+
+    button_obj = ProconBypassMan::Procon::Button.new(button)
+    value = binary[button_obj.byte_position].unpack("C").first - (2**button_obj.bit_position)
+    binary[button_obj.byte_position] = ["%02X" % value.to_s].pack("H*")
+  end
+
+  # @param [Symbol] button
+  def write_as_press_button_only(button)
+    set_no_action!
+    write_as_press_button(button)
+  end
+
+  # @param [Integer] cap
+  def write_as_apply_left_analog_stick_cap(cap: )
+    analog_stick_cap = ProconBypassMan::Procon::AnalogStickCap.new(binary)
+    binary[6..8] = analog_stick_cap.capped_position(cap_hypotenuse: cap).to_binary
+  end
+end

data/lib/procon_bypass_man/domains.rb

@@ -0,0 +1,11 @@
+module ProconBypassMan
+  module Domains
+    module Binary; end
+  end
+end
+
+require_relative "domains/binary/base"
+require_relative "domains/binary/has_mutable_binary"
+require_relative "domains/binary/has_immutable_binary"
+require_relative "domains/binary/inbound_procon_binary"
+require_relative "domains/binary/processing_procon_binary"

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

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module FastReturn
-          def self.name
+          def self.display_name
             :fast_return
           end
 

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

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module JumpToLeftKey
-          def self.name
+          def self.display_name
             :jump_to_left_key
           end
 

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

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module JumpToRightKey
-          def self.name
+          def self.display_name
             :jump_to_right_key
           end
 

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

@@ -3,7 +3,7 @@ module ProconBypassMan
     module Splatoon2
       module Macro
         module JumpToUpKey
-          def self.name
+          def self.display_name
             :jump_to_up_key
           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/plugin/splatoon2/version.rb

@@ -3,7 +3,7 @@
 module ProconBypassMan
   module Plugin
     module Splatoon2
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end