diff options
author | Claire McQuin <mcquin@users.noreply.github.com> | 2015-09-04 09:36:37 -0700 |
---|---|---|
committer | Claire McQuin <mcquin@users.noreply.github.com> | 2015-09-04 09:36:37 -0700 |
commit | 886a3faa3d689957acbda4ee4c836140bfb98b1f (patch) | |
tree | f2580da833cbd7c5c18f7b2fa0ef024a7db071d3 /lib | |
parent | bc890071b8b1e0eba9aa04fa51a36311848ab1cc (diff) | |
parent | 86869f9aba02d8b40b3ee8c84f0cfaf50295a96e (diff) | |
download | chef-886a3faa3d689957acbda4ee4c836140bfb98b1f.tar.gz |
Merge pull request #3875 from chef/mcquin/monkeypatch-win32-registry-delete
Monkeypatch Win32::Registry methods delete_key, delete_value
Diffstat (limited to 'lib')
-rw-r--r-- | lib/chef/monkey_patches/win32/registry.rb | 47 | ||||
-rw-r--r-- | lib/chef/win32/api/registry.rb | 6 | ||||
-rw-r--r-- | lib/chef/win32/registry.rb | 41 |
3 files changed, 67 insertions, 27 deletions
diff --git a/lib/chef/monkey_patches/win32/registry.rb b/lib/chef/monkey_patches/win32/registry.rb new file mode 100644 index 0000000000..5ebe67c45d --- /dev/null +++ b/lib/chef/monkey_patches/win32/registry.rb @@ -0,0 +1,47 @@ +# +# Copyright:: Copyright 2015 Chef Software, Inc. +# License:: Apache License, Version 2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +require 'chef/win32/api/registry' +require 'chef/win32/unicode' +require 'win32/registry' + +module Win32 + class Registry + module API + + extend Chef::ReservedNames::Win32::API::Registry + + module_function + + if RUBY_VERSION =~ /^2\.1/ + # ::Win32::Registry#delete_value is broken in Ruby 2.1 (up to Ruby 2.1.6). + # This should be resolved in a later release (see note #9 in link below). + # https://bugs.ruby-lang.org/issues/10820 + def DeleteValue(hkey, name) + check RegDeleteValueW(hkey, name.to_wstring) + end + end + + # ::Win32::Registry#delete_key uses RegDeleteKeyW. We need to use + # RegDeleteKeyExW to properly support WOW64 systems. + def DeleteKey(hkey, name) + check RegDeleteKeyExW(hkey, name.to_wstring, 0, 0) + end + + end + end +end
\ No newline at end of file diff --git a/lib/chef/win32/api/registry.rb b/lib/chef/win32/api/registry.rb index 45b91d7d32..cbbf6b66bb 100644 --- a/lib/chef/win32/api/registry.rb +++ b/lib/chef/win32/api/registry.rb @@ -39,6 +39,12 @@ class Chef safe_attach_function :RegDeleteKeyExW, [ :HKEY, :LPCTSTR, :LONG, :DWORD ], :LONG safe_attach_function :RegDeleteKeyExA, [ :HKEY, :LPCTSTR, :LONG, :DWORD ], :LONG + # LONG WINAPI RegDeleteValue( + # _In_ HKEY hKey, + # _In_opt_ LPCTSTR lpValueName + # ); + safe_attach_function :RegDeleteValueW, [ :HKEY, :LPCTSTR ], :LONG + end end end diff --git a/lib/chef/win32/registry.rb b/lib/chef/win32/registry.rb index b25ce7937e..12ad08a965 100644 --- a/lib/chef/win32/registry.rb +++ b/lib/chef/win32/registry.rb @@ -21,6 +21,7 @@ require 'chef/win32/api' require 'chef/mixin/wide_string' if RUBY_PLATFORM =~ /mswin|mingw32|windows/ + require 'chef/monkey_patches/win32/registry' require 'chef/win32/api/registry' require 'win32/registry' require 'win32/api' @@ -126,37 +127,23 @@ class Chef Chef::Log.debug("Registry key #{key_path}, does not exist, not deleting") return true end - #key_path is in the form "HKLM\Software\Opscode" for example, extracting - #hive = HKLM, - #hive_namespace = ::Win32::Registry::HKEY_LOCAL_MACHINE - hive = key_path.split("\\").shift - hive_namespace, key_including_parent = get_hive_and_key(key_path) - if has_subkeys?(key_path) - if recursive == true - subkeys = get_subkeys(key_path) - subkeys.each do |key| - keypath_to_check = hive+"\\"+key_including_parent+"\\"+key - Chef::Log.debug("Deleting registry key #{key_path} recursively") - delete_key(keypath_to_check, true) - end - delete_key_ex(hive_namespace, key_including_parent) - else - raise Chef::Exceptions::Win32RegNoRecursive, "Registry key #{key_path} has subkeys, and recursive not specified" - end - else - delete_key_ex(hive_namespace, key_including_parent) - return true + if has_subkeys?(key_path) && !recursive + raise Chef::Exceptions::Win32RegNoRecursive, "Registry key #{key_path} has subkeys, and recursive not specified" + end + hive, key_including_parent = get_hive_and_key(key_path) + # key_including_parent: Software\\Root\\Branch\\Fruit + # key => Fruit + # key_parent => Software\\Root\\Branch + key_parts = key_including_parent.split("\\") + key = key_parts.pop + key_parent = key_parts.join("\\") + hive.open(key_parent, ::Win32::Registry::KEY_WRITE | registry_system_architecture) do |reg| + reg.delete_key(key, recursive) end + Chef::Log.debug("Registry key #{key_path} deleted") true end - #Using the 'RegDeleteKeyEx' Windows API that correctly supports WOW64 systems (Win2003) - #instead of the 'RegDeleteKey' - def delete_key_ex(hive, key) - hive_num = hive.hkey - (1 << 32) - RegDeleteKeyExW(hive_num, wstring(key), ::Win32::Registry::KEY_WRITE | registry_system_architecture, 0) == 0 - end - def key_exists?(key_path) hive, key = get_hive_and_key(key_path) begin |