mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
Feature/win stat extra info (#19148)
* Added more return results to win_stat * Changed Win2012 methods to support older versions in setup * staging of the tests to work with older servers
This commit is contained in:
Jordan Borean
Matt Davis
parent
a655e90e41
commit
971783a7fd
8 changed files with 925 additions and 108 deletions
|
|
@ -17,7 +17,51 @@
|
|||
# WANT_JSON
|
||||
# POWERSHELL_COMMON
|
||||
|
||||
$params = Parse-Args $args $true;
|
||||
$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;
|
||||
using System.Text;
|
||||
using Microsoft.Win32.SafeHandles;
|
||||
using System.ComponentModel;
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace Ansible.Command
|
||||
{
|
||||
public class SymLinkHelper
|
||||
{
|
||||
private const int FILE_SHARE_WRITE = 2;
|
||||
private const int CREATION_DISPOSITION_OPEN_EXISTING = 3;
|
||||
private const int FILE_FLAG_BACKUP_SEMANTICS = 0x02000000;
|
||||
|
||||
[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,
|
||||
int dwShareMode, IntPtr SecurityAttributes, int dwCreationDisposition, int dwFlagsAndAttributes, IntPtr hTemplateFile);
|
||||
|
||||
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());
|
||||
|
||||
StringBuilder path = new StringBuilder(512);
|
||||
int size = GetFinalPathNameByHandle(directoryHandle.DangerousGetHandle(), path, path.Capacity, 0);
|
||||
|
||||
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();
|
||||
}
|
||||
}
|
||||
}
|
||||
"@
|
||||
Add-Type -TypeDefinition $symlink_util
|
||||
|
||||
function Date_To_Timestamp($start_date, $end_date)
|
||||
{
|
||||
|
|
@ -27,15 +71,26 @@ function Date_To_Timestamp($start_date, $end_date)
|
|||
}
|
||||
}
|
||||
|
||||
$path = Get-Attr $params "path" $FALSE;
|
||||
If ($path -eq $FALSE)
|
||||
{
|
||||
Fail-Json (New-Object psobject) "missing required argument: path";
|
||||
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
|
||||
}
|
||||
Else
|
||||
{
|
||||
$net_algorithm = [Security.Cryptography.HashAlgorithm]::Create($algorithm)
|
||||
$raw_hash = [System.BitConverter]::ToString($net_algorithm.ComputeHash([System.IO.File]::ReadAllBytes($path)))
|
||||
$hash = $raw_hash -replace '-'
|
||||
}
|
||||
|
||||
$hash.ToLower()
|
||||
}
|
||||
|
||||
$get_md5 = Get-Attr $params "get_md5" $TRUE | ConvertTo-Bool;
|
||||
# until we support real aliasing, get the default value from get_md5
|
||||
$get_checksum = Get-Attr $params "get_checksum" $get_md5 | ConvertTo-Bool;
|
||||
$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'
|
||||
|
||||
$result = New-Object psobject @{
|
||||
stat = New-Object psobject
|
||||
|
|
@ -46,11 +101,20 @@ If (Test-Path $path)
|
|||
{
|
||||
Set-Attr $result.stat "exists" $TRUE;
|
||||
|
||||
$info = Get-Item $path;
|
||||
$iscontainer = Get-Attr $info "PSIsContainer" $null;
|
||||
$length = Get-Attr $info "Length" $null;
|
||||
$extension = Get-Attr $info "Extension" $null;
|
||||
$attributes = Get-Attr $info "Attributes" "";
|
||||
# Need to use -Force so it picks up hidden files
|
||||
$info = Get-Item -Force $path;
|
||||
$iscontainer = $info.PSIsContainer;
|
||||
$filename = $info.Name;
|
||||
$filepath = $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';
|
||||
|
||||
If ($info)
|
||||
{
|
||||
$accesscontrol = $info.GetAccessControl();
|
||||
|
|
@ -59,26 +123,72 @@ If (Test-Path $path)
|
|||
{
|
||||
$accesscontrol = $null;
|
||||
}
|
||||
$owner = Get-Attr $accesscontrol "Owner" $null;
|
||||
$creationtime = Get-Attr $info "CreationTime" $null;
|
||||
$lastaccesstime = Get-Attr $info "LastAccessTime" $null;
|
||||
$lastwritetime = Get-Attr $info "LastWriteTime" $null;
|
||||
|
||||
$owner = $accessControl.Owner;
|
||||
$creationtime = $info.CreationTime;
|
||||
$lastaccesstime = $info.LastAccessTime;
|
||||
$lastwritetime = $info.LastAccessTime;
|
||||
|
||||
$epoch_date = Get-Date -Date "01/01/1970"
|
||||
If ($iscontainer)
|
||||
$islink = $false
|
||||
$isdir = $false
|
||||
$isshared = $false
|
||||
|
||||
If ($attributes -contains 'ReparsePoint')
|
||||
{
|
||||
Set-Attr $result.stat "isdir" $TRUE;
|
||||
# TODO: Find a way to differenciate between soft and junction links
|
||||
$islink = $true
|
||||
$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 {}
|
||||
}
|
||||
ElseIf ($iscontainer)
|
||||
{
|
||||
$isdir = $true
|
||||
|
||||
$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;
|
||||
}
|
||||
|
||||
$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;
|
||||
}
|
||||
Else{
|
||||
Set-Attr $result.stat "size" $dir_files_sum.Sum;
|
||||
}
|
||||
}
|
||||
Else
|
||||
{
|
||||
Set-Attr $result.stat "isdir" $FALSE;
|
||||
Set-Attr $result.stat "size" $length;
|
||||
Set-Attr $result.stat "size" $info.Length;
|
||||
Set-Attr $result.stat "extension" $info.extension;
|
||||
|
||||
If ($get_md5) {
|
||||
$md5 = Get-Hash -path $path -algorithm 'md5'
|
||||
Set-Attr $result.stat "md5" $md5
|
||||
}
|
||||
|
||||
If ($get_checksum) {
|
||||
$checksum = Get-Hash -path $path -algorithm $checksum_algorithm
|
||||
Set-Attr $result.stat "checksum" $checksum
|
||||
}
|
||||
}
|
||||
Set-Attr $result.stat "extension" $extension;
|
||||
Set-Attr $result.stat "attributes" $attributes.ToString();
|
||||
# Set-Attr $result.stat "owner" $getaccesscontrol.Owner;
|
||||
# Set-Attr $result.stat "owner" $info.GetAccessControl().Owner;
|
||||
|
||||
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);
|
||||
|
|
@ -89,12 +199,4 @@ Else
|
|||
Set-Attr $result.stat "exists" $FALSE;
|
||||
}
|
||||
|
||||
# only check get_checksum- it either got its value from get_md5 or was set directly.
|
||||
If (($get_checksum) -and $result.stat.exists -and -not $result.stat.isdir)
|
||||
{
|
||||
$hash = Get-FileChecksum($path);
|
||||
Set-Attr $result.stat "md5" $hash;
|
||||
Set-Attr $result.stat "checksum" $hash;
|
||||
}
|
||||
|
||||
Exit-Json $result;
|
||||
|
|
|
|||
|
|
@ -29,27 +29,33 @@ short_description: returns information about a Windows file
|
|||
description:
|
||||
- Returns information about a Windows file
|
||||
options:
|
||||
path:
|
||||
description:
|
||||
- The full path of the file/object to get the facts of; both forward and
|
||||
back slashes are accepted.
|
||||
required: true
|
||||
default: null
|
||||
aliases: []
|
||||
get_md5:
|
||||
description:
|
||||
- Whether to return the checksum sum of the file. As of Ansible 1.9 this
|
||||
is no longer a MD5, but a SHA1 instead.
|
||||
required: false
|
||||
default: yes
|
||||
aliases: []
|
||||
get_checksum:
|
||||
description:
|
||||
- Whether to return a checksum of the file
|
||||
(only sha1 currently supported)
|
||||
required: false
|
||||
default: yes
|
||||
version_added: "2.1"
|
||||
path:
|
||||
description:
|
||||
- The full path of the file/object to get the facts of; both forward and
|
||||
back slashes are accepted.
|
||||
required: yes
|
||||
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
|
||||
2.3 this is back to an MD5. Will return None if host is unable to
|
||||
use specified algorithm
|
||||
required: no
|
||||
default: True
|
||||
get_checksum:
|
||||
description:
|
||||
- Whether to return a checksum of the file (default sha1)
|
||||
required: no
|
||||
default: True
|
||||
version_added: "2.1"
|
||||
checksum_algorithm:
|
||||
description:
|
||||
- Algorithm to determine checksum of file. Will throw an error if
|
||||
the host is unable to use specified algorithm.
|
||||
required: no
|
||||
default: sha1
|
||||
choices: ['sha1', 'sha256', 'sha384', 'sha512']
|
||||
version_added: "2.3"
|
||||
author: "Chris Church (@cchurch)"
|
||||
'''
|
||||
|
||||
|
|
@ -59,7 +65,140 @@ EXAMPLES = r'''
|
|||
path: C:\foo.ini
|
||||
register: file_info
|
||||
|
||||
# Obtain information about a folder
|
||||
- win_stat:
|
||||
path: C:\\bar
|
||||
register: folder_info
|
||||
|
||||
# Get MD5 checksum of a file
|
||||
- win_stat:
|
||||
path: C:\\foo.ini
|
||||
get_md5: True
|
||||
register: md5_checksum
|
||||
|
||||
- debug:
|
||||
var: file_info
|
||||
var: md5_checksum.stat.md5
|
||||
|
||||
# Get SHA1 checksum of file
|
||||
- win_stat:
|
||||
path: C:\\foo.ini
|
||||
get_checksum: True
|
||||
register: sha1_checksum
|
||||
|
||||
- debug:
|
||||
var: sha1_checksum.stat.checksum
|
||||
|
||||
# Get SHA256 checksum of file
|
||||
- win_stat:
|
||||
path: C:\\foo.ini
|
||||
get_checksum: True
|
||||
checksum_algorithm: sha256
|
||||
register: sha256_checksum
|
||||
|
||||
- debug:
|
||||
var: sha256_checksum.stat.checksum
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
changed:
|
||||
description: Whether anything was changed
|
||||
returned: always
|
||||
type: boolean
|
||||
sample: True
|
||||
stat:
|
||||
description: dictionary containing all the stat data
|
||||
returned: success
|
||||
type: dictionary
|
||||
contains:
|
||||
attributes:
|
||||
description: attributes of the file at path in raw form
|
||||
returned: success, path exists
|
||||
type: string
|
||||
sample: "Archive, Hidden"
|
||||
checksum:
|
||||
description: The checksum of a file based on checksum_algorithm specified
|
||||
returned: success, path exist, path is a file, get_checksum == True
|
||||
checksum_algorithm specified is supported
|
||||
type: string
|
||||
sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98
|
||||
creationtime:
|
||||
description: the create time of the file represented in seconds since epoch
|
||||
returned: success, path exists
|
||||
type: float
|
||||
sample: 1477984205.15
|
||||
extension:
|
||||
description: the extension of the file at path
|
||||
returned: success, path exists, path is a file
|
||||
type: string
|
||||
sample: ".ps1"
|
||||
isarchive:
|
||||
description: if the path is ready for archiving or not
|
||||
returned: success, path exists
|
||||
type: boolean
|
||||
sample: True
|
||||
isdir:
|
||||
description: if the path is a directory or not
|
||||
returned: success, path exists
|
||||
type: boolean
|
||||
sample: True
|
||||
ishidden:
|
||||
description: if the path is hidden or not
|
||||
returned: success, path exists
|
||||
type: boolean
|
||||
sample: True
|
||||
islink:
|
||||
description: if the path is a symbolic link or junction or not
|
||||
returned: success, path exists
|
||||
type: boolean
|
||||
sample: True
|
||||
isreadonly:
|
||||
description: if the path is read only or not
|
||||
returned: success, path exists
|
||||
type: boolean
|
||||
sample: True
|
||||
isshared:
|
||||
description: if the path is shared or not
|
||||
returned: success, path exists
|
||||
type: boolean
|
||||
sample: True
|
||||
lastaccesstime:
|
||||
description: the last access time of the file represented in seconds since epoch
|
||||
returned: success, path exists
|
||||
type: float
|
||||
sample: 1477984205.15
|
||||
lastwritetime:
|
||||
description: the last modification time of the file represented in seconds since epoch
|
||||
returned: success, path exists
|
||||
type: float
|
||||
sample: 1477984205.15
|
||||
lnk_source:
|
||||
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
|
||||
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
|
||||
type: string
|
||||
sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98
|
||||
owner:
|
||||
description: the owner of the file
|
||||
returned: success, path exists
|
||||
type: string
|
||||
sample: BUILTIN\\Administrators
|
||||
path:
|
||||
description: the full absolute path to the file
|
||||
returned: success, path exists
|
||||
type: string
|
||||
sample: BUILTIN\\Administrators
|
||||
sharename:
|
||||
description: the name of share if folder is shared
|
||||
returned: success, path exists, file is a directory and isshared == True
|
||||
type: string
|
||||
sample: file-share
|
||||
size:
|
||||
description: the size in bytes of a file or folder
|
||||
returned: success, path exists, file is not a link
|
||||
type: int
|
||||
sample: 1024
|
||||
'''
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue