Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ConvertTo-ExcelXlsx] Accept a collection of paths #1605

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[ConvertTo-ExcelXlsx] Accept a collection of paths #1605

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
66c0fee
Prevent error: "Unable to get the SaveAs property of the Workbook class"
edwardmiller-mesirow May 21, 2024
88a3aac
accept a collection of paths
edwardmiller-mesirow May 21, 2024
b6034c3
use ChangeExtension for robustness
edwardmiller-mesirow May 21, 2024
37cd733
optionally cache to temp file to avoid locking issues
edwardmiller-mesirow May 22, 2024
34c30eb
allow configuring cache directory
edwardmiller-mesirow May 22, 2024
5096aa2
add helpful hint for users who experience errors
edwardmiller-mesirow Jun 21, 2024
4e499ab
allow setting just -CacheToDirectory for clarity
edwardmiller-mesirow Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 102 additions & 41 deletions Public/ConvertTo-ExcelXlsx.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,60 +3,121 @@ function ConvertTo-ExcelXlsx {
param
(
[parameter(Mandatory = $true, ValueFromPipeline)]
[string]$Path,
[string[]]$Path,
[parameter(Mandatory = $false)]
[switch]$Force
[switch]$Force,
[parameter(Mandatory = $false)]
[switch]$CacheToTemp,
[parameter(Mandatory = $false)]
[string]$CacheToDirectory
)
process {
if (-Not ($Path | Test-Path) ) {
throw "File not found"
}
if (-Not ($Path | Test-Path -PathType Leaf) ) {
throw "Folder paths are not allowed"
}
try {

$xlFixedFormat = 51 #Constant for XLSX Workbook
$xlsFile = Get-Item -Path $Path
$xlsxPath = "{0}x" -f $xlsFile.FullName
if ($CacheToTemp -and $CacheToDirectory) {
throw "Cannot specify both -CacheToTemp and -CacheToDirectory. Please choose one or the other."
}

if ($xlsFile.Extension -ne ".xls") {
throw "Expected .xls extension"
}
if ($CacheToTemp) {
$CacheToDirectory = [System.IO.Path]::GetTempPath()
}

if (Test-Path -Path $xlsxPath) {
if ($Force) {
try {
Remove-Item $xlsxPath -Force
}
catch {
throw "{0} already exists and cannot be removed. The file may be locked by another application." -f $xlsxPath
if ($CacheToDirectory) {
if (-not (Test-Path -Path $CacheToDirectory -PathType Container)) {
throw "CacheToDirectory path does not exist or is not writeable"
}
Write-Verbose $("Removed {0}" -f $xlsxPath)
}
else {
throw "{0} already exists!" -f $xlsxPath
}
}

try {
$Excel = New-Object -ComObject "Excel.Application"
}
catch {
throw "Could not create Excel.Application ComObject. Please verify that Excel is installed."
}
foreach ($singlePath in $Path) {
if (-Not ($singlePath | Test-Path) ) {
throw "File not found"
}
if (-Not ($singlePath | Test-Path -PathType Leaf) ) {
throw "Folder paths are not allowed"
}

$xlFixedFormat = 51 #Constant for XLSX Workbook
$xlsFile = Get-Item -Path $singlePath
$destinationXlsxPath = [System.IO.Path]::ChangeExtension($xlsFile.FullName, ".xlsx")

try {
$Excel.Visible = $false
$null = $Excel.Workbooks.Open($xlsFile.FullName, $null, $true)
$Excel.ActiveWorkbook.SaveAs($xlsxPath, $xlFixedFormat)
if ($xlsFile.Extension -ne ".xls") {
throw "Expected .xls extension"
}

if (Test-Path -Path $destinationXlsxPath) {
if ($Force) {
try {
Remove-Item $destinationXlsxPath -Force
}
catch {
throw "{0} already exists and cannot be removed. The file may be locked by another application." -f $destinationXlsxPath
}
Write-Verbose $("Removed {0}" -f $destinationXlsxPath)
}
else {
throw "{0} already exists!" -f $destinationXlsxPath
}
}

if ($null -eq $Excel)
{
try {
$Excel = New-Object -ComObject "Excel.Application"
}
catch {
throw "Could not create Excel.Application ComObject. Please verify that Excel is installed."
}
}

if ($CacheToDirectory) {
$tempPath = [System.IO.Path]::Combine($CacheToDirectory, [System.IO.Path]::GetFileName($xlsFile.FullName))
Write-Host ("Using Temp path: {0}" -f $tempPath)
Copy-Item -Path $xlsFile.FullName -Destination $tempPath -Force
$fileToProcess = $tempPath
}
else {
$fileToProcess = $xlsFile.FullName
}

$xlsxPath = [System.IO.Path]::ChangeExtension($fileToProcess, ".xlsx")

try {
$Excel.Visible = $false
$workbook = $Excel.Workbooks.Open($fileToProcess, $null, $true)
if ($null -eq $workbook) {
Write-Host "Failed to open workbook"
} else {
$workbook.SaveAs($xlsxPath, $xlFixedFormat)

if ($CacheToDirectory) {
Copy-Item -Path $xlsxPath -Destination $destinationXlsxPath -Force
}
}
}
catch {
Write-Error ("Failed to convert {0} to XLSX. To avoid network issues or locking issues, you could try the -CacheToTemp or -CacheToDirectory parameter." -f $xlsFile.FullName)
throw
}
finally {
if ($null -ne $workbook) {
$workbook.Close()
[System.Runtime.InteropServices.Marshal]::ReleaseComObject($workbook) | Out-Null
$workbook = $null
}

if ($CacheToDirectory) {
Remove-Item -Path $tempPath -Force
Remove-Item -Path $xlsxPath -Force
}
}
}
}
finally {
if ($null -ne $Excel.ActiveWorkbook) {
$Excel.ActiveWorkbook.Close()
if ($null -ne $Excel) {
$Excel.Quit()
[System.Runtime.InteropServices.Marshal]::ReleaseComObject($Excel) | Out-Null
$Excel = $null
}

$Excel.Quit()
}
}
}