procon_bypass_man 0.1.21 → 0.2.0

data/lib/procon_bypass_man/remote_macro/remote_macro_object.rb

@@ -0,0 +1,30 @@
+module ProconBypassMan
+  class RemoteMacroObject
+    # valueobjectがvalidatorの責務も持っている. 今度分離する
+    class ValidationError < StandardError; end
+    class MustBeNotNilError < ValidationError; end
+    class NonSupportAction < ValidationError; end
+
+    attr_accessor :name, :uuid, :steps
+
+    # @param [String] name
+    # @param [String] uuid
+    # @param [Array] steps
+    def initialize(name: , uuid:, steps: )
+      @name = name
+      @uuid = uuid
+      @steps = steps
+      freeze
+    end
+
+    # @raise [MustBeNotNilError]
+    # @raise [NonSupportAction]
+    # @return [void]
+    def validate!
+      self.uuid or raise MustBeNotNilError, "uuidは値が必須です"
+      unless self.steps.is_a?(Array)
+        raise ValidationError, "stepsは配列です"
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/remote_macro/remote_macro_receiver.rb

@@ -0,0 +1,37 @@
+class ProconBypassMan::RemoteMacroReceiver
+  # forkしたプロセスで動かすクラス。sock経由で命令を受け取ってmacoのキューに積んでいく
+  def self.start_with_foreground!
+    return unless ProconBypassMan.config.enable_remote_macro?
+
+    run
+  end
+
+  def self.start!
+    return unless ProconBypassMan.config.enable_remote_macro?
+
+    Thread.start do
+      start_with_foreground!
+    end
+  end
+
+  def self.run
+    while(task = ProconBypassMan::QueueOverProcess.pop)
+      receive(task)
+    end
+    shutdown
+  rescue Errno::ENOENT, Errno::ECONNRESET, Errno::ECONNREFUSED => e
+    ProconBypassMan.logger.debug(e)
+  end
+
+
+  # @param [ProconBypassMan::RemoteMacro::Task] task
+  def self.receive(task)
+    ProconBypassMan.logger.info "[remote macro][receiver] name: #{task.name}, uuid: #{task.uuid}, steps: #{task.steps}"
+    ProconBypassMan::RemoteMacro::TaskQueueInProcess.push(task)
+    true
+  end
+
+  def self.shutdown
+    ProconBypassMan.logger.info("ProconBypassMan::RemoteMacroReceiverを終了します。")
+  end
+end

data/lib/procon_bypass_man/remote_macro/remote_macro_sender.rb

@@ -0,0 +1,8 @@
+class ProconBypassMan::RemoteMacroSender
+  def self.execute(name: , uuid: , steps: )
+    ProconBypassMan.logger.info "[remote macro][sender] name: #{name}, uuid: #{uuid}, steps: #{steps}"
+    ProconBypassMan::QueueOverProcess.push(
+      ProconBypassMan::RemoteMacro::Task.new(name, uuid, steps)
+    )
+  end
+end

data/lib/procon_bypass_man/remote_macro/task.rb

@@ -0,0 +1,6 @@
+module ProconBypassMan
+  module RemoteMacro
+    class Task < Struct.new(:name, :uuid, :steps)
+    end
+  end
+end

data/lib/procon_bypass_man/remote_macro/task_queue.rb

@@ -0,0 +1,13 @@
+module ProconBypassMan
+  module RemoteMacro
+    class TaskQueue < ::Queue
+      def present?
+        not empty?
+      end
+
+      def non_blocking_shift
+        present? && shift
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/remote_macro.rb

@@ -0,0 +1,14 @@
+module ProconBypassMan
+  module RemoteMacro
+    require "procon_bypass_man/remote_macro/remote_macro_object"
+    require "procon_bypass_man/remote_macro/remote_macro_receiver"
+    require "procon_bypass_man/remote_macro/remote_macro_sender"
+    require "procon_bypass_man/remote_macro/queue_over_process"
+    require "procon_bypass_man/remote_macro/task"
+    require "procon_bypass_man/remote_macro/task_queue"
+
+    ACTION_KEY = "remote_macro"
+
+    TaskQueueInProcess = ProconBypassMan::RemoteMacro::TaskQueue.new
+  end
+end

data/lib/procon_bypass_man/remote_pbm_action/restore_pbm_setting.rb

@@ -17,7 +17,8 @@ module ProconBypassMan
           path: ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path,
           content: setting,
         )
-        ProconBypassMan.hot_reload!
+
+        hot_reload!
       end
 
       private
@@ -29,6 +30,11 @@ module ProconBypassMan
       def after_action_callback
         be_processed
       end
+
+      # @return [void]
+      def hot_reload!
+        Process.kill(:USR2, ProconBypassMan.pid)
+      end
     end
   end
 end

data/lib/procon_bypass_man/remote_pbm_action/value_objects/remote_pbm_action_object.rb

@@ -11,7 +11,7 @@ module ProconBypassMan
     # @param [String] status
     # @param [String] #uuid
     # @param [Time] created_at
-    # @return [Hash] job_args
+    # @param [Hash] job_args
     def initialize(action: , status:, uuid:, created_at:, job_args: )
       self.action = action
       self.status = status

data/lib/procon_bypass_man/remote_pbm_action.rb

@@ -6,6 +6,8 @@ module ProconBypassMan
     require "procon_bypass_man/remote_pbm_action/stop_pbm_action"
     require "procon_bypass_man/remote_pbm_action/restore_pbm_setting.rb"
     require "procon_bypass_man/remote_pbm_action/commands/update_remote_pbm_action_status_command"
+    require "procon_bypass_man/remote_pbm_action/commands/run_remote_pbm_action_dispatch_command"
+    require "procon_bypass_man/remote_pbm_action/value_objects/remote_pbm_action_object"
 
     ACTION_CHANGE_PBM_VERSION = "change_pbm_version"
     ACTION_REBOOT_OS = "reboot_os"

data/lib/procon_bypass_man/runner.rb

@@ -8,13 +8,11 @@ class ProconBypassMan::Runner
   def initialize(gadget: , procon: )
     @gadget = gadget
     @procon = procon
-
-    ProconBypassMan::PrintBootMessageCommand.execute
   end
 
   def run
     self_read, self_write = IO.pipe
-    %w(TERM INT USR1 USR2).each do |sig|
+    %w(TERM INT USR2).each do |sig|
       begin
         trap sig do
           self_write.puts(sig)
@@ -25,21 +23,25 @@ class ProconBypassMan::Runner
     end
 
     loop do
-      $will_terminate_token = false
       # NOTE メインプロセスではThreadをいくつか起動しているので念のためパフォーマンスを優先するためにforkしていく
-      child_pid = Kernel.fork { ProconBypassMan::BypassCommand.new(gadget: @gadget, procon: @procon).execute }
+      child_pid = Kernel.fork {
+        $will_terminate_token = false
+        DRb.start_service if defined?(DRb)
+        ProconBypassMan::RemoteMacroReceiver.start!
+        ProconBypassMan::BypassCommand.new(gadget: @gadget, procon: @procon).execute # ここでblockingする
+        next
+      }
 
       begin
-        # TODO 小プロセスが消滅した時に、メインプロセスは生き続けてしまい、何もできなくなる問題がある
+        # TODO 子プロセスが消滅した時に、メインプロセスは生き続けてしまい、何もできなくなる問題がある
         while(readable_io = IO.select([self_read]))
           signal = readable_io.first[0].gets.strip
           handle_signal(signal)
         end
       rescue InterruptForRestart
-        $will_terminate_token = true
-        Process.kill("TERM", child_pid)
+        ProconBypassMan::PrintMessageCommand.execute(text: "設定ファイルの再読み込みを開始します")
+        Process.kill("USR2", child_pid)
         Process.wait
-        ProconBypassMan::PrintMessageCommand.execute(text: "Reloading config file")
         begin
           ProconBypassMan::ButtonsSettingConfiguration::Loader.reload_setting
           ProconBypassMan::SendReloadConfigEventCommand.execute
@@ -49,12 +51,10 @@ class ProconBypassMan::Runner
         end
         ProconBypassMan::PrintMessageCommand.execute(text: "バイパス処理を再開します")
       rescue Interrupt
-        $will_terminate_token = true
+        puts
+        ProconBypassMan::PrintMessageCommand.execute(text: "処理を終了します")
         Process.kill("TERM", child_pid)
         Process.wait
-        ProconBypassMan::PrintMessageCommand.execute(text: "処理を終了します")
-        @gadget&.close
-        @procon&.close
         break
       end
     end

data/lib/procon_bypass_man/support/cycle_sleep.rb

@@ -0,0 +1,22 @@
+# n秒間sleepしつつ、mainスレッドをm秒間隔で動かしたい時に使う
+class ProconBypassMan::CycleSleep
+  attr_accessor :cycle_interval, :execution_cycle
+
+  def initialize(cycle_interval: , execution_cycle: )
+    @cycle_interval = cycle_interval
+    @execution_cycle = execution_cycle
+    @counter = 0
+  end
+
+  def sleep_or_execute
+    result = nil
+    if @counter >= @execution_cycle
+      @counter = 0
+      result = yield
+    else
+      @counter += 1
+    end
+    sleep(@cycle_interval)
+    return result
+  end
+end

data/lib/procon_bypass_man/support/device_mouse_finder.rb

@@ -0,0 +1,60 @@
+class ProconBypassMan::DeviceMouseFinder
+  class USBDevice < Struct.new(:display_name, :event_no)
+    # TODO bInterfaceProtocolの値を見てmouseかを判断したい
+    def mouse?
+      !!(display_name =~ /mouse/i)
+    end
+
+    def keyboard?
+      !!(display_name =~ /keyboard/i)
+    end
+
+    def event_device_path
+     "/dev/input/#{event_no}"
+    end
+  end
+
+  class Parser
+    def self.parse(shell_output)
+      instance = new
+      instance.set_usb_devices_from(shell_output)
+      instance
+    end
+
+    def set_usb_devices_from(shell_output)
+      @usb_devices =
+        shell_output.split(/\n\n/).map do |text|
+          display_name =  /N: Name="(.+?)"$/ =~ text && $1
+          event_no = /H: Handlers=.*?(event\d).*?$/ =~ text && $1
+          USBDevice.new(display_name, event_no)
+        end
+    end
+
+    def usb_devices
+      @usb_devices ||= []
+    end
+  end
+
+  def self.find
+    new.find
+  end
+
+  # @return [String, NilClass]
+  def find
+    find_path
+  end
+
+  private
+
+  def find_path
+    Parser.parse(shell_output).usb_devices.detect(&:mouse?)&.event_device_path
+  end
+
+  def shell_output
+    `bash -c '#{shell}'`
+  end
+
+  def shell
+    'cat /proc/bus/input/devices'
+  end
+end

data/lib/procon_bypass_man/{device_procon_finder.rb → support/device_procon_finder.rb}

@@ -31,8 +31,6 @@ class ProconBypassMan::DeviceProconFinder
 
   def get_list_shell
     <<~SHELL
-      #!/bin/bash
-
       FILES=/dev/hidraw*
       for f in $FILES
       do

data/lib/procon_bypass_man/support/never_exit_accidentally.rb

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

data/lib/procon_bypass_man/support/remote_macro_http_client.rb

@@ -0,0 +1,9 @@
+module ProconBypassMan
+  class RemoteMacroHttpClient < HttpClient
+    def post(job_id: )
+      super(request_body: {
+        job_id: job_id,
+      })
+    end
+  end
+end

data/lib/procon_bypass_man/support/safe_timeout.rb

@@ -7,8 +7,14 @@ module ProconBypassMan
       @timeout = timeout
     end
 
+    # @raise [Timeout]
     def throw_if_timeout!
-      raise Timeout if @timeout < Time.now
+      raise Timeout if timeout?
+    end
+
+    # @return [Boolean]
+    def timeout?
+      @timeout < Time.now
     end
   end
 end

data/lib/procon_bypass_man/{usb_device_controller.rb → support/usb_device_controller.rb}

@@ -1,17 +1,19 @@
 class ProconBypassMan::UsbDeviceController
   class << self
-    def reset
-      system('echo > /sys/kernel/config/usb_gadget/procon/UDC')
-      system('ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC')
-      sleep 0.5
+    def reset(cooldown: 0.5)
+      [ "echo > /sys/kernel/config/usb_gadget/procon/UDC",
+        "ls /sys/class/udc > /sys/kernel/config/usb_gadget/procon/UDC",
+      ].each do |shell|
+        system shell
+        ProconBypassMan.logger.debug { "[SHELL] #{shell}" }
+      end
+      sleep cooldown
     end
 
     def init
       return if initialized?
 
       shell = <<~EOH
-        #!/bin/bash
-
         cd /sys/kernel/config/usb_gadget/
         mkdir -p procon
         cd procon
@@ -44,6 +46,7 @@ class ProconBypassMan::UsbDeviceController
       EOH
 
       `bash -c '#{shell}'`
+      sleep(1)
     end
 
     def initialized?

data/lib/procon_bypass_man/support/yaml_loader.rb

@@ -0,0 +1,12 @@
+class ProconBypassMan::YamlLoader
+  # @param [String] path
+  # @return [Hash]
+  def self.load(path: )
+    YAML.load_file(path).tap do |y|
+      # 行末に空白があるとto_yamlしたときに改行コードがエスケープされてしまうのでstrip
+      y.transform_values do |v|
+        v.strip! if v.is_a?(String)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/version.rb

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

data/lib/procon_bypass_man/websocket/{pbm_job_client.rb → client.rb}

@@ -1,6 +1,6 @@
 module ProconBypassMan
   module Websocket
-    module PbmJobClient
+    module Client
       CHANNEL = 'PbmJobChannel'
 
       def self.start!
@@ -20,11 +20,10 @@ module ProconBypassMan
           )
 
           client.connected {
-            ProconBypassMan.logger.info('websocket client: successfully connected in ProconBypassMan::Websocket::PbmJobClient')
+            ProconBypassMan.logger.info('websocket client: successfully connected in ProconBypassMan::Websocket::Client')
           }
           client.subscribed { |msg|
-            ProconBypassMan.logger.info('websocket client: subscribed')
-            puts({ event: :subscribed, msg: msg })
+            ProconBypassMan.logger.info("websocket client: subscribed(#{msg})")
             ProconBypassMan::SyncDeviceStatsJob.perform(ProconBypassMan::DeviceStatus.current)
           }
 
@@ -39,13 +38,11 @@ module ProconBypassMan
 
           client.disconnected {
             ProconBypassMan.logger.info('websocket client: disconnected!!')
-            puts :disconnected
             client.reconnect!
             sleep 2
           }
           client.errored { |msg|
             ProconBypassMan.logger.error("websocket client: errored!!, #{msg}")
-            puts :errored
             client.reconnect!
             sleep 2
           }
@@ -63,17 +60,22 @@ module ProconBypassMan
       # @param [Hash] data
       def self.dispatch(data: , client: )
         pbm_job_hash = data.dig("message")
-        if pbm_job_hash['action'] == "ping"
+        case pbm_job_hash['action']
+        when "ping"
           client.perform('pong', { device_id: ProconBypassMan.device_id, message: 'hello from pbm' })
+        when ProconBypassMan::RemoteMacro::ACTION_KEY
+          validate_and_run_remote_macro(data: data)
+        when *ProconBypassMan::RemotePbmAction::ACTIONS
+          validate_and_run_remote_pbm_action(data: data)
         else
-          validate_and_run(data: data)
+          ProconBypassMan.logger.error "unknown action"
         end
       end
 
       # @raise [ProconBypassMan::RemotePbmActionObject::ValidationError]
       # @param [Hash] data
       # @return [Void]
-      def self.validate_and_run(data: )
+      def self.validate_and_run_remote_pbm_action(data: )
         pbm_job_hash = data.dig("message")
         begin
           pbm_job_object = ProconBypassMan::RemotePbmActionObject.new(action: pbm_job_hash["action"],
@@ -83,7 +85,8 @@ module ProconBypassMan
                                                                       job_args: pbm_job_hash["args"])
           pbm_job_object.validate!
         rescue ProconBypassMan::RemotePbmActionObject::ValidationError => e
-          raise
+          ProconBypassMan::SendErrorCommand.execute(error: e)
+          return
         end
 
         ProconBypassMan::RunRemotePbmActionDispatchCommand.execute(
@@ -92,6 +95,25 @@ module ProconBypassMan
           job_args: pbm_job_object.job_args
         )
       end
+
+      def self.validate_and_run_remote_macro(data: )
+        pbm_job_hash = data.dig("message")
+        begin
+          remote_macro_object = ProconBypassMan::RemoteMacroObject.new(name: pbm_job_hash["name"],
+                                                                       uuid: pbm_job_hash["uuid"],
+                                                                       steps: pbm_job_hash["steps"])
+          remote_macro_object.validate!
+        rescue ProconBypassMan::RemoteMacroObject::ValidationError => e
+          ProconBypassMan::SendErrorCommand.execute(error: e)
+          return
+        end
+
+        ProconBypassMan::RemoteMacroSender.execute(
+          name: remote_macro_object.name,
+          uuid: remote_macro_object.uuid,
+          steps: remote_macro_object.steps,
+        )
+      end
     end
   end
 end