Dictionaries/Dict.Unix.Linux.Debian/Dict.Unix.Linux.Debian.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479

# List here the name of the package to add to system
# . fuseiso : mount ISO files as non-root user
# . libhivex-bin : read Windows registry files
# . mount : for 'losetup' (should already be installed)
# . util-linux : for 'lsblk' (should already be installed)
# . wimtools : mnipulate wim files
$Script:PackageList = "fuseiso libhivex-bin mount util-linux wimtools"

<#
 
 ######## ### ###### ## ## ### ###### ########
 ## ## ## ## ## ## ## ## ## ## ## ## ##
 ## ## ## ## ## ## ## ## ## ## ##
 ######## ## ## ## ##### ## ## ## #### ######
 ## ######### ## ## ## ######### ## ## ##
 ## ## ## ## ## ## ## ## ## ## ## ##
 ## ## ## ###### ## ## ## ## ###### ########
 
#>


<#
.SYNOPSIS
Install a package on debian-like distribution
 
.DESCRIPTION
Install a package using apt command
 
.EXAMPLE
Install-OSPackage -Name firefox
 
.NOTES
General notes
#>

function Install-OSPackage {
    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')]
    [OutputType([boolean])]
    Param (
        # The name of the package to install
        [Alias('Name')]
        [Parameter(Mandatory = $true, ValueFromPipeLine = $true)][string]$PackageName
    )
    Begin {
        Write-EnterFunction
        $command = "DEBIAN_FRONTEND=noninteractive apt -y install --no-install-recommends"
    }

    Process {
        $command += " $PackageName"
    }

    End {
        if ($PSCmdlet.ShouldProcess("Install package ?")) {
            $rc = Execute-Command -exe "bash" -args "-c `"$command`""
        } else {
            $rc = $false
        }
        return $rc
        Write-LeaveFunction
    }
}

<#
.SYNOPSIS
Uninstall a package from disk
 
.DESCRIPTION
Uninstall a package using apt command
 
.EXAMPLE
Uninstall-OSPackage -Name firefox
 
.EXAMPLE
Uninstall-OSPackage -Name firefox -Purge
 
.NOTES
General notes
#>

function Uninstall-OSPackage {
    [CmdletBinding(SupportsShouldProcess = $true)]
    [OutputType([boolean])]
    Param (
        # The name of the package to install
        [Alias('Name')]
        [Parameter(Mandatory = $true, ValueFromPipeLine = $true)][string]$PackageName,

        # Purge configuration
        [switch]$Purge
    )
    Begin {
        Write-EnterFunction
        $command = "DEBIAN_FRONTEND=noninteractive apt -y remove"
        if ($Purge) { $command += " --purge" }
    }

    Process {
        $command += " $PackageName"
    }

    End {
        if ($PSCmdlet.ShouldProcess("Uninstall package ?")) {
            $rc = Execute-Command -exe "bash" -args "-c `"$command`""
        } else {
            $rc = $false
        }
        return $rc
        Write-LeaveFunction
    }
}

<#
.SYNOPSIS
Install dependencies to unlock full PWSH functionnalities
 
.DESCRIPTION
PWSH can make use of some binaries that are not included in distro at install time.
This function can install them all at once.
 
#>

function Install-Dependencies {
    # [CmdletBinding()]Param (
    # [Parameter(Mandatory = $true,ValueFromPipeLine = $true)][string]$string = ""
    # )
    Begin {
        Write-EnterFunction
    }

    Process {
        ebegin("Installing dependancies. Please wait")
        eexec apt-get install -y $Script:PackagesList
        eend $?
    }

    End {
        Write-LeaveFunction
    }
}

<#
.SYNOPSIS
Remove dependencies from current system
 
.DESCRIPTION
Cleanly remove dependencies
# TODO add this function to the uninstall process
 
#>

function Remove-Dependencies {
    # [CmdletBinding()]Param (
    # [Parameter(Mandatory = $true,ValueFromPipeLine = $true)][string]$string = ""
    # )
    Begin {
        Write-EnterFunction
    }

    Process {
        ebegin("Removing dependancies. Please wait")
        eexec apt-get purge -y $Script:PackagesList
        eexec apt-get autoremove -y
        eexec apt-get autoclean -y
        eend $?
    }

    End {
        Write-LeaveFunction
    }
}

<#
 
 #### ###### #######
  ## ## ## ## ##
  ## ## ## ##
  ## ###### ## ##
  ## ## ## ##
  ## ## ## ## ##
 #### ###### #######
 
#>


<#
.SYNOPSIS
Mount an .iso file somewhere on the filesystem
 
.DESCRIPTION
Mount-Iso take care if Iso file is already mounted.
If not, it tries to mount it in /mnt directory.
It return absolute path name of mountpoint.
 
.EXAMPLE
Mount-Iso -File /path/to/cdrom.iso
Mount the iso '/path/to/cdrom.iso' into the filesystem
 
.EXAMPLE
Mount-Iso -File /path/to/cdrom.iso -To /tmp/myiso
Mount the iso '/path/to/cdrom.iso' into the /tmp/myiso directory
 
.OUTPUTS
Absolute pathname of the mountpoint of the iso file
 
.NOTES
# TODO make Mount-Iso work as non-root user. It should be OK with fuseiso, but it can't mount UDF ISO files so it is not reliable
#>

function Mount-Iso {
    [CmdletBinding()][OutputType([System.Boolean])]Param (
        [Parameter(Mandatory = $true,ValueFromPipeLine = $true)][string]$File,
        [string]$To = $null
    )
    Begin {
        Write-EnterFunction
        # edevel ("To = $To")
        if ($To -eq "") {
            if (IamAdmin) {
                $To = "/tmp/iso-" + $(New-Guid)
            } else {
                $To = $env:HOME + "/iso-" + $(New-Guid)
            }
        }
        # edevel ("To = $To")
    }

    Process {

        if (!(fileExist -Name $File)) { return $false }

        # $oFile = Get-Item $File
        # $To = $To + '/' + $(New-Guid)

        # check if iso file is already mounted on system
        $loop = losetup --list --json -j $File | ConvertFrom-Json
        if ($null -ne $loop) {
            $loopDevice = $loop.loopdevices[0].name
            $blkDevice = lsblk --list --json -O $loopDevice | ConvertFrom-Json
            return $blkDevice.blockdevices[0].mountpoint
        } # else continue on

        new-item -path $To -ItemType Directory -Force

        if (IamAdmin) {
            try {
                eexec -exe mount -args "-o loop $File $To"
            } catch {
                remove-item $To -Confirm:$false
                return $false
            }
        } else {
            ewarn($MyInvocation.MyCommand.ToString() + "() : You must be root.")
            return $false
            # eexec -exe fuseiso -args "'$File' '$To'"
        }

        return $To
    }

    End {
        Write-LeaveFunction
    }
}

<#
.SYNOPSIS
Unmount an .iso file
 
.DESCRIPTION
Dismount-Iso unmount iso file either by specifying iso filename or mountpoint.
 
.EXAMPLE
Dismount-Iso -File /path/to/cdrom.iso
Dismount the iso '/path/to/cdrom.iso' from the filesystem
 
.EXAMPLE
Dismount-Iso -From /mnt/myiso
Dismount the iso from the /mnt/myiso directory
 
.OUTPUTS
$true on success, $false otherwise
 
#>

function Dismount-Iso {
    [CmdletBinding(DefaultParameterSetName = 'MOUNTPOINT')]Param (
        [Parameter(ParameterSetName = 'FILE', Mandatory = $true,ValueFromPipeLine = $true)]
        [string]$File,
        [Parameter(ParameterSetName = 'MOUNTPOINT', Mandatory = $true,ValueFromPipeLine = $true)]
        [Alias('From')][string]$Mountpoint,
        [switch]$Force
    )
    Begin {
        Write-EnterFunction
        if ($Force) {
            $options = "-f"
        }
    }

    Process {

        switch ($PSCmdlet.ParameterSetName) {
            'FILE' {
                if (!(fileExist -Name $File)) { return $false }

                # $oFile = Get-Item $File
                # $To = $To + '/' + $(New-Guid)

                # 1st check if iso file is already mounted on system
                $loop = losetup --list --json -j $File | ConvertFrom-Json
                if ($null -ne $loop) {
                    $loopDevice = $loop.loopdevices[0].name
                    $blkDevice = lsblk --list --json -O $loopDevice | ConvertFrom-Json
                    eexec umount $options $blkDevice.blockdevices[0].mountpoint
                } # else continue on
            }
            'MOUNTPOINT' {
                if (IamAdmin) {
                    eexec umount $options $Mountpoint
                } else {
                    eexec fusermount -u $Mountpoint
                }
            }
        }

        Remove-Item $Mountpoint -Recurse:$false -Confirm:$false -Force
        $rc = $?

        return $rc
    }

    End {
        Write-LeaveFunction
    }
}

<#
 
 ## ## #### ## ##
 ## ## ## ## ### ###
 ## ## ## ## #### ####
 ## ## ## ## ## ### ##
 ## ## ## ## ## ##
 ## ## ## ## ## ##
  ### ### #### ## ##
 
#>


<#
.SYNOPSIS
Mount a .wim file somewhere on the filesystem
 
.DESCRIPTION
Mount-wim CANNOT take care if wim file is already mounted (fuse limitation)
If not, it tries to mount it in /mnt directory.
It return absolute path name of mountpoint.
 
.EXAMPLE
Mount-wim -File /path/to/install.wim
Mount the wim '/path/to/install.wim' into the filesystem
 
.EXAMPLE
Mount-wim -File /path/to/install.wim -Index 3 -To /tmp/mywim
Mount the wim '/path/to/install.wim' into the /tmp/mywim directory
 
.OUTPUTS
Absolute pathname of the mountpoint of the wim file
 
.NOTES
Mount-wim CANNOT take care if wim file is already mounted (fuse limitation)
#>

function Mount-Wim {
    [CmdletBinding()]Param (
        [Parameter(Mandatory = $true,ValueFromPipeLine = $true)][string]$File,
        [uint16]$Index = 1,
        [string]$To = $null
    )
    Begin {
        Write-EnterFunction
        # edevel ("To = $To")
        if ($To -eq "") {
            if (IamAdmin) {
                $To = "/tmp/wim-" + $(New-Guid)
            } else {
                $To = $env:HOME + "/wim-" + $(New-Guid)
            }
        }
        # edevel ("To = $To")
    }

    Process {

        if (!(fileExist -Name $File)) { return $false }

        new-item -path $To -ItemType Directory -Force

        eexec -exe wimmount -args "$File $Index $To"

        return $To
    }

    End {
        Write-LeaveFunction
    }
}

<#
.SYNOPSIS
Unmount an .wim file
 
.DESCRIPTION
Dismount-wim unmount wim file either by specifying wim filename or mountpoint.
 
.EXAMPLE
Dismount-wim -File /path/to/cdrom.wim
Dismount the wim '/path/to/cdrom.wim' from the filesystem
 
.EXAMPLE
Dismount-wim -From /mnt/mywim
Dismount the wim from the /mnt/mywim directory
 
.OUTPUTS
$true on success, $false otherwise
 
#>

function Dismount-Wim {
    [CmdletBinding(DefaultParameterSetName = 'MOUNTPOINT')][OutputType([System.Boolean])]Param (
        # [Parameter(ParameterSetName = 'FILE', Mandatory = $true,ValueFromPipeLine = $true)]
        # [string]$File,
        [Parameter(ParameterSetName = 'MOUNTPOINT', Mandatory = $true,ValueFromPipeLine = $true)]
        [Alias('From')][string]$Mountpoint
        # [switch]$Force
    )
    Begin {
        Write-EnterFunction
        if ($Force) {
            $options = "-f"
        }
    }

    Process {

        switch ($PSCmdlet.ParameterSetName) {
            'FILE' {
                if (!(fileExist -Name $File)) { return $false }

                # $oFile = Get-Item $File
                # $To = $To + '/' + $(New-Guid)

                # 1st check if wim file is already mounted on system
                $loop = losetup --list --json -j $File | ConvertFrom-Json
                if ($null -ne $loop) {
                    $loopDevice = $loop.loopdevices[0].name
                    $blkDevice = lsblk --list --json -O $loopDevice | ConvertFrom-Json
                    eexec umount $options $blkDevice.blockdevices[0].mountpoint
                } # else continue on
            }
            'MOUNTPOINT' {
                eexec fusermount -u $Mountpoint
            }
        }

        Remove-Item $Mountpoint -Recurse:$false -Confirm:$false -Force
        $rc = $?

        return $rc
    }

    End {
        Write-LeaveFunction
    }
}

<#
 
  ###### ####### ## ## ######## ## ## ######## ######## ########
 ## ## ## ## ### ### ## ## ## ## ## ## ## ##
 ## ## ## #### #### ## ## ## ## ## ## ## ##
 ## ## ## ## ### ## ######## ## ## ## ###### ########
 ## ## ## ## ## ## ## ## ## ## ## ##
 ## ## ## ## ## ## ## ## ## ## ## ## ##
  ###### ####### ## ## ## ####### ## ######## ## ##
 
#>