mediakit 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b89173bcea5b5f50317e32e2034f49d28826f241
-  data.tar.gz: df29a2019137bc3524e5936eb240edc8694b9910
+  metadata.gz: 739026ab070097e01f9e544c1838bbf532559641
+  data.tar.gz: bec5a0d43369988119be0a84d1999d781cdc4859
 SHA512:
-  metadata.gz: 4277da4ec46a39da0570ad8d06380103890fa7e3fc80b11d2a257b514bf00fccc3c68a3feb7c6aaa48c7a543b266da2302e8ec2ab3340cac256a027d0062fa20
-  data.tar.gz: ca904cac4f9c3d92911db53dd344610bf06616b9c76ff982790230c24fde0e00c608cebe755406b50bdc97b9ca4a22ea14a0deffccf77c54be0474af44efa7cb
+  metadata.gz: 34b726d533096261e10df0dc11c79b737247b4c3eab3b6b6f9d94558e20166574735fd1c83660a0725e350c76c7be4c6129f2509015c4015b3b7866b1ebf2c30
+  data.tar.gz: aece0527121a414e45f4b46d4efb3ae6610cae4a43e134963d1ba4dc810f5c51565c001a3b0ef7b409706d406ff65ba65a926060f92f1728577750d753b43989

data/README.md

@@ -10,10 +10,13 @@ I've design this library for following purpose.
 
 ## Development Plan
 
-Currently under development.
+Currently you can use low-level inteface of mediakit!
 
 * [x] low-level interface for ffmpeg
-* [ ] low-level interface's basic feature
+* [*] low-level interface's basic feature
+  * [*] nice setting
+  * [*] read timeout setting
+  * [*] shell escape for security
 * [ ] high-level interface for ffmpeg
 * [ ] low-level interface for sox
 * [ ] high-level interface for sox
@@ -43,14 +46,14 @@ So it need each binary command file.
 
 ## Usage
 
-### Low Level Usage
+### Low Level Interface
 
 The low level means it's near command line usage.
 This is a little bore interface for constructing options,
 but can pass certain it.
 
 ```rb
-driver = Mediakit::Drivers::FFmpeg.new
+driver = Mediakit::Drivers::FFmpeg.new(timeout: 30, nice: 0)
 ffmpeg = Mediakit::FFmpeg.new(driver)
 
 options = Mediakit::FFmpeg::Options.new(
@@ -75,7 +78,7 @@ puts "$ #{ffmpeg.command(options)}"
 puts ffmpeg.run(options)
 ```
 
-### High Level Usage
+### High Level Interface
 
 TBD
 

data/lib/mediakit/drivers.rb

@@ -34,9 +34,8 @@ module Mediakit
       def run(*args)
         options = (args.last && args.last.kind_of?(Hash)) ? args.pop : {}
         begin
-          escaped_args = Mediakit::Utils::ProcessRunner.escape(*args)
           runner = Mediakit::Utils::ProcessRunner.new(options)
-          stdout, stderr, exit_status = runner.run(bin, escaped_args)
+          stdout, stderr, exit_status = runner.run(bin, *args)
           raise(FailError, stderr) unless exit_status
           stdout
         rescue Mediakit::Utils::ProcessRunner::CommandNotFoundError => e
@@ -52,44 +51,11 @@ module Mediakit
       #   @param args [Array] arguments for command
       # @return [String] command
       def command(*args)
-        escaped_args = Mediakit::Utils::ProcessRunner.escape(*args)
+        escaped_args = Mediakit::Utils::ShellEscape.escape(*args)
         "#{bin} #{escaped_args}"
       end
     end
 
-    class CocaineDriver < Base
-      # execute command and return result
-      #
-      # @overload run(args)
-      #   @param args [String] arguments for command
-      # @overload run(*args, options)
-      #   @param args [Array] arguments for command
-      #   @option options [Hash] run options
-      # @return [Bool] stdout output
-      def run(args = '')
-        begin
-          # Force escape args string on here,
-          # because this design can't use Cocaine::CommandLine's safety solution.
-          escaped_args = Mediakit::Utils::ProcessRunner.escape(args.dup)
-          command_line = Cocaine::CommandLine.new(bin, escaped_args, swallow_stderr: true)
-          command_line.run
-        rescue Cocaine::ExitStatusError => e
-          raise(FailError, e.message)
-        end
-      end
-
-      # return command to execute
-      #
-      # @overload run(args)
-      #   @param args [String] arguments for command
-      # @overload run(*args)
-      #   @param args [Array] arguments for command
-      # @return [String] command commands to execute
-      def command(args = '')
-        Cocaine::CommandLine.new(bin, args).command
-      end
-    end
-
     class FakeDriver < Base
       def run(args = '')
         true
@@ -120,8 +86,6 @@ module Mediakit
           case type.to_sym
           when :popen
             PopenDriver.new(bin)
-          when :cocaine
-            CocaineDriver.new(bin)
           when :fake
             FakeDriver.new(bin)
           else

data/lib/mediakit/utils/process_runner.rb

@@ -1,8 +1,8 @@
-require 'shellwords'
 require 'open3'
 require 'thread'
 require 'timeout'
 require 'cool.io'
+require 'mediakit/utils/shell_escape'
 
 module Mediakit
   module Utils
@@ -12,7 +12,9 @@ module Mediakit
       class TimeoutError < StandardError;
       end
 
-      def initialize(timeout: nil, nice: 0)
+      DEFAULT_READ_TIMEOUT_INTERVAL = 30
+
+      def initialize(timeout: DEFAULT_READ_TIMEOUT_INTERVAL, nice: 0)
         @timeout = timeout
         @nice = nice
       end
@@ -28,34 +30,28 @@ module Mediakit
       # @return exit_status [Boolean] is succeeded
       def run(bin, *args)
         command = build_command(bin, *args)
-        pid, exit_status = nil
-        out_reader, err_reader = nil
-        loop = Coolio::Loop.new
+        exit_status = nil
         begin
           stdin, stdout, stderr, wait_thr = Open3.popen3(command)
           stdin.close
           pid = wait_thr.pid
-          timer = TimeoutTimer.new(@timeout, Thread.current)
-          timer.attach(loop)
-          out_watcher = IOWatcher.new(stdout) { timer.update }
-          out_watcher.attach(loop)
-          err_watcher = IOWatcher.new(stderr) { timer.update }
-          err_watcher.attach(loop)
-          loop_thread = Thread.new do
-            loop.run
+          begin
+            loop = Coolio::Loop.new
+            timer, out_watcher, err_watcher = setup_watchers(loop, stdout, stderr)
+            loop_thread = Thread.new { loop.run }
+            wait_thr.join
+            exit_status = (wait_thr.value.exitstatus == 0)
+          rescue Timeout::Error => error
+            force_kill_process(pid)
+            raise(error)
+          ensure
+            out_watcher.close unless out_watcher && out_watcher.closed?
+            err_watcher.close unless err_watcher && err_watcher.closed?
+            timer.detach if timer
+            loop_thread.join if loop_thread
           end
-          wait_thr.join
-          exit_status = (wait_thr.value.exitstatus == 0)
         rescue Errno::ENOENT => e
           raise(CommandNotFoundError, "Can't find command - #{command}, #{e.meessage}")
-        rescue Timeout::Error => error
-          safe_kill_process(pid)
-          raise(error)
-        ensure
-          out_watcher.close if out_watcher
-          err_watcher.close if err_watcher
-          timer.detach if timer
-          loop_thread.join
         end
 
         [out_watcher.data, err_watcher.data, exit_status]
@@ -63,36 +59,30 @@ module Mediakit
 
       def build_command(bin, *args)
         command = build_command_without_options(bin, *args)
-        unless @nice == 0
-          "nice -n #{@nice} sh -c \"#{command}\""
-        else
+        if @nice == 0
           command
+        else
+          "nice -n #{ShellEscape.escape(@nice)} sh -c \"#{command}\""
         end
       end
 
       def build_command_without_options(bin, *args)
-        escaped_args = self.class.escape(*args)
+        escaped_args = ShellEscape.escape(*args)
         "#{bin} #{escaped_args}"
       end
 
-      def self.escape(*args)
-        case args.size
-        when 1
-          escape_with_split(args[0])
-        else
-          Shellwords.join(args.map { |x| Shellwords.escape(x) })
-        end
-      end
-
-      private
+      def setup_watchers(loop, stdout, stderr)
+        timer = TimeoutTimer.new(@timeout, Thread.current)
+        timer.attach(loop)
+        out_watcher = IOWatcher.new(stdout) { timer.update }
+        out_watcher.attach(loop)
+        err_watcher = IOWatcher.new(stderr) { timer.update }
+        err_watcher.attach(loop)
 
-      def self.escape_with_split(string)
-        splits = Shellwords.split(string)
-        splits = splits.map { |x| Shellwords.escape(x) }
-        splits.join(' ')
+        [timer, out_watcher, err_watcher]
       end
 
-      def safe_kill_process(pid)
+      def force_kill_process(pid)
         Process.kill('SIGKILL', pid)
       rescue Errno::ESRCH
         warn 'already killedd'

data/lib/mediakit/utils/shell_escape.rb

@@ -0,0 +1,25 @@
+require 'shellwords'
+
+module Mediakit
+  module Utils
+    module ShellEscape
+      def escape(*args)
+        case args.size
+        when 1
+          escape_with_split(args[0])
+        else
+          Shellwords.join(args.map { |x| Shellwords.escape(x) })
+        end
+      end
+      module_function(:escape)
+
+      private
+
+      def self.escape_with_split(string)
+        splits = Shellwords.split(string)
+        splits = splits.map { |x| Shellwords.escape(x) }
+        splits.join(' ')
+      end
+    end
+  end
+end

data/lib/mediakit/version.rb

@@ -1,3 +1,3 @@
 module Mediakit
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/mediakit.gemspec

@@ -22,7 +22,6 @@ EOS
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "cocaine", "~> 0.5.7"
   spec.add_runtime_dependency "activesupport", "~> 4"
   spec.add_runtime_dependency "cool.io", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mediakit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - ainame
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-23 00:00:00.000000000 Z
+date: 2015-05-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: cocaine
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.7
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +117,7 @@ files:
 - lib/mediakit/ffmpeg/options.rb
 - lib/mediakit/ffprobe.rb
 - lib/mediakit/utils/process_runner.rb
+- lib/mediakit/utils/shell_escape.rb
 - lib/mediakit/version.rb
 - mediakit.gemspec
 - sample/configure.rb