internal/functions/Invoke-Robocopy.ps1
|
<#
.Synopsis Wrapper function for robocopy.exe From https://raw.githubusercontent.com/RamblingCookieMonster/PSDeploy/master/PSDeploy/Private/Invoke-Robocopy.ps1 .Parameter Path String. Source path. You can use relative path. .Parameter Destination Array of destination paths. You can use relative paths. .Parameter ArgumentList Array of additional arguments for robocopy.exe .Parameter Retry Integer. Number of retires. Default is 2. .Parameter EnableExit Switch. Exit function if Robocopy throws "terminating" error code. .Parameter PassThru Switch. Returns an object with the following properties: StdOut - array of strings captured from StandardOutput StdErr - array of strings captured from StandardError ExitCode - Enum with Robocopy exit code in human-readable format By default, this function doesn't generate any output. .Link https://technet.microsoft.com/en-us/library/cc733145.aspx .Link http://ss64.com/nt/robocopy.html .Link http://ss64.com/nt/robocopy-exit.html .Example 'c:\bravo', 'c:\charlie' | Invoke-Robocopy -Path 'c:\alpha' -ArgumentList @('/xo', '/e' ) Copy 'c:\alpha' to 'c:\bravo' and 'c:\charlie'. Copy subdirectories, include empty directories, exclude older files. #> function Invoke-Robocopy { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] Param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [PsfValidateScript({ Test-Path -Path $args[0] }, ErrorMessage = 'Path must already exist: {0}')] [string]$Path, [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [string[]]$Destination, [Parameter(ValueFromPipelineByPropertyName = $true)] [string[]]$ArgumentList, [Parameter(ValueFromPipelineByPropertyName = $true)] [int]$Retry = 2, [Parameter(ValueFromPipelineByPropertyName = $true)] [switch]$EnableExit, [Parameter(ValueFromPipelineByPropertyName = $true)] [switch]$PassThru ) Begin { function Start-ConsoleProcess { Param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string]$FilePath, [string[]]$ArgumentList, [Parameter(ValueFromPipeline = $true)] [string[]]$InputObject ) End { if ($Input) { # Collect all pipeline input # http://www.powertheshell.com/input_psv3/ $StdIn = @($Input) } else { $StdIn = $InputObject } try { "Starting process: $FilePath", "Redirect StdIn: $([bool]$StdIn.Count)", "Arguments: $ArgumentList" | Write-Verbose if ($StdIn.Count) { $Output = $StdIn | & $FilePath $ArgumentList 2>&1 } else { $Output = & $FilePath $ArgumentList 2>&1 } } catch { throw $_ } Write-PSFMessage -Level Verbose -Message 'Finished, processing output' $StdOut = New-Object -TypeName System.Collections.Generic.List``1[String] $StdErr = New-Object -TypeName System.Collections.Generic.List``1[String] foreach ($item in $Output) { # Data from StdOut will be strings, while StdErr produces # System.Management.Automation.ErrorRecord objects. # http://stackoverflow.com/a/33002914/4424236 if ($item.Exception.Message) { $StdErr.Add($item.Exception.Message) } else { $StdOut.Add($item) } } Write-Verbose 'Returning result' [pscustomobject]@{ ExitCode = $LASTEXITCODE StdOut = $StdOut.ToArray() StdErr = $StdErr.ToArray() } | Select-Object -Property StdOut, StdErr, ExitCode } } # https://learn-powershell.net/2016/03/07/building-a-enum-that-supports-bit-fields-in-powershell/ function New-RobocopyHelper { $TypeName = 'Robocopy.ExitCode' # http://stackoverflow.com/questions/16552801/how-do-i-conditionally-add-a-class-with-add-type-typedefinition-if-it-isnt-add if (! ([System.Management.Automation.PSTypeName]$TypeName).Type) { try { #region Module Builder $Domain = [System.AppDomain]::CurrentDomain $DynAssembly = New-Object -TypeName System.Reflection.AssemblyName($TypeName) $AssemblyBuilder = $Domain.DefineDynamicAssembly($DynAssembly, [System.Reflection.Emit.AssemblyBuilderAccess]::Run) # Only run in memory $ModuleBuilder = $AssemblyBuilder.DefineDynamicModule($TypeName, $false) #endregion Module Builder # https://pshirwin.wordpress.com/2016/03/18/robocopy-exitcodes-the-powershell-way/ #region Enum $EnumBuilder = $ModuleBuilder.DefineEnum($TypeName, 'Public', [int32]) [void]$EnumBuilder.DefineLiteral('NoChange', [int32]0x00000000) [void]$EnumBuilder.DefineLiteral('OKCopy', [int32]0x00000001) [void]$EnumBuilder.DefineLiteral('ExtraFiles', [int32]0x00000002) [void]$EnumBuilder.DefineLiteral('MismatchedFilesFolders', [int32]0x00000004) [void]$EnumBuilder.DefineLiteral('FailedCopyAttempts', [int32]0x00000008) [void]$EnumBuilder.DefineLiteral('FatalError', [int32]0x000000010) $EnumBuilder.SetCustomAttribute( [FlagsAttribute].GetConstructor([Type]::EmptyTypes), @() ) [void]$EnumBuilder.CreateType() #endregion Enum } catch { throw $_ } } } New-RobocopyHelper } Process { foreach ($item in $Destination) { # Resolve destination paths, remove trailing backslash, add Retries and combine all arguments into one array $AllArguments = @( (Resolve-Path -Path $Path).ProviderPath -replace '\\+$' ) + ( $item | ForEach-Object { $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($_) -replace '\\+$' } ) + $ArgumentList + "/R:$Retry" # Invoke Robocopy $Result = Start-ConsoleProcess -FilePath 'robocopy.exe' -ArgumentList $AllArguments $Result.ExitCode = [Robocopy.ExitCode]$Result.ExitCode # Dump Robocopy log to Verbose stream $Result.StdOut | Write-Verbose # Process Robocopy exit code # http://latkin.org/blog/2012/07/08/using-enums-in-powershell/ if ($Result.ExitCode -band [Robocopy.ExitCode]'FailedCopyAttempts, FatalError') { if ($EnableExit) { $host.SetShouldExit(1) } else { $ErrorMessage = @($Result.ExitCode) + ( # Try to provide additional info about error. # WARNING: This WILL fail in localized Windows. E.g., "??????" in Russian. $Result.StdOut | Select-String -Pattern '\s*ERROR\s+:\s+(.+)' | ForEach-Object { $_.Matches.Groups[1].Value } ) $ErrorMessage -join [System.Environment]::NewLine | Write-Error } } else { # Passthru Robocopy result if ($PassThru) { $Result } } } } } |