nl.nlsw.Ini.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# __ _ ____ _ _ _ _ ____ ____ ____ ____ ____ ___ _ _ ____ ____ ____
# | \| |=== |/\| |___ | |--- |=== ==== [__] |--- | |/\| |--| |--< |===
#
# @file nl.nlsw.Ini.psm1
# @copyright Ernst van der Pols, Licensed under the EUPL-1.2-or-later
# @date 2021-09-30
#requires -version 3

<#
.SYNOPSIS
    Gets the content of an INI file
 
.DESCRIPTION
    Gets the content of an INI file and returns it as an ordered hashtable.
 
.INPUTS
    System.String
 
.OUTPUTS
    System.Collections.Specialized.OrderedDictionary
 
.PARAMETER Path
    Specifies the path to the input file.
 
.EXAMPLE
    $FileContent = Import-Ini "C:\myinifile.ini"
    -----------
    Description
    Saves the content of the c:\myinifile.ini in a hashtable called $FileContent
 
.EXAMPLE
    $inifilepath | $FileContent = Import-Ini
    -----------
    Description
    Gets the content of the ini file passed through the pipe into a hashtable called $FileContent
 
.EXAMPLE
    C:\PS>$FileContent = Import-Ini "c:\settings.ini"
    C:\PS>$FileContent["Section"]["Key"]
    -----------
    Description
    Returns the key "Key" of the section "Section" from the C:\settings.ini file
 
.LINK
    Export-Ini
 
.LINK
    https://gallery.technet.microsoft.com/scriptcenter/ea40c1ef-c856-434b-b8fb-ebd7a76e8d91
 
.NOTES
    Author : Oliver Lipkau <oliver@lipkau.net>
    Blog : http://oliver.lipkau.net/blog/
    Original: Get-IniContent
    Source : https://github.com/lipkau/PsIni
              http://gallery.technet.microsoft.com/scriptcenter/ea40c1ef-c856-434b-b8fb-ebd7a76e8d91
    Version : 1.0 - 2010/03/12 - Initial release
              1.1 - 2014/12/11 - Typo (Thx SLDR)
                                 Typo (Thx Dave Stiff)
 
    #Requires -Version 2.0
#>

function Import-Ini {
    [CmdletBinding()]
    param(
        [ValidateNotNullOrEmpty()]
        #[ValidateScript({(Test-Path $_) -and ((Get-Item $_).Extension -eq ".ini")})]
        [Parameter(ValueFromPipeline=$True,Mandatory=$True)]
        [string]$Path
    )
    begin {
    }
    process {
        Write-Verbose "$($MyInvocation.MyCommand.Name):: importing $Path"

        $ini = [ordered]@{}
        switch -regex -file $Path
        {
            "^\[(.+)\]$" # Section
            {
                if ($section)
                {
                    if ($CommentCount -gt 0)
                    {
                        $ini[$section][';CommentCount'] = $CommentCount
                    }
                }
                $section = $matches[1]
                $ini[$section] = [ordered]@{}
                $CommentCount = 0
            }
            "^;(.*)$" # Comment
            {
                if (!($section))
                {
                    $section = "No-Section"
                    $ini[$section] = [ordered]@{}
                    $CommentCount = 0
                }
                $value = $matches[1]
                $CommentCount = $CommentCount + 1
                $name = ";Comment" + $CommentCount
                $ini[$section][$name] = $value
            }
            "(.+?)\s*=\s*(.*)" # Key
            {
                if (!($section))
                {
                    $section = "No-Section"
                    $ini[$section] = [ordered]@{}
                    $CommentCount = 0
                }
                $name,$value = $matches[1..2]
                $ini[$section][$name] = $value
            }
        }
        if ($section)
        {
            if ($CommentCount -gt 0)
            {
                $ini[$section][';CommentCount'] = $CommentCount
            }
        }

        Write-Verbose "$($MyInvocation.MyCommand.Name):: imported $($ini.Keys.Count) ini sections"
        return $ini
    }
    end {
    }
}

<#
.SYNOPSIS
    Write hashtable content to INI file
 
.DESCRIPTION
    Write hashtable content to INI file
 
.INPUTS
    System.String
    System.Collections.Hashtable
 
.OUTPUTS
    System.IO.FileSystemInfo
 
.PARAMETER Append
    Adds the output to the end of an existing file, instead of replacing the file contents.
 
.PARAMETER InputObject
    Specifies the Hashtable to be written to the file. Enter a variable that contains the objects or type a command or expression that gets the objects.
 
.PARAMETER Path
    Specifies the path to the output file.
 
 PARAMETER Encoding
    Specifies the type of character encoding used in the file. Valid values are "Unicode", "UTF7",
     "UTF8", "UTF32", "ASCII", "BigEndianUnicode", "Default", and "OEM". "Unicode" is the default.
 
    "Default" uses the encoding of the system's current ANSI code page.
 
    "OEM" uses the current original equipment manufacturer code page identifier for the operating
    system.
 
.PARAMETER Force
    Allows the cmdlet to overwrite an existing read-only file. Even using the Force parameter, the cmdlet cannot override security restrictions.
 
.PARAMETER PassThru
    Passes an object representing the location to the pipeline. By default, this cmdlet does not generate any output.
 
.EXAMPLE
    Export-Ini $IniVar "C:\myinifile.ini"
    -----------
    Description
    Saves the content of the $IniVar Hashtable to the INI File c:\myinifile.ini
 
.EXAMPLE
    $IniVar | Export-Ini "C:\myinifile.ini" -Force
    -----------
    Description
    Saves the content of the $IniVar Hashtable to the INI File c:\myinifile.ini and overwrites the file if it is already present
 
.EXAMPLE
    $file = Export-Ini $IniVar "C:\myinifile.ini" -PassThru
    -----------
    Description
    Saves the content of the $IniVar Hashtable to the INI File c:\myinifile.ini and saves the file into $file
 
.EXAMPLE
    $Category1 = @{"Key1"="Value1";"Key2"="Value2"}
    $Category2 = @{"Key1"="Value1";"Key2"="Value2"}
    $NewINIContent = @{"Category1"=$Category1;"Category2"=$Category2}
    Export-Ini -InputObject $NewINIContent -Path "C:\MyNewFile.INI"
    -----------
    Description
    Creating a custom Hashtable and saving it to C:\MyNewFile.INI
 
.LINK
    Import-Ini
 
.LINK
    https://github.com/lipkau/PsIni
 
.NOTES
    Author : Oliver Lipkau <oliver@lipkau.net>
    Blog : http://oliver.lipkau.net/blog/
    Original : Out-IniFile
    Source : https://github.com/lipkau/PsIni
    Version : 1.0 - 2010/03/12 - Initial release
                  1.1 - 2012/04/19 - Bugfix/Added example to help (Thx Ingmar Verheij)
                  1.2 - 2014/12/11 - Improved handling for missing output file (Thx SLDR)
 
    #Requires -Version 2.0
#>

function Export-Ini {
    [CmdletBinding()]
    [OutputType([System.IO.FileSystemInfo])]
    param(
        [switch]$Append,

        [ValidateSet("Unicode","UTF7","UTF8","UTF32","ASCII","BigEndianUnicode","Default","OEM")]
        [Parameter()]
        [string]$Encoding = "UTF8",


        [ValidateNotNullOrEmpty()]
        [ValidatePattern('^([a-zA-Z]\:)?.+\.ini$')]
        [Parameter(Mandatory=$True)]
        [string]$Path,

        [switch]$Force,

        [ValidateNotNullOrEmpty()]
        [Parameter(ValueFromPipeline=$True,Mandatory=$True)]
        [Hashtable]$InputObject,

        [switch]$Passthru
    )

    begin  {
        Write-Verbose "$($MyInvocation.MyCommand.Name):: Function started"
    }

    process {
        Write-Verbose "$($MyInvocation.MyCommand.Name):: Writing to file: $Path"

        if ($append) {
            $outfile = Get-Item $Path
        }
        else {
            $outFile = New-Item -ItemType file -Path $Path -Force:$Force
        }
        if (!($outFile)) {
            throw "Could not create File"
        }
        foreach ($i in $InputObject.keys)
        {
            if (!($($InputObject[$i].GetType().Name) -eq "Hashtable"))
            {
                #No Sections
                Write-Verbose "$($MyInvocation.MyCommand.Name):: Writing key: $i"
                Add-Content -Path $outFile -Value "$i=$($InputObject[$i])" -Encoding $Encoding
            }
            else {
                #Sections
                Write-Verbose "$($MyInvocation.MyCommand.Name):: Writing Section: [$i]"
                Add-Content -Path $outFile -Value "[$i]" -Encoding $Encoding
                Foreach ($j in $($InputObject[$i].keys | Sort-Object))
                {
                    if ($j -match "^;Comment[\d]+") {
                        Write-Verbose "$($MyInvocation.MyCommand.Name):: Writing comment: $j"
                        Add-Content -Path $outFile -Value ";$($InputObject[$i][$j])" -Encoding $Encoding
                    } else {
                        Write-Verbose "$($MyInvocation.MyCommand.Name):: Writing key: $j"
                        Add-Content -Path $outFile -Value "$j=$($InputObject[$i][$j])" -Encoding $Encoding
                    }

                }
                Add-Content -Path $outFile -Value "" -Encoding $Encoding
            }
        }
        Write-Verbose "$($MyInvocation.MyCommand.Name):: Finished Writing to file: $path"
        if ($PassThru) {return $outFile}
    }

    end {
        Write-Verbose "$($MyInvocation.MyCommand.Name):: Function ended"
    }
}

Export-ModuleMember -Function *