MetaNull.Queue.psm1
|
# Module Constants $User = [Security.Principal.WindowsIdentity]::GetCurrent() $Principal = [Security.Principal.WindowsPrincipal]::new($User) $Role = [Security.Principal.WindowsBuiltInRole]::Administrator if($Principal.IsInRole($Role)) { # Current use is Administrator $PSDriveRoot = 'HKLM:\SOFTWARE\MetaNull\PowerShell\MetaNull.Queue' } else { # Current user is not Administrator $PSDriveRoot = 'HKCU:\SOFTWARE\MetaNull\PowerShell\MetaNull.Queue' } if(-not (Test-Path $PSDriveRoot)) { New-Item -Path $PSDriveRoot -Force | Out-Null } New-Variable MetaNull -Scope script -Value @{ Queue = @{ PSDriveRoot = $PSDriveRoot Lock = New-Object Object Drive = New-PSDrive -Name 'MetaNull' -Scope Script -PSProvider Registry -Root $PSDriveRoot } } if(-not (Test-Path MetaNull:\Queues)) { New-Item -Path MetaNull:\Queues -Force | Out-Null } Function Test-IsAdministrator { <# .SYNOPSIS Tests if the current user has Administrative rights #> [CmdletBinding()] [OutputType([bool])] param() Process { $User = [Security.Principal.WindowsIdentity]::GetCurrent() $Principal = [Security.Principal.WindowsPrincipal]::new($User) $Role = [Security.Principal.WindowsBuiltInRole]::Administrator return $Principal.IsInRole($Role) } } Function Clear-Queue { <# .SYNOPSIS Remove all Commands from the queue #> [CmdletBinding()] [OutputType([pscustomobject])] param( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, Position = 0)] [guid] $Id ) Process { $BackupErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Stop' try { # Find the queue if(-not "$Id" -or -not (Test-Path "MetaNull:\Queues\$Id")) { throw "Queue $Id not found" } # Remove the command [System.Threading.Monitor]::Enter($MetaNull.Queue.Lock) try { Remove-Item "MetaNull:\Queues\$Id\Commands\*" -Force -Recurse } finally { [System.Threading.Monitor]::Exit($MetaNull.Queue.Lock) } } finally { $ErrorActionPreference = $BackupErrorActionPreference } } } Function Get-Queue { <# .SYNOPSIS Returns the list of Queues .DESCRIPTION Returns the list of Queues .PARAMETER Id The Id of the Queue to return .PARAMETER Name The filter to apply on the name of the Queues Filter supports wildcards .EXAMPLE # Get all the Queues Get-Queue .EXAMPLE # Get the Queue with the Id '00000000-0000-0000-0000-000000000000' Get-Queue -Id '00000000-0000-0000-0000-000000000000' .EXAMPLE # Get the Queues with the name starting with 'Queue' Get-Queue -Name 'Queue*' #> [CmdletBinding()] [OutputType([PSCustomObject])] param( [Parameter(Mandatory = $false, ValueFromPipeline, ValueFromPipelineByPropertyName, Position = 0)] [guid] $Id = [guid]::Empty, [Parameter(Mandatory = $false, Position = 1)] [SupportsWildcards()] [ArgumentCompleter( { param ( $commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters ) $NameList = Get-ChildItem -Path "MetaNull:\Queues" | Get-ItemProperty | Select-Object Name | Select-Object -ExpandProperty Name $NameList -like *_ } )] [string] $Name = '*' ) Process { $BackupErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Stop' try { # Set the filter to '*' or the 'Id' $Filter = '*' if($Id -ne [guid]::Empty) { $Filter = $Id.ToString() } [System.Threading.Monitor]::Enter($MetaNull.Queue.Lock) try { # Get the queue(s) Get-Item -Path "MetaNull:\Queues\$Filter" | Foreach-Object { $Queue = $_ | Get-ItemProperty | Select-Object * | Select-Object -ExcludeProperty PS* $Queue | Add-Member -MemberType NoteProperty -Name 'RegistryKey' -Value $RegistryKey $Queue | Add-Member -MemberType NoteProperty -Name 'Commands' -Value @() # Return the queue object $Queue | Write-Output } | Where-Object { # Filter the queue(s) by 'Name' $_.Name -like $Name } | ForEach-Object { # Add command(s) to the queue object $_.Commands = Get-ChildItem "MetaNull:\Queues\$($_.Id)\Commands" | Foreach-Object { $Command = $_ | Get-ItemProperty | Select-Object * | Select-Object -ExcludeProperty PS* $Command | Add-Member -MemberType NoteProperty -Name 'RegistryKey' -Value $RegistryKey $Command | Write-Output } # Return the Queue object $_ | write-output } } finally { [System.Threading.Monitor]::Exit($MetaNull.Queue.Lock) } } finally { $ErrorActionPreference = $BackupErrorActionPreference } } } Function New-Queue { <# .SYNOPSIS Create a Queue #> [CmdletBinding()] [OutputType([guid])] param( [Parameter(Mandatory)] [string] $Name, [Parameter(Mandatory=$false)] [AllowNull()] [AllowEmptyString()] [string] $Description, [Parameter(Mandatory=$false)] [ValidateSet('Iddle','Running','Disabled','Suspended')] [string] $Status = 'Iddle' ) Process { $BackupErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Stop' try { # Create the queue object $Guid = [guid]::NewGuid().ToString() $Properties = @{ Id = $Guid Name = $Name Description = $Description Status = $Status } # Store the queue into the registry [System.Threading.Monitor]::Enter($MetaNull.Queue.Lock) try { $Item = New-Item -Path "MetaNull:\Queues\$Guid" -Force New-Item -Path "MetaNull:\Queues\$Guid\Commands" -Force | Out-Null $Properties.GetEnumerator() | ForEach-Object { $Item | New-ItemProperty -Name $_.Key -Value $_.Value | Out-Null } return $Guid } finally { [System.Threading.Monitor]::Exit($MetaNull.Queue.Lock) } } finally { $ErrorActionPreference = $BackupErrorActionPreference } } } Function Pop-QueueCommand { <# .SYNOPSIS Remove a Command from the top or bottom of the queue #> [CmdletBinding()] [OutputType([pscustomobject])] param( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, Position = 0)] [guid] $Id, [Parameter(Mandatory = $false)] [switch] $Unshift ) Process { $BackupErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Stop' [System.Threading.Monitor]::Enter($MetaNull.Queue.Lock) try { # Collect the existing commands $Commands = Get-ChildItem "MetaNull:\Queues\$Id\Commands" | Foreach-Object { $_ | Get-ItemProperty | Select-Object * | Select-Object -ExcludeProperty PS* | Write-Output } | Sort-Object -Property Index # Select which command to remove if($Unshift.IsPresent -and $Unshift) { $Command = $Commands | Select-Object -First 1 } else { $Command = $Commands | Select-Object -Last 1 } if(-not $Command -or -not $Command.Index) { return } # Remove the command from the registry Remove-Item -Force -Recurse "MetaNull:\Queues\$Id\Commands\$($Command.Index)" # Return the popped/unshifted command $Command | Write-Output } finally { [System.Threading.Monitor]::Exit($MetaNull.Queue.Lock) $ErrorActionPreference = $BackupErrorActionPreference } } } Function Push-QueueCommand { <# .SYNOPSIS Add a new Command at the end of a queue #> [CmdletBinding(DefaultParameterSetName='REG_MULTI_SZ')] [OutputType([int])] param( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, Position = 0)] [guid] $Id, [Parameter(Mandatory, Position = 1, ParameterSetName = 'REG_MULTI_SZ')] [string[]] $Commands, [Parameter(Mandatory, Position = 1, ParameterSetName = 'REG_SZ')] [string[]] $Command, [Parameter(Mandatory, Position = 1, ParameterSetName = 'REG_EXPAND_SZ')] [string[]] $ExpandableCommand, [Parameter(Mandatory = $false, Position = 2)] [AllowEmptyString()] [AllowNull()] [string] $Name, [Parameter(Mandatory = $false)] [switch] $Unique ) Process { $BackupErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Stop' [System.Threading.Monitor]::Enter($MetaNull.Queue.Lock) try { # Collect the existing commands $CommandList = [object[]](Get-ChildItem "MetaNull:\Queues\$Id\Commands" -ErrorAction SilentlyContinue | Foreach-Object { $_ | Get-ItemProperty | Select-Object * | Select-Object -ExcludeProperty PS* | Write-Output } | Sort-Object -Property Index) # Check if the command is already present if($Unique.IsPresent -and $Unique -and ($Commands | Where-Object { $_.Command -eq $Command })) { throw "Command already present in queue $Id" } # Find the last command index $LastCommandIndex = ($CommandList | Select-Object -Last 1 | Select-Object -ExpandProperty Index) + 1 # Create the new command $Properties = @{ Index = $LastCommandIndex Name = $Name # Command = $Command # This value is set separately, as it allows different types (REG_SZ, REG_MULTI_SZ, REG_EXPAND_SZ) } # Add the new command to the registry $Item = New-Item "MetaNull:\Queues\$Id\Commands\$LastCommandIndex" -Force switch($PSCmdlet.ParameterSetName) { 'REG_EXPAND_SZ' { $Item | New-ItemProperty -Name Command -Value $ExpandableCommand -Type ExpandString | Out-Null } 'REG_SZ' { $Item | New-ItemProperty -Name Command -Value $Command -Type String | Out-Null } default { $Item | New-ItemProperty -Name Command -Value ([string[]]$Commands) -Type MultiString | Out-Null } } $Properties.GetEnumerator() | ForEach-Object { $Item | New-ItemProperty -Name $_.Key -Value $_.Value | Out-Null } # Return the command Index return $LastCommandIndex } finally { [System.Threading.Monitor]::Exit($MetaNull.Queue.Lock) $ErrorActionPreference = $BackupErrorActionPreference } } } Function Remove-Queue { <# .SYNOPSIS Returns the list of Queues #> [CmdletBinding()] [OutputType([void])] param( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, Position = 0)] [guid] $Id, [Parameter(Mandatory = $false)] [switch] $Force ) Process { $BackupErrorActionPreference = $ErrorActionPreference $ErrorActionPreference = 'Stop' try { # Test if the queue exists if(-not "$Id" -or -not (Test-Path "MetaNull:\Queues\$Id")) { throw "Queue $Id not found" } # Remove the queue [System.Threading.Monitor]::Enter($MetaNull.Queue.Lock) try { $DoForce = $Force.IsPresent -and $Force Remove-Item "MetaNull:\Queues\$Id" -Recurse -Force:$DoForce } finally { [System.Threading.Monitor]::Exit($MetaNull.Queue.Lock) } } finally { $ErrorActionPreference = $BackupErrorActionPreference } } } |