ResolveString.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\ResolveString.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName ResolveString.Import.DoDotSource -Fallback $false if ($ResolveString_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName ResolveString.Import.IndividualFiles -Fallback $false if ($ResolveString_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($Path).ProviderPath if ($doDotSource) { . $resolvedPath } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($resolvedPath))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\preimport.ps1" # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\postimport.ps1" # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code <# This file loads the strings documents from the respective language folders. This allows localizing messages and errors. Load psd1 language files for each language you wish to support. Partial translations are acceptable - when missing a current language message, it will fallback to English or another available language. #> Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'ResolveString' -Language 'en-US' function Clear-StringMapping { <# .SYNOPSIS Clears all string mappings for the target module. .DESCRIPTION Clears all string mappings for the target module. Use this to reset all mappings in one go. .PARAMETER ModuleName The name of the module to operate for. String mappings are automatically assigned per-module, to avoid multiple modules colliding. This is automatically detected based on the caller, but the detection might fail in some circumstances. Use this parameter to override the automatic detection. .EXAMPLE PS C:\> Clear-StringMapping -Module MyModule Clears all string mappings for the MyModule module. #> [CmdletBinding()] Param ( [string] $ModuleName = [PSFramework.Utility.UtilityHost]::Callstack.InvocationInfo[0].MyCommand.Module.Name ) process { $script:mapping.Remove($ModuleName) } } function Get-StringMapping { <# .SYNOPSIS Lists registered string mappings. .DESCRIPTION Lists registered string mappings. By default, this command filters by ModuleName. .PARAMETER Name Default: '*' Name filter for the search, filtering entries by their placeholder using wildcard comparison. .PARAMETER ModuleName The name of the module to operate for. String mappings are automatically assigned per-module, to avoid multiple modules colliding. This is automatically detected based on the caller, but the detection might fail in some circumstances. Use this parameter to override the automatic detection. .EXAMPLE PS C:\> Get-StringMapping Lists all string mappings of the current module .EXAMPLE PS C:\> Get-StringMapping -ModuleName * Lists ALL string mappings, irrespective of module. #> [CmdletBinding()] Param ( [string] $Name = '*', [string] $ModuleName = [PSFramework.Utility.UtilityHost]::Callstack.InvocationInfo[0].MyCommand.Module.Name ) process { foreach ($key in $script:mapping.Keys) { if ($key -notlike $ModuleName) { continue } $script:mapping[$key].Values | Where-Object Name -like $Name } } } function Register-StringMapping { <# .SYNOPSIS Registers a string to insert for the specified name label. .DESCRIPTION Registers a string to insert for the specified name label. Alternatively you can also store a scriptblock, that will be executed at runtime to generate the value to insert. .PARAMETER Name The name of the placeholder to insert into. Only accepts values that do not contain regex special characters (such as "\" or "."). Choose the name with care, as _and_ match will be replaced, so it should be unlikely to occur by accident. - Bad name: "computer" - Better name: "%computer%" .PARAMETER Value The string value to insert into the placeholder defined in the Name parameter. .PARAMETER Scriptblock A scriptblock that should be executed at runtime to calculate the values to insert. Keep scaling in mind as you use this parameter: If script execution takes a bit, and you use this command a lot, scriptblock execution time might add up to significant delays. Scriptblocks will only be executed if their values are actually used in the replacement string. Consider caching schemes if performance is a concern. .PARAMETER ModuleName The name of the module to operate for. String mappings are automatically assigned per-module, to avoid multiple modules colliding. This is automatically detected based on the caller, but the detection might fail in some circumstances. Use this parameter to override the automatic detection. .EXAMPLE PS C:\> Register-StringMapping -Name '%Date%' -Value (Get-Date -Format 'yyyy-MM-dd') Registers the current date under the placeholder %Date% #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [PsfValidateScript('ResolveString.Validate.NoRegex', ErrorString = 'ResolveString.Validate.NoRegex')] [string] $Name, [Parameter(Mandatory = $true, ParameterSetName = 'Value', ValueFromPipelineByPropertyName = $true)] [string] $Value, [Parameter(Mandatory = $true, ParameterSetName = 'Scriptblock', ValueFromPipelineByPropertyName = $true)] [Scriptblock] $Scriptblock, [Parameter(ValueFromPipelineByPropertyName = $true)] [string] $ModuleName = [PSFramework.Utility.UtilityHost]::Callstack.InvocationInfo[0].MyCommand.Module.Name ) process { if (-not $ModuleName) { $ModuleName = '<Unknown>' } if (-not $script:mapping[$ModuleName]) { $script:mapping[$ModuleName] = @{ } } $script:mapping[$ModuleName][$Name] = [PSCustomObject]@{ PSTypeName = 'ResolveString.StringMapping' Name = $Name Value = $Value Scriptblock = $Scriptblock Type = $PSCmdlet.ParameterSetName ModuleName = $ModuleName } } } function Resolve-String { <# .SYNOPSIS Resolves any placeholders in the input string. .DESCRIPTION Resolves any placeholders in the input string. You can define placeholders using the Register-StringMapping command. For example, you could have a string like this: "Today is %Date%" Expanded to: "Today is 2020-05-28" (or whatever your current date is). .PARAMETER Text The text to resolve. .PARAMETER Mode Whether to operate in Strict mode (default) or lax mode. - Strict Mode: Any error during conversion will fail the conversion with a terminating exception. - Lax Mode: Any error will only cause a warning and return the original input value .PARAMETER ArgumentList Any arguments to send to any insertion scriptblock. Using Register-StringMapping, you can either assign a static value to an insertion tag, or you can offer a scriptblock. When storing a scriptblock, it will be executed at runtime, receiving the string it was matched to and these arguments as arguments. .PARAMETER ModuleName The name of the module to operate for. String mappings are automatically assigned per-module, to avoid multiple modules colliding. This is automatically detected based on the caller, but the detection might fail in some circumstances. Use this parameter to override the automatic detection. .EXAMPLE PS C:\> Resolve-String -Text $name -Mode Lax Resolves the string stored in $name, without throwing errors. .EXAMPLE PS C:\> Resolve-String -Text $path -ArgumentList $parameters Resolves the string stored in $path, providing the content of variable $parameters as argument to any scriptblock being executed as part of the resolution. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '')] [OutputType([string])] [CmdletBinding()] Param ( [Parameter(ValueFromPipeline = $true)] [AllowEmptyString()] [string[]] $Text, [ValidateSet('Strict', 'Lax')] [string] $Mode = 'Strict', $ArgumentList, [Parameter(ValueFromPipelineByPropertyName = $true)] [string] $ModuleName = [PSFramework.Utility.UtilityHost]::Callstack.InvocationInfo[0].MyCommand.Module.Name ) begin { #region Resolution Scriptblock $replacementScript = { param ( [string] $Match ) if ($script:mapping[$ModuleName][$Match]) { if($script:mapping[$ModuleName][$Match].Type -eq 'Scriptblock') { try { $script:mapping[$ModuleName][$Match].Scriptblock.Invoke($Match, $ArgumentList) -as [string] } catch { if ($Mode -eq 'Lax') { Write-PSFMessage -Level Warning -String 'Resolve-String.Resolution.ItemError' -StringValues $Match, $ModuleName -Exception $_.Exception.InnerException -FunctionName Resolve-String -ModuleName ResolveString return $Match } throw [System.Exception]::new("Error processing $($Match): $($_.Exception.InnerException.Message)", $_.Exception.InnerException) } } else { $script:mapping[$ModuleName][$Match].Value } } else { $Match } } #endregion Resolution Scriptblock } process { foreach ($textItem in $Text) { # Skip where continuing doesn't make sense if (-not $textItem -or -not $script:mapping[$ModuleName] -or $script:mapping[$ModuleName].Count -eq 0) { $textItem continue } $pattern = $script:mapping[$ModuleName].Keys -join "|" try { [regex]::Replace($textItem, $pattern, $replacementScript, 'IgnoreCase') } catch { Write-PSFMessage -Level Warning -String 'Resolve-String.Resolution.Error' -StringValues $textItem, $ModuleName -Exception $_.Exception.InnerException switch ($Mode) { 'Strict' { throw } 'Lax' { $textItem } } } } } } function Unregister-StringMapping { <# .SYNOPSIS Removes a specific string mappping from the list of mappings. .DESCRIPTION Removes a specific string mappping from the list of mappings. .PARAMETER Name The specific name of the string mapping to unregister. .PARAMETER ModuleName The name of the module to operate for. String mappings are automatically assigned per-module, to avoid multiple modules colliding. This is automatically detected based on the caller, but the detection might fail in some circumstances. Use this parameter to override the automatic detection. .EXAMPLE PS C:\> Unregister-StringMapping -Name '%Date%' Removes the %Date% string mapping from the current module's string mapping store. #> [CmdletBinding()] Param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [string] $Name, [Parameter(ValueFromPipelineByPropertyName = $true)] [string] $ModuleName = [PSFramework.Utility.UtilityHost]::Callstack.InvocationInfo[0].MyCommand.Module.Name ) process { if (-not $script:mapping[$ModuleName]) { return } $script:mapping[$ModuleName].Remove($Name) } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'ResolveString' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'ResolveString' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'ResolveString' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." <# Stored scriptblocks are available in [PsfValidateScript()] attributes. This makes it easier to centrally provide the same scriptblock multiple times, without having to maintain it in separate locations. It also prevents lengthy validation scriptblocks from making your parameter block hard to read. Set-PSFScriptblock -Name 'ResolveString.ScriptBlockName' -Scriptblock { } #> Set-PSFScriptblock -Name 'ResolveString.Validate.NoRegex' -Scriptblock { $_ -eq ([regex]::Escape($_)) } <# # Example: Register-PSFTeppScriptblock -Name "ResolveString.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name ResolveString.alcohol #> $script:mapping = @{ } New-PSFLicense -Product 'ResolveString' -Manufacturer 'Friedrich Weinmann' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2020-05-28") -Text @" Copyright (c) 2020 Friedrich Weinmann Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "@ #endregion Load compiled code |