Public/Get-Properties.ps1
|
function Get-Properties { <# .SYNOPSIS Get properties from configuration files .DESCRIPTION Get properties from configuration files .PARAMETER File The File parameter should be the name of the property file. .PARAMETER Directory The Directory parameter should be the path to the directory containing the property file. .PARAMETER Custom The Custom parameter should be the name of the custom property file. .PARAMETER CustomDirectory The CustomDirectory parameter should be the path to the directory containing the custom property file. .PARAMETER Path The path parameter corresponds to the path to the property file. .PARAMETER CustomPath The custom path parameter corresponds to the path to the custom property file. .OUTPUTS System.Collections.Specialized.OrderedDictionary. Get-Properties returns an ordered hash table containing the names and values of the properties listed in the property files. .EXAMPLE Get-Properties -File "default.ini" -Directory ".\conf" -Custom "custom.ini" -CustomDirectory "\\shared" In this example, Get-Properties will read properties from the default.ini file contained in the .\conf directory, then read the properties from in the custom.ini file contained in the \\shared directory, and override the default ones with the custom ones. .NOTES File name: Get-Properties.ps1 Author: Florian Carrier Creation date: 2018-11-27 Last modified: 2024-09-13 Comment: Get-Properties does not currently allow the use of sections to group properties in custom files #> [CmdletBinding (DefaultParameterSetName = "File")] Param ( [Parameter ( Position = 1, Mandatory = $true, ParameterSetName = "File", HelpMessage = "Property file name" )] [ValidateNotNullOrEmpty ()] [String] $File, [Parameter ( Position = 2, Mandatory = $true, ParameterSetName = "File", HelpMessage = "Path to the directory containing the property files" )] [ValidateNotNullOrEmpty ()] [String] $Directory, [Parameter ( Position = 3, Mandatory = $false, ParameterSetName = "File", HelpMessage = "Custom property file name" )] [String] $Custom, [Parameter ( Position = 4, Mandatory = $false, ParameterSetName = "File", HelpMessage = "Path to the directory containing the custom property file" )] [String] $CustomDirectory = $Directory, [Parameter ( Position = 1, Mandatory = $true, ParameterSetName = "Path", HelpMessage = "Property file path" )] [ValidateNotNullOrEmpty ()] [String] $Path, [Parameter ( Position = 2, Mandatory = $false, ParameterSetName = "Path", HelpMessage = "Custom property file path" )] [ValidateNotNullOrEmpty ()] [String] $CustomPath, [Parameter ( Position = 5, Mandatory = $false, HelpMessage = "List of properties to check" )] [String[]] $ValidateSet, [Parameter ( HelpMessage = "Define if section headers should be used to group properties or be ignored" )] [Switch] $Section, [Parameter ( HelpMessage = "Switch to retrieve metadata about properties" )] [Switch] $Metadata ) Begin { # Get global preference variables Get-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState } Process { # Build paths if ($PSCmdlet.ParameterSetName -eq "File") { # Check that specified file exists $Path = Join-Path -Path $Directory -ChildPath $File # Check if a custom file is provided if ($Custom) { # Make sure said file does exists $CustomPath = Join-Path -Path $CustomDirectory -ChildPath $Custom } } # Check path if (Test-Path -Path $Path) { # Parse properties with or without section split $Properties = Read-Properties -Path $Path -Section:$Section -Metadata:$Metadata # Check if a custom file is provided if ($CustomPath) { # Make sure said file does exists if (Test-Path -Path $CustomPath) { # Override default properties with custom ones $Customs = Read-Properties -Path $CustomPath -Metadata:$Metadata foreach ($Property in $Customs.Keys) { # Override default with custom if (Find-Key -Hashtable $Properties -Key $Property) { if ($Metadata -eq $true) { # Update value but retain metadata $Properties.$Property.Value = $Customs.$Property.Value } else { $Properties.$Property = $Customs.$Property } } else { Write-Log -Type "WARN" -Object "The ""$Property"" property defined in $Custom is unknown" } } } else { Write-Log -Type "WARN" -Object "$Custom not found in directory $CustomDirectory" } } # If some items are mandatory if ($PSBoundParameters.ContainsKey("ValidateSet")) { $MissingProperties = 0 foreach ($Item in $ValidateSet) { # Check that the property has been defined if (-Not $Properties.$Item) { Write-Log -Type "WARN" -Object "$Item property is missing from $File" $MissingProperties += 1 } } if ($MissingProperties -ge 1) { if ($MissingProperties -eq 1) { $Grammar = "property is" } else { $Grammar = "properties are" } Write-Log -Type "ERROR" -Object "$MissingProperties $Grammar not defined" -ExitCode 1 } } return $Properties } else { Write-Log -Type "ERROR" -Object "$File not found in directory $Directory" -ExitCode 1 } } } |