Private/Get-FileFromInternet.ps1
|
<# .Synopsis Created on: 28/10/2023 Created by: Ben Whitmore Filename: Get-FileFromInternet.ps1 .Description Function to download a file from the internet .PARAMETER LogID The component (script name) passed as LogID to the 'Write-Log' function. This parameter is built from the line number of the call from the function up the pipeline .PARAMETER URI The URI of the file to download .PARAMETER Destination The destination folder to download the file to #> function Get-FileFromInternet { param ( [Parameter(Mandatory = $false, ValuefromPipeline = $false, HelpMessage = "The component (script name) passed as LogID to the 'Write-Log' function")] [string]$LogId = $($MyInvocation.MyCommand).Name, [Parameter(Mandatory = $true, ValueFromPipeline = $false, Position = 0, HelpMessage = 'The URI of the file to download')] [String]$Uri, [Parameter(Mandatory = $true, ValueFromPipeline = $false, Position = 1, HelpMessage = 'The destination folder to download the file to')] [String]$Destination ) begin { Write-Log -Message 'Function: Get-FileFromInternet was called' -LogId $LogId Write-Log -Message ("Attempting to download the file from '{0}'" -f $Uri) -LogId $LogId Write-Host ("Attempting to download the file from '{0}'" -f $Uri) -ForegroundColor Cyan $file = $Uri -replace '.*/' $fileDestination = Join-Path -Path $destination -ChildPath $file } process { # Test the Uri is valid try { $uriRequest = Invoke-WebRequest -Method Get -UseBasicParsing -URI $Uri -ErrorAction SilentlyContinue $statusCode = $uriRequest.StatusCode } catch { $statusCode = $_.Exception.Response.StatusCode.Value__ Write-Log -Message ("It looks like the Uri '{0}' is invalid. Error '{1}" -f $Uri, $statusCode) -LogId $LogId -Severity 3 Write-Warning -Message ("It looks like the Uri '{0}' is invalid. Error '{1}'" -f $Uri, $statusCode) Get-ScriptEnd -LogId $LogId -Message $_.Exception.Message } # If the URL is valid, attempt to download the file otherwise break and warn if ($statusCode -eq 200) { try { Write-Log -Message ("Response '{0}' received'. Attempting download...'" -f $statusCode) -LogId $LogId Write-Host ("Response '{0}' received'. Attempting download...'" -f $statusCode) -ForegroundColor Cyan Invoke-WebRequest -UseBasicParsing -Method Get -Uri $Uri -OutFile $fileDestination -ErrorAction SilentlyContinue if (Test-Path -Path $fileDestination) { Write-Log -Message ("File download successful. File saved to '{0}'" -f $fileDestination) -LogId $LogId Write-Host ("File download sucessful. File saved to '{0}'" -f $fileDestination) -ForegroundColor Green } else { Write-Log -Message ("The download was interrupted or an error occured moving the file to '{0}'" -f $Uri) -LogId $LogId -Severity 3 Write-Warning -Message ("The download was interrupted or an error occured moving the file to '{0}'" -f $Uri) Get-ScriptEnd -LogId $LogId -Message $_.Exception.Message } } catch { Write-Log -Message ("Error downloading file '{0}'" -f $Uri) -LogId $LogId -Severity 3 Write-Warning -Message ("Error downloading file '{0}'" -f $Uri) Get-ScriptEnd -LogId $LogId -Message $_.Exception.Message } } else { Write-Log -Message ("URL Does not exists or the website is down. Status Code '{0}'" -f $statusCode) -LogId $LogId -Severity 3 Write-Warning -Message ("URL Does not exists or the website is down. Status Code '{0}'" -f $statusCode) Get-ScriptEnd -LogId $LogId -Message $_.Exception.Message } } } |