mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
win_stat: Module cleanup (#20672)
* win_stat: Clean up and bugfixes - Fix an issue where LastWriteTime was actually LastAccessTime - Return lnk_source = $null for a broken link - Remove a useless -Replace '\\','\\' - Make use of new parameter options (-type and -aliases) * Deprecate get_md5 with checksum_algorithm: md5 As suggested in comments we deprecate get_md5 and internally replace it with `get_checksum` and `checksum_algorithm: md5`. We show a warning to the user about this change. Also remove empty warnings output. This simplifies modules code (e.g. standard empty list is provided and snippets can add items). * Adapted to use the new Add-DeprecationWarning() mechanism * Revert to original formatting
This commit is contained in:
Dag Wieers
Matt Davis
parent
f47901c3ad
commit
01afed4dc5
2 changed files with 83 additions and 85 deletions
|
|
@ -17,8 +17,6 @@
|
|||
# WANT_JSON
|
||||
# POWERSHELL_COMMON
|
||||
|
||||
$params = Parse-Args -arguments $args -supports_check_mode $true;
|
||||
|
||||
# C# code to determine link target, copied from http://chrisbensen.blogspot.com.au/2010/06/getfinalpathnamebyhandle.html
|
||||
$symlink_util = @"
|
||||
using System;
|
||||
|
|
@ -38,12 +36,12 @@ namespace Ansible.Command
|
|||
[DllImport("kernel32.dll", EntryPoint = "GetFinalPathNameByHandleW", CharSet = CharSet.Unicode, SetLastError = true)]
|
||||
public static extern int GetFinalPathNameByHandle(IntPtr handle, [In, Out] StringBuilder path, int bufLen, int flags);
|
||||
|
||||
[DllImport("kernel32.dll", EntryPoint = "CreateFileW", CharSet = CharSet.Unicode, SetLastError = true)]
|
||||
public static extern SafeFileHandle CreateFile(string lpFileName, int dwDesiredAccess,
|
||||
[DllImport("kernel32.dll", EntryPoint = "CreateFileW", CharSet = CharSet.Unicode, SetLastError = true)]
|
||||
public static extern SafeFileHandle CreateFile(string lpFileName, int dwDesiredAccess,
|
||||
int dwShareMode, IntPtr SecurityAttributes, int dwCreationDisposition, int dwFlagsAndAttributes, IntPtr hTemplateFile);
|
||||
|
||||
public static string GetSymbolicLinkTarget(System.IO.DirectoryInfo symlink)
|
||||
{
|
||||
public static string GetSymbolicLinkTarget(System.IO.DirectoryInfo symlink)
|
||||
{
|
||||
SafeFileHandle directoryHandle = CreateFile(symlink.FullName, 0, 2, System.IntPtr.Zero, CREATION_DISPOSITION_OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, System.IntPtr.Zero);
|
||||
if(directoryHandle.IsInvalid)
|
||||
throw new Win32Exception(Marshal.GetLastWin32Error());
|
||||
|
|
@ -54,9 +52,9 @@ namespace Ansible.Command
|
|||
if (size<0)
|
||||
throw new Win32Exception(Marshal.GetLastWin32Error()); // The remarks section of GetFinalPathNameByHandle mentions the return being prefixed with "\\?\" // More information about "\\?\" here -> http://msdn.microsoft.com/en-us/library/aa365247(v=VS.85).aspx
|
||||
if (path[0] == '\\' && path[1] == '\\' && path[2] == '?' && path[3] == '\\')
|
||||
return path.ToString().Substring(4);
|
||||
else
|
||||
return path.ToString();
|
||||
return path.ToString().Substring(4);
|
||||
else
|
||||
return path.ToString();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -67,7 +65,7 @@ function Date_To_Timestamp($start_date, $end_date)
|
|||
{
|
||||
If($start_date -and $end_date)
|
||||
{
|
||||
Write-Output (New-TimeSpan -Start $start_date -End $end_date).TotalSeconds
|
||||
return (New-TimeSpan -Start $start_date -End $end_date).TotalSeconds
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -75,7 +73,7 @@ function Get-Hash($path, $algorithm) {
|
|||
# Using PowerShell V4 and above we can use some powershell cmdlets instead of .net
|
||||
If ($PSVersionTable.PSVersion.Major -ge 4)
|
||||
{
|
||||
$hash = (Get-FileHash $path -Algorithm $algorithm).Hash
|
||||
$hash = (Get-FileHash -Path $path -Algorithm $algorithm).Hash
|
||||
}
|
||||
Else
|
||||
{
|
||||
|
|
@ -87,33 +85,51 @@ function Get-Hash($path, $algorithm) {
|
|||
$hash.ToLower()
|
||||
}
|
||||
|
||||
$path = Get-AnsibleParam -obj $params -name 'path' -failifempty $true;
|
||||
$get_md5 = Get-AnsibleParam -obj $params -name 'get_md5' -failifempty $false -default $true | ConvertTo-Bool;
|
||||
$get_checksum = Get-AnsibleParam -obj $params -name 'get_checksum' -failifempty $false -default $true | ConvertTo-Bool;
|
||||
$checksum_algorithm = Get-AnsibleParam -obj $params -name 'checksum_algorithm' -failifempty $false -default 'sha1' -ValidateSet 'sha1','sha256','sha384','sha512'
|
||||
$params = Parse-Args $args -supports_check_mode $true
|
||||
|
||||
$result = New-Object psobject @{
|
||||
stat = New-Object psobject
|
||||
$path = Get-AnsibleParam -obj $params -name "path" -type "path" -failifempty $true -aliases "dest","name"
|
||||
$get_md5 = Get-AnsibleParam -obj $params -name "get_md5" -type "bool" -default $true
|
||||
$get_checksum = Get-AnsibleParam -obj $params -name "get_checksum" -type "bool" -default $true
|
||||
$checksum_algorithm = Get-AnsibleParam -obj $params -name "checksum_algorithm" -type "str" -default "sha1" -validateset "md5","sha1","sha256","sha384","sha512"
|
||||
|
||||
$result = @{
|
||||
changed = $false
|
||||
stat = @{}
|
||||
};
|
||||
|
||||
If (Test-Path $path)
|
||||
# Backward compatibility
|
||||
if ($get_md5 -eq $true -and (Get-Member -inputobject $params -name "get_md5") ) {
|
||||
Add-DeprecationWarning $result "The parameter 'get_md5' is being replaced with 'checksum_algorithm: md5'"
|
||||
}
|
||||
|
||||
If (Test-Path -Path $path)
|
||||
{
|
||||
Set-Attr $result.stat "exists" $TRUE;
|
||||
$result.stat.exists = $true
|
||||
|
||||
# Initial values
|
||||
$result.stat.isdir = $false
|
||||
$result.stat.islink = $false
|
||||
$result.stat.isshared = $false
|
||||
|
||||
# Need to use -Force so it picks up hidden files
|
||||
$info = Get-Item -Force $path;
|
||||
$iscontainer = $info.PSIsContainer;
|
||||
$filename = $info.Name;
|
||||
$filepath = $info.FullName;
|
||||
$info = Get-Item -Force $path
|
||||
|
||||
$epoch_date = Get-Date -Date "01/01/1970"
|
||||
$result.stat.creationtime = (Date_To_Timestamp $epoch_date $info.CreationTime)
|
||||
$result.stat.lastaccesstime = (Date_To_Timestamp $epoch_date $info.LastAccessTime)
|
||||
$result.stat.lastwritetime = (Date_To_Timestamp $epoch_date $info.LastWriteTime)
|
||||
|
||||
$result.stat.filename = $info.Name
|
||||
$result.stat.path = $info.FullName
|
||||
|
||||
$attributes = @()
|
||||
foreach ($attribute in ($info.Attributes -split ',')) {
|
||||
$attributes += $attribute.Trim();
|
||||
}
|
||||
$attributes_string = $info.Attributes.ToString();
|
||||
$isreadonly = $attributes -contains 'ReadOnly';
|
||||
$ishidden = $attributes -contains 'Hidden';
|
||||
$isarchive = $attributes -contains 'Archive';
|
||||
$result.stat.attributes = $info.Attributes.ToString()
|
||||
$result.stat.isarchive = $attributes -contains "Archive"
|
||||
$result.stat.ishidden = $attributes -contains "Hidden"
|
||||
$result.stat.isreadonly = $attributes -contains "ReadOnly"
|
||||
|
||||
If ($info)
|
||||
{
|
||||
|
|
@ -123,80 +139,58 @@ If (Test-Path $path)
|
|||
{
|
||||
$accesscontrol = $null;
|
||||
}
|
||||
$owner = $accessControl.Owner;
|
||||
$creationtime = $info.CreationTime;
|
||||
$lastaccesstime = $info.LastAccessTime;
|
||||
$lastwritetime = $info.LastAccessTime;
|
||||
|
||||
$epoch_date = Get-Date -Date "01/01/1970"
|
||||
$islink = $false
|
||||
$isdir = $false
|
||||
$isshared = $false
|
||||
$result.stat.owner = $accesscontrol.Owner
|
||||
|
||||
$iscontainer = $info.PSIsContainer
|
||||
If ($attributes -contains 'ReparsePoint')
|
||||
{
|
||||
# TODO: Find a way to differenciate between soft and junction links
|
||||
$islink = $true
|
||||
$isdir = $true
|
||||
$result.stat.islink = $true
|
||||
$result.stat.isdir = $true
|
||||
# Try and get the symlink source, can result in failure if link is broken
|
||||
try {
|
||||
$lnk_source = [Ansible.Command.SymLinkHelper]::GetSymbolicLinkTarget($path)
|
||||
Set-Attr $result.stat "lnk_source" $lnk_source
|
||||
} catch {}
|
||||
}
|
||||
$result.stat.lnk_source = [Ansible.Command.SymLinkHelper]::GetSymbolicLinkTarget($path)
|
||||
} catch {
|
||||
$result.stat.lnk_source = $null
|
||||
}
|
||||
}
|
||||
ElseIf ($iscontainer)
|
||||
{
|
||||
$isdir = $true
|
||||
$result.stat.isdir = $true
|
||||
|
||||
$share_info = Get-WmiObject -Class Win32_Share -Filter "Path='$($info.Fullname -replace '\\', '\\')'";
|
||||
If ($share_info -ne $null)
|
||||
$share_info = Get-WmiObject -Class Win32_Share -Filter "Path='$($info.Fullname -replace '\\', '\\')'"
|
||||
If ($share_info -ne $null)
|
||||
{
|
||||
$isshared = $true
|
||||
Set-Attr $result.stat "sharename" $share_info.Name;
|
||||
$result.stat.isshared = $true
|
||||
$result.stat.sharename = $share_info.Name
|
||||
}
|
||||
|
||||
$dir_files_sum = Get-ChildItem $info.FullName -Recurse | Measure-Object -property length -sum;
|
||||
If ($dir_files_sum -eq $null)
|
||||
{
|
||||
Set-Attr $result.stat "size" 0;
|
||||
$result.stat.size = 0
|
||||
}
|
||||
Else{
|
||||
Set-Attr $result.stat "size" $dir_files_sum.Sum;
|
||||
$result.stat.size = $dir_files_sum.Sum
|
||||
}
|
||||
}
|
||||
Else
|
||||
{
|
||||
Set-Attr $result.stat "size" $info.Length;
|
||||
Set-Attr $result.stat "extension" $info.extension;
|
||||
$result.stat.size = $info.Length
|
||||
$result.stat.extension = $info.Extension
|
||||
|
||||
If ($get_md5) {
|
||||
$md5 = Get-Hash -path $path -algorithm 'md5'
|
||||
Set-Attr $result.stat "md5" $md5
|
||||
$result.stat.md5 = Get-Hash -Path $path -Algorithm "md5"
|
||||
}
|
||||
|
||||
If ($get_checksum) {
|
||||
$checksum = Get-Hash -path $path -algorithm $checksum_algorithm
|
||||
Set-Attr $result.stat "checksum" $checksum
|
||||
$result.stat.checksum = Get-Hash -Path $path -Algorithm $checksum_algorithm
|
||||
}
|
||||
}
|
||||
|
||||
Set-Attr $result.stat "islink" $islink;
|
||||
Set-Attr $result.stat "isdir" $isdir;
|
||||
Set-Attr $result.stat "isshared" $isshared;
|
||||
Set-Attr $result.stat "isreadonly" $isreadonly;
|
||||
Set-Attr $result.stat "ishidden" $ishidden;
|
||||
Set-Attr $result.stat "isarchive" $isarchive;
|
||||
Set-Attr $result.stat "filename" $filename;
|
||||
Set-Attr $result.stat "path" $filepath;
|
||||
Set-Attr $result.stat "attributes" $attributes_string;
|
||||
Set-Attr $result.stat "owner" $owner;
|
||||
Set-Attr $result.stat "creationtime" (Date_To_Timestamp $epoch_date $creationtime);
|
||||
Set-Attr $result.stat "lastaccesstime" (Date_To_Timestamp $epoch_date $lastaccesstime);
|
||||
Set-Attr $result.stat "lastwritetime" (Date_To_Timestamp $epoch_date $lastwritetime);
|
||||
}
|
||||
Else
|
||||
{
|
||||
Set-Attr $result.stat "exists" $FALSE;
|
||||
$result.stat.exists = $false
|
||||
}
|
||||
|
||||
Exit-Json $result;
|
||||
|
|
|
|||
|
|
@ -37,11 +37,14 @@ options:
|
|||
get_md5:
|
||||
description:
|
||||
- Whether to return the checksum sum of the file. Between Ansible 1.9
|
||||
and 2.2 this is no longer an MD5, but a SHA1 isntead. As of Ansible
|
||||
and 2.2 this is no longer an MD5, but a SHA1 instead. As of Ansible
|
||||
2.3 this is back to an MD5. Will return None if host is unable to
|
||||
use specified algorithm
|
||||
use specified algorithm.
|
||||
- This option is deprecated in Ansible 2.3 and is replaced with
|
||||
C(checksum_algorithm=md5).
|
||||
required: no
|
||||
default: True
|
||||
version_removed: "2.3"
|
||||
get_checksum:
|
||||
description:
|
||||
- Whether to return a checksum of the file (default sha1)
|
||||
|
|
@ -54,7 +57,7 @@ options:
|
|||
the host is unable to use specified algorithm.
|
||||
required: no
|
||||
default: sha1
|
||||
choices: ['sha1', 'sha256', 'sha384', 'sha512']
|
||||
choices: ['md5', 'sha1', 'sha256', 'sha384', 'sha512']
|
||||
version_added: "2.3"
|
||||
author: "Chris Church (@cchurch)"
|
||||
'''
|
||||
|
|
@ -67,22 +70,23 @@ EXAMPLES = r'''
|
|||
|
||||
# Obtain information about a folder
|
||||
- win_stat:
|
||||
path: C:\\bar
|
||||
path: C:\bar
|
||||
register: folder_info
|
||||
|
||||
# Get MD5 checksum of a file
|
||||
- win_stat:
|
||||
path: C:\\foo.ini
|
||||
get_md5: True
|
||||
path: C:\foo.ini
|
||||
get_checksum: yes
|
||||
checksum_algorithm: md5
|
||||
register: md5_checksum
|
||||
|
||||
- debug:
|
||||
var: md5_checksum.stat.md5
|
||||
var: md5_checksum.stat.checksum
|
||||
|
||||
# Get SHA1 checksum of file
|
||||
- win_stat:
|
||||
path: C:\\foo.ini
|
||||
get_checksum: True
|
||||
path: C:\foo.ini
|
||||
get_checksum: yes
|
||||
register: sha1_checksum
|
||||
|
||||
- debug:
|
||||
|
|
@ -90,8 +94,8 @@ EXAMPLES = r'''
|
|||
|
||||
# Get SHA256 checksum of file
|
||||
- win_stat:
|
||||
path: C:\\foo.ini
|
||||
get_checksum: True
|
||||
path: C:\foo.ini
|
||||
get_checksum: yes
|
||||
checksum_algorithm: sha256
|
||||
register: sha256_checksum
|
||||
|
||||
|
|
@ -99,7 +103,7 @@ EXAMPLES = r'''
|
|||
var: sha256_checksum.stat.checksum
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r'''
|
||||
changed:
|
||||
description: Whether anything was changed
|
||||
returned: always
|
||||
|
|
@ -175,7 +179,7 @@ stat:
|
|||
description: the target of the symbolic link, will return null if not a link or the link is broken
|
||||
return: success, path exists, file is a symbolic link
|
||||
type: string
|
||||
sample: C:\\temp
|
||||
sample: C:\temp
|
||||
md5:
|
||||
description: The MD5 checksum of a file (Between Ansible 1.9 and 2.2 this was returned as a SHA1 hash)
|
||||
returned: success, path exist, path is a file, get_md5 == True, md5 is supported
|
||||
|
|
@ -185,12 +189,12 @@ stat:
|
|||
description: the owner of the file
|
||||
returned: success, path exists
|
||||
type: string
|
||||
sample: BUILTIN\\Administrators
|
||||
sample: BUILTIN\Administrators
|
||||
path:
|
||||
description: the full absolute path to the file
|
||||
returned: success, path exists
|
||||
type: string
|
||||
sample: BUILTIN\\Administrators
|
||||
sample: BUILTIN\Administrators
|
||||
sharename:
|
||||
description: the name of share if folder is shared
|
||||
returned: success, path exists, file is a directory and isshared == True
|
||||
|
|
|
|||
Loading…
Reference in a new issue