This is a test email.
' + Send-HtmlMail -SMTPServer "smtp.example.com" -SMTPServerPort 587 -SmtpUser "user@example.com" + -SmtpPassword "P@ssw0rd" -To "recipient@example.com" -From "sender@example.com" + -Subject "Test Email" -HTMLBody "This is a test email.
" + Sends a test email with HTML content. #> + function Send-HtmlMail { [CmdletBinding()] param( @@ -78,14 +72,6 @@ function Send-HtmlMail { "HTMLBody" = $HTMLBody } - - - if (-not (Get-Module -Name Send-MailKitMessage -ListAvailable)) { - Install-Module -Name Send-MailKitMessage -AllowClobber -Force -Confirm:$false -Scope CurrentUser - } else { - Import-Module -Name Send-MailKitMessage - } - # Send the email try { Send-MailKitMessage @Parameters diff --git a/functions/Send-Mail.ps1 b/functions/Send-Mail.ps1 deleted file mode 100644 index 4f369de..0000000 --- a/functions/Send-Mail.ps1 +++ /dev/null @@ -1,106 +0,0 @@ -function Send-Mail { - <# - .SYNOPSIS - Send mail - - .DESCRIPTION - Send email with file contents as body - - .PARAMETER SMTPserver - SMTP server - - .PARAMETER SMTPport - SMTP Port - - .PARAMETER MailTo - Mail to - - .PARAMETER MailFrom - Mail From - - .PARAMETER MailFromName - Mail From Name - - .PARAMETER MailSubject - Mail Subject - - .PARAMETER MailBody - Path to html file as mail body - - .PARAMETER SMTPuser - SMTP User - - .PARAMETER SMTPpass - SMTP Password - - .EXAMPLE - Send-Mail -SMTPserver 'mail.domain.com' -SMTPPort '25' -MailTo 'recipient@mail.com' -MailFrom 'sender@mail.com' -MailFromName 'Sender Name' -MailSubject 'Mail Subject' -MailBody 'C:\Temp\log.html' -SMTPuser 'user' -SMTPpass 'p@ssw0rd' - - .NOTES - General notes - #> - [CmdletBinding()] - param ( - [Parameter( - Mandatory = $true - )] - [string]$SMTPserver, - - [Parameter( - Mandatory = $true - )] - [string]$SMTPport, - - [Parameter( - Mandatory = $true - )] - [string]$MailTo, - - [Parameter( - Mandatory = $true - )] - [string]$MailFrom, - - [Parameter( - Mandatory = $true - )] - [string]$MailFromName, - - [Parameter( - Mandatory = $true - )] - [string]$MailSubject, - - [Parameter( - Mandatory = $true - )] - [string]$MailBody, - - [Parameter( - Mandatory = $true - )] - [string]$SMTPuser, - - [Parameter( - Mandatory = $true - )] - [string]$SMTPpass - ) - - $StartInfo = New-Object System.Diagnostics.ProcessStartInfo - $StartInfo.FileName = $MailSendPath - $StartInfo.RedirectStandardError = $true - $StartInfo.RedirectStandardOutput = $true - $StartInfo.UseShellExecute = $false - $StartInfo.Arguments = @("-smtp $SMTPserver", "-port $SMTPport", "-domain $SMTPserver", "-t $MailTo", "-f $MailFrom", "-fname `"$MailFromName`"", "-sub `"$MailSubject`"", 'body', "-file `"$MailBody`"", "-mime-type `"text/html`"", '-ssl', "auth -user $SMTPuser -pass $SMTPpass") - $Process = New-Object System.Diagnostics.Process - $Process.StartInfo = $StartInfo - $Process.Start() | Out-Null - # $stdout = $Process.StandardOutput.ReadToEnd() - # $stderr = $Process.StandardError.ReadToEnd() - # Write-Host "stdout: $stdout" - # Write-Host "stderr: $stderr" - $Process.WaitForExit() - # Write-Host "exit code: " + $p.ExitCode - # return $stdout -} \ No newline at end of file diff --git a/functions/Start-FileCopy.ps1 b/functions/Start-FileCopy.ps1 new file mode 100644 index 0000000..9785a01 --- /dev/null +++ b/functions/Start-FileCopy.ps1 @@ -0,0 +1,197 @@ +<# +.SYNOPSIS + Copies files using RoboCopy or falls back to PowerShell Copy if RoboCopy is not available. +.DESCRIPTION + This function copies files from a source to a destination using RoboCopy or PowerShell Copy. +.PARAMETER Source + Specifies the source path of the files to be copied. +.PARAMETER Destination + Specifies the destination path where the files will be copied. +.PARAMETER File + Specifies the filter for files to be copied. Use '*.*' for all files. +.PARAMETER DownloadLabel + Specifies the label for the download operation (for logging purposes). +.PARAMETER DownloadName + Specifies the name of the download operation (for logging purposes). +.OUTPUTS + None +.EXAMPLE + Start-FileCopy -Source "C:\Source" -Destination "D:\Destination" -File '*.*' -DownloadLabel "Label" -DownloadName "Download" + Copies all files from C:\Source to D:\Destination and logs the results. +.EXAMPLE + Start-FileCopy -Source "C:\Source" -Destination "D:\Destination" -File 'example.txt' -DownloadLabel "Label" -DownloadName "Download" + Copies a single file named 'example.txt' from C:\Source to D:\Destination and logs the results. +#> + + +function Start-FileCopy { + [CmdletBinding()] + param ( + [Parameter(Mandatory = $true)] + [string]$Source, + + [Parameter(Mandatory = $true)] + [string]$Destination, + + [Parameter(Mandatory = $true)] + [string]$File, + + [Parameter(Mandatory = $true)] + [string]$DownloadLabel, + + [Parameter(Mandatory = $true)] + [string]$DownloadName + ) + + # Make sure needed functions are available otherwise try to load them. + $functionsToLoad = @('Write-HTMLLog', 'Stop-Script', 'Format-Size') + foreach ($functionName in $functionsToLoad) { + if (-not (Get-Command $functionName -ErrorAction SilentlyContinue)) { + try { + . "$PSScriptRoot\$functionName.ps1" + Write-Host "$functionName function loaded." -ForegroundColor Green + } catch { + Write-Error "Failed to import $functionName function: $_" + exit 1 + } + } + } + + if (Test-Path "$env:SystemRoot\system32\Robocopy.exe") { + + # Set RoboCopy options based on the file parameter. + $options = @('/R:1', '/W:1', '/J', '/NP', '/NJH', '/NFL', '/NDL', '/MT8') + if ($File -eq '*.*') { + $options += '/E' + } + + $cmdArgs = @("`"$Source`"", "`"$Destination`"", "`"$File`"", $options) + + # Execute RoboCopy command + Write-HTMLLog -Column1 'Starting:' -Column2 'RoboCopy files' + try { + $Output = robocopy @cmdArgs + } catch { + Write-Host 'Exception:' $_.Exception.Message -ForegroundColor Red + Write-Host 'RoboCopy not found' -ForegroundColor Red + exit 1 + } + + # Parse RoboCopy output + foreach ($line in $Output) { + switch -Regex ($line) { + # Dir metrics + '^\s+Dirs\s:\s*' { + # Example: Dirs : 35 0 0 0 0 0 + $dirs = $_.Replace('Dirs :', '').Trim() + # Now remove the white space between the values.' + $dirs = $dirs -split '\s+' + + # Assign the appropriate column to values. + $TotalDirs = $dirs[0] + $CopiedDirs = $dirs[1] + $FailedDirs = $dirs[4] + } + # File metrics + '^\s+Files\s:\s[^*]' { + # Example: Files : 8318 0 8318 0 0 0 + $files = $_.Replace('Files :', '').Trim() + # Now remove the white space between the values.' + $files = $files -split '\s+' + + # Assign the appropriate column to values. + $TotalFiles = $files[0] + $CopiedFiles = $files[1] + $FailedFiles = $files[4] + } + # Byte metrics + '^\s+Bytes\s:\s*' { + # Example: Bytes : 1.607 g 0 1.607 g 0 0 0 + $bytes = $_.Replace('Bytes :', '').Trim() + # Now remove the white space between the values.' + $bytes = $bytes -split '\s+' + + # The raw text from the log file contains a k,m,or g after the non zero numbers. + # This will be used as a multiplier to determine the size in kb. + $counter = 0 + $tempByteArray = 0, 0, 0, 0, 0, 0 + $tempByteArrayCounter = 0 + foreach ($column in $bytes) { + if ($column -eq 'k') { + $tempByteArray[$tempByteArrayCounter - 1] = '{0:N2}' -f ([single]($bytes[$counter - 1]) * 1024) + $counter += 1 + } elseif ($column -eq 'm') { + $tempByteArray[$tempByteArrayCounter - 1] = '{0:N2}' -f ([single]($bytes[$counter - 1]) * 1048576) + $counter += 1 + } elseif ($column -eq 'g') { + $tempByteArray[$tempByteArrayCounter - 1] = '{0:N2}' -f ([single]($bytes[$counter - 1]) * 1073741824) + $counter += 1 + } else { + $tempByteArray[$tempByteArrayCounter] = $column + $counter += 1 + $tempByteArrayCounter += 1 + } + } + # Assign the appropriate column to values. + $TotalSize = Format-Size -SizeInBytes ([double]::Parse($tempByteArray[0])) + $CopiedSize = Format-Size -SizeInBytes ([double]::Parse($tempByteArray[1])) + $FailedSize = Format-Size -SizeInBytes ([double]::Parse($tempByteArray[4])) + # array columns 2,3, and 5 are available, but not being used currently. + } + # Speed metrics + '^\s+Speed\s:.*sec.$' { + # Example: Speed : 120.816 Bytes/min. + $speed = $_.Replace('Speed :', '').Trim() + $speed = $speed.Replace('Bytes/sec.', '').Trim() + # Remove any dots in the number + $speed = $speed.Replace('.', '').Trim() + # Assign the appropriate column to values. + $speed = Format-Size -SizeInBytes $speed + } + } + } + + # Log results + if ($FailedDirs -gt 0 -or $FailedFiles -gt 0) { + Write-HTMLLog -Column1 'Dirs' -Column2 "$TotalDirs Total" -ColorBg 'Error' + Write-HTMLLog -Column1 'Dirs' -Column2 "$FailedDirs Failed" -ColorBg 'Error' + Write-HTMLLog -Column1 'Files:' -Column2 "$TotalFiles Total" -ColorBg 'Error' + Write-HTMLLog -Column1 'Files:' -Column2 "$FailedFiles Failed" -ColorBg 'Error' + Write-HTMLLog -Column1 'Size:' -Column2 "$TotalSize Total" -ColorBg 'Error' + Write-HTMLLog -Column1 'Size:' -Column2 "$FailedSize Failed" -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' + Stop-Script -ExitReason "Copy Error: $DownloadLabel - $DownloadName" + } else { + Write-HTMLLog -Column1 'Dirs:' -Column2 "$CopiedDirs Copied" + Write-HTMLLog -Column1 'Files:' -Column2 "$CopiedFiles Copied" + Write-HTMLLog -Column1 'Size:' -Column2 "$CopiedSize" + Write-HTMLLog -Column1 'Throughput:' -Column2 "$Speed/s" + Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' + } + } else { + # RoboCopy not available, fallback to PowerShell copy + Write-HTMLLog -Column1 'Starting:' -Column2 'Copy files using PowerShell Copy' + try { + # Start the Stopwatch + $copyResultsStopWatch = [system.diagnostics.stopwatch]::startNew() + $copyResults = Copy-Item -Path $Source -Destination $Destination -Filter $File -Recurse -PassThru -ErrorAction Stop + # Stop the Stopwatch + $copyResultsStopWatch.Stop() + + # Log results for Copy-Item + $totalFiles = ($copyResults | Where-Object { -not $_.PSIsContainer }).Count + $totalDirs = ($copyResults | Where-Object { $_.PSIsContainer }).Count + $totalSize = ($copyResults | Measure-Object Length -Sum).Sum + + Write-HTMLLog -Column1 'Dirs:' -Column2 $totalDirs + Write-HTMLLog -Column1 'Files:' -Column2 "$totalFiles Copied" + Write-HTMLLog -Column1 'Size:' -Column2 (Format-Size -SizeInBytes $totalSize) + Write-HTMLLog -Column1 'Throughput:' -Column2 "$(Format-Size -SizeInBytes ($TotalSize/$copyResultsStopWatch.Elapsed.TotalSeconds))/s" + Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' + } catch { + # Log error for Copy-Item + Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' + Stop-Script -ExitReason "Copy Error: $DownloadLabel - $DownloadName" + } + } +} \ No newline at end of file diff --git a/functions/Start-MKVSubtitleStrip.ps1 b/functions/Start-MKVSubtitleStrip.ps1 index 6a3b7e7..6ee2e90 100644 --- a/functions/Start-MKVSubtitleStrip.ps1 +++ b/functions/Start-MKVSubtitleStrip.ps1 @@ -1,111 +1,133 @@ +<# +.SYNOPSIS + Strips unwanted subtitles from MKV files and extracts desired SRT subtitles. +.DESCRIPTION + This function extracts SRT subtitles from MKV files based on specified criteria, + and removes unwanted subtitles. It also remuxes the MKV file to exclude undesired + subtitle tracks. +.PARAMETER Source + Specifies the path to the directory containing MKV files. +.PARAMETER MKVMergePath + Specifies the path to the MKVMerge executable. +.PARAMETER MKVExtractPath + Specifies the path to the MKVExtract executable. +.PARAMETER WantedLanguages + Specifies an array of language codes for the desired subtitles. + The function extracts subtitles for the specified languages. + Example: @("eng", "dut") +.PARAMETER SubtitleNamesToRemove + Specifies an array of subtitle names to be removed. + Subtitles with matching names will be excluded from the extraction. + Example: @("Forced") +.PARAMETER LanguageCodeLookup + Specifies an Hashtable of language code mappings. + Each item in the array should be a hashtable with 'alpha3' and 'alpha2' keys + representing the three-letter and two-letter language codes, respectively. + Example: @(@{alpha3="eng"; alpha2="en"}, @{alpha3="dut"; alpha2="nl"}) +.OUTPUTS + None +.EXAMPLE + Start-MKVSubtitleStrip -Source "C:\Path\To\MKVFiles" -MKVMergePath "C:\Program Files\MKVToolNix\mkvmerge.exe" + -MKVExtractPath "C:\Program Files\MKVToolNix\mkvextract.exe" -WantedLanguages @("eng", "dut") + -SubtitleNamesToRemove @("Forced") -LanguageCodes @{"en"=@{"639-1"="en";"639-2"="eng";"name"="English"}; "nl"=@{"639-1"="nl";"639-2"="nld";"639-2/B"="dut";"name"="Dutch"}} +#> + function Start-MKVSubtitleStrip { - <# - .SYNOPSIS - Extract wanted SRT subtitles from MKVs in root folder and remux MKVs to strip out unwanted subtitle languages - .DESCRIPTION - Searches for all MKV files in root folder and extracts the SRT that are defined in $WantedLanguages - Remux any MKV that has subtitles of unwanted languages or Track_name in $SubtitleNamesToRemove. - Rename srt subtitle files based on $LanguageCodes - .PARAMETER Source - Defines the root folder to start the search for MKV files - .EXAMPLE - Start-MKVSubtitleStrip 'C:\Temp\Source' - .OUTPUTS - SRT files of the desired languages - file.en.srt - file.2.en.srt - file.nl.srt - file.de.srt - MKV files without the unwanted subtitles - file.mkv - #> [CmdletBinding()] param( - [Parameter( - Mandatory = $true - )] - $Source + [Parameter(Mandatory = $true)] + [string]$Source, + + [Parameter(Mandatory = $true)] + [string]$MKVMergePath, + + [Parameter(Mandatory = $true)] + [string]$MKVExtractPath, + + [Parameter(Mandatory = $true)] + [array]$WantedLanguages, + + [Parameter(Mandatory = $true)] + [array]$SubtitleNamesToRemove, + + [Parameter(Mandatory = $true)] + [hashtable]$LanguageCodeLookup ) # Make sure needed functions are available otherwise try to load them. - $commands = 'Write-HTMLLog' - foreach ($commandName in $commands) { - if (!($command = Get-Command $commandName -ErrorAction SilentlyContinue)) { - Try { - . $PSScriptRoot\$commandName.ps1 - Write-Host "$commandName Function loaded." -ForegroundColor Green - } Catch { - Write-Error -Message "Failed to import $commandName function: $_" + $functionsToLoad = @('Write-HTMLLog') + foreach ($functionName in $functionsToLoad) { + if (-not (Get-Command $functionName -ErrorAction SilentlyContinue)) { + try { + . "$PSScriptRoot\$functionName.ps1" + Write-Host "$functionName function loaded." -ForegroundColor Green + } catch { + Write-Error "Failed to import $functionName function: $_" exit 1 } } } - # Start - - $episodes = @() + + # Initialize variables + $MkvFiles = @() $SubsExtracted = $false $TotalSubsToExtract = 0 $TotalSubsToRemove = 0 - Write-HTMLLog -Column1 '*** Extract srt files from Video Container ***' -Header + Write-HTMLLog -Column1 '*** Extract srt files from MKV ***' -Header + Get-ChildItem -LiteralPath $Source -Recurse -Filter '*.mkv' | Where-Object { $_.DirectoryName -notlike "*\Sample" } | ForEach-Object { - Get-ChildItem -LiteralPath $_.FullName | ForEach-Object { - $fileName = $_.BaseName - $filePath = $_.FullName - $fileRoot = $_.Directory + $MkvFileInfo = $_ - # Start the json export with MKVMerge on the available tracks - $StartInfo = New-Object System.Diagnostics.ProcessStartInfo - $StartInfo.FileName = $MKVMergePath - $StartInfo.RedirectStandardError = $true - $StartInfo.RedirectStandardOutput = $true - $StartInfo.UseShellExecute = $false - $StartInfo.Arguments = @('-J', "`"$filePath`"") - $Process = New-Object System.Diagnostics.Process - $Process.StartInfo = $StartInfo - $Process.Start() | Out-Null - $stdout = $Process.StandardOutput.ReadToEnd() - # $stderr = $Process.StandardError.ReadToEnd() - # Write-Host "stdout: $stdout" - # Write-Host "stderr: $stderr" - $Process.WaitForExit() - if ($Process.ExitCode -eq 2) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 1) { + # Start the json export with MKVMerge on the available tracks + $StartInfo = New-Object System.Diagnostics.ProcessStartInfo + $StartInfo.FileName = $MKVMergePath + $StartInfo.RedirectStandardError = $true + $StartInfo.RedirectStandardOutput = $true + $StartInfo.UseShellExecute = $false + $StartInfo.Arguments = @('-J', "`"$($MkvFileInfo.FullName)`"") + $Process = New-Object System.Diagnostics.Process + $Process.StartInfo = $StartInfo + $Process.Start() | Out-Null + $stdout = $Process.StandardOutput.ReadToEnd() + $Process.WaitForExit() + + switch ($process.ExitCode) { + 0 { + $MkvFileMetadata = $stdout | ConvertFrom-Json + } + 1 { Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 0) { - $fileMetadata = $stdout | ConvertFrom-Json - } else { + } + default { Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' } + } - $file = @{ - FileName = $fileName - FilePath = $filePath - FileRoot = $fileRoot - FileTracks = $fileMetadata.tracks - FileAttachments = $fileMetadata.attachments - } - - $episodes += New-Object PSObject -Property $file + $file = @{ + FileName = $MkvFileInfo.BaseName + FilePath = $MkvFileInfo.FullName + FileRoot = $MkvFileInfo.Directory + FileTracks = $MkvFileMetadata.tracks + FileAttachments = $MkvFileMetadata.attachments } + + $MkvFiles += New-Object PSObject -Property $file } # Extract wanted SRT subtitles - $episodes | ForEach-Object { - $episode = $_ + $MkvFiles | ForEach-Object { + $MkvFile = $_ $SubIDsToExtract = @() $SubIDsToRemove = @() $SubsToExtract = @() $SubNamesToKeep = @() - $episode.FileTracks | ForEach-Object { + $MkvFile.FileTracks | ForEach-Object { $FileTrack = $_ if ($FileTrack.id) { # Check if subtitle is srt @@ -119,35 +141,18 @@ function Start-MKVSubtitleStrip { elseif ($FileTrack.properties.language -in $WantedLanguages) { # Handle multiple subtitles of same language, if exist skip duplicates of same language - if ("$($episode.FileName).$($FileTrack.properties.language).srt" -notin $SubNamesToKeep) { + if ("$($MkvFile.FileName).$($FileTrack.properties.language).srt" -notin $SubNamesToKeep) { $prefix = "$($FileTrack.properties.language)" # Add Subtitle name and ID to be extracted - $SubsToExtract += "`"$($FileTrack.id):$($episode.FileRoot)\$($episode.FileName).$($prefix).srt`"" + $SubsToExtract += "`"$($FileTrack.id):$($MkvFile.FileRoot)\$($MkvFile.FileName).$($prefix).srt`"" # Keep track of subtitle file names that will be extracted to handle possible duplicates - $SubNamesToKeep += "$($episode.FileName).$($prefix).srt" + $SubNamesToKeep += "$($MkvFile.FileName).$($prefix).srt" # Add subtitle ID to for MKV remux $SubIDsToExtract += $FileTrack.id - } - - # Handle multiple subtitles of same language, if exist append ID to file - # if ("$($episode.FileName).$($FileTrack.properties.language).srt" -in $SubNamesToKeep) { - # $prefix = "$($FileTrack.id).$($FileTrack.properties.language)" - # } else { - # $prefix = "$($FileTrack.properties.language)" - # } - - # # Add Subtitle name and ID to be extracted - # $SubsToExtract += "`"$($FileTrack.id):$($episode.FileRoot)\$($episode.FileName).$($prefix).srt`"" - - # # Keep track of subtitle file names that will be extracted to handle possible duplicates - # $SubNamesToKeep += "$($episode.FileName).$($prefix).srt" - - # # Add subtitle ID to for MKV remux - # $SubIDsToExtract += $FileTrack.id - + } } else { $SubIDsToRemove += $FileTrack.id } @@ -155,7 +160,7 @@ function Start-MKVSubtitleStrip { } } - # Count all subtitles to keep and remove of logging + # Count all subtitles to keep and remove for logging $TotalSubsToExtract = $TotalSubsToExtract + $SubIDsToExtract.count $TotalSubsToRemove = $TotalSubsToRemove + $SubIDsToRemove.count @@ -166,67 +171,62 @@ function Start-MKVSubtitleStrip { $StartInfo.RedirectStandardError = $true $StartInfo.RedirectStandardOutput = $true $StartInfo.UseShellExecute = $false - $StartInfo.Arguments = @("`"$($episode.FilePath)`"", 'tracks', "$SubsToExtract") + $StartInfo.Arguments = @("`"$($MkvFile.FilePath)`"", 'tracks', "$SubsToExtract") $Process = New-Object System.Diagnostics.Process $Process.StartInfo = $StartInfo $Process.Start() | Out-Null $stdout = $Process.StandardOutput.ReadToEnd() - # $stderr = $Process.StandardError.ReadToEnd() - # Write-Host "stdout: $stdout" - # Write-Host "stderr: $stderr" $Process.WaitForExit() - if ($Process.ExitCode -eq 2) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvextract:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 1) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvextract:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 0) { - $SubsExtracted = $true - # Write-HTMLLog -Column1 "Extracted:" -Column2 "$($SubsToExtract.count) Subtitles" - } else { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvextract:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Unknown' -ColorBg 'Error' + + switch ($process.ExitCode) { + 0 { + $SubsExtracted = $true + } + 1 { + Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' + Write-HTMLLog -Column1 'mkvextract:' -Column2 $stdout -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' + } + default { + Write-HTMLLog -Column1 'Exit Code:' -Column2 $process.ExitCode -ColorBg 'Error' + Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' + } } } + + # Remux and strip out all unwanted subtitle languages if ($SubIDsToRemove.Count -gt 0) { - $TmpFileName = $Episode.FileName + '.tmp' - $TmpMkvPath = Join-Path $episode.FileRoot $TmpFileName + $TmpFileName = $MkvFile.FileName + '.tmp' + $TmpMkvPath = Join-Path $MkvFile.FileRoot $TmpFileName $StartInfo = New-Object System.Diagnostics.ProcessStartInfo $StartInfo.FileName = $MKVMergePath $StartInfo.RedirectStandardError = $true $StartInfo.RedirectStandardOutput = $true $StartInfo.UseShellExecute = $false - $StartInfo.Arguments = @("-o `"$TmpMkvPath`"", "-s !$($SubIDsToRemove -join ',')", "`"$($episode.FilePath)`"") + $StartInfo.Arguments = @("-o `"$TmpMkvPath`"", "-s !$($SubIDsToRemove -join ',')", "`"$($MkvFile.FilePath)`"") $Process = New-Object System.Diagnostics.Process $Process.StartInfo = $StartInfo $Process.Start() | Out-Null $stdout = $Process.StandardOutput.ReadToEnd() - # $stderr = $Process.StandardError.ReadToEnd() - # Write-Host "stdout: $stdout" - # Write-Host "stderr: $stderr" $Process.WaitForExit() - if ($Process.ExitCode -eq 2) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 1) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 0) { - # Overwrite original mkv after successful remux - Move-Item -LiteralPath $TmpMkvPath -Destination $($episode.FilePath) -Force - # Write-HTMLLog -Column1 "Removed:" -Column2 "$($SubIDsToRemove.Count) unwanted subtitle languages" - } else { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' + + switch ($process.ExitCode) { + 0 { + Move-Item -LiteralPath $TmpMkvPath -Destination $($MkvFile.FilePath) -Force + } + 1 { + Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' + Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' + } + default { + Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' + Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' + } } } } @@ -234,18 +234,22 @@ function Start-MKVSubtitleStrip { # Rename extracted subs to correct 2 county code based on $LanguageCodes if ($SubsExtracted) { $SrtFiles = Get-ChildItem -LiteralPath $Source -Recurse -Filter '*.srt' + foreach ($srt in $SrtFiles) { - $FileDirectory = $srt.Directory - $FilePath = $srt.FullName - $FileName = $srt.Name - foreach ($LanguageCode in $Config.LanguageCodes) { - $FileNameNew = $FileName.Replace(".$($LanguageCode.alpha3).", ".$($LanguageCode.alpha2).") - $ReplacementWasMade = $FileName -cne $FileNameNew - if ($ReplacementWasMade) { - $Destination = Join-Path -Path $FileDirectory -ChildPath $FileNameNew - Move-Item -LiteralPath $FilePath -Destination $Destination -Force - break - } + $SrtDirectory = $srt.Directory + $SrtPath = $srt.FullName + $SrtName = $srt.Name + + # Extract the language code from the file name + $languageCode = $srt -replace '.*\.([a-zA-Z]+)\.srt$', '$1' + + # Check if the language code exists in the lookup table + if ($LanguageCodeLookup.ContainsKey($languageCode)) { + $SrtNameNew = $SrtName -replace "\.$languageCode\.srt$", ".$($LanguageCodeLookup[$languageCode]).srt" + $Destination = Join-Path -Path $SrtDirectory -ChildPath $SrtNameNew + Move-Item -LiteralPath $SrtPath -Destination $Destination -Force + } else { + Write-HTMLLog -Column2 "Language code $languageCode not found in the 3 letter lookup table." -ColorBg 'Error' } } if ($TotalSubsToExtract -gt 0) { diff --git a/functions/Start-MP4ToMKVRemux.ps1 b/functions/Start-MP4ToMKVRemux.ps1 index 468b0bf..903cef7 100644 --- a/functions/Start-MP4ToMKVRemux.ps1 +++ b/functions/Start-MP4ToMKVRemux.ps1 @@ -1,38 +1,39 @@ +<# +.SYNOPSIS + Remuxes MP4 files to MKV using MKVMerge. +.DESCRIPTION + This function remuxes MP4 files to MKV format using MKVMerge. + It deletes the original MP4 file after successful remux and + overwrites the original MKV file. +.PARAMETER Source + Specifies the path to the directory containing MP4 files to remux. +.PARAMETER MKVMergePath + Specifies the path to the MKVMerge executable. +.OUTPUTS + Outputs the remuxed MKV files to the specified directory. +.EXAMPLE + Start-MP4ToMKVRemux -Source "C:\Videos" -MKVMergePath "C:\Program Files\MKVToolNix\mkvmerge.exe" + # Remuxes all MP4 files in the "C:\Videos" directory using MKVMerge. +#> function Start-MP4ToMKVRemux { - <# - .SYNOPSIS - Converts MP4 video files to MKV format using mkvmerge. - - .DESCRIPTION - This function remuxes MP4 video files to MKV format by extracting available tracks using mkvmerge. It deletes the original MP4 file upon successful conversion and saves the resulting MKV file. - - .PARAMETER Source - Specifies the MP4 video file(s) to be converted to MKV format. - - .EXAMPLE - Start-MP4ToMKVRemux -VideoFileObjects "C:\Videos\example.mp4" - Remuxes the specified MP4 file to MKV format. - - .OUTPUTS - This function does not return any specific output. It performs the conversion process and logs the result in an HTML log file. - #> [CmdletBinding()] param( - [Parameter( - Mandatory = $true - )] - $VideoFileObjects + [Parameter(Mandatory = $true)] + [string]$Source, + + [Parameter(Mandatory = $true)] + [string]$MKVMergePath ) # Make sure needed functions are available otherwise try to load them. - $commands = 'Write-HTMLLog' - foreach ($commandName in $commands) { - if (!($command = Get-Command $commandName -ErrorAction SilentlyContinue)) { - Try { - . $PSScriptRoot\$commandName.ps1 - Write-Host "$commandName Function loaded." -ForegroundColor Green - } Catch { - Write-Error -Message "Failed to import $commandName function: $_" + $functionsToLoad = @('Write-HTMLLog') + foreach ($functionName in $functionsToLoad) { + if (-not (Get-Command $functionName -ErrorAction SilentlyContinue)) { + try { + . "$PSScriptRoot\$functionName.ps1" + Write-Host "$functionName function loaded." -ForegroundColor Green + } catch { + Write-Error "Failed to import $functionName function: $_" exit 1 } } @@ -40,50 +41,47 @@ function Start-MP4ToMKVRemux { # Start Write-HTMLLog -Column1 '*** Remux MP4 to MKV ***' -Header - $VideoFileObjects | ForEach-Object { - Get-ChildItem -LiteralPath $_.FullName | ForEach-Object { - $fileName = $_.BaseName - $filePath = $_.FullName - $fileRoot = $_.Directory - # Start the json export with MKVMerge on the available tracks - $TmpFileName = $fileName + '.tmp' - $TmpMkvPath = Join-Path $fileRoot $TmpFileName - $StartInfo = New-Object System.Diagnostics.ProcessStartInfo - $StartInfo.FileName = $MKVMergePath - $StartInfo.RedirectStandardError = $true - $StartInfo.RedirectStandardOutput = $true - $StartInfo.UseShellExecute = $false - $StartInfo.Arguments = @("-o `"$TmpMkvPath`"", "`"$filePath`"") - $Process = New-Object System.Diagnostics.Process - $Process.StartInfo = $StartInfo - $Process.Start() | Out-Null - $stdout = $Process.StandardOutput.ReadToEnd() - # $stderr = $Process.StandardError.ReadToEnd() - # Write-Host "stdout: $stdout" - # Write-Host "stderr: $stderr" - $Process.WaitForExit() - if ($Process.ExitCode -eq 2) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 1) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' - } elseif ($Process.ExitCode -eq 0) { + Get-ChildItem -LiteralPath $Source -Recurse -Filter '*.mp4' | Where-Object { $_.DirectoryName -notlike "*\Sample" } | ForEach-Object { + $fileName = $_.BaseName + $filePath = $_.FullName + $fileRoot = $_.Directory + + # Start MKVMerge to remux MP4 to MKV + $TmpFileName = $fileName + '.tmp' + $TmpMkvPath = Join-Path $fileRoot $TmpFileName + $StartInfo = New-Object System.Diagnostics.ProcessStartInfo + $StartInfo.FileName = $MKVMergePath + $StartInfo.RedirectStandardError = $true + $StartInfo.RedirectStandardOutput = $true + $StartInfo.UseShellExecute = $false + $StartInfo.Arguments = @("-o `"$TmpMkvPath`"", "`"$filePath`"") + $Process = New-Object System.Diagnostics.Process + $Process.StartInfo = $StartInfo + $Process.Start() | Out-Null + $stdout = $Process.StandardOutput.ReadToEnd() + $Process.WaitForExit() + + switch ($process.ExitCode) { + 0 { # Delete original MP4 Remove-Item -Force -LiteralPath $filePath + # Overwrite original mkv after successful remux - Rename-Item -LiteralPath $TmpMkvPath -NewName $($fileName + ".mkv") - # Write-HTMLLog -Column1 "Removed:" -Column2 "$($SubIDsToRemove.Count) unwanted subtitle languages" - } else { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' + Rename-Item -LiteralPath $tmpMkvPath -NewName "$fileName.mkv" + Write-HTMLLog -Column1 'Remuxed:' -Column2 "$fileName.mp4" + } + 1 { + Write-HTMLLog -Column1 'Exit Code:' -Column2 $process.ExitCode -ColorBg 'Warning' + Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Warning' + Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Warning' + } + default { + Write-HTMLLog -Column1 'Exit Code:' -Column2 $process.ExitCode -ColorBg 'Error' Write-HTMLLog -Column1 'mkvmerge:' -Column2 $stdout -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Warning' -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' } - - } } + Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' } diff --git a/functions/Start-OpenSubtitlesDownload.ps1 b/functions/Start-OpenSubtitlesDownload.ps1 new file mode 100644 index 0000000..95929c4 --- /dev/null +++ b/functions/Start-OpenSubtitlesDownload.ps1 @@ -0,0 +1,390 @@ +<# +.SYNOPSIS + Downloads missing subtitles from OpenSubtitle.com. +.DESCRIPTION + This function searches for and downloads missing subtitles for specified video files + from OpenSubtitle.com. It supports downloading subtitles in multiple languages. +.PARAMETER Source + The source directory containing the video files for which subtitles are to be downloaded. +.PARAMETER OpenSubUser + The username for accessing the OpenSubtitle API. +.PARAMETER OpenSubPass + The password for accessing the OpenSubtitle API. +.PARAMETER OpenSubAPI + The API key for accessing the OpenSubtitle API. +.PARAMETER OpenSubHearing_impaired + Indicates whether to include subtitles for the hearing impaired (include/exclude/only). +.PARAMETER OpenSubForeign_parts_only + Indicates whether to include subtitles for foreign parts only (include/exclude/only). +.PARAMETER OpenSubMachine_translated + Indicates whether to include machine-translated subtitles (include/exclude/only). +.PARAMETER OpenSubAI_translated + Indicates whether to include AI-translated subtitles (include/exclude/only). +.PARAMETER WantedLanguages + An array of language codes specifying the desired subtitle languages. +.PARAMETER Type + The type of the video files (e.g., movie, episode). + +.OUTPUTS + This function outputs a log of downloaded and failed subtitles along with language-specific counts + and the remaining downloads for the day. + +.EXAMPLE + Start-OpenSubtitlesDownload -Source "C:\Videos" -OpenSubUser "username" -OpenSubPass "password" + -OpenSubAPI "APIKey" -OpenSubHearing_impaired "exclude" -OpenSubForeign_parts_only "exclude" + -OpenSubMachine_translated "exclude" -OpenSubAI_translated "exclude" -WantedLanguages @("en", "fr") + -Type "movie" + Searches for and downloads missing subtitles for video files in the "C:\Videos" directory, + excluding hearing impaired and foreign parts only subtitles, and including English and Spanish subtitles. +#> + +function Start-OpenSubtitlesDownload { + param( + [Parameter(Mandatory = $true)] + [string]$Source, + + [Parameter(Mandatory = $true)] + [string]$OpenSubUser, + + [Parameter(Mandatory = $true)] + [string]$OpenSubPass, + + [Parameter(Mandatory = $true)] + [string]$OpenSubAPI, + + [Parameter(Mandatory = $true)] + [ValidateSet("include", "exclude", "only")] + [string]$OpenSubHearing_impaired, + + [Parameter(Mandatory = $true)] + [ValidateSet("include", "exclude", "only")] + [string]$OpenSubForeign_parts_only, + + [Parameter(Mandatory = $true)] + [ValidateSet("include", "exclude", "only")] + [string]$OpenSubMachine_translated, + + [Parameter(Mandatory = $true)] + [ValidateSet("include", "exclude", "only")] + [string]$OpenSubAI_translated, + + [Parameter(Mandatory = $true)] + [array]$WantedLanguages, + + [Parameter(Mandatory = $true)] + [ValidateSet("episode", "movie")] + [string]$Type + ) + + # Make sure needed functions are available otherwise try to load them. + $functionsToLoad = @('Write-HTMLLog') + foreach ($functionName in $functionsToLoad) { + if (-not (Get-Command $functionName -ErrorAction SilentlyContinue)) { + try { + . "$PSScriptRoot\$functionName.ps1" + Write-Host "$functionName function loaded." -ForegroundColor Green + } catch { + Write-Error "Failed to import $functionName function: $_" + exit 1 + } + } + } + + # Function to connect to the OpenSubtitle API + function Connect-OpenSubtitleAPI { + param( + [string]$username, + [string]$password, + [string]$APIKey + ) + + # Set headers + $headers = @{ + "Content-Type" = "application/json" + "User-Agent" = "Torrentscript" + "Accept" = "application/json" + "Api-Key" = $APIKey + } + + # Set body + $body = @{ + username = $username + password = $password + } | ConvertTo-Json + + try { + # Make requests + $response = Invoke-RestMethod -Uri 'https://api.opensubtitles.com/api/v1/login' -Method POST -Headers $headers -ContentType 'application/json' -Body $body + # Check for successful login + if ($response.status -eq 200) { + return $response.token + } else { + Write-HTMLLog -Column1 'OpenSubs:' -Column2 "Login failed:" -ColorBg 'Error' + Write-HTMLLog -Column2 "$($response.status)" -ColorBg 'Error' + return $null + } + } catch { + Write-HTMLLog -Column1 'OpenSubs:' -Column2 "Error occurred while logging in:" -ColorBg 'Error' + Write-HTMLLog -Column2 "$($_.Exception.Message)" -ColorBg 'Error' + return $null + } + } + + # Function to disconnect from the OpenSubtitle API + function Disconnect-OpenSubtitleAPI { + param( + [string]$APIKey, + [string]$token + ) + + # Set headers + $headers = @{ + "User-Agent" = "Torrentscript" + "Accept" = "application/json" + "Api-Key" = $APIKey + "Authorization" = "Bearer $token" + } + + try { + # Make request + $response = Invoke-RestMethod -Uri 'https://api.opensubtitles.com/api/v1/logout' -Method DELETE -Headers $headers + + # Check for successful logout + if ($response.status -eq 200) { + Write-Host "Logout successful: $($response.message)" + } else { + Write-Host "Logout failed: $($response.status)" + } + } catch { + Write-Host "Error occurred while logging out: $_" + } + } + + # Function to search for subtitles + function Search-Subtitles { + param( + [string]$type, + [string]$query, + [string]$languages, + [string]$moviehash, + [string]$APIKey, + [string]$hearing_impaired, + [string]$foreign_parts_only, + [string]$machine_translated, + [string]$ai_translated + ) + + # Set headers + $headers = @{ + "User-Agent" = "Torrentscript" + "Api-Key" = $APIKey + } + + # Build the URI with query parameters + $uri = "https://api.opensubtitles.com/api/v1/subtitles?type=$type&query=$query&languages=$languages&moviehash=$moviehash&hearing_impaired=$hearing_impaired&foreign_parts_only=$foreign_parts_only&machine_translated=$machine_translated&ai_translated=$ai_translated" + + try { + # Make request + $response = Invoke-RestMethod -Uri $uri -Method GET -Headers $headers + + # Check for successful response + if ($response) { + # Initialize a hashtable to store subtitle IDs for each language + $subtitleInfo = @{ + VideoFileName = $query + SubtitleIds = @{} + } + + # Loop through the data to find the IDs for each language + foreach ($subtitle in $response.data) { + $language = $subtitle.attributes.language + + # Check if the language key exists in the hashtable + if (-not $subtitleInfo.SubtitleIds.ContainsKey($language)) { + $subtitleInfo.SubtitleIds[$language] = $subtitle.attributes.files[0].file_id + } + } + + # Return the hashtable containing subtitle IDs for each language + return $subtitleInfo + } else { + # No subtitles found for $query + return $null + } + } catch { + Write-HTMLLog -Column1 'OpenSubs:' -Column2 "Error occurred while searching for subtitles:" -ColorBg 'Error' + Write-HTMLLog -Column2 "$($_.Exception.Message)" -ColorBg 'Error' + return $null + } + } + + # Function to download all subtitles missing + function Save-AllSubtitles { + param( + [hashtable]$subtitleInfo, + [string]$APIKey, + [string]$token, + [string]$baseDirectory + ) + + # Initialize counters + $downloadedCount = 0 + $failedCount = 0 + $languageCounts = @{} + + # Set headers + $headers = @{ + "User-Agent" = "Torrentscript" + "Content-Type" = "application/json" + "Accept" = "application/json" + "Api-Key" = $APIKey + "Authorization" = "Bearer $token" + } + + # Iterate through each language in the subtitle info + foreach ($language in $subtitleInfo.SubtitleIds.Keys) { + $subtitleId = $subtitleInfo.SubtitleIds[$language] + $videoFileName = $subtitleInfo.VideoFileName + $subtitleFileName = "$baseDirectory\$videoFileName.$language.srt" + + # Check if the subtitle file already exists + if (-not (Test-Path $subtitleFileName)) { + # Build the body for the request + $body = @{ + file_id = $subtitleId + } | ConvertTo-Json + + try { + # Make request to download the subtitle + $response = Invoke-RestMethod -Uri 'https://api.opensubtitles.com/api/v1/download' -Method POST -Headers $headers -ContentType 'application/json' -Body $body + + # Check if the link is present in the response + if ($response.link) { + # Download the subtitle file + Invoke-WebRequest -Uri $response.link -OutFile $subtitleFileName + + # Increment downloaded count + $downloadedCount++ + + # Increment language-specific count + if (-not $languageCounts.ContainsKey($language)) { + $languageCounts[$language] = 1 + } else { + $languageCounts[$language]++ + } + } else { + Write-HTMLLog -Column1 'OpenSubs:' -Column2 "Failed to download subtitle for language: $language" -ColorBg 'Error' + # Increment failed count + $failedCount++ + } + } catch { + Write-HTMLLog -Column1 'OpenSubs:' -Column2 "Error occurred while downloading subtitle for language $($language):" -ColorBg 'Error' + Write-HTMLLog -Column2 "$($_.Exception.Message)" -ColorBg 'Error' + # Increment failed count + $failedCount++ + } + } + } + + # Return the counts and language-specific counts + return @{ + Downloaded = $downloadedCount + Failed = $failedCount + LanguageCounts = $languageCounts + RemainingDownloads = $response.remaining + } + } + + + # Function to get video hash + function Get-VideoHash([string]$path) { + $dataLength = 65536 + + function LongSum([UInt64]$a, [UInt64]$b) { + [UInt64](([Decimal]$a + $b) % ([Decimal]([UInt64]::MaxValue) + 1)) + } + + function StreamHash([IO.Stream]$stream) { + $hashLength = 8 + [UInt64]$lhash = 0 + [byte[]]$buffer = New-Object byte[] $hashLength + $i = 0 + while ( ($i -lt ($dataLength / $hashLength)) -and ($stream.Read($buffer, 0, $hashLength) -gt 0) ) { + $i++ + $lhash = LongSum $lhash ([BitConverter]::ToUInt64($buffer, 0)) + } + $lhash + } + + try { + $stream = [IO.File]::OpenRead($path) + [UInt64]$lhash = $stream.Length + $lhash = LongSum $lhash (StreamHash $stream) + $stream.Position = [Math]::Max(0L, $stream.Length - $dataLength) + $lhash = LongSum $lhash (StreamHash $stream) + $hash = "{0:X}" -f $lhash + if ($hash.Length -lt 16) { + $hash = ("0" * (16 - $hash.Length)) + $hash + } + $hash + } finally { + $stream.Close() + } + } + + #* Start the search and download of the subtitles + try { + Write-HTMLLog -Column1 '*** Download missing subs from OpenSubtitle.com ***' -Header + $token = Connect-OpenSubtitleAPI -username $OpenSubUser -password $OpenSubPass -APIKey $OpenSubAPI + + if ($token) { + $videoFiles = @(Get-ChildItem -LiteralPath $ProcessPathFull -Recurse -Filter '*.mkv' | Where-Object { $_.DirectoryName -notlike "*\Sample" }) + + foreach ($videoFile in $videoFiles) { + $videoHash = Get-VideoHash $videoFile.FullName + + $languageString = $WantedLanguages -join ',' + + $queryParams = @{ + query = $videoFile.BaseName + APIKey = $OpenSubAPI + type = $Type + moviehash = $videoHash + hearing_impaired = $OpenSubHearing_impaired + foreign_parts_only = $OpenSubForeign_parts_only + machine_translated = $OpenSubMachine_translated + ai_translated = $OpenSubAI_translated + languages = $languageString + } + $subtitleInfo = Search-Subtitles @queryParams + + # Call Save-AllSubtitles and capture the counts + $subtitlesCounts = Save-AllSubtitles -subtitleInfo $subtitleInfo -APIKey $OpenSubAPI -token $token -baseDirectory $videoFile.DirectoryName + } + + if ($($subtitlesCounts.Downloaded) -gt 0) { + # Log language-specific counts + foreach ($language in $subtitlesCounts.LanguageCounts.Keys) { + Write-HTMLLog -Column1 "Downloaded:" -Column2 "$($subtitlesCounts.LanguageCounts[$language]) in $($language.ToUpper())" + } + # Log the counts + Write-HTMLLog -Column1 "Downloaded:" -Column2 "$($subtitlesCounts.Downloaded) Total" + Write-HTMLLog -Column2 "Remaining downloads today: $($subtitlesCounts.RemainingDownloads)" + + if ($($subtitlesCounts.Failed) -gt 0) { + Write-HTMLLog -Column1 "Failed:" -Column2 "$($subtitlesCounts.Failed) failed to download" -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' + } else { + Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' + } + } else { + Write-HTMLLog -Column1 'Result:' -Column2 'No downloads found or needed' -ColorBg 'Success' + } + + Disconnect-OpenSubtitleAPI -APIKey $OpenSubAPI -token $token + } + } catch { + Write-HTMLLog -Column1 'OpenSubs:' -Column2 "Error occurred:" -ColorBg 'Error' + Write-HTMLLog -Column2 "$($_.Exception.Message)" -ColorBg 'Error' + } +} \ No newline at end of file diff --git a/functions/Start-RoboCopy.ps1 b/functions/Start-RoboCopy.ps1 deleted file mode 100644 index 5125f12..0000000 --- a/functions/Start-RoboCopy.ps1 +++ /dev/null @@ -1,162 +0,0 @@ -function Start-RoboCopy { - <# - .SYNOPSIS - RoboCopy wrapper - .DESCRIPTION - Wrapper for RoboCopy since it it way faster to copy that way. - This Function relies on Write-HTMLLog Function and Stop-Script Function - .PARAMETER Source - Source path - .PARAMETER Destination - Destination path - .PARAMETER File - File patern to copy *.* or name.ext - This allows for folder or single filecopy - .EXAMPLE - Start-RoboCopy -Source 'C:\Temp\Source' -Destination 'C:\Temp\Destination' -File '*.*' - Start-RoboCopy -Source 'C:\Temp\Source' -Destination 'C:\Temp\Destination' -File 'file.ext' - #> - [CmdletBinding()] - param( - [Parameter( - Mandatory = $true - )] - [string]$Source, - - [Parameter( - Mandatory = $true - )] - [string]$Destination, - - [Parameter( - Mandatory = $true - )] - [string]$File - ) - - # Make sure needed functions are available otherwise try to load them. - $commands = 'Write-HTMLLog', 'Stop-Script', 'Format-Size' - foreach ($commandName in $commands) { - if (!($command = Get-Command $commandName -ErrorAction SilentlyContinue)) { - Try { - . $PSScriptRoot\$commandName.ps1 - Write-Host "$commandName Function loaded." -ForegroundColor Green - } Catch { - Write-Error -Message "Failed to import $commandName function: $_" - exit 1 - } - } - } - - # Start - if ($File -ne '*.*') { - $options = @('/R:1', '/W:1', '/J', '/NP', '/NP', '/NJH', '/NFL', '/NDL', '/MT8') - } elseif ($File -eq '*.*') { - $options = @('/R:1', '/W:1', '/E', '/J', '/NP', '/NJH', '/NFL', '/NDL', '/MT8') - } - - $cmdArgs = @("`"$Source`"", "`"$Destination`"", "`"$File`"", $options) - - # executing unrar command - Write-HTMLLog -Column1 'Starting:' -Column2 'Copy files' - try { - # executing Robocopy command - $Output = robocopy @cmdArgs - } catch { - Write-Host 'Exception:' $_.Exception.Message -ForegroundColor Red - Write-Host 'RoboCopy not found' -ForegroundColor Red - exit 1 - } - - - foreach ($line in $Output) { - switch -Regex ($line) { - # Dir metrics - '^\s+Dirs\s:\s*' { - # Example: Dirs : 35 0 0 0 0 0 - $dirs = $_.Replace('Dirs :', '').Trim() - # Now remove the white space between the values.' - $dirs = $dirs -split '\s+' - - # Assign the appropriate column to values. - $TotalDirs = $dirs[0] - $CopiedDirs = $dirs[1] - $FailedDirs = $dirs[4] - } - # File metrics - '^\s+Files\s:\s[^*]' { - # Example: Files : 8318 0 8318 0 0 0 - $files = $_.Replace('Files :', '').Trim() - # Now remove the white space between the values.' - $files = $files -split '\s+' - - # Assign the appropriate column to values. - $TotalFiles = $files[0] - $CopiedFiles = $files[1] - $FailedFiles = $files[4] - } - # Byte metrics - '^\s+Bytes\s:\s*' { - # Example: Bytes : 1.607 g 0 1.607 g 0 0 0 - $bytes = $_.Replace('Bytes :', '').Trim() - # Now remove the white space between the values.' - $bytes = $bytes -split '\s+' - - # The raw text from the log file contains a k,m,or g after the non zero numbers. - # This will be used as a multiplier to determine the size in kb. - $counter = 0 - $tempByteArray = 0, 0, 0, 0, 0, 0 - $tempByteArrayCounter = 0 - foreach ($column in $bytes) { - if ($column -eq 'k') { - $tempByteArray[$tempByteArrayCounter - 1] = '{0:N2}' -f ([single]($bytes[$counter - 1]) * 1024) - $counter += 1 - } elseif ($column -eq 'm') { - $tempByteArray[$tempByteArrayCounter - 1] = '{0:N2}' -f ([single]($bytes[$counter - 1]) * 1048576) - $counter += 1 - } elseif ($column -eq 'g') { - $tempByteArray[$tempByteArrayCounter - 1] = '{0:N2}' -f ([single]($bytes[$counter - 1]) * 1073741824) - $counter += 1 - } else { - $tempByteArray[$tempByteArrayCounter] = $column - $counter += 1 - $tempByteArrayCounter += 1 - } - } - # Assign the appropriate column to values. - $TotalSize = Format-Size -SizeInBytes ([double]::Parse($tempByteArray[0])) - $CopiedSize = Format-Size -SizeInBytes ([double]::Parse($tempByteArray[1])) - $FailedSize = Format-Size -SizeInBytes ([double]::Parse($tempByteArray[4])) - # array columns 2,3, and 5 are available, but not being used currently. - } - # Speed metrics - '^\s+Speed\s:.*sec.$' { - # Example: Speed : 120.816 Bytes/min. - $speed = $_.Replace('Speed :', '').Trim() - $speed = $speed.Replace('Bytes/sec.', '').Trim() - # Remove any dots in the number - $speed = $speed.Replace('.', '').Trim() - # Assign the appropriate column to values. - $speed = Format-Size -SizeInBytes $speed - } - } - } - - - if ($FailedDirs -gt 0 -or $FailedFiles -gt 0) { - Write-HTMLLog -Column1 'Dirs' -Column2 "$TotalDirs Total" -ColorBg 'Error' - Write-HTMLLog -Column1 'Dirs' -Column2 "$FailedDirs Failed" -ColorBg 'Error' - Write-HTMLLog -Column1 'Files:' -Column2 "$TotalFiles Total" -ColorBg 'Error' - Write-HTMLLog -Column1 'Files:' -Column2 "$FailedFiles Failed" -ColorBg 'Error' - Write-HTMLLog -Column1 'Size:' -Column2 "$TotalSize Total" -ColorBg 'Error' - Write-HTMLLog -Column1 'Size:' -Column2 "$FailedSize Failed" -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' - Stop-Script -ExitReason "Copy Error: $DownloadLabel - $DownloadName" - } else { - Write-HTMLLog -Column1 'Dirs:' -Column2 "$CopiedDirs Copied" - Write-HTMLLog -Column1 'Files:' -Column2 "$CopiedFiles Copied" - Write-HTMLLog -Column1 'Size:' -Column2 "$CopiedSize" - Write-HTMLLog -Column1 'Throughput:' -Column2 "$Speed/s" - Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' - } -} \ No newline at end of file diff --git a/functions/Start-SubEdit.ps1 b/functions/Start-SubEdit.ps1 deleted file mode 100644 index 44075e3..0000000 --- a/functions/Start-SubEdit.ps1 +++ /dev/null @@ -1,70 +0,0 @@ -function Start-SubEdit { - <# - .SYNOPSIS - Start Subtitle Edit - - .DESCRIPTION - Start Subtitle Edit to clean up subtitles - - .PARAMETER Source - Path to process and clean subtitles - - .PARAMETER Files - The files to process, this will be *.srt typically - - .EXAMPLE - Start-SubEdit -File '*.srt' -Source 'C:\Temp\Episode' - - .NOTES - General notes - #> - [CmdletBinding()] - param ( - [Parameter( - Mandatory = $true - )] - [string]$Source, - - [Parameter( - Mandatory = $true - )] - [string]$Files - ) - - # Make sure needed functions are available otherwise try to load them. - $commands = 'Write-HTMLLog' - foreach ($commandName in $commands) { - if (!($command = Get-Command $commandName -ErrorAction SilentlyContinue)) { - Try { - . $PSScriptRoot\$commandName.ps1 - Write-Host "$commandName Function loaded." -ForegroundColor Green - } Catch { - Write-Error -Message "Failed to import $commandName function: $_" - exit 1 - } - } - } - # Start - - Write-HTMLLog -Column1 '*** Clean up Subtitles ***' -Header - $StartInfo = New-Object System.Diagnostics.ProcessStartInfo - $StartInfo.FileName = $SubtitleEditPath - $StartInfo.RedirectStandardError = $true - $StartInfo.RedirectStandardOutput = $true - $StartInfo.UseShellExecute = $false - $StartInfo.Arguments = @('/convert', "$Files", 'subrip', "/inputfolder`:`"$Source`"", '/overwrite', '/MergeSameTexts', '/fixcommonerrors', '/removetextforhi', '/fixcommonerrors', '/fixcommonerrors') - $Process = New-Object System.Diagnostics.Process - $Process.StartInfo = $StartInfo - $Process.Start() | Out-Null - $stdout = $Process.StandardOutput.ReadToEnd() - $stderr = $Process.StandardError.ReadToEnd() - $Process.WaitForExit() - if ($Process.ExitCode -gt 1) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'Error:' -Column2 $stderr -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' - Stop-Script -ExitReason "SubEdit Error: $DownloadLabel - $DownloadName" - } else { - Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' - } -} \ No newline at end of file diff --git a/functions/Start-Subliminal.ps1 b/functions/Start-Subliminal.ps1 deleted file mode 100644 index 42190d6..0000000 --- a/functions/Start-Subliminal.ps1 +++ /dev/null @@ -1,87 +0,0 @@ -function Start-Subliminal { - <# - .SYNOPSIS - Start Subliminal to download subs - - .DESCRIPTION - Start Subliminal to download needed subtitles - - .PARAMETER Source - Path to files that need subtitles - - .EXAMPLE - Start-Subliminal -Source 'C:\Temp\Episode' - - .NOTES - General notes - #> - [CmdletBinding()] - param ( - [Parameter( - Mandatory = $true - )] - [string]$Source - ) - - # Make sure needed functions are available otherwise try to load them. - $commands = 'Write-HTMLLog' - foreach ($commandName in $commands) { - if (!($command = Get-Command $commandName -ErrorAction SilentlyContinue)) { - Try { - . $PSScriptRoot\$commandName.ps1 - Write-Host "$commandName Function loaded." -ForegroundColor Green - } Catch { - Write-Error -Message "Failed to import $commandName function: $_" - exit 1 - } - } - } - # Start - - Write-HTMLLog -Column1 '*** Download missing Subtitles ***' -Header - $StartInfo = New-Object System.Diagnostics.ProcessStartInfo - $StartInfo.FileName = $SubliminalPath - $StartInfo.RedirectStandardError = $true - $StartInfo.RedirectStandardOutput = $true - $StartInfo.UseShellExecute = $false - $StartInfo.Arguments = @('--opensubtitles', $OpenSubUser, $OpenSubPass, "--omdb $omdbAPI", 'download', '-r omdb', '-p opensubtitles', '-l eng', '-l nld', "`"$Source`"") - $Process = New-Object System.Diagnostics.Process - $Process.StartInfo = $StartInfo - $Process.Start() | Out-Null - $stdout = $Process.StandardOutput.ReadToEnd() - $stderr = $Process.StandardError.ReadToEnd() - $Process.WaitForExit() - # Write-Host $stdout - # Write-Host $stderr - if ($stdout -match '(\d+)(?=\s*video collected)') { - $VideoCollected = $Matches.0 - } - if ($stdout -match '(\d+)(?=\s*video ignored)') { - $VideoIgnored = $Matches.0 - } - if ($stdout -match '(\d+)(?=\s*error)') { - $VideoError = $Matches.0 - } - if ($stdout -match '(\d+)(?=\s*subtitle)') { - $SubsDownloaded = $Matches.0 - } - if ($stdout -match 'Some providers have been discarded due to unexpected errors') { - $SubliminalExitCode = 1 - } - if ($SubliminalExitCode -gt 0) { - Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' - Write-HTMLLog -Column1 'Error:' -Column2 $stderr -ColorBg 'Error' - Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' - } else { - if ($SubsDownloaded -gt 0) { - # Write-HTMLLog -Column1 "Downloaded:" -Column2 "$SubsDownloaded Subtitles" - Write-HTMLLog -Column1 'Collected:' -Column2 "$VideoCollected Videos" - Write-HTMLLog -Column1 'Ignored:' -Column2 "$VideoIgnored Videos" - Write-HTMLLog -Column1 'Error:' -Column2 "$VideoError Videos" - Write-HTMLLog -Column1 'Downloaded:' -Column2 "$SubsDownloaded Subtitles" - Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' - } else { - Write-HTMLLog -Column1 'Result:' -Column2 'No subs downloaded with Subliminal' - } - } -} \ No newline at end of file diff --git a/functions/Start-SubtitleEdit.ps1 b/functions/Start-SubtitleEdit.ps1 new file mode 100644 index 0000000..bc6672c --- /dev/null +++ b/functions/Start-SubtitleEdit.ps1 @@ -0,0 +1,114 @@ +<# +.SYNOPSIS + Starts Subtitle Edit to clean up subtitles. +.DESCRIPTION + This function initiates Subtitle Edit, a free and open-source subtitle editor, + to clean up subtitles for specified files. +.PARAMETER Source + Specifies the source directory of the subtitle files. +.PARAMETER Files + Specifies the file or wildcard pattern for subtitle files to process. +.PARAMETER SubtitleEditPath + Specifies the path to the Subtitle Edit executable. +.PARAMETER DownloadLabel + Specifies the label associated with the download. +.PARAMETER DownloadName + Specifies the name of the downloaded content. +.OUTPUTS +None. +.EXAMPLE + Start-SubtitleEdit -Source "C:\Subtitles" -Files "*.srt" -SubtitleEditPath "C:\SubtitleEdit.exe" -DownloadLabel "TV" -DownloadName "Episode1" + # Initiates Subtitle Edit to clean up subtitles for TV Episode1. +.EXAMPLE + Start-SubtitleEdit -Source "C:\Movies" -Files "*.sub" -SubtitleEditPath "C:\SubtitleEdit.exe" -DownloadLabel "Movie" -DownloadName "FilmA" + # Initiates Subtitle Edit to clean up subtitles for Movie FilmA. +#> +function Start-SubtitleEdit { + + [CmdletBinding()] + param ( + [Parameter(Mandatory = $true)] + [string]$Source, + + [Parameter(Mandatory = $true)] + [string]$Files, + + [Parameter(Mandatory = $true)] + [string]$SubtitleEditPath, + + [Parameter(Mandatory = $true)] + [string]$DownloadLabel, + + [Parameter(Mandatory = $true)] + [string]$DownloadName + ) + + # Make sure needed functions are available otherwise try to load them. + $functionsToLoad = @('Write-HTMLLog') + foreach ($functionName in $functionsToLoad) { + if (-not (Get-Command $functionName -ErrorAction SilentlyContinue)) { + try { + . "$PSScriptRoot\$functionName.ps1" + Write-Host "$functionName function loaded." -ForegroundColor Green + } catch { + Write-Error "Failed to import $functionName function: $_" + exit 1 + } + } + } + # Start + + Write-HTMLLog -Column1 '*** Clean up Subtitles ***' -Header + $StartInfo = New-Object System.Diagnostics.ProcessStartInfo + $StartInfo.FileName = $SubtitleEditPath + $StartInfo.RedirectStandardError = $true + $StartInfo.RedirectStandardOutput = $true + $StartInfo.UseShellExecute = $false + $StartInfo.Arguments = @('/convert', "$Files", 'subrip', "/inputfolder`:`"$Source`"", '/overwrite', '/MergeSameTexts', '/fixcommonerrors', '/removetextforhi', '/fixcommonerrors', '/fixcommonerrors') + $Process = New-Object System.Diagnostics.Process + $Process.StartInfo = $StartInfo + $Process.Start() | Out-Null + $stdout = $Process.StandardOutput.ReadToEnd() + # $stderr = $Process.StandardError.ReadToEnd() + $Process.WaitForExit() + + # Regular expressions to extract information + $versionRegex = "Subtitle Edit (\d+\.\d+\.\d+)" + $filesConvertedRegex = "(\d+) file\(s\) converted" + $timeTakenRegex = "(\d+:\d+:\d+\.\d+)" + + # Extract information using regular expressions + $matchResult = $stdout -match $versionRegex + if ($matchResult) { + $version = $matches[1] + } + + $matchResult = $stdout -match $filesConvertedRegex + if ($matchResult) { + $filesConverted = $matches[1] + } + + $matchResult = $stdout -match $timeTakenRegex + if ($matchResult) { + $timeTaken = $matches[1] + # Convert the string to a TimeSpan object + $timeSpan = [TimeSpan]::Parse($timeTaken) + # Format the TimeSpan object as a string in a user-friendly way + $userFriendlyTime = $timeSpan.ToString("hh\:mm\:ss") + } + + switch ($process.ExitCode) { + 0 { + Write-HTMLLog -Column1 'SubtitleEdit:' -Column2 "V $version" + Write-HTMLLog -Column1 'Subtitles:' -Column2 "$filesConverted Converted" + Write-HTMLLog -Column1 'Time Taken:' -Column2 $userFriendlyTime + Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' + } + default { + Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' + Write-HTMLLog -Column1 'Error:' -Column2 $stdout -ColorBg 'Error' + Write-HTMLLog -Column1 'Result:' -Column2 'Failed' -ColorBg 'Error' + Stop-Script -ExitReason "SubEdit Error: $DownloadLabel - $DownloadName" + } + } +} \ No newline at end of file diff --git a/functions/Start-UnRar.ps1 b/functions/Start-UnRar.ps1 index 3fdb22e..3e9b445 100644 --- a/functions/Start-UnRar.ps1 +++ b/functions/Start-UnRar.ps1 @@ -1,38 +1,48 @@ +<# +.SYNOPSIS + Start-UnRar function extracts RAR files using WinRAR. +.DESCRIPTION + This function extracts RAR files specified by the UnRarSourcePath to the UnRarTargetPath. + It logs the extraction process, handles errors, and stops the script if extraction fails. +.PARAMETER UnRarSourcePath + Specifies the path of the RAR file to be extracted. +.PARAMETER UnRarTargetPath + Specifies the target path where the contents of the RAR file will be extracted. +.PARAMETER DownloadLabel + Specifies the label associated with the download. +.PARAMETER DownloadName + Specifies the name of the download. +.OUTPUTS + Outputs the result of the extraction process. +.EXAMPLE + Start-UnRar -UnRarSourcePath "C:\Downloads\File.rar" -UnRarTargetPath "C:\Extracted" -DownloadLabel "TV" -DownloadName "Show1" + # Extracts File.rar to C:\Extracted and logs the process. +#> function Start-UnRar { - <# - .SYNOPSIS - Unrar file - .DESCRIPTION - Takes rar file and unrar them to target - .PARAMETER UnRarSourcePath - Path of rar file to extract - .PARAMETER UnRarTargetPath - Destination folder path - .EXAMPLE - Start-UnRar -UnRarSourcePath 'C:\Temp\Source\file.rar' -UnRarTargetPath 'C:\Temp\Destination' - #> [CmdletBinding()] Param( - [Parameter( - Mandatory = $true - )] + [Parameter(Mandatory = $true)] [string]$UnRarSourcePath, - [Parameter( - Mandatory = $true - )] - [string]$UnRarTargetPath + [Parameter(Mandatory = $true)] + [string]$UnRarTargetPath, + + [Parameter(Mandatory = $true)] + [string]$DownloadLabel, + + [Parameter(Mandatory = $true)] + [string]$DownloadName ) # Make sure needed functions are available otherwise try to load them. - $commands = 'Write-HTMLLog', 'Stop-Script' - foreach ($commandName in $commands) { - if (!($command = Get-Command $commandName -ErrorAction SilentlyContinue)) { - Try { - . $PSScriptRoot\$commandName.ps1 - Write-Host "$commandName Function loaded." -ForegroundColor Green - } Catch { - Write-Error -Message "Failed to import $commandName function: $_" + $functionsToLoad = @('Write-HTMLLog', 'Stop-Script') + foreach ($functionName in $functionsToLoad) { + if (-not (Get-Command $functionName -ErrorAction SilentlyContinue)) { + try { + . "$PSScriptRoot\$functionName.ps1" + Write-Host "$functionName function loaded." -ForegroundColor Green + } catch { + Write-Error "Failed to import $functionName function: $_" exit 1 } } @@ -51,10 +61,9 @@ function Start-UnRar { $Process = New-Object System.Diagnostics.Process $Process.StartInfo = $StartInfo $Process.Start() | Out-Null - # $stdout = $Process.StandardOutput.ReadToEnd() + $stdout = $Process.StandardOutput.ReadToEnd() $stderr = $Process.StandardError.ReadToEnd() - # Write-Host "stdout: $stdout" - # Write-Host "stderr: $stderr" + $Process.WaitForExit() if ($Process.ExitCode -gt 0) { Write-HTMLLog -Column1 'Exit Code:' -Column2 $($Process.ExitCode) -ColorBg 'Error' diff --git a/functions/Stop-Script.ps1 b/functions/Stop-Script.ps1 index 8c8d8dc..9b42319 100644 --- a/functions/Stop-Script.ps1 +++ b/functions/Stop-Script.ps1 @@ -1,17 +1,18 @@ +<# +.SYNOPSIS + Stop-Script function stops the script execution, logs the execution time, and sends an email notification. +.DESCRIPTION + This function is designed to stop script execution, record the execution time, and send an email notification. +.PARAMETER ExitReason + Mandatory parameter specifying the reason for stopping the script. +.EXAMPLE + Stop-Script -ExitReason "Script completed successfully" + Stops the script, logs execution time, and sends an email with the specified exit reason. +.NOTES + This functions relies heavily on variables that have been set in the main script, + they are not passed as parameters to this functions +#> function Stop-Script { - <# - .SYNOPSIS - Stops the script, removes Mutex and send log file. - - .DESCRIPTION - Stops the script and removes the Mutex. - - .PARAMETER ExitReason - Reason for exit. - - .EXAMPLE - Stop-Script -ExitReason "Script completed successfully." - #> [CmdletBinding()] Param( [Parameter(Mandatory = $true)] @@ -19,14 +20,14 @@ function Stop-Script { ) # Make sure needed functions are available otherwise try to load them. - $commands = 'Write-HTMLLog', 'Send-HtmlMail', 'Remove-Mutex' - foreach ($commandName in $commands) { - if (!($command = Get-Command $commandName -ErrorAction SilentlyContinue)) { - Try { - . $PSScriptRoot\$commandName.ps1 - Write-Host "$commandName Function loaded." -ForegroundColor Green - } Catch { - Write-Error -Message "Failed to import $commandName function: $_" + $functionsToLoad = @('Write-HTMLLog', 'Send-HtmlMail', 'Remove-Mutex') + foreach ($functionName in $functionsToLoad) { + if (-not (Get-Command $functionName -ErrorAction SilentlyContinue)) { + try { + . "$PSScriptRoot\$functionName.ps1" + Write-Host "$functionName function loaded." -ForegroundColor Green + } catch { + Write-Error "Failed to import $functionName function: $_" exit 1 } } @@ -34,10 +35,10 @@ function Stop-Script { # Start # Stop the Stopwatch - $StopWatch.Stop() + $ScriptTimer.Stop() - Write-HTMLLog -Column1 '*** Script Exection time ***' -Header - Write-HTMLLog -Column1 'Time Taken:' -Column2 $($StopWatch.Elapsed.ToString('mm\:ss')) + Write-HTMLLog -Column1 '*** Script Execution time ***' -Header + Write-HTMLLog -Column1 'Time Taken:' -Column2 $($ScriptTimer.Elapsed.ToString('mm\:ss')) Format-Table Write-Log -LogFile $LogFilePath diff --git a/functions/Test-Variable-Path.ps1 b/functions/Test-Variable-Path.ps1 index e89cdc0..72aae61 100644 --- a/functions/Test-Variable-Path.ps1 +++ b/functions/Test-Variable-Path.ps1 @@ -1,29 +1,36 @@ -function Test-Variable-Path { - <# - .SYNOPSIS - Test path to variables - - .DESCRIPTION - Test path to - - .PARAMETER Path - File path to test if exist - - .EXAMPLE +<# +.SYNOPSIS + Test path to variables. +.DESCRIPTION + This function tests the existence of a specified file path. +.PARAMETER Path + Specifies the file path to be tested for existence. +.INPUTS + Accepts a string representing the file path to be tested. +.EXAMPLE Test-Variable-Path -Path 'c:\Windows\notepad.exe' - - .NOTES - General notes - #> + # Checks if the specified file path exists. +#> +function Test-Variable-Path { [CmdletBinding()] param ( - [Parameter(Mandatory = $true)] + [Parameter( + Mandatory = $false, + ValueFromPipeline = $true + )] [string]$Path ) + + if ([string]::IsNullOrWhiteSpace($Path)) { + Write-Host "Path cannot be empty or null." -ForegroundColor Red + Write-Host 'Will now exit!' -ForegroundColor Red + Exit 1 + } + if (!(Test-Path -LiteralPath $Path)) { Write-Host "Cannot find: $Path" -ForegroundColor Red Write-Host "As defined in config" -ForegroundColor Red Write-Host 'Will now exit!' -ForegroundColor Red Exit 1 } -} \ No newline at end of file +} diff --git a/functions/Write-HTMLLog.ps1 b/functions/Write-HTMLLog.ps1 index 981dd84..1b14c56 100644 --- a/functions/Write-HTMLLog.ps1 +++ b/functions/Write-HTMLLog.ps1 @@ -1,26 +1,20 @@ -function Format-Table { - <# - .SYNOPSIS +<# +.SYNOPSIS Starts and stops Log file - - .DESCRIPTION - Will either initiate the Log Variable in memory and open the HTML Table or clos the table - - .PARAMETER Start +.DESCRIPTION + Will either initiate the Log Variable in memory and open the HTML Table or closes the table +.PARAMETER Start If defined indicated to open the HTML Table, without it the HTML table will be closed - - .EXAMPLE +.EXAMPLE Format-Table -Start Format-Table - - .NOTES +.NOTES General notes - #> +#> +function Format-Table { [CmdletBinding()] param ( - [Parameter( - Mandatory = $false - )] + [Parameter(Mandatory = $false)] [switch]$Start ) @@ -38,61 +32,44 @@ function Format-Table { } } -Function Write-HTMLLog { - <# - .SYNOPSIS +<# +.SYNOPSIS Add line to in memory log - - .DESCRIPTION - Adds a line to the in memory log file and based on the parameters will do formating - - .PARAMETER Column1 - Text to be put in first column, mandatory - - .PARAMETER Column2 +.DESCRIPTION + Adds a line to the in memory log file and based on the parameters will do formatting +.PARAMETER Column1 + Text to be put in first column, not mandatory +.PARAMETER Column2 Text to be put in the second column, not mandatory - - .PARAMETER Header +.PARAMETER Header Define that the Text from the parameter Column1 should be treated as new Header in the log table. If switch is defined Column2 is ignored - - .PARAMETER ColorBg +.PARAMETER ColorBg Background color of Table Cell, this is a switch indicating a Success or Error. If not defined the standard color will be used. - Success will get Green Table Cell color Error will get Red Table Cell Color - - .EXAMPLE +.EXAMPLE Write-HTMLLog -Column1 '*** Header of the table ***' -Header Write-HTMLLog -Column1 'Column1 Text' -Column2 'Column2 Text' Write-HTMLLog -Column1 'Exit Code:' -Column2 'Failed to do X' -ColorBg 'Error' Write-HTMLLog -Column1 'Result:' -Column2 'Successful' -ColorBg 'Success' - - .NOTES - General notes - #> +#> +Function Write-HTMLLog { [CmdletBinding()] Param( - [Parameter( - Mandatory = $true - )] + [Parameter(Mandatory = $false)] [string]$Column1, - [Parameter( - Mandatory = $false - )] + [Parameter(Mandatory = $false)] [string]$Column2, - [Parameter( - Mandatory = $false - )] + [Parameter(Mandatory = $false)] [switch]$Header, - [Parameter( - Mandatory = $false - )] + [Parameter(Mandatory = $false)] [ValidateSet( - 'Success', 'Error' + 'Success', + 'Error' )] [string]$ColorBg ) @@ -115,32 +92,28 @@ Function Write-HTMLLog { $global:Log += '' } } - Write-Output "$Column1 $Column2" + if ($Column1 -eq "") { + <# Action to perform if the condition is true #> + } + Write-Host $(($Column1, $Column2 | Where-Object { $_ }) -join ' ') + # Write-Host "$Column1 $Column2" } -function Write-Log { - <# - .SYNOPSIS +<# +.SYNOPSIS Write log to disk - - .DESCRIPTION +.DESCRIPTION Takes the Global Variable that hold the log in memory and writes it to disk - - .PARAMETER LogFile +.PARAMETER LogFile Log File including the Path to write - - .EXAMPLE +.EXAMPLE Write-Log -LogFile 'C:\Temp\logfile.html' - - .NOTES - General notes - #> +#> +function Write-Log { [CmdletBinding()] param ( - [Parameter( - Mandatory = $true - )] + [Parameter(Mandatory = $true)] [string]$LogFile ) Set-Content -LiteralPath $LogFile -Value $global:Log