Fonts.psm1
|
[Cmdletbinding()] param() $scriptName = $MyInvocation.MyCommand.Name Write-Verbose "[$scriptName] Importing subcomponents" #region - Data import Write-Verbose "[$scriptName] - [data] - Processing folder" $dataFolder = (Join-Path $PSScriptRoot 'data') Write-Verbose "[$scriptName] - [data] - [$dataFolder]" Get-ChildItem -Path "$dataFolder" -Recurse -Force -Include '*.psd1' -ErrorAction SilentlyContinue | ForEach-Object { Write-Verbose "[$scriptName] - [data] - [$($_.Name)] - Importing" New-Variable -Name $_.BaseName -Value (Import-PowerShellDataFile -Path $_.FullName) -Force Write-Verbose "[$scriptName] - [data] - [$($_.Name)] - Done" } Write-Verbose "[$scriptName] - [data] - Done" #endregion - Data import #region - From private Write-Verbose "[$scriptName] - [private] - Processing folder" #region - From private/common.ps1 Write-Verbose "[$scriptName] - [private/common.ps1] - Importing" $script:fontRegPath = @{ CurrentUser = 'HKCU:\Software\Microsoft\Windows NT\CurrentVersion\Fonts' AllUsers = 'HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Fonts' } $script:fontFolderPath = @{ CurrentUser = "$env:LOCALAPPDATA\Microsoft\Windows\Fonts" AllUsers = "$($env:windir)\Fonts" } Write-Verbose "[$scriptName] - [private/common.ps1] - Done" #endregion - From private/common.ps1 Write-Verbose "[$scriptName] - [private] - Done" #endregion - From private #region - From public Write-Verbose "[$scriptName] - [public] - Processing folder" #region - From public/Get-Font.ps1 Write-Verbose "[$scriptName] - [public/Get-Font.ps1] - Importing" function Get-Font { <# .SYNOPSIS Retrieves the installed fonts. .DESCRIPTION Retrieves the installed fonts. .EXAMPLE Get-Font Gets all the fonts installed for the current user. .EXAMPLE Get-Font -Name 'Arial*' Gets all the fonts installed for the current user that start with 'Arial'. .EXAMPLE Get-Font -Scope 'AllUsers' Gets all the fonts installed for all users. .EXAMPLE Get-Font -Name 'Calibri' -Scope 'AllUsers' Gets the font with the name 'Calibri' for all users. .OUTPUTS System.Management.Automation.PSCustomObject[] #> [OutputType([pscustomobject[]])] [CmdletBinding()] param( # Specifies the name of the font to get. [Parameter( ValueFromPipeline, ValueFromPipelineByPropertyName )] [SupportsWildcards()] [string[]] $Name = '*', # Specifies the scope of the font(s) to get. [Parameter( ValueFromPipeline, ValueFromPipelineByPropertyName )] [Alias('ConfigScope')] [System.Management.Automation.Configuration.ConfigScope[]] $Scope = 'CurrentUser' ) begin { $functionName = $MyInvocation.MyCommand.Name Write-Verbose "[$functionName]" $fonts = @() #TODO: [Collections.Generic.List[PSCustomObject]]::new() } process { $scopeCount = $Scope.Count Write-Verbose "[$functionName] - Processing [$scopeCount] scope(s)" foreach ($ScopeItem in $Scope) { $scopeName = $ScopeItem.ToString() Write-Verbose "[$functionName] - [$scopeName] - Getting font(s)" $fontRegistryPath = $script:fontRegPath[$scopeName] $registeredFonts = (Get-ItemProperty -Path $fontRegistryPath).PSObject.Properties | Where-Object { $_.Name -notlike 'PS*' } # Remove PS* properties $registeredFontsCount = $($registeredFonts.Count) Write-Verbose "[$functionName] - [$scopeName] - Filtering from [$registeredFontsCount] font(s)" $nameCount = $Name.Count Write-Verbose "[$functionName] - [$scopeName] - Filtering based on [$nameCount] name pattern(s)" foreach ($fontFilter in $Name) { Write-Verbose "[$functionName] - [$scopeName] - [$fontFilter] - Filtering font(s)" $filteredFonts = $registeredFonts | Where-Object { $_.Name -like $fontFilter } foreach ($fontItem in $filteredFonts) { $fontName = $fontItem.Name $fontPath = $Scope -eq 'AllUsers' ? (Join-Path "$($env:windir)\Fonts" $fontItem.Value) : $fontItem.Value $fontScope = $scopeName Write-Verbose "[$functionName] - [$scopeName] - [$fontFilter] - Found [$fontName] at [$fontPath]" #TODO: $fonts.Add() instead of += $fonts += [PSCustomObject]@{ Name = $fontName Path = $fontPath Scope = $fontScope } } Write-Verbose "[$functionName] - [$scopeName] - [$fontFilter] - Done" } Write-Verbose "[$functionName] - [$scopeName] - Done" } } end { Write-Verbose "[$functionName] - Done" return $fonts } } Write-Verbose "[$scriptName] - [public/Get-Font.ps1] - Done" #endregion - From public/Get-Font.ps1 #region - From public/Install-Font.ps1 Write-Verbose "[$scriptName] - [public/Install-Font.ps1] - Importing" #Requires -Modules Utilities function Install-Font { <# .SYNOPSIS Installs a font in the system .DESCRIPTION Installs a font in the system .EXAMPLE Install-Font -Path C:\FontFiles\Arial.ttf Installs the font file 'C:\FontFiles\Arial.ttf' to the current user profile. .EXAMPLE Install-Font -Path C:\FontFiles\Arial.ttf -Scope AllUsers Installs the font file 'C:\FontFiles\Arial.ttf' so it is available for all users. This requires administrator rights. .EXAMPLE Install-Font -Path C:\FontFiles\Arial.ttf -Force Installs the font file 'C:\FontFiles\Arial.ttf' to the current user profile. If the font already exists, it will be overwritten. .EXAMPLE Install-Font -Path C:\FontFiles\Arial.ttf -Scope AllUsers -Force Installs the font file 'C:\FontFiles\Arial.ttf' so it is available for all users. This requires administrator rights. If the font already exists, it will be overwritten. .EXAMPLE Get-ChildItem -Path C:\FontFiles\ -Filter *.ttf | Install-Font Gets all font files in the folder 'C:\FontFiles\' and installs them to the current user profile. .EXAMPLE Get-ChildItem -Path C:\FontFiles\ -Filter *.ttf | Install-Font -Scope AllUsers Gets all font files in the folder 'C:\FontFiles\' and installs them so it is available for all users. This requires administrator rights. .EXAMPLE Get-ChildItem -Path C:\FontFiles\ -Filter *.ttf | Install-Font -Force Gets all font files in the folder 'C:\FontFiles\' and installs them to the current user profile. If the font already exists, it will be overwritten. .EXAMPLE Get-ChildItem -Path C:\FontFiles\ -Filter *.ttf | Install-Font -Scope AllUsers -Force Gets all font files in the folder 'C:\FontFiles\' and installs them so it is available for all users. This requires administrator rights. If the font already exists, it will be overwritten. #> [CmdletBinding(SupportsShouldProcess)] param ( # File or folder path(s) to the font(s) to install. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [Alias('FullName')] [string[]] $Path, # Scope of the font installation. # CurrentUser will install the font for the current user only. # AllUsers will install the font so it is available for all users on the system. [Parameter( ValueFromPipeline, ValueFromPipelineByPropertyName )] [Alias('ConfigScope')] [System.Management.Automation.Configuration.ConfigScope[]] $Scope = 'CurrentUser', # Recurse will install all fonts in the specified folder and subfolders. [Parameter()] [switch] $Recurse, # Force will overwrite existing fonts [Parameter()] [switch] $Force ) begin { $functionName = $MyInvocation.MyCommand.Name Write-Verbose "[$functionName]" if ($Scope -contains 'AllUsers' -and -not (IsAdmin)) { throw "Administrator rights are required to install fonts in [$($script:fontFolderPath['AllUsers'])]. Please run the command again with elevated rights (Run as Administrator) or provide '-Scope CurrentUser' to your command." } $maxRetries = 10 $retryIntervalSeconds = 1 } process { $scopeCount = $Scope.Count Write-Verbose "[$functionName] - Processing [$scopeCount] scopes(s)" foreach ($scopeItem in $Scope) { $scopeName = $scopeItem.ToString() $fontDestinationFolderPath = $script:fontFolderPath[$scopeName] $fontDestinationRegPath = $script:fontRegPath[$scopeName] $pathCount = $Path.Count Write-Verbose "[$functionName] - [$scopeName] - Processing [$pathCount] path(s)" foreach ($PathItem in $Path) { Write-Verbose "[$functionName] - [$scopeName] - [$PathItem] - Processing" $pathExists = Test-Path -Path $PathItem if (-not $pathExists) { Write-Error "[$functionName] - [$scopeName] - [$PathItem] - Path not found, skipping." continue } $item = Get-Item -Path $PathItem -ErrorAction Stop if ($item.PSIsContainer) { Write-Verbose "[$functionName] - [$scopeName] - [$PathItem] - Folder found" Write-Verbose "[$functionName] - [$scopeName] - [$PathItem] - Gathering font(s) to install" $fontFiles = Get-ChildItem -Path $item.FullName -ErrorAction Stop -File -Recurse:$Recurse Write-Verbose "[$functionName] - [$scopeName] - [$PathItem] - Found [$($FontFiles.Count)] font file(s)" } else { Write-Verbose "[$functionName] - [$scopeName] - [$PathItem] - File found" $FontFiles = $Item } $shell = New-Object -ComObject Shell.Application foreach ($fontFile in $fontFiles) { $fontFileName = $fontFile.Name $fontFilePath = $fontFile.FullName Write-Verbose "[$functionName] - [$scopeName] - [$fontFilePath] - Processing" $fontFileDestinationPath = Join-Path $fontDestinationFolderPath $fontFileName $fontFileAlreadyInstalled = Test-Path -Path $fontFileDestinationPath if ($fontFileAlreadyInstalled) { if ($Force) { Write-Verbose "[$functionName] - [$scopeName] - [$fontFilePath] - Already installed. Forcing install." } else { Write-Verbose "[$functionName] - [$scopeName] - [$fontFilePath] - Already installed. Skipping." continue } } $fontType = switch ($FontFile.Extension) { '.ttf' { 'TrueType' } # TrueType Font '.otf' { 'OpenType' } # OpenType Font '.ttc' { 'TrueType' } # TrueType Font Collection '.pfb' { 'PostScript Type 1' } # PostScript Type 1 Font '.pfm' { 'PostScript Type 1' } # PostScript Type 1 Outline Font '.woff' { 'Web Open Font Format' } # Web Open Font Format '.woff2' { 'Web Open Font Format 2' } # Web Open Font Format 2 } if ($null -eq $fontType) { # Write-Warning "[$fontFileName] - Unknown font type. Skipping." continue } Write-Verbose "[$functionName] - [$scopeName] - [$fontFilePath] - Installing font" $shellFolder = $shell.Namespace($FontFile.Directory.FullName) $shellFile = $shellFolder.ParseName($fontFileName) $fontName = $shellFolder.GetDetailsOf($shellFile, 21) $retryCount = 0 $fileCopied = $false do { try { Copy-Item -Path $FontFile.FullName -Destination $fontFileDestinationPath -Force -ErrorAction Stop $fileCopied = $true } catch { $retryCount++ if (-not $fileRemoved -and $retryCount -eq $maxRetries) { Write-Error $_ Write-Error "[$functionName] - [$scopeName] - [$fontFilePath] - Installing font - Failed [$retryCount/$maxRetries] - Stopping" break } Write-Verbose "[$functionName] - [$scopeName] - [$fontFilePath] - Installing font - Failed [$retryCount/$maxRetries] - Retrying in $retryIntervalSeconds seconds..." Start-Sleep -Seconds $retryIntervalSeconds } } while (-not $fileCopied -and $retryCount -lt $maxRetries) if (-not $fileCopied) { continue } $registeredFontName = "$fontName ($fontType)" Write-Verbose "[$functionName] - [$scopeName] - [$fontFilePath] - Registering font as [$registeredFontName]" $regValue = 'AllUsers' -eq $Scope ? $fontFileName : $fontFileDestinationPath New-ItemProperty -Name $registeredFontName -Path $fontDestinationRegPath -PropertyType string -Value $regValue -Force -ErrorAction stop | Out-Null Write-Verbose "[$functionName] - [$scopeName] - [$fontFilePath] - Done" } Write-Verbose "[$functionName] - [$scopeName] - [$PathItem] - Done" } Write-Verbose "[$functionName] - [$scopeName] - Done" } } end { Write-Verbose "[$functionName] - Done" } } Write-Verbose "[$scriptName] - [public/Install-Font.ps1] - Done" #endregion - From public/Install-Font.ps1 #region - From public/Uninstall-Font.ps1 Write-Verbose "[$scriptName] - [public/Uninstall-Font.ps1] - Importing" #Requires -Modules Utilities function Uninstall-Font { <# .SYNOPSIS Uninstalls a font from the system. .DESCRIPTION Uninstalls a font from the system. .EXAMPLE Uninstall-Font -Name 'Courier New' Uninstalls the 'Courier New' font from the system for the current user. .EXAMPLE Uninstall-Font -Name 'Courier New' -Scope AllUsers Uninstalls the Courier New font from the system for all users. .OUTPUTS None #> [CmdletBinding()] param ( # Scope of the font to uninstall. # CurrentUser will uninstall the font for the current user. # AllUsers will uninstall the font so it is removed for all users. [Parameter( ValueFromPipeline, ValueFromPipelineByPropertyName )] [Alias('ConfigScope')] [System.Management.Automation.Configuration.ConfigScope[]] $Scope = 'CurrentUser' ) DynamicParam { $runtimeDefinedParameterDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary $attributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute] $parameterName = 'Name' $parameterAliases = @('FontName', 'Font') $parameterAttribute = New-Object System.Management.Automation.ParameterAttribute $parameterAttribute.Mandatory = $true $parameterAttribute.Position = 1 $parameterAttribute.HelpMessage = 'Name of the font to uninstall.' $parameterAttribute.ValueFromPipeline = $true $parameterAttribute.ValueFromPipelineByPropertyName = $true $attributeCollection.Add($parameterAttribute) foreach ($parameterAlias in $parameterAliases) { $parameterAttribute = New-Object System.Management.Automation.AliasAttribute($parameterAlias) $attributeCollection.Add($parameterAttribute) } $parameterValidateSet = switch ($Scope) { 'AllUsers' { (Get-Font -Scope 'AllUsers').Name } 'CurrentUser' { (Get-Font -Scope 'CurrentUser').Name } default { (Get-Font -Scope 'CurrentUser').Name + (Get-Font -Scope 'AllUsers').Name } } $validateSetAttribute = New-Object System.Management.Automation.ValidateSetAttribute($parameterValidateSet) $validateSetAttribute.ErrorMessage = "The font name provided was not found in the selected scope [$Scope]." $attributeCollection.Add($validateSetAttribute) $runtimeParameter = New-Object System.Management.Automation.RuntimeDefinedParameter($parameterName, [string[]], $attributeCollection) $runtimeDefinedParameterDictionary.Add($parameterName, $runtimeParameter) return $runtimeDefinedParameterDictionary } begin { $functionName = $MyInvocation.MyCommand.Name Write-Verbose "[$functionName]" if ($Scope -contains 'AllUsers' -and -not (IsAdmin)) { throw "Administrator rights are required to uninstall fonts in [$($script:fontFolderPath['AllUsers'])]. Please run the command again with elevated rights (Run as Administrator) or provide '-Scope CurrentUser' to your command." } $maxRetries = 10 $retryIntervalSeconds = 1 } process { $Name = $PSBoundParameters['Name'] $scopeCount = $Scope.Count Write-Verbose "[$functionName] - Processing [$scopeCount] scopes(s)" foreach ($ScopeItem in $Scope) { $scopeName = $scopeItem.ToString() $fontDestinationRegPath = $script:fontRegPath[$scopeName] $nameCount = $Name.Count Write-Verbose "[$functionName] - [$scopeName] - Processing [$nameCount] font(s)" foreach ($fontName in $Name) { Write-Verbose "[$functionName] - [$scopeName] - [$fontName] - Processing" $font = Get-Font -Name $fontName -Scope $Scope -Verbose:$false $filePath = $font.path $fileExists = Test-Path -Path $filePath if (-not $fileExists) { Write-Warning "[$fontName] - File [$filePath] does not exist. Skipping." } else { Write-Verbose "[$functionName] - [$scopeName] - [$fontName] - Removing file [$filePath]" $retryCount = 0 $fileRemoved = $false do { try { Remove-Item -Path $filePath -Force -ErrorAction Stop $fileRemoved = $true } catch { # Common error; 'file in use'. Usually VSCode or any web browser. $retryCount++ if (-not $fileRemoved -and $retryCount -eq $maxRetries) { Write-Error $_ Write-Error "[$functionName] - [$scopeName] - [$fontName] - Removing file [$filePath] - Failed [$retryCount/$maxRetries] - Stopping" break } Write-Verbose $_ Write-Verbose "[$functionName] - [$scopeName] - [$fontName] - Removing file [$filePath] - Failed [$retryCount/$maxRetries] - Retrying in $retryIntervalSeconds seconds..." #TODO: Find a way to try to unlock file here. Start-Sleep -Seconds $retryIntervalSeconds } } while (-not $fileRemoved -and $retryCount -lt $maxRetries) if (-not $fileRemoved) { break # Break to skip unregistering the font if the file could not be removed. } } $fontRegistryPathExists = Get-ItemProperty -Path $fontDestinationRegPath -Name $fontName -ErrorAction SilentlyContinue if (-not $fontRegistryPathExists) { Write-Verbose "[$functionName] - [$scopeName] - [$fontName] - Font is not registered. Skipping." } else { Write-Verbose "[$functionName] - [$scopeName] - [$fontName] - Unregistering font with path [$fontDestinationRegPath]" Remove-ItemProperty -Path $fontDestinationRegPath -Name $fontName -Force -ErrorAction Stop } Write-Verbose "[$functionName] - [$scopeName] - [$fontName] - Done" } Write-Verbose "[$functionName] - [$scopeName] - Done" } } end { Write-Verbose "[$functionName] - Done" } } Write-Verbose "[$scriptName] - [public/Uninstall-Font.ps1] - Done" #endregion - From public/Uninstall-Font.ps1 Write-Verbose "[$scriptName] - [public] - Done" #endregion - From public Export-ModuleMember -Function 'Get-Font','Install-Font','Uninstall-Font' -Cmdlet '' -Variable '' -Alias '*' |