functions/Utilities.ps1
|
Function Get-PowerShellEngine { [CmdletBinding()] Param([switch]$Detail) #get the current PowerShell process and the file that launched it $engine = Get-Process -id $pid | Get-Item if ($Detail) { [PSCustomObject]@{ Path = $engine.FullName FileVersion = $engine.VersionInfo.FileVersion PSVersion = $PSVersionTable.PSVersion.ToString() ProductVersion = $engine.VersionInfo.ProductVersion Edition = $PSVersionTable.PSEdition Host = $host.name Culture = $host.CurrentCulture Platform = $PSVersionTable.platform } } else { $engine.FullName } } Function Out-More { [cmdletbinding()] [alias("om")] Param( [Parameter(Mandatory, ValueFromPipeline)] [object[]]$InputObject, [ValidateRange(1, 1000)] [Alias("i")] [int]$Count = 50, [Alias("cls")] [Switch]$ClearScreen ) Begin { if ($ClearScreen) { Clear-Host } Write-Verbose "Starting: $($MyInvocation.MyCommand)" Write-Verbose "Using a count of $count" #initialize an array to hold objects Write-Verbose "Initializing data array" $data = @() #initialize some variables to control flow $ShowAll = $False $ShowNext = $False $Ready = $False $Quit = $False } #begin Process { if ($Quit) { Write-Verbose "Quitting" Break } elseif ($ShowAll) { $InputObject } elseif ($ShowNext) { Write-Verbose "Show Next" $ShowNext = $False $Ready = $True $data = , $InputObject } elseif ($data.count -lt $count) { Write-Verbose "Adding data" $data += $InputObject } else { #write the data to the pipeline $data #reset data $data = , $InputObject $Ready = $True } If ($Ready) { #pause Do { Write-Host "[M]ore [A]ll [N]ext [Q]uit " -ForegroundColor Green -NoNewline $r = Read-Host if ($r.Length -eq 0 -OR $r -match "^m") { #don't really do anything $Asked = $True } else { Switch -Regex ($r) { "^n" { $ShowNext = $True $InputObject $Asked = $True } "^a" { $InputObject $Asked = $True $ShowAll = $True } "^q" { #bail out $Asked = $True $Quit = $True } Default { $Asked = $False } } #Switch } #else } Until ($Asked) $Ready = $False $Asked = $False } #else } #process End { #test if data is from a get-help command in #which case it will be a single string that needs #to be broken apart if ([regex]::Matches($data, "`n").count -gt 1) { [void]$PSBoundParameters.remove("InputObject") Write-Verbose "Splitting input and re-running through Out-More" $data.split("`n") | Out-More @PSBoundParameters } elseif ($data[0].PSObject.TypeNames -contains "MamlCommandHelpInfo") { Write-Verbose "Help output detected" [void]$PSBoundParameters.remove("InputObject") ($data | Out-String).split("`n") | Out-More @PSBoundParameters } #display whatever is left in $data if ($data -AND -Not $ShowAll) { Write-Verbose "Displaying remaining data" $data } Write-Verbose "Ending: $($MyInvocation.MyCommand)" } #end } #end Out-More Function Invoke-InputBox { [cmdletbinding(DefaultParameterSetName = "plain")] [alias("ibx")] [OutputType([System.String], ParameterSetName = 'plain')] [OutputType([System.Security.SecureString], ParameterSetName = 'secure')] Param( [Parameter(ParameterSetName = "secure")] [Parameter(HelpMessage = "Enter the title for the input box. No more than 25 characters.", ParameterSetName = "plain")] [ValidateNotNullOrEmpty()] [ValidateScript( {$_.length -le 25})] [string]$Title = "User Input", [Parameter(ParameterSetName = "secure")] [Parameter(HelpMessage = "Enter a prompt. No more than 50 characters.", ParameterSetName = "plain")] [ValidateNotNullOrEmpty()] [ValidateScript( {$_.length -le 50})] [string]$Prompt = "Please enter a value:", [Parameter(HelpMessage = "Use to mask the entry and return a secure string.", ParameterSetName = "secure")] [switch]$AsSecureString, [string]$BackgroundColor = "White" ) if ((Test-IsPSWindows)) { Add-Type -AssemblyName PresentationFramework Add-Type -AssemblyName PresentationCore #remove the variable because it might get cached in the ISE or VS Code Remove-Variable -Name myInput -Scope script -ErrorAction SilentlyContinue $form = New-Object System.Windows.Window $stack = New-Object System.Windows.Controls.StackPanel #define what it looks like $form.Title = $title $form.Height = 150 $form.Width = 350 $form.Background = $BackgroundColor $label = New-Object System.Windows.Controls.Label $label.Content = " $Prompt" $label.HorizontalAlignment = "left" $stack.AddChild($label) if ($AsSecureString) { $InputBox = New-Object System.Windows.Controls.PasswordBox } else { $InputBox = New-Object System.Windows.Controls.TextBox } $InputBox.Width = 300 $InputBox.HorizontalAlignment = "center" $stack.AddChild($InputBox) $space = New-Object System.Windows.Controls.Label $space.Height = 10 $stack.AddChild($space) $btn = New-Object System.Windows.Controls.Button $btn.Content = "_OK" $btn.Width = 65 $btn.HorizontalAlignment = "center" $btn.VerticalAlignment = "bottom" #add an event handler $btn.Add_click( { if ($AsSecureString) { $script:myInput = $InputBox.SecurePassword } else { $script:myInput = $InputBox.text } $form.Close() }) $stack.AddChild($btn) $space2 = New-Object System.Windows.Controls.Label $space2.Height = 10 $stack.AddChild($space2) $btn2 = New-Object System.Windows.Controls.Button $btn2.Content = "_Cancel" $btn2.Width = 65 $btn2.HorizontalAlignment = "center" $btn2.VerticalAlignment = "bottom" #add an event handler $btn2.Add_click( { $form.Close() }) $stack.AddChild($btn2) #add the stack to the form $form.AddChild($stack) #show the form [void]$InputBox.Focus() $form.WindowStartupLocation = [System.Windows.WindowStartupLocation]::CenterScreen [void]$form.ShowDialog() #write the result from the input box back to the pipeline $script:myInput } else { Write-Warning "Sorry. This command requires a Windows platform." #bail out Return } } Function Set-ConsoleTitle { [cmdletbinding(SupportsShouldProcess)] [OutputType("None")] Param( [Parameter(Position = 0, Mandatory, HelpMessage = "Enter the title for the console window.")] [ValidateNotNullOrEmpty()] [string]$Title ) Begin { Write-Verbose "[$((Get-Date).TimeOfDay) BEGIN ] Starting $($MyInvocation.MyCommand)" $width = ($host.UI.RawUI.MaxWindowSize.Width * 2) } #begin Process { if ($host.Name -ne "ConsoleHost") { Write-Warning "This command must be run from a PowerShell console session. Not the PowerShell ISE or Visual Studio Code or similar environments." } elseif (($title.length -ge $width)) { Write-Warning "Your title is too long. It needs to be less than $width to fit your current console." } else { Write-Verbose "[$((Get-Date).TimeOfDay) PROCESS] Setting console title to $Title" if ($PSCmdlet.ShouldProcess($Title)) { $host.UI.RawUI.WindowTitle = $Title } } } #process End { Write-Verbose "[$((Get-Date).TimeOfDay) END ] Ending $($MyInvocation.MyCommand)" } #end } #close Set-ConsoleTitle <# Function Set-ConsoleColor { #This command is marked as deprecated 3/3/2023 #9 June 2024 this command has been removed from the module [cmdletbinding(SupportsShouldProcess)] [OutputType("None")] Param( [Parameter(HelpMessage = "Specify a foreground console color")] [ValidateNotNullOrEmpty()] [alias("fg")] [System.ConsoleColor]$Foreground, [Parameter( HelpMessage = "Specify a background console color")] [ValidateNotNullOrEmpty()] [alias("bg")] [System.ConsoleColor]$Background, [Alias("cls")] [switch]$ClearScreen, [switch]$PassThru ) Begin { Write-Verbose "[$((Get-Date).TimeOfDay) BEGIN ] Starting $($MyInvocation.MyCommand)" } #begin Process { if ($host.Name -ne "ConsoleHost") { Write-Warning "This command must be run from a PowerShell console session. Not the PowerShell ISE or Visual Studio Code or similar environments." #bail out } Write-Verbose "[$((Get-Date).TimeOfDay) PROCESS] Bound Parameters" $PSBoundParameters | Out-String | Write-Verbose # ! There are issues with this if PSReadline is running if (Get-Module -name PSReadline) { Write-Verbose "[$((Get-Date).TimeOfDay) PROCESS] Detected PSReadline Module is loaded" Write-Warning "You appear to be running the PSReadline module. Please use Set-PSReadlineOption or related command to modify the console." #make sure we don't clear the screen $ClearScreen = $False } else { if ($Foreground) { Write-Verbose "[$((Get-Date).TimeOfDay) PROCESS] Configuring console foreground color to $Foreground" if ($PSCmdlet.ShouldProcess($Foreground)) { $host.UI.RawUI.ForegroundColor = $Foreground $modified = $True } } if ($Background) { Write-Verbose "[$((Get-Date).TimeOfDay) PROCESS] Configuring console background color to $Background" if ($PSCmdlet.ShouldProcess($Background)) { $host.UI.RawUI.BackgroundColor = $Background $modified = $True } } } } #process End { if ($ClearScreen) { Clear-Host } #only PassThru if asked for and if a change was made. if ($PassThru -AND $modified) { $host.UI.RawUI | Select-Object -Property ForegroundColor, BackgroundColor } Write-Verbose "[$((Get-Date).TimeOfDay) END ] Ending $($MyInvocation.MyCommand)" } #end } #close Set-ConsoleTitle #> #This command is not exported <# You use this function like this: $newrunspace = <code> $pscmd = [powershell]::create() add commands to $pscmd $pscmd.runspace = $newrunspace $handle = $pscmd.beginInvoke() Start a thread job to test if runspace is being used and close it if it is finished New-RunspaceCleanUpJob -handle $handle -powershell $pscmd -sleepinterval 30 #> Function New-RunspaceCleanupJob { [cmdletbinding()] [OutputType("None", "ThreadJob")] Param( [Parameter(Mandatory, HelpMessage = "This should be the System.Management.Automation.Runspaces.AsyncResult object from the BeginInvoke() method.")] [ValidateNotNullOrEmpty()] [object]$Handle, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [System.Management.Automation.PowerShell]$PowerShell, [Parameter(HelpMessage = "Specify a sleep interval in seconds")] [ValidateRange(5, 600)] [int32]$SleepInterval = 10, [Parameter(HelpMessage = "Pass the thread job object to the pipeline")] [switch]$PassThru ) $job = Start-ThreadJob -ScriptBlock { param($handle, $ps, $sleep) #the Write-Host lines are so that if you look at the results of the thread job #you'll see something you can use for debugging or troubleshooting. Write-Host "[$(Get-Date)] Sleeping in $sleep second loops" Write-Host "Watching this runspace" Write-Host ($ps.runspace | Select-Object -property * | Out-String) #loop until the handle shows as completed, sleeping the the specified #number of seconds do { Start-Sleep -Seconds $sleep } Until ($handle.IsCompleted) Write-Host "[$(Get-Date)] Closing runspace" $ps.runspace.close() Write-Host "[$(Get-Date)] Disposing runspace" $ps.runspace.Dispose() Write-Host "[$(Get-Date)] Disposing PowerShell" $ps.dispose() Write-Host "[$(Get-Date)] Ending job" } -ArgumentList $Handle, $PowerShell, $SleepInterval if ($PassThru) { #Write the ThreadJob object to the pipeline $job } } |