win32-process 0.6.0 → 0.6.1

data/CHANGES

@@ -1,3 +1,11 @@
+= 0.6.1 - 16-Jul-2009
+* Added the Process.uid method. This method returns a user id (really, the RID
+  of the SID) by default, but can also take an optional parameter to return
+  a binary SID instead at the user's discretion.
+* Added working implementations of Process.getpriority and Process.setpriority.
+  Note they they only work for processes, not process groups or users.
+* Set license to Artistic 2.0, and updated the gemspec.
+
 = 0.6.0 - 31-Oct-2008
 * The mandatory argument for Process.create has been switched from 'app_name'
   to 'command_line', to be more in line with underlying CreateProcess API.

data/lib/win32/process.rb

@@ -8,15 +8,18 @@ require 'windows/console'
 require 'windows/window'
 require 'windows/unicode'
 require 'windows/tool_helper'
+require 'windows/security'
+require 'windows/msvcrt/string'
 
 module Process
    class Error < RuntimeError; end
 
    # Eliminates redefinition warnings.
-   undef_method :kill, :wait, :wait2, :waitpid, :waitpid2, :ppid
+   undef_method :getpriority, :kill, :ppid, :setpriority
+   undef_method :wait, :wait2, :waitpid, :waitpid2, :uid
    
    # The version of this library
-   WIN32_PROCESS_VERSION = '0.6.0'
+   WIN32_PROCESS_VERSION = '0.6.1'
    
    include Windows::Process
    include Windows::Thread
@@ -24,20 +27,24 @@ module Process
    include Windows::Library
    include Windows::Console
    include Windows::Handle
+   include Windows::Security
    include Windows::Synchronize
    include Windows::Window
    include Windows::Unicode
    include Windows::ToolHelper
+   include Windows::MSVCRT::String
 
    extend Windows::Error
    extend Windows::Process
    extend Windows::Thread
+   extend Windows::Security
    extend Windows::Synchronize
    extend Windows::Handle
    extend Windows::Library
    extend Windows::Console
    extend Windows::Unicode
    extend Windows::ToolHelper
+   extend Windows::MSVCRT::String
    
    # Used by Process.create
    ProcessInfo = Struct.new("ProcessInfo",
@@ -50,6 +57,122 @@ module Process
    @child_pids = []  # Static variable used for Process.fork
    @i = -1           # Static variable used for Process.fork
 
+   # Retrieves the priority class for the specified process id +int+. Unlike
+   # the default implementation, lower values do not necessarily correspond to
+   # higher priority classes.
+   #
+   # The +kind+ parameter is ignored but present for API compatibility.
+   # You can only retrieve process information, not process group or user
+   # information, so it is effectively always Process::PRIO_PROCESS.
+   #
+   # Possible return values are:
+   #
+   # 32    - Process::NORMAL_PRIORITY_CLASS
+   # 64    - Process::IDLE_PRIORITY_CLASS
+   # 128   - Process::HIGH_PRIORITY_CLASS
+   # 256   - Process::REALTIME_PRIORITY_CLASS
+   # 16384 - Process::BELOW_NORMAL_PRIORITY_CLASS
+   # 32768 - Process::ABOVE_NORMAL_PRIORITY_CLASS
+   # 
+   def getpriority(kind = Process::PRIO_PROCESS, int = nil)
+      raise ArgumentError unless int
+
+      handle = OpenProcess(PROCESS_QUERY_INFORMATION, 0 , int)
+
+      if handle == INVALID_HANDLE_VALUE
+         raise Error, get_last_error
+      end
+
+      priority_class = GetPriorityClass(handle)
+
+      if priority_class == 0
+         raise Error, get_last_error
+      end
+
+      priority_class
+   end
+
+   # Sets the priority class for the specified process id +int+.
+   #
+   # The +kind+ parameter is ignored but present for API compatibility.
+   # You can only retrieve process information, not process group or user
+   # information, so it is effectively always Process::PRIO_PROCESS.
+   #
+   # Possible +int_priority+ values are:
+   #
+   # * Process::NORMAL_PRIORITY_CLASS
+   # * Process::IDLE_PRIORITY_CLASS
+   # * Process::HIGH_PRIORITY_CLASS
+   # * Process::REALTIME_PRIORITY_CLASS
+   # * Process::BELOW_NORMAL_PRIORITY_CLASS
+   # * Process::ABOVE_NORMAL_PRIORITY_CLASS
+   #
+   def setpriority(kind = nil, int = nil, int_priority = nil)
+      raise ArgumentError unless int
+      raise ArgumentError unless int_priority
+
+      handle = OpenProcess(PROCESS_SET_INFORMATION, 0 , int)
+
+      if handle == INVALID_HANDLE_VALUE
+         raise Error, get_last_error
+      end
+
+      unless SetPriorityClass(handle, int_priority)
+         raise Error, get_last_error
+      end
+
+      return 0 # Match the spec
+   end
+
+   # Returns the uid of the current process. Specifically, it returns the
+   # RID of the SID associated with the owner of the process.
+   #
+   # If +sid+ is set to true, then a binary sid is returned. Otherwise, a
+   # numeric id is returned (the default).
+   #--
+   # The Process.uid method in core Ruby always returns 0 on MS Windows.
+   #
+   def uid(sid = false)
+      token = 0.chr * 4
+
+      unless OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, token)
+         raise Error, get_last_error
+      end
+
+      token   = token.unpack('V')[0]
+      rlength = 0.chr * 4
+      tuser   = 0.chr * 512
+
+      bool = GetTokenInformation(
+         token,
+         TokenUser,
+         tuser,
+         tuser.size,
+         rlength
+      )
+
+      unless bool
+         raise Error, get_last_error
+      end
+
+      lsid = tuser[8, (rlength.unpack('L').first - 8)]
+
+      if sid
+         lsid
+      else
+         sid_addr = [lsid].pack('p*').unpack('L')[0]
+         sid_buf  = 0.chr * 80
+         sid_ptr  = 0.chr * 4
+
+         unless ConvertSidToStringSid(sid_addr, sid_ptr)
+            raise Error, get_last_error
+         end
+
+         strcpy(sid_buf, sid_ptr.unpack('L')[0])
+         sid_buf.strip.split('-').last.to_i
+      end
+   end 
+
    # Waits for the given child process to exit and returns that pid.
    # 
    # Note that the $? (Process::Status) global variable is NOT set.  This
@@ -699,8 +822,8 @@ module Process
       pid 
    end
    
-   module_function :kill, :wait, :wait2, :waitpid, :waitpid2, :create, :fork
-   module_function :ppid
+   module_function :create, :fork, :getpriority, :kill, :ppid, :setpriority
+   module_function :wait, :wait2, :waitpid, :waitpid2, :uid
 end
 
 # Create a global fork method

data/test/test_win32_process.rb

@@ -37,10 +37,11 @@ class TC_Win32Process < Test::Unit::TestCase
 
    def setup
       @pid = nil
+      @pri_class = Process::NORMAL_PRIORITY_CLASS
    end
   
    def test_version
-      assert_equal('0.6.0', Process::WIN32_PROCESS_VERSION)
+      assert_equal('0.6.1', Process::WIN32_PROCESS_VERSION)
    end
    
    def test_kill
@@ -117,6 +118,35 @@ class TC_Win32Process < Test::Unit::TestCase
       assert_equal(true, Process.ppid > 0)
       assert_equal(false, Process.pid == Process.ppid)
    end
+   
+   def test_uid
+      assert_respond_to(Process, :uid)
+      assert_kind_of(Fixnum, Process.uid)
+      assert_kind_of(String, Process.uid(true))      
+   end
+
+   def test_getpriority
+      assert_respond_to(Process, :getpriority)
+      assert_nothing_raised{ Process.getpriority(nil, Process.pid) }
+      assert_kind_of(Fixnum, Process.getpriority(nil, Process.pid))
+   end
+
+   def test_getpriority_expected_errors
+      assert_raise{ Process.getpriority }
+      assert_raise{ Process.getpriority(nil) }
+   end
+
+   def test_setpriority
+      assert_respond_to(Process, :setpriority)
+      assert_nothing_raised{ Process.setpriority(nil, Process.pid, @pri_class) }
+      assert_equal(0, Process.setpriority(nil, Process.pid, @pri_class))
+   end
+
+   def test_setpriority_expected_errors
+      assert_raise{ Process.setpriority }
+      assert_raise{ Process.setpriority(nil) }
+      assert_raise{ Process.setpriority(nil, Process.pid) }
+   end
   	
    def test_creation_constants
       assert_not_nil(Process::CREATE_DEFAULT_ERROR_MODE)

data/win32-process.gemspec

@@ -1,26 +1,30 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-   desc = "Adds create, fork, wait, wait2, waitpid, and a special kill method"
-   gem.name        = "win32-process"
-   gem.version     = "0.6.0"
-   gem.authors     = ['Daniel Berger', 'Park Heesob']
-   gem.email       = "djberg96@gmail.com"
+   gem.name       = 'win32-process'
+   gem.version    = '0.6.1'
+   gem.license    = 'Artistic 2.0'
+   gem.authors    = ['Daniel Berger', 'Park Heesob']
+   gem.email      = 'djberg96@gmail.com'
+   gem.homepage   = 'http://www.rubyforge.org/projects/win32utils'
+   gem.platform   = Gem::Platform::RUBY
+   gem.summary    = 'Adds and redefines several Process methods for MS Windows'
+   gem.test_files = Dir['test/*.rb']
+   gem.has_rdoc   = true
+   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.description = <<-EOF
+      The win32-process library implements several Process methods that are
+      either unimplemented or dysfunctional in some way in the default Ruby
+      implementation. Examples include Process.kill, Process.waitpid,
+      Process.create and an experimental Process.fork method.
+   EOF
+
    gem.rubyforge_project = 'win32utils'
-   gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
-   gem.platform    = Gem::Platform::RUBY
-   gem.summary     = desc
-   gem.description = desc
-   gem.test_files  = Dir["test/*.rb"]
-   gem.has_rdoc    = true
-   gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"] + Dir["examples/*"]
-   gem.files.reject! { |fn| fn.include? "CVS" }
-   gem.require_path = "lib"
-   gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
-   gem.add_dependency("windows-pr", ">= 0.8.6")
-end
+   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
 
-if $0 == __FILE__
-   Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.3
-   Gem::Builder.new(spec).build
+   gem.add_dependency('windows-pr', '>= 1.0.5')
 end
+
+Gem.manage_gems if Gem::RubyGemsVersion.to_f < 1.3
+Gem::Builder.new(spec).build

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-process
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - Daniel Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-31 00:00:00 -06:00
+date: 2009-07-16 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,9 +21,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.6
+        version: 1.0.5
     version: 
-description: Adds create, fork, wait, wait2, waitpid, and a special kill method
+description: "      The win32-process library implements several Process methods that are\n      either unimplemented or dysfunctional in some way in the default Ruby\n      implementation. Examples include Process.kill, Process.waitpid,\n      Process.create and an experimental Process.fork method.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -34,22 +34,21 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files: 
-- lib/win32/process.rb
-- test/test_win32_process.rb
 - CHANGES
-- examples
-- lib
-- MANIFEST
-- Rakefile
-- README
-- test
-- win32-process.gemspec
 - examples/test_create.rb
 - examples/test_fork_wait.rb
 - examples/test_fork_waitpid.rb
 - examples/test_kill.rb
+- lib/win32/process.rb
+- MANIFEST
+- Rakefile
+- README
+- test/test_win32_process.rb
+- win32-process.gemspec
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -70,9 +69,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
-summary: Adds create, fork, wait, wait2, waitpid, and a special kill method
+specification_version: 3
+summary: Adds and redefines several Process methods for MS Windows
 test_files: 
 - test/test_win32_process.rb