Merge pull request #256 from PowershellFrameworkCollective/New-Commands

FriedrichWeinmann · web-flow · commit 56458a2da87a · 2018-12-01T16:13:39.000Z
New commands
diff --git a/PSFramework/PSFramework.psd1 b/PSFramework/PSFramework.psd1
@@ -93,6 +93,7 @@
 		'Import-PSFLocalizedString',
 		'Install-PSFLoggingProvider',
 		'Invoke-PSFCommand',
+		'Join-PSFPath',
 		'New-PSFLicense',
 		'New-PSFMessageLevelModifier',
 		'New-PSFSupportPackage',
@@ -107,6 +108,7 @@
 		'Register-PSFTeppArgumentCompleter',
 		'Register-PSFTeppScriptblock',
 		'Register-PSFTypeSerializationData',
+		'Remove-PSFAlias',
 		'Remove-PSFLicense',
 		'Remove-PSFMessageLevelModifier',
 		'Reset-PSFConfig',
diff --git a/PSFramework/PSFramework.psm1 b/PSFramework/PSFramework.psm1
@@ -58,7 +58,7 @@ function Import-ModuleFile
 		if ($doDotSource) { . (Resolve-Path $Path) }
 		else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText((Resolve-Path $Path).ProviderPath))), $null, $null) }
 	}
-	catch { throw (New-Object System.Exception("Failed to import $(Resolve-Path $Path) _ $_", $_.Exception)) }
+	catch { throw (New-Object System.Exception("Failed to import $(Resolve-Path $Path) : $_", $_.Exception)) }
 }
 
 #region Load individual files
diff --git a/PSFramework/bin/PSFramework.dll b/PSFramework/bin/PSFramework.dll
diff --git a/PSFramework/bin/PSFramework.pdb b/PSFramework/bin/PSFramework.pdb
diff --git a/PSFramework/bin/PSFramework.xml b/PSFramework/bin/PSFramework.xml
diff --git a/PSFramework/changelog.md b/PSFramework/changelog.md
@@ -1,4 +1,11 @@
 ﻿# CHANGELOG
+## 0.10.30.165 : 2018-12-01
+ - New: Command Join-PSFPath performs multi-segment path joins and path normalization
+ - New: Command Remove-PSFAlias deletes global aliases
+ - New: Configuration setting to define current language
+ - Upd: PsfValidatePattern now supports localized strings using the `ErrorString` property.
+ - Fix: Race condition / concurrent access on license content during import with ramping up CPU availability
+
 ## 0.10.29.160 : 2018-11-04
  - New: Command ConvertTo-PSFHashtable converts objects into hashtables
  - New: Command Get-PSFPipeline grants access to the current pipeline and all its works.
diff --git a/PSFramework/en-us/stringsAssembly.psd1 b/PSFramework/en-us/stringsAssembly.psd1
@@ -0,0 +1,5 @@
+﻿@{
+	Assembly_UtilityHost_AliasNotFound = 'Failed to find alias: {0}'
+	Assembly_UtilityHost_AliasProtected = 'The alias "{0}" is protected and cannot be removed!'
+	Assembly_UtilityHost_AliasReadOnly = 'The alias "{0}" is read only! To remove it, also specify the "-Force" parameter.'
+}
diff --git a/PSFramework/en-us/stringsConfiguration.psd1 b/PSFramework/en-us/stringsConfiguration.psd1
@@ -0,0 +1,3 @@
+﻿@{
+	Configuration_ValidateLanguage  = '{0} is not recognized as a legal language code, such as "en-US" or "de-DE"'
+}
diff --git a/PSFramework/functions/localization/Import-PSFLocalizedString.ps1 b/PSFramework/functions/localization/Import-PSFLocalizedString.ps1
@@ -24,7 +24,7 @@
 	.EXAMPLE
 		PS C:\> Import-PSFLocalizedString -Path '$moduleRoot\strings.psd1' -Module 'MyModule'
 	
-		Improts the strigns stored in strings.psd1 for the module MyModule as 'en-US' language strings.
+		Imports the strings stored in strings.psd1 for the module MyModule as 'en-US' language strings.
 #>
 	[CmdletBinding()]
 	param (
@@ -54,8 +54,4 @@
 			[PSFramework.Localization.LocalizationHost]::Write($Module, $key, $Language, $data[$key])
 		}
 	}
-	end
-	{
-	
-	}
 }
diff --git a/PSFramework/functions/utility/Join-PSFPath.ps1 b/PSFramework/functions/utility/Join-PSFPath.ps1
@@ -0,0 +1,61 @@
+﻿function Join-PSFPath
+{
+<#
+    .SYNOPSIS
+        Performs multisegment path joins.
+    
+    .DESCRIPTION
+        Performs multisegment path joins.
+    
+    .PARAMETER Path
+        The basepath to join on.
+    
+    .PARAMETER Child
+        Any number of child paths to add.
+	
+	.PARAMETER Normalize
+		Normalizes path separators for the path segments offered.
+		This ensures the correct path separators for the current OS are chosen.
+    
+    .EXAMPLE
+        PS C:\> Join-PSFPath -Path 'C:\temp' 'Foo' 'Bar'
+    
+        Returns 'C:\temp\Foo\Bar'
+	
+	.EXAMPLE
+		PS C:\> Join-PSFPath -Path 'C:\temp' 'Foo' 'Bar' -Normalize
+    
+        Returns 'C:\temp\Foo\Bar' on a Windows OS.
+		Returns 'C:/temp/Foo/Bar' on most non-Windows OSes.
+#>
+	[CmdletBinding()]
+	param (
+		[Parameter(Mandatory = $true, Position = 0)]
+		[string]
+		$Path,
+		
+		[Parameter(ValueFromRemainingArguments = $true)]
+		[string[]]
+		$Child,
+		
+		[switch]
+		$Normalize
+	)
+	
+	$resultingPath = $Path
+	
+	foreach ($childItem in $Child)
+	{
+		$resultingPath = Join-Path -Path $resultingPath -ChildPath $childItem
+	}
+	
+	if ($Normalize)
+	{
+		$defaultSeparator = [System.IO.Path]::DirectorySeparatorChar
+		$altSeparator = "/"
+		if ($defaultSeparator -eq "/") { $altSeparator = "\" }
+		$resultingPath = $resultingPath.Replace($altSeparator, $defaultSeparator)
+	}
+	
+	$resultingPath
+}
diff --git a/PSFramework/functions/utility/Remove-PSFAlias.ps1 b/PSFramework/functions/utility/Remove-PSFAlias.ps1
@@ -0,0 +1,52 @@
+﻿function Remove-PSFAlias
+{
+<#
+	.SYNOPSIS
+		Removes an alias from the global scope.
+	
+	.DESCRIPTION
+		Removes an alias from the global* scope.
+		Please note that this always affects the global scope and should not be used lightly.
+		This has the potential to break code that does not comply with PowerShell best practices and relies on the use of aliases.
+	
+		Refuses to delete constant aliases.
+		Requires the '-Force' parameter to delete ReadOnly aliases.
+	
+		*This includes aliases exported by modules.
+	
+	.PARAMETER Name
+		The name of the alias to remove.
+	
+	.PARAMETER Force
+		Enforce removal of aliases. Required to remove ReadOnly aliases (including default aliases such as "select" or "group").
+	
+	.EXAMPLE
+		PS C:\> Remove-PSFAlias -Name 'grep'
+	
+		Removes the global alias 'grep'
+	
+	.EXAMPLE
+		PS C:\> Remove-PSFAlias -Name 'select' -Force
+	
+		Removes the default alias 'select'
+#>
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
+	[CmdletBinding()]
+	param (
+		[Parameter(ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $true)]
+		[string[]]
+		$Name,
+		
+		[switch]
+		$Force
+	)
+	
+	process
+	{
+		foreach ($alias in $Name)
+		{
+			try { [PSFramework.Utility.UtilityHost]::RemovePowerShellAlias($alias, $Force.ToBool()) }
+			catch { Stop-PSFFunction -Message $_ -EnableException $true -Cmdlet $PSCmdlet -ErrorRecord $_ -OverrideExceptionMessage }
+		}
+	}
+}
diff --git a/PSFramework/internal/configurations/general.ps1 b/PSFramework/internal/configurations/general.ps1
@@ -6,4 +6,7 @@ Set-PSFConfig -Module PSFramework -Name 'SupportPackage.ContactMessage' -Value '
 # Encoding Settings
 Set-PSFConfig -Module PSFramework -Name 'Text.Encoding.FullTabCompletion' -Value $false -Initialize -Validation 'bool' -Description 'Whether all encodings should be part of the tab completion for encodings. By default, only a manageable subset is shown.'
 Set-PSFConfig -Module PSFramework -Name 'Text.Encoding.DefaultWrite' -Value 'utf-8' -Initialize -Validation 'string' -Description 'The default encoding to use when writing to file. Only applied by implementing commands.'
-Set-PSFConfig -Module PSFramework -Name 'Text.Encoding.DefaultRead' -Value 'utf-8' -Initialize -Validation 'string' -Description 'The default encoding to use when reading from file. Only applied by implementing commands.'
+Set-PSFConfig -Module PSFramework -Name 'Text.Encoding.DefaultRead' -Value 'utf-8' -Initialize -Validation 'string' -Description 'The default encoding to use when reading from file. Only applied by implementing commands.'
+
+# Localization Stuff
+Set-PSFConfig -Module PSFramework -Name 'Localization.Language' -Value ([System.Globalization.CultureInfo]::CurrentUICulture.Name) -Initialize -Handler { [PSFramework.Localization.LocalizationHost]::Language = $args[0] } -Validation 'languagecode' -Description 'The language the current PowerShell session is operating under'
diff --git a/PSFramework/internal/configurationvalidation/languagecode.ps1 b/PSFramework/internal/configurationvalidation/languagecode.ps1
@@ -0,0 +1,25 @@
+﻿Register-PSFConfigValidation -Name "languagecode" -ScriptBlock {
+	param (
+		$Value
+	)
+	
+	$Result = New-Object PSObject -Property @{
+		Success = $True
+		Value   = $null
+		Message = ""
+	}
+	
+	$legal = [System.Globalization.CultureInfo]::GetCultures([System.Globalization.CultureTypes]::AllCultures).Name | Where-Object { $_ -and ($_.Trim()) }
+	
+	if ($Value -in $legal)
+	{
+		$Result.Value = [string]$Value
+	}
+	else
+	{
+		$Result.Success = $false
+		$Result.Message = [PSFramework.Localization.LocalizationHost]::Read('PSFramework.Configuration_ValidateLanguage')
+	}
+	
+	return $Result
+}
diff --git a/PSFramework/internal/functions/localization/Import-LocalizedString.ps1 b/PSFramework/internal/functions/localization/Import-LocalizedString.ps1
@@ -0,0 +1,56 @@
+﻿function Import-LocalizedString
+{
+<#
+	.SYNOPSIS
+		Imports a set of localized strings from a PowerShell data file.
+	
+	.DESCRIPTION
+		Imports a set of localized strings from a PowerShell data file.
+		This is used to feed the localized string feature set.
+		Always import for all languages, do not select by current language - the system handles language selection.
+	
+		Strings are process wide, so loading additional languages can be offloaded into a background task.
+	
+	.PARAMETER Path
+		The path to the psd1 file to import as strings file.
+	
+	.PARAMETER Module
+		The module for which to import the strings.
+	
+	.PARAMETER Language
+		The language of the specific strings file.
+		Defaults to en-US.
+	
+	.EXAMPLE
+		PS C:\> Import-LocalizedString -Path '$moduleRoot\strings.psd1' -Module 'MyModule'
+	
+		Imports the strings stored in strings.psd1 for the module MyModule as 'en-US' language strings.
+#>
+	[CmdletBinding()]
+	param (
+		[Parameter(Mandatory = $true)]
+		[string]
+		$Path,
+		
+		[Parameter(Mandatory = $true)]
+		[string]
+		$Module,
+		
+		[string]
+		$Language = 'en-US'
+	)
+	
+	begin
+	{
+		try { $resolvedPath = Resolve-PSFPath -Path $Path -Provider FileSystem -SingleItem }
+		catch { Stop-PSFFunction -Message "Failed to resolve path: $Path" -EnableException $true -Cmdlet $PSCmdlet -ErrorRecord $_ }
+	}
+	process
+	{
+		$data = Import-PowerShellDataFile -Path $resolvedPath
+		foreach ($key in $data.Keys)
+		{
+			[PSFramework.Localization.LocalizationHost]::Write($Module, $key, $Language, $data[$key])
+		}
+	}
+}
diff --git a/PSFramework/internal/scripts/postimport.ps1 b/PSFramework/internal/scripts/postimport.ps1
@@ -1,6 +1,9 @@
 ﻿# Load the cmdlets
 . Import-ModuleFile -Path "$($script:ModuleRoot)\internal\scripts\cmdlets.ps1"
 
+# Load the strings
+. Import-ModuleFile -Path "$($script:ModuleRoot)\internal\scripts\strings.ps1"
+
 # Initialize the configurations
 foreach ($file in (Get-ChildItem -Path "$($script:ModuleRoot)\internal\configurationvalidation\*.ps1"))
 {
diff --git a/PSFramework/internal/scripts/strings.ps1 b/PSFramework/internal/scripts/strings.ps1
@@ -0,0 +1,4 @@
+﻿Import-LocalizedString -Path (Resolve-Path "$script:ModuleRoot\en-us\stringsAssembly.psd1") -Module PSFramework -Language 'en-US'
+
+
+$script:strings = Get-PSFLocalizedString -Module PSFramework
diff --git a/PSFramework/internal/tepp/scripts/localization.ps1 b/PSFramework/internal/tepp/scripts/localization.ps1
@@ -1,5 +1,5 @@
 ﻿Register-PSFTeppScriptblock -Name 'PSFramework-LanguageNames' -ScriptBlock {
-	[System.Globalization.CultureInfo]::GetCultures([System.Globalization.CultureTypes]::AllCultures).Name
+	[System.Globalization.CultureInfo]::GetCultures([System.Globalization.CultureTypes]::AllCultures).Name | Where-Object { $_ -and ($_.Trim()) }
 }
 
 Register-PSFTeppScriptblock -Name 'PSFramework-LocalizedStrings-Names' -ScriptBlock {
diff --git a/build/filesAfter.txt b/build/filesAfter.txt
@@ -2,6 +2,7 @@
 # In the order they are loaded during preimport
 
 internal\scripts\cmdlets.ps1
+internal\scripts\strings.ps1
 internal\configurationvalidation\*.ps1
 internal\configurations\*.ps1
 internal\scripts\loadConfigurationPersisted.ps1
diff --git a/library/PSFramework/Localization/LocalString.cs b/library/PSFramework/Localization/LocalString.cs
@@ -44,6 +44,8 @@ public string Value
                     return _Strings[LocalizationHost.Language];
                 if (_Strings.ContainsKey(CultureInfo.CurrentUICulture.Name))
                     return _Strings[CultureInfo.CurrentUICulture.Name];
+                if (_Strings.ContainsKey("en-US"))
+                    return _Strings["en-US"];
 
                 return _Strings.Values.First();
             }
diff --git a/library/PSFramework/Utility/UtilityHost.cs b/library/PSFramework/Utility/UtilityHost.cs
@@ -235,6 +235,34 @@ public static object GetExecutionContextFromTLS()
             return method.Invoke(null, BindingFlags.NonPublic | BindingFlags.Static, null, null, System.Globalization.CultureInfo.CurrentCulture);
         }
 
+        /// <summary>
+        /// Removes an alias from the global list of aliases
+        /// </summary>
+        /// <param name="Name">The name of the laias to kill</param>
+        /// <param name="Force">Whether to remove ReadOnly items</param>
+        public static void RemovePowerShellAlias(string Name, bool Force)
+        {
+            object context = GetExecutionContextFromTLS();
+            PropertyInfo contextProperty = context.GetType().GetProperty("TopLevelSessionState", BindingFlags.Instance | BindingFlags.NonPublic);
+            object topLevelState = contextProperty.GetValue(context);
+            PropertyInfo topLevelStateProperty = topLevelState.GetType().GetProperty("GlobalScope", BindingFlags.Instance | BindingFlags.NonPublic);
+            object globalScope = topLevelStateProperty.GetValue(topLevelState);
+            FieldInfo aliasesField = globalScope.GetType().GetField("_alias", BindingFlags.Instance | BindingFlags.NonPublic);
+            Dictionary<string, AliasInfo> aliases = (Dictionary<string, AliasInfo>)aliasesField.GetValue(globalScope);
+
+            if (!aliases.ContainsKey(Name))
+                throw new ItemNotFoundException(String.Format(Localization.LocalizationHost.Read("PSFramework.Assembly_UtilityHost_AliasNotFound"), Name));
+
+            AliasInfo alias = aliases[Name];
+
+            if ((alias.Options & ScopedItemOptions.Constant) != 0)
+                throw new InvalidOperationException(String.Format(Localization.LocalizationHost.Read("PSFramework.Assembly_UtilityHost_AliasProtected"), Name));
+            if (!Force && ((alias.Options & ScopedItemOptions.ReadOnly) != 0))
+                throw new InvalidOperationException(String.Format(Localization.LocalizationHost.Read("PSFramework.Assembly_UtilityHost_AliasReadOnly"), Name));
+            
+            aliases.Remove(Name);
+        }
+
         /// <summary>
         /// Returns the current callstack
         /// </summary>
diff --git a/library/PSFramework/Validation/PsfValidatePatternAttribute.cs b/library/PSFramework/Validation/PsfValidatePatternAttribute.cs

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ function Import-ModuleFile`
`58`	`58`	`if ($doDotSource) { . (Resolve-Path $Path) }`
`59`	`59`	`else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText((Resolve-Path $Path).ProviderPath))), $null, $null) }`
`60`	`60`	`}`
`61`		`- catch { throw (New-Object System.Exception("Failed to import $(Resolve-Path $Path) _ $_", $_.Exception)) }`
	`61`	`+ catch { throw (New-Object System.Exception("Failed to import $(Resolve-Path $Path) : $_", $_.Exception)) }`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`#region Load individual files`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+@{`
	`2`	`+ Configuration_ValidateLanguage = '{0} is not recognized as a legal language code, such as "en-US" or "de-DE"'`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`.EXAMPLE`
`25`	`25`	`PS C:\> Import-PSFLocalizedString -Path '$moduleRoot\strings.psd1' -Module 'MyModule'`
`26`	`26`
`27`		`- Improts the strigns stored in strings.psd1 for the module MyModule as 'en-US' language strings.`
	`27`	`+ Imports the strings stored in strings.psd1 for the module MyModule as 'en-US' language strings.`
`28`	`28`	`#>`
`29`	`29`	`[CmdletBinding()]`
`30`	`30`	`param (`
`@@ -54,8 +54,4 @@`
`54`	`54`	`[PSFramework.Localization.LocalizationHost]::Write($Module, $key, $Language, $data[$key])`
`55`	`55`	`}`
`56`	`56`	`}`
`57`		`- end`
`58`		`- {`
`59`		`-`
`60`		`- }`
`61`	`57`	`}`