vrvirtualdesktop 0.0.1

data/lib/Win32/Registry.rb

@@ -0,0 +1,515 @@
+##################################################################################################
+#
+# $Author: Steve $
+# $Date: 2005/12/16 18:35:42 $
+# $Version: 0.99 $
+# $Change: $
+#
+##################################################################################################
+
+module Win32
+
+	require 'Win32/Base'
+	require 'Win32/APIMapper'
+	require 'Win32/Encoding'
+
+	#---------------------------------------------------------------------------------------------
+	#---------------------------------------------------------------------------------------------
+	# Win32 Exceptions
+	class RegistryError < Win32::Error
+	end
+
+	#---------------------------------------------------------------------------------------------
+	#---------------------------------------------------------------------------------------------
+	# This class provides some low-level functionality for manipulating the Win32 registry
+	class RegKey
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "Predefined Registry Keys"
+		# (from WinReg.h)
+		HKEY_CLASSES_ROOT				= 0x80000000
+		HKEY_CURRENT_CONFIG				= 0x80000005
+		HKEY_CURRENT_USER				= 0x80000001
+		HKEY_DYN_DATA					= 0x80000006	# Works only on Win95/98/Me
+		HKEY_LOCAL_MACHINE				= 0x80000002
+		HKEY_PERFORMANCE_DATA			= 0x80000004
+		HKEY_USERS						= 0x80000003
+
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "Security and Access Rights (Open, Create)"
+		# (from WinReg.h)
+		KEY_QUERY_VALUE					= 1
+		KEY_SET_VALUE					= 2
+		KEY_CREATE_SUB_KEY				= 4
+		KEY_ENUMERATE_SUB_KEYS			= 8
+		KEY_NOTIFY						= 16
+		KEY_CREATE_LINK					= 32
+		KEY_WRITE						= 131078
+		KEY_EXECUTE						= 131097
+		KEY_READ						= 131097
+		KEY_ALL_ACCESS					= 983103
+
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "Registry Value Types"
+		# (from WinReg.h)
+		REG_NONE						= 0
+		REG_SZ							= 1
+		REG_EXPAND_SZ					= 2
+		REG_BINARY						= 3
+		REG_DWORD						= 4
+		REG_DWORD_LITTLE_ENDIAN			= 4
+		REG_DWORD_BIG_ENDIAN			= 5
+		REG_LINK						= 6
+		REG_MULTI_SZ					= 7
+
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "Registry Key Creation Options"
+		# (from WinReg.h)
+		REG_OPTION_RESERVED				= 0
+		REG_OPTION_NON_VOLATILE			= 0
+		REG_OPTION_VOLATILE				= 1
+		REG_OPTION_CREATE_LINK			= 2
+		REG_OPTION_BACKUP_RESTORE		= 4
+		REG_OPTION_OPEN_LINK			= 8
+
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "Registry Key Disposition on Create"
+		# (from WinReg.h)
+		REG_CREATED_NEW_KEY				= 1
+		REG_OPENED_EXISTING_KEY			= 2
+
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "Restore Options"
+		# (from WinReg.h)
+		REG_WHOLE_HIVE_VOLATILE			= 1
+		REG_REFRESH_HIVE				= 2
+		REG_NO_LAZY_FLUSH				= 4
+		REG_FORCE_RESTORE				= 1234		#TODO
+
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "miscellaneous"
+		# (from WinReg.h)
+		REG_FULL_RESOURCE_DESCRIPTOR	= 9
+		REG_LEGAL_CHANGE_FILTER			= 15
+		REG_LEGAL_OPTION				= 15
+		REG_NOTIFY_CHANGE_ATTRIBUTES	= 2
+		REG_NOTIFY_CHANGE_LAST_SET		= 4
+		REG_NOTIFY_CHANGE_NAME			= 1
+		REG_NOTIFY_CHANGE_SECURITY		= 8
+
+		REG_RESOURCE_LIST				= 8
+		REG_RESOURCE_REQUIREMENTS_LIST	= 10
+
+		#-----------------------------------------------------------------------------------------
+		# constsFor: "String buffer size"
+		MAXCHARS     = 256 * 2		# We exchange UCS2 characters with Windows
+
+		#-----------------------------------------------------------------------------------------
+		include APIMapper
+
+		APIMapper.Initialize(
+			'OpenKey'					=> { DLL => 'advapi32', NAME => 'RegOpenKeyExW',
+											IN => ['L', 'P', 'L', 'L', 'P'], OUT => 'L'},
+			'ConnectRegistry'			=> { DLL => 'advapi32', NAME => 'RegConnectRegistryW',
+											IN => ['P', 'L', 'P'], OUT => 'L'},
+			'CreateKey'					=> { DLL => 'advapi32', NAME => 'RegCreateKeyExW',
+											IN => ['L', 'P']*2 + ['L']*2 + ['P']*3, OUT => 'L'},
+			'CloseKey'					=> { DLL => 'advapi32', NAME => 'RegCloseKey',
+											IN => ['L'], OUT => 'L'},
+			'DeleteKey'					=> { DLL => 'advapi32', NAME => 'RegDeleteKey',
+											IN => ['L', 'P'], OUT => 'L'},
+			'DeleteValue'				=> { DLL => 'advapi32', NAME => 'RegDeleteValue',
+											IN => ['L', 'P'], OUT => 'L'},
+			'DisablePredefinedCache'	=> { DLL => 'advapi32', NAME => 'RegDisablePredefinedCache',
+											IN => [], OUT => 'L'},
+			'EnumKey'					=> { DLL => 'advapi32', NAME => 'RegEnumKeyExW',
+											IN => ['L', 'L'] + ['P']*6, OUT => 'L'},
+			'EnumValue'					=> { DLL => 'advapi32', NAME => 'RegEnumValueW',
+											IN => ['L', 'L'] + ['P']*6, OUT => 'L'},
+			'FlushKey'					=> { DLL => 'advapi32', NAME => 'RegFlushKey',
+											IN => ['L'], OUT => 'L'},
+			'LoadKey'					=> { DLL => 'advapi32', NAME => 'RegLoadKeyW',
+											IN => ['L', 'P', 'P'], OUT => 'L'},
+			'OverridePredefKey'			=> { DLL => 'advapi32', NAME => 'RegOverridePredefKey',
+											IN => ['L', 'L'], OUT => 'L'},
+			'QueryInfoKey'				=> { DLL => 'advapi32', NAME => 'RegQueryInfoKeyW',
+											IN => ['L'] + ['P']*11, OUT => 'L'},
+			'QueryValue'				=> { DLL => 'advapi32', NAME => 'RegQueryValueExW',
+											IN => ['L'] + ['P']*5, OUT => 'L'},
+			'QueryMultipleValues'		=> { DLL => 'advapi32', NAME => 'RegQueryMultipleValuesW',
+											IN => ['L'] + ['P', 'L', 'P', 'P'] , OUT => 'L'},
+			'ReplaceKey'				=> { DLL => 'advapi32', NAME => 'RegReplaceKeyW',
+											IN => ['L', 'L', 'P', 'P'], OUT => 'L'},
+			'RestoreKey'				=> { DLL => 'advapi32', NAME => 'RegRestoreKeyW',
+											IN => ['L', 'P', 'L'], OUT => 'L'},
+			'SaveKey'					=> { DLL => 'advapi32', NAME => 'RegSaveKeyW',
+											IN => ['L', 'P', 'P'], OUT => 'L'},
+			'SetValue'					=> { DLL => 'advapi32', NAME => 'RegSetValueExW',
+											IN => ['L', 'P', 'L', 'L', 'P', 'L'], OUT => 'L'},
+			'UnLoadKey'					=> { DLL => 'advapi32', NAME => 'RegUnLoadKey',
+											IN => ['L', 'P'], OUT => 'L'}
+		)
+
+		#-----------------------------------------------------------------------------------------
+		# class methodsFor: "initialization"
+		def initialize()
+			@key = nil
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# class methodsFor: "opening/creating/connecting"
+		def RegKey.open(p_key, p_strSubKey, p_samDesired = KEY_QUERY_VALUE)
+			key = RegKey.new
+			key.open(p_key, p_strSubKey, p_samDesired)
+			return key
+		end
+
+		def RegKey.create(
+				p_key,
+				p_strSubKey,
+				p_strClass            = '',
+				p_nOptions            = REG_OPTION_NON_VOLATILE,
+				p_samDesired          = 0,
+				p_pSecurityAttributes = nil)
+			key = RegKey.new
+			key.create(	p_key, p_strSubKey, p_strClass,
+						p_nOptions, p_samDesired, p_pSecurityAttributes)
+			return key
+		end
+
+		def RegKey.connect(p_strHost, p_key)
+			key = RegKey.new
+			key.connect(p_strHost, p_key)
+			return key
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "opening/creating/connecting"
+		def open(p_key, p_strSubKey, p_samDesired = KEY_QUERY_VALUE)
+			self.close if !@key.nil?
+			pKey = "\0" * 4		# pointer to long
+			ret = WCall('OpenKey', p_key.to_i, p_strSubKey.to_ucs2(true), 0, p_samDesired, pKey)
+			raise RegistryError.new(ret), "Cannot Open Key: #{p_strSubKey}", caller if 0 != ret
+			@key = pKey.unpack("L")[0]
+		end
+
+		def create(
+				p_key,
+				p_strSubKey,
+				p_strClass            = '',
+				p_nOptions            = REG_OPTION_NON_VOLATILE,
+				p_samDesired          = 0,
+				p_pSecurityAttributes = nil)
+			self.close if !@key.nil?
+			pKey         = "\0" * 4		# pointer to long
+			pDisposition = "\0" * 4		# pointer to long
+			ret = WCall('CreateKey',
+						p_key.to_i, p_strSubKey.to_ucs2(true), 0, p_strClass.to_ucs2(true),
+						p_nOptions, p_samDesired, 0, #p_SecurityAttributes.pack, let's ignore this...
+						pKey, pDisposition)
+			if 0 == ret or (ERROR_ACCESS_DENIED == ret and
+							REG_OPENED_EXISTING_KEY == pDisposition.unpack('L')[0])
+				@key = pKey.unpack("L")[0]
+			else
+				raise RegistryError.new(ret), "Cannot create: #{p_strSubKey}", caller
+			end
+		end
+
+		def connect(p_strHost, p_key)
+			self.close if !@key.nil?
+			pKey = "\0" * 4		# pointer to long
+			ret = WCall('ConnectRegistry', p_strHost.to_ucs2(true), p_key.to_i, pKey)
+			raise RegistryError.new(ret), "Cannot connect to #{p_strHost}", caller if 0 != ret
+			@key = pKey.unpack("L")[0]
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "replacing"
+		def replace(p_subKey, p_strNewFilename, p_strOldFilename)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			ret = WCall('ReplaceKey', @key, p_subKey,
+						p_strNewFilename.to_ucs2(true), p_strOldFilename.to_ucs2(true))
+			raise RegistryError.new(ret), "Cannot replace #{p_subKey}", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "closing"
+		def close(p_bFlush = false)
+			return 0 if @key.nil?
+			flush() if p_bFlush
+			ret = WCall('CloseKey', @key)
+			@key = nil
+			raise RegistryError.new(ret), "Cannot close key", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "flushing"
+		def flush
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			ret = WCall('FlushKey', @key)
+			raise RegistryError.new(ret), "Error while flushing", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# class methodsFor: "deleting"
+		def RegKey.Delete(p_key, p_subKey)
+			ret = APIMapper.WCall('DeleteKey', p_key.to_i, p_subKey)
+			raise RegistryError.new(ret), "Error while deleting #{p_subkey}", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# class methodsFor: "miscellaneous"
+		def RegKey.DisablePredefinedCache
+			ret = APIMapper.WCall('DisablePredefinedCache')
+			raise RegistryError.new(ret), "Error while disabling predefined cache", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "miscellaneous"
+		def overridePredefKey(p_key)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			ret = WCall('OverridePredefKey', p_key, @key)
+			raise RegistryError.new(ret), "Error while overriding predefined key", caller if 0 != ret
+		end
+
+		def deleteValue(p_strName)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			ret = WCall('DeleteValue', @key, p_strName.to_ucs2(true))
+			raise RegistryError.new(ret), "Error while deleting value #{p_strName}", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "loading/unloading"
+		def load(p_subKey, p_strFilename)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			ret = WCall('LoadKey', @key, p_subKey, p_strFilename.to_ucs2(true))
+			raise RegistryError.new(ret), "Error while loading #{p_strFilename} into #{p_subkey}", caller if 0 != ret
+		end
+
+		def unLoad(p_subKey)
+			return -1 if @key.nil?
+			ret = WCall('UnLoadKey', @key, p_subKey)
+			raise RegistryError.new(ret), "Error while unloading #{p_subkey}", caller if 0 != ret
+		end
+
+		def save(p_strFilename, p_security = 0)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			ret = WCall('SaveKey', @key, p_strFilename.to_ucs2(true), pSecurity)
+			raise RegistryError.new(ret), "Error while saving to #{p_strFilename}", caller if 0 != ret
+		end
+
+		def restore(p_strFilename, p_options)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			ret = WCall('RestoreKey', @key, p_strFilename.to_ucs2(true), p_options)
+			raise RegistryError.new(ret), "Error while restoring from #{p_strFilename}", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "enumerating"
+		def eachKey
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			return 0 if !block_given?
+			n = 0
+			while true
+				strKey       = "\0" * MAXCHARS		# UCS2 String Buffer
+				pszKey       = [MAXCHARS].pack('L')	# pointer to long
+				strClass     = "\0" * MAXCHARS		# UCS2 String Buffer
+				pszClass     = [MAXCHARS].pack("L")	# pointer to long
+				pftLastWrite = "\0" * 4				# pointer to long
+				ret = WCall('EnumKey', @key, n, strKey, pszKey, 0, strClass, pszClass, pftLastWrite)
+				case ret
+					when 0
+						szKey   = pszKey.unpack('L')[0] * 2		# UCS2 characters
+						szClass = pszClass.unpack('L')[0] * 2	# UCS2 characters
+						yield(	strKey[0, szKey].to_utf8,
+								strClass[0, szClass].to_utf8,
+								pftLastWrite.unpack('L')[0])
+						n += 1
+					when ERROR_NO_MORE_ITEMS then break
+					else
+						raise RegistryError.new(ret), "Cannot access key ##{n} in enumeration", caller
+				end
+			end
+			return n
+		end
+
+		def eachValue
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			return 0 if !block_given?
+			n = 0
+
+			while true
+				strName = "\0" * MAXCHARS			# UCS2 String Buffer
+				pszName = [MAXCHARS].pack('L')		# pointer to long
+				pnType  = " " * 4					# pointer to long
+				pszData = " " * 4					# pointer to long
+
+				# First call determines the size of data
+				ret = WCall('EnumValue', @key, n, strName, pszName, 0, pnType, 0, pszData)
+				case ret
+					when 0
+						szName = pszName.unpack('L')[0] * 2	# UCS2 characters
+						szData = pszData.unpack('L')[0]
+						nType  = pnType.unpack('L')[0]
+						pData  = nil
+						if szData > 0
+							pszName = [512].pack('L')	# pointer to long
+							pData   = "\0" * szData		# pointer to data
+							# Second call retrieves the data
+							ret = WCall('EnumValue', @key, n, strName, pszName, 0, 0, pData, pszData)
+							raise RegistryError.new(ret), "Cannot access value ##{n} in enumeration", caller if 0 != ret
+						end
+						yield(	strName[0, szName].to_utf8,
+								nType,
+								szData,
+								convertData(nType, pData, szData))
+						n += 1
+					when ERROR_NO_MORE_ITEMS then break
+					else
+						raise RegistryError.new(ret), "Cannot access value ##{n} in enumeration", caller
+				end
+			end
+			return n
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "querying"
+		def queryInfo
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			pszClass             = "\0" * 4		# pointer to long
+			pnSubKeys            = "\0" * 4		# pointer to long
+			pnMaxSubKeyLen       = "\0" * 4		# pointer to long
+			pnMaxClassLen        = "\0" * 4		# pointer to long
+			pnValues             = "\0" * 4		# pointer to long
+			pnMaxValueNameLen    = "\0" * 4		# pointer to long
+			pnMaxValueLen        = "\0" * 4		# pointer to long
+			pnSecurityDescriptor = "\0" * 4		# pointer to long
+			pftLastWriteTime     = "\0" * 4		# pointer to long
+			ret = WCall('QueryInfoKey',
+					@key,
+					0, pszClass,
+					0,
+					pnSubKeys, pnMaxSubKeyLen,
+					pnMaxClassLen,
+					pnValues, pnMaxValueNameLen, pnMaxValueLen,
+					pnSecurityDescriptor,
+					pftLastWriteTime)
+			raise RegistryError.new(ret), "Cannot query info", caller if 0 != ret
+
+			mRet = {}
+			szClass                    = pszClass.unpack('L')[0] * 2			# UCS2 characters
+			mRet['SubKeys']            = pnSubKeys.unpack('L')[0]
+			mRet['MaxSubKeyLen']       = pnMaxSubKeyLen.unpack('L')[0]
+			mRet['MaxClassLen']        = pnMaxClassLen.unpack('L')[0]
+			mRet['Values']             = pnValues.unpack('L')[0]
+			mRet['MaxValueNameLen']    = pnMaxValueNameLen.unpack('L')[0]
+			mRet['MaxValueLen']        = pnMaxValueLen.unpack('L')[0]
+			mRet['SecurityDescriptor'] = pnSecurityDescriptor.unpack('L')[0]
+			mRet['LastWriteTime']      = pftLastWriteTime.unpack('L')[0]
+
+			if szClass > 0
+				szClass += 2
+				strClass = " " * szClass
+				pszClass = [szClass].pack('L')
+				ret = WCall('QueryInfoKey', @key, strClass, pszClass, 0, 0, 0, 0, 0, 0, 0, 0, 0)
+				raise RegistryError.new(ret), "Cannot query info", caller if 0 != ret
+				mRet['Class'] = strClass.to_utf8
+				print "class: ", strClass.inspect, "->", strClass, "\n"
+			end
+			return mRet
+		end
+
+		def queryValue(p_strName)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			strName = p_strName.to_ucs2(true)
+			pnType  = " " * 4		# pointer to long
+			pszData = " " * 4		# pointer to long
+			ret = WCall('QueryValue', @key, strName, 0, pnType, 0, pszData)
+			raise RegistryError.new(ret), "Cannot query value #{p_strName}", caller if 0 != ret
+
+			mRet         = {}
+			mRet['Type'] = nType = pnType.unpack('L')[0]
+			szData       = pszData.unpack('L')[0]
+			if szData > 0
+				pData = "\0" * szData	# pointer to long
+				ret = WCall('QueryValue', @key, strName, 0, 0, pData, pszData)
+				raise RegistryError.new(ret), "Cannot query value #{p_strName}", caller if 0 != ret
+				mRet['Value'] = convertData(nType, pData, szData)
+			end
+			return mRet
+		end
+
+		def queryMultipleValues(p_vstrNames)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			pszData  = "\0" * 4		# pointer to long
+			pvValues = Array.new()
+			p_vstrNames.each {|str| pvValues << str.to_ucs2(true) }
+			ret = WCall('QueryMultipleValues', @key, pvValues, pvValues.size, 0, pszData)
+			raise RegistryError.new(ret), "Cannot query values #{p_vstrNames}", caller if 0 != ret and ERROR_MORE_DATA != ret
+
+			mRet = {}
+			szData = pszData.unpack('L')[0]
+			if szData > 0
+				pData = "\0" * szData	# pointer to long
+				ret = WCall('QueryMultipleValues', @key, pvValues, pvValues.size, pData, pszData)
+				raise RegistryError.new(ret), "Cannot query values #{p_vstrNames}", caller if 0 != ret
+				mRet['Value'] = convertData(nType, pData, szData)
+			end
+			return mRet
+		end
+
+		def setValue(p_strName, p_nType, p_pData)
+			raise Registry, "Key was not initialized properly", caller if @key.nil?
+			case p_nType
+				when REG_BINARY					then pData = [p_pData].pack('C*')
+				when REG_DWORD					then pData = [p_pData].pack('L')
+				when REG_DWORD_BIG_ENDIAN		then pData = [p_pData].pack('L')
+				when REG_DWORD_LITTLE_ENDIAN	then pData = [p_pData].pack('V')
+				when REG_EXPAND_SZ				then pData = p_pData.to_ucs2(true)
+				when REG_LINK					then pData = p_pData
+				when REG_NONE					then pData = p_pData
+				when REG_SZ						then pData = p_pData.to_ucs2(true)
+				when REG_MULTI_SZ
+					pData = []
+					p_pData.each {|str| pData << str.to_ucs2(true) }
+					pData << "\000\000"
+				else							return -2
+			end
+			strName = p_strName.to_ucs2(true)
+			ret = WCall('SetValue', @key, strName, 0, p_nType, pData, pData.size)
+			raise RegistryError.new(ret), "Cannot set value #{p_strName}", caller if 0 != ret
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "accessing"
+		def to_i
+			return @key
+		end
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "printing"
+		def to_s
+			return super + " Key: #{@key}"
+		end
+
+		#-----------------------------------------------------------------------------------------
+		private
+
+		#-----------------------------------------------------------------------------------------
+		# methodsFor: "data conversion"
+		def convertData(p_nType, p_pData, p_szData)
+			return nil if p_pData.nil?
+			case p_nType
+				when REG_BINARY					then return p_pData.unpack('C*')
+				when REG_DWORD					then return p_pData.unpack('L')[0]
+				when REG_DWORD_BIG_ENDIAN		then return p_pData.unpack('L')[0]
+				when REG_DWORD_LITTLE_ENDIAN	then return p_pData.unpack('V')[0]
+				when REG_EXPAND_SZ				then return p_pData[0, p_szData - 2].to_utf8
+				when REG_LINK					then return p_pData
+				when REG_NONE					then return p_pData
+				when REG_SZ						then return p_pData[0, p_szData - 2].to_utf8
+				when REG_MULTI_SZ				then return p_pData.to_utf8.unpack('Z*')
+				else							return nil
+			end
+		end
+	end
+end