win32-process 0.5.4 → 0.5.5

data/CHANGES

@@ -1,3 +1,10 @@
+== 0.5.5 - 12-Dec-2007
+* The Process.create method now automatically closes the process and thread
+  handles in the ProcessInfo struct before returning, unless you explicitly
+  tell it not to via the 'close_handles' option.
+* The Process.create method now supports creating a process as another user
+  via the 'with_logon', 'password' and 'domain' options.
+
 == 0.5.4 - 23-Nov-2007
 * Changed ProcessError to Process::Error.
 * Now requires windows-pr 0.7.3 or later because of some reorganization in

data/lib/win32/process.rb

@@ -6,11 +6,12 @@ require 'windows/handle'
 require 'windows/library'
 require 'windows/console'
 require 'windows/window'
+require 'windows/unicode'
 
 module Process
    class Error < RuntimeError; end
    
-   WIN32_PROCESS_VERSION = '0.5.4'
+   WIN32_PROCESS_VERSION = '0.5.5'
    
    include Windows::Process
    include Windows::Thread
@@ -20,6 +21,7 @@ module Process
    include Windows::Handle
    include Windows::Synchronize
    include Windows::Window
+   include Windows::Unicode
    extend Windows::Error
    extend Windows::Process
    extend Windows::Thread
@@ -27,6 +29,7 @@ module Process
    extend Windows::Handle
    extend Windows::Library
    extend Windows::Console
+   extend Windows::Unicode
    
    # Used by Process.create
    ProcessInfo = Struct.new("ProcessInfo",
@@ -216,9 +219,9 @@ module Process
    
    # Process.create(key => value, ...) => ProcessInfo
    # 
-   # This is a wrapper for the CreateProcess() function.  It executes a process,
-   # returning a ProcessInfo struct.  It accepts a hash as an argument.
-   # There are eight primary keys:
+   # This is a wrapper for the CreateProcess() function. It executes a process,
+   # returning a ProcessInfo struct. It accepts a hash as an argument.
+   # There are several primary keys:
 	#
    # * app_name         (mandatory)
    # * inherit          (default: false)
@@ -228,12 +231,19 @@ module Process
    # * cwd              (default: Dir.pwd)
    # * startup_info     (default: nil)
    # * environment      (default: nil)
+   # * close_handles    (default: true)
+   # * with_logon       (default: nil)
+   # * domain           (default: nil)
+   # * password         (default: nil)
 	#
    # Of these, the 'app_name' must be specified or an error is raised.
+   #
+   # The 'domain' and 'password' options are only relevent in the context
+   # of 'with_logon'.
 	#
-   # The startup_info key takes a hash.  Its keys are attributes that are
+   # The startup_info key takes a hash. Its keys are attributes that are
    # part of the StartupInfo struct, and are generally only meaningful for
-   # GUI or console processes.  See the documentation on CreateProcess()
+   # GUI or console processes. See the documentation on CreateProcess()
    # and the StartupInfo struct on MSDN for more information.
 	# 	
    # * desktop
@@ -253,9 +263,9 @@ module Process
    # 
    # The relevant constants for 'creation_flags', 'sw_flags' and 'startf_flags'
    # are included in the Windows::Process, Windows::Console and Windows::Window
-   # modules.  These come with the windows-pr package, a prerequisite of this
-   # package.  Note that the 'stdin', 'stdout' and 'stderr' options can be
-   # either Ruby IO objects or file descriptors (i.e. a fileno).  However,
+   # modules. These come with the windows-pr library, a prerequisite of this
+   # library. Note that the 'stdin', 'stdout' and 'stderr' options can be
+   # either Ruby IO objects or file descriptors (i.e. a fileno). However,
    # StringIO objects are not currently supported.
    # 
    # The ProcessInfo struct contains the following members:
@@ -265,6 +275,13 @@ module Process
    # * process_id     - Process ID.
    # * thread_id      - Thread ID.
    #
+   # If the 'close_handles' option is set to true (the default) then the
+   # process_handle and the thread_handle are automatically closed for you
+   # before the ProcessInfo struct is returned.
+   #
+   # If the 'with_logon' option is set, then the process runs the specified
+   # executable file in the security context of the specified credentials.
+   #
    def create(args)
       unless args.kind_of?(Hash)
          raise TypeError, 'Expecting hash-style keyword arguments'
@@ -272,7 +289,8 @@ module Process
       
       valid_keys = %w/
          app_name inherit creation_flags cwd environment startup_info
-         thread_inherit process_inherit
+         thread_inherit process_inherit close_handles with_logon domain
+         password
       /
 
       valid_si_keys = %/
@@ -280,15 +298,11 @@ module Process
          y_count_chars fill_attribute sw_flags stdin stdout stderr
       /
 
-      # Set some default values
+      # Set default values
       hash = {
-         'inherit'          => 0,
-         'process_inherit'  => 0,
-         'thread_inherit'   => 0,
-         'creation_flags'   => 0,
-         'cwd'              => 0
+         'creation_flags' => 0,
+         'close_handles'  => true
       }
-      env = 0
       
       # Validate the keys, and convert symbols and case to lowercase strings.     
       args.each{ |key, val|
@@ -296,16 +310,7 @@ module Process
          unless valid_keys.include?(key)
             raise Error, "invalid key '#{key}'"
          end
-         
-         # Convert true to 1 and nil/false to 0.
-         case val
-            when true, false
-               hash[key] = val == false ? 0 : 1
-            when nil
-               hash[key] = 0 # Win32API sometimes doesn't like nil
-            else
-               hash[key] = val
-         end
+         hash[key] = val
       }
       
       si_hash = {}
@@ -330,7 +335,14 @@ module Process
       # paths.
       if hash['environment'] 
          env = hash['environment'].split(File::PATH_SEPARATOR) << 0.chr
-         env = [env.join("\0")].pack('p*').unpack('L').first
+         if hash['with_logon']
+            env = env.map{ |e| multi_to_wide(e) }
+            env = [env.join("\0\0")].pack('p*').unpack('L').first            
+         else
+            env = [env.join("\0")].pack('p*').unpack('L').first
+         end
+      else
+         env = nil
       end
  
       startinfo = [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
@@ -390,23 +402,56 @@ module Process
          startinfo[64,4] = [si_hash['stderr']].pack('L') if si_hash['stderr']        
       end
 
-      bool = CreateProcess(
-         0,                      # App name
-         hash['app_name'],       # Command line
-         process_security,       # Process attributes
-         thread_security,        # Thread attributes
-         hash['inherit'],        # Inherit handles?
-         hash['creation_flags'], # Creation flags
-         env,                    # Environment
-         hash['cwd'],            # Working directory
-         startinfo,              # Startup Info
-         procinfo                # Process Info
-      )
-      
+      if hash['with_logon']
+         logon  = multi_to_wide(hash['with_logon'])
+         domain = multi_to_wide(hash['domain'])
+         app    = multi_to_wide(hash['app_name'])
+         cwd    = multi_to_wide(hash['cwd'])
+         passwd = multi_to_wide(hash['password'])
+         
+         hash['creation_flags'] |= CREATE_UNICODE_ENVIRONMENT
+
+         bool = CreateProcessWithLogonW(
+            logon,                  # User
+            domain,                 # Domain
+            passwd,                 # Password
+            LOGON_WITH_PROFILE,     # Logon flags
+            nil,                    # App name
+            app,                    # Command line
+            hash['creation_flags'], # Creation flags
+            env,                    # Environment
+            cwd,                    # Working directory
+            startinfo,              # Startup Info
+            procinfo                # Process Info
+         )
+      else     
+         bool = CreateProcess(
+            nil,                    # App name
+            hash['app_name'],       # Command line
+            process_security,       # Process attributes
+            thread_security,        # Thread attributes
+            hash['inherit'],        # Inherit handles?
+            hash['creation_flags'], # Creation flags
+            env,                    # Environment
+            hash['cwd'],            # Working directory
+            startinfo,              # Startup Info
+            procinfo                # Process Info
+         )
+      end      
+      
+      # TODO: Close stdin, stdout and stderr handles in the si_hash unless
+      # they're pointing to one of the standard handles already.
       unless bool
          raise Error, "CreateProcess() failed: ", get_last_error
       end
       
+      # Automatically close the process and thread handles in the
+      # PROCESS_INFORMATION struct unless explicitly told not to.
+      if hash['close_handles']
+         CloseHandle(procinfo[8,4].unpack('L').first)
+         CloseHandle(procinfo[12,4].unpack('L').first)
+      end      
+      
       ProcessInfo.new(
          procinfo[0,4].unpack('L').first, # hProcess
          procinfo[4,4].unpack('L').first, # hThread

data/win32-process.gemspec

@@ -1,21 +1,22 @@
 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.5.4"
+   gem.version     = "0.5.5"
    gem.author      = "Daniel J. Berger"
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
    gem.platform    = Gem::Platform::RUBY
-   gem.summary     = "Adds fork, wait, wait2, waitpid, waitpid2 and a special kill method"
-   gem.description = "Adds fork, wait, wait2, waitpid, waitpid2 and a special kill method"
+   gem.summary     = desc
+   gem.description = desc
    gem.test_file   = "test/tc_process.rb"
    gem.has_rdoc    = true
    gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
    gem.files.reject! { |fn| fn.include? "CVS" }
    gem.require_path = "lib"
    gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
-   gem.add_dependency("windows-pr", ">= 0.7.3")
+   gem.add_dependency("windows-pr", ">= 0.7.4")
 end
 
 if $0 == __FILE__

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-process
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-11-23 00:00:00 -07:00
+date: 2007-12-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,9 +19,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.3
+        version: 0.7.4
     version: 
-description: Adds fork, wait, wait2, waitpid, waitpid2 and a special kill method
+description: Adds create, fork, wait, wait2, waitpid, and a special kill method
 email: djberg96@gmail.com
 executables: []
 
@@ -69,6 +69,6 @@ rubyforge_project:
 rubygems_version: 0.9.5
 signing_key: 
 specification_version: 2
-summary: Adds fork, wait, wait2, waitpid, waitpid2 and a special kill method
+summary: Adds create, fork, wait, wait2, waitpid, and a special kill method
 test_files: 
 - test/tc_process.rb