more 2.13 updates

Author: jdhitsolutions

PSScriptTools.psd1

@@ -4,14 +4,14 @@ if ($myinvocation.line -match "-verbose") {
 }
 Write-Verbose "Loading public functions"
 
-Get-ChildItem -path $PSScriptRoot\functions\*.ps1 | foreach-object -process {
-    write-verbose $_.fullname
+Get-ChildItem -path $PSScriptRoot\functions\*.ps1 | ForEach-Object -process {
+    Write-Verbose $_.fullname
     . $_.FullName
 }
 
 #add ToDo options to the ISE or VS Code
 if ($psEditor) {
-    write-verbose "Defining VSCode additions"
+    Write-Verbose "Defining VSCode additions"
     $sb = {
         Param(
             [Microsoft.PowerShell.EditorServices.Extensions.EditorContext]$context
@@ -27,18 +27,20 @@ if ($psEditor) {
 
 }
 elseif ($psise) {
-        write-verbose "Defining ISE additions"
-    $action = {
+    Write-Verbose "Defining ISE additions"
 
-        $prompt = "What do you need to do?"
-        $title = "To Do"
-        $item = Invoke-Inputbox -Title $title -Prompt $prompt
-        $todo = "# [$(Get-Date)] TODO: $item"
-        $psise.CurrentFile.Editor.InsertText($todo)
-        #jump cursor to the end
-        $psise.CurrentFile.editor.SetCaretPosition($psise.CurrentFile.Editor.CaretLine, $psise.CurrentFile.Editor.CaretColumn)
-    }
+    if ($psISE.CurrentPowerShellTab.AddOnsMenu.Submenus.DisplayName -notcontains "ToDo") {
 
-    #add the action to the Add-Ons menu
-    $psISE.CurrentPowerShellTab.AddOnsMenu.Submenus.Add("ToDo", $Action, "Ctrl+Alt+2" ) | Out-Null
+        $action = {
+            $prompt = "What do you need to do?"
+            $title = "To Do"
+            $item = Invoke-Inputbox -Title $title -Prompt $prompt
+            $todo = "# [$(Get-Date)] TODO: $item"
+            $psise.CurrentFile.Editor.InsertText($todo)
+            #jump cursor to the end
+            $psise.CurrentFile.editor.SetCaretPosition($psise.CurrentFile.Editor.CaretLine, $psise.CurrentFile.Editor.CaretColumn)
+        }
+        #add the action to the Add-Ons menu
+        $psISE.CurrentPowerShellTab.AddOnsMenu.Submenus.Add("ToDo", $Action, "Ctrl+Alt+2" ) | Out-Null
+    }
 }

PSScriptTools.psm1

@@ -12,13 +12,13 @@ You can get the current release from this repository or install this from the Po
 Install-Module PSScriptTools
 ```
 
-or in PowerShell Core:
+or in PowerShell 7:
 
 ```powershell
 Install-Module PSScriptTools -scope CurrentUser
 ```
 
-Starting in v2.2.0, the module was restructured to better support Desktop and Core editions. It is recommended that you uninstall any version older than 2.2.0 and then install the latest version from the PowerShell Gallery.
+Starting in v2.2.0, the module was restructured to better support Desktop and Core editions. But starting with version 2.13.0, the module design has reverted. All commands will be exported. Anything that is platform specific should be handled on a per command basis. It is assumed you will be running this module in Windows PowerShell 5.1 or PowerShell 7.
 
 ```powershell
 Uninstall-Module PSScriptTools -allversions
@@ -30,6 +30,38 @@ Please post any questions, problems or feedback in [Issues](https://github.com/j
 
 ## General Tools
 
+### [Convert-EventLogRecord](docs/Convert-EventLogRecord.md)
+
+When you use Get-WinEvent, the results are objects you can work with in PowerShell.
+However, often times there is additional information that is part of the eventlog record, such as replacement strings, that are used to construct a message.
+This additional information is not readily exposed.
+You can use this command to convert results of a Get-WinEvent command into a PowerShell custom object with additional information.
+
+```powershell
+PS C:\> get-winevent -FilterHashtable @{Logname='System';ID=7045} -MaxEvents 1 | Convert-EventLogRecord
+
+
+LogName      : System
+RecordType   : Information
+TimeCreated  : 1/21/2020 3:49:46 PM
+ID           : 7045
+ServiceName  : Netwrix Account Lockout Examiner
+ImagePath    : "C:\Program Files (x86)\Netwrix\Account Lockout Examiner\ALEService.exe"
+ServiceType  : user mode service
+StartType    : auto start
+AccountName  : bovine320\jeff
+Message      : A service was installed in the system.
+
+               Service Name:  Netwrix Account Lockout Examiner
+               Service File Name:  "C:\Program Files (x86)\Netwrix\Account Lockout Examiner\ALEService.exe"
+               Service Type:  user mode service
+               Service Start Type:  auto start
+               Service Account:  bovine320\jeff
+Keywords     : {Classic}
+Source       : Service Control Manager
+Computername : Bovine320
+```
+
 ### [Get-WhoIs](docs/Get-WhoIs.md)
 
 This command will retrieve WhoIs information from the ARIN database for a given IPv4 address.
@@ -331,7 +363,7 @@ PS /mnt/c/scripts> new-randomfilename -home -Extension tmp
 
 ### [ConvertTo-Markdown](docs/ConvertTo-Markdown.md)
 
-This command is designed to accept pipelined output and create a markdown document. The pipeline output will formatted as a text block. You can optionally define a title, content to appear before the output and content to appear after the output. You can run a command like this:
+This command is designed to accept pipelined output and create a markdown document. The pipeline output will formatted as a text block or a table You can optionally define a title, content to appear before the output and content to appear after the output. You can run a command like this:
 
 ```powershell
  Get-Service Bits,Winrm | Convertto-Markdown -title "Service Check" -precontent "## $($env:computername)"  -postcontent "_report $(Get-Date)_"
@@ -352,7 +384,7 @@ which generates this markdown:
     Running  Winrm              Windows Remote Management (WS-Manag...
     ```
 
-    _report 09/25/2018 09:57:12_
+    _report 09/25/2019 09:57:12_
 ```
 
 Because the function writes markdown to the pipeline you will need to pipe it to a command `Out-File` to create a file.
@@ -566,7 +598,7 @@ Convert a hashtable object to a string equivalent that you can copy into your sc
 This command will take an object and create a hashtable based on its properties. You can have the hashtable exclude some properties as well as properties that have no value.
 
 ```powershell
-PS C:\> get-process -id $pid | select name,id,handles,workingset | ConvertTo-HashTable
+PS C:\> Get-Process -id $pid | select name,id,handles,workingset | ConvertTo-HashTable
 
 Name                           Value
 ----                           -----
@@ -576,7 +608,7 @@ Id                             3456
 Handles                        958
 ```
 
-### [Join-Hashtable](docs/Join-Hashtable.md)
+### [Join-HashTable](docs/Join-HashTable.md)
 
 This command will combine two hashtables into a single hashtable.Join-Hashtable will test for duplicate keys. If any of the keys from the first, or primary hashtable are found in the secondary hashtable, you will be prompted for which to keep. Or you can use -Force which will always keep the conflicting key from the first hashtable.
 
@@ -599,6 +631,39 @@ Computer                       HAL
 Count                          3
 ```
 
+### [Rename-Hashtable](docs/Rename-HashTable.md)
+
+This command allows you to rename a key in an existing hashtable or ordered dictionary object.
+
+```powershell
+PS C:\> $h = Get-Service Spooler | ConvertTo-HashTable
+```
+
+The hashtable in $h has Machinename property which can be renamed.
+
+```powershell
+PS C:\> Rename-HashTable -Name h -Key Machinename -NewKey Computername -Passthru
+
+Name                           Value
+----                           -----
+ServiceType                    Win32OwnProcess, InteractiveProcess
+ServiceName                    Spooler
+Container
+CanPauseAndContinue            False
+RequiredServices               {RPCSS, http}
+ServicesDependedOn             {RPCSS, http}
+Computername                   .
+CanStop                        True
+StartType                      Automatic
+Site
+ServiceHandle                  SafeServiceHandle
+DisplayName                    Print Spooler
+CanShutdown                    False
+Status                         Running
+Name                           Spooler
+DependentServices              {Fax}
+```
+
 ## Select Functions
 
 The module contains 2 functions which simplify the use of `Select-Object`. The commands are intended to make it easier to select the first or last X number of objects. The commands include features so that you can sort the incoming objects on a given property first.
@@ -993,6 +1058,6 @@ Begin {
 
 ## Compatibility
 
-Where possible these commands have been tested with PowerShell Core, but not every platform. If you encounter problems, have suggestions or other feedback, please post an issue.
+Where possible these commands have been tested with PowerShell 7, but not every platform. If you encounter problems, have suggestions or other feedback, please post an issue. It is assumed you will not be running this commands on any edition of PowerShell Core or any beta releases of PowerShell 7.
 
-last Updated 2019-08-20 19:20:40Z UTC
+last Updated 2020-01-22 16:15:55Z UTC

README.md

@@ -5,8 +5,14 @@
 + Added `New-RunspaceCleanupJob` command to be used with WPF commands running in a new runspace
 + Modified `ConvertTo-WPFGrid` to clean up runspace when closed. (Issue #25)
 + Modified `ConvertTo-WPFGrid` to attempt to run on all platforms and gracefully fail where it won't work. (Issue $56)
++ Added 'Convert-EventLogRecord' function and its alias `clr`
++ Added `Rename-Hashtable` function and its alias `rht`
++ Updated `Convertto-Markdown` to include options to format as a table
 + Updated module manifest to export `ConvertTo-WPFGrid` to all hosts. Code in the command will determine compatibility.
++ Updated `Find-FileItem` to work better cross-platform
++ Updated `New-WPFMessagebox` to work on PowerShell 7 on Windows platforms.
 + Help Updates
++ Modified module and manifest to export all functions regardless of edition. Any OS limitations will be handled on a per command basis.
 + Updated `README.md`
 
 ## v2.12.0

changelog.md

@@ -0,0 +1,103 @@
+
+Function Convert-EventLogRecord {
+
+    [cmdletbinding()]
+    [alias("clr")]
+
+    Param(
+        [Parameter(Position = 0, Mandatory, ValueFromPipeline)]
+        [ValidateNotNullorEmpty()]
+        [System.Diagnostics.Eventing.Reader.EventLogRecord[]]$LogRecord
+    )
+
+    Begin {
+        Write-Verbose "[BEGIN  ] Starting: $($MyInvocation.Mycommand)"
+    } #begin
+
+    Process {
+        foreach ($record in $LogRecord) {
+            Write-Verbose "[PROCESS] Processing event id $($record.ID) from $($record.logname) log on $($record.machinename)"
+            Write-Verbose "[PROCESS] Creating XML data"
+            [xml]$r = $record.ToXml()
+
+            $h = [ordered]@{
+                LogName     = $record.LogName
+                RecordType  = $record.LevelDisplayName
+                TimeCreated = $record.TimeCreated
+                ID          = $record.Id
+            }
+
+            if ($r.Event.EventData.Data.Count -gt 0) {
+                Write-Verbose "[PROCESS] Parsing event data"
+                if ($r.Event.EventData.Data -is [array]) {
+                <#
+                 I only want to enumerate with the For loop if the data is an array of objects
+                 If the data is just a single string like Foo, then when using the For loop,
+                 the data value will be the F and not the complete string, Foo.
+                 #>
+                for ($i = 0; $i -lt $r.Event.EventData.Data.count; $i++) {
+
+                    $data = $r.Event.EventData.data[$i]
+                    #test if there is structured data or just text
+                    if ($data.name) {
+                        $Name = $data.name
+                        $Value = $data.'#text'
+                    }
+                    else {
+                        Write-Verbose "[PROCESS] No data property name detected"
+                        $Name = "RawProperties"
+                        #data will likely be an array of strings
+                        [string[]]$Value = $data
+                    }
+
+                    if ($h.Contains("RawProperties")) {
+                        Write-Verbose "[PROCESS] Appending to RawProperties"
+                        $h.RawProperties += $value
+                    }
+                    else {
+                        Write-Verbose "[PROCESS] Adding $name"
+                        $h.add($name, $Value)
+                    }
+                } #for data
+                } #data is an array
+                else {
+                    $data = $r.Event.EventData.data
+                    if ($data.name) {
+                        $Name = $data.name
+                        $Value = $data.'#text'
+                    }
+                    else {
+                        Write-Verbose "[PROCESS] No data property name detected"
+                        $Name = "RawProperties"
+                        #data will likely be an array of strings
+                        [string[]]$Value = $data
+                    }
+
+                    if ($h.Contains("RawProperties")) {
+                        Write-Verbose "[PROCESS] Appending to RawProperties"
+                        $h.RawProperties += $value
+                    }
+                    else {
+                        Write-Verbose "[PROCESS] Adding $name"
+                        $h.add($name, $Value)
+                    }
+                }
+            } #if data
+            else {
+                Write-Verbose "[PROCESS] No event data to process"
+            }
+
+            $h.Add("Message", $record.Message)
+            $h.Add("Keywords", $record.KeywordsDisplayNames)
+            $h.Add("Source", $record.ProviderName)
+            $h.Add("Computername", $record.MachineName)
+
+            Write-Verbose "[PROCESS] Creating custom object"
+            New-Object -TypeName PSObject -Property $h
+        } #foreach record
+    } #process
+
+    End {
+        Write-Verbose "[END    ] Ending: $($MyInvocation.Mycommand)"
+    } #end
+}

functions/Convert-EventLogRecord.ps1

@@ -13,7 +13,9 @@ Function ConvertTo-Markdown {
         [string[]]$PreContent,
         [string[]]$PostContent,
         [ValidateScript( {$_ -ge 10})]
-        [int]$Width = 80
+        [int]$Width = 80,
+        #display results as a markdown table
+        [switch]$AsTable
     )
 
     Begin {
@@ -36,7 +38,6 @@ Function ConvertTo-Markdown {
         }
 
     } #begin
-
     Process {
         #add incoming objects to data array
         Write-Verbose "[PROCESS] Adding processed object"
@@ -46,26 +47,56 @@ Function ConvertTo-Markdown {
     End {
         #add the data to the text
         if ($data) {
-            #convert data to strings and trim each line
-            Write-Verbose "[END    ] Converting data to strings"
-            [string]$trimmed = (($data | Out-String -Width $width).split("`n")).ForEach( {"$($_.trimend())`n"})
-            Write-Verbose "[END    ] Adding to markdown"
-            $text += @"
+            if ($AsTable) {
+                Write-Verbose "[END    ] Formatting as a table"
+                $names = $data[0].psobject.Properties.name
+                $head = "| $($names -join " | ") |"
+                $text += $head
+                $text += "`n"
+
+                $bars = "| $(($names -replace '.','-') -join " | ") |"
+
+                $text += $bars
+                $text += "`n"
+
+                foreach ($item in $data) {
+                    $line = "| "
+                    $values = @()
+                    for ($i = 0; $i -lt $names.count; $i++) {
+                        # $line += $item.($names[$i])
+                        $values += $item.($names[$i])
+                    }
+                    $line += $values -join " | "
+                    $line += " |"
+                    $text += $line
+                    $text += "`n"
+                }
+
+            }
+            else {
+                #convert data to strings and trim each line
+                Write-Verbose "[END    ] Converting data to strings"
+                [string]$trimmed = (($data | Out-String -Width $width).split("`n")).ForEach( { "$($_.trim())`n" })
+                Write-Verbose "[END    ] Adding to markdown"
+                $clean = $($trimmed.trimend())
+                $text += @"
 ``````text
-$($trimmed.trimend())
+$clean
 ``````
 
 "@
-        }
 
+            } #else as text
+        } #if $data
         If ($postcontent) {
             Write-Verbose "[END    ] Adding postcontent"
             $text += "`n"
             $text += $postcontent
         }
         #write the markdown to the pipeline
-        $text
+        $text.TrimEnd()
         Write-Verbose "[END    ] Ending $($myinvocation.MyCommand)"
     } #end
 
+
 } #close ConvertTo-Markdown