Public/Get-OSDBuilder.ps1

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
<#
.SYNOPSIS
Offline Servicing for Windows 10, Windows Server 2016 and Windows Server 2019
 
.DESCRIPTION
Offline Servicing for Windows 7, Windows 10, Windows Server 2012 R2, Windows Server 2016 and Windows Server 2019
 
.LINK
https://osdbuilder.osdeploy.com/module/functions/get-osdbuilder
#>

function Get-OSDBuilder {
    [CmdletBinding()]
    Param (
        #Creates OSDBuilder directory structure
        #Directories are automatically created with first Import
        #Alias: Create
        [Alias('Create')]
        [switch]$CreatePaths,

        #Quick Download options
        [ValidateSet('FeatureUpdates','OneDrive','OneDriveEnterprise','OSMediaUpdates')]
        [string]$Download,

        #Hides Write-Host output. Used when called from other functions
        #Alias: Silent
        [Alias('Silent')]
        [switch]$HideDetails,

        #Quick options
        [ValidateSet('OneDrive','Download','Cleanup')]
        [string]$Quick,
        
        #Changes the path from the default of C:\OSDBuilder to the path specified
        #Alias: Path
        [Alias('Path')]
        [string]$SetPath,

        #Updates the OSDBuilder Module
        #Alias: Update
        [Alias('Update')]
        [switch]$UpdateModule
    )
    #===================================================================================================
    # OSDBuilder Hashtable
    #===================================================================================================
    if ($null -eq $global:GetOSDBuilder) {$global:GetOSDBuilder = [ordered]@{}}
    if ($null -eq $global:SetOSDBuilder) {$global:SetOSDBuilder = [ordered]@{}}
    #===================================================================================================
    # OSDBuilder Defaults
    #===================================================================================================
    $global:SetOSDBuilder.AllowContentPacks    = $false
    $global:SetOSDBuilder.AllowGlobalOptions   = $true
    #===================================================================================================
    # OSDBuilder.Home
    #===================================================================================================
    if (!(Test-Path HKCU:\Software\OSDeploy\OSBuilder)) {New-Item HKCU:\Software\OSDeploy -Name OSBuilder -Force | Out-Null}
    if (!(Get-ItemProperty -Path 'HKCU:\Software\OSDeploy' -Name OSBuilderPath -ErrorAction SilentlyContinue)) {New-ItemProperty -Path "HKCU:\Software\OSDeploy" -Name OSBuilderPath -Force | Out-Null}
    if ($SetPath) {Set-ItemProperty -Path "HKCU:\Software\OSDeploy" -Name "OSBuilderPath" -Value "$SetPath" -Force}
    $global:GetOSDBuilder.Home = $(Get-ItemProperty "HKCU:\Software\OSDeploy").OSBuilderPath
    if (!($global:GetOSDBuilder.Home)) {$global:GetOSDBuilder.Home = "$Env:SystemDrive\OSDBuilder"}
    #===================================================================================================
    # Corrections
    #===================================================================================================
    if (Test-Path "$($global:GetOSDBuilder.Home)\Media") {
        Rename-Item "$($global:GetOSDBuilder.Home)\Media" "$($global:GetOSDBuilder.Home)\FeatureUpdates" -Force | Out-Null
    }
    #===================================================================================================
    # OSDBuilder Set (Read Write)
    #===================================================================================================
    $global:SetOSDBuilder.PathFeatureUpdates    = "$($global:GetOSDBuilder.Home)\FeatureUpdates"
    $global:SetOSDBuilder.PathOSImport          = "$($global:GetOSDBuilder.Home)\OSImport"
    $global:SetOSDBuilder.PathOSMedia           = "$($global:GetOSDBuilder.Home)\OSMedia"
    $global:SetOSDBuilder.PathOSBuilds          = "$($global:GetOSDBuilder.Home)\OSBuilds"
    $global:SetOSDBuilder.PathPEBuilds          = "$($global:GetOSDBuilder.Home)\PEBuilds"
    $global:SetOSDBuilder.PathContentPacks      = "$($global:GetOSDBuilder.Home)\ContentPacks"
    $global:SetOSDBuilder.PathMount             = "$($global:GetOSDBuilder.PathContent)\Mount"
    $global:SetOSDBuilder.PathOSDUpdate         = "$($global:GetOSDBuilder.PathContent)\OSDUpdate"
    #===================================================================================================
    # OSDBuilder Get (Read Only)
    #===================================================================================================
    $global:GetOSDBuilder.PathTasks             = "$($global:GetOSDBuilder.Home)\Tasks"
    $global:GetOSDBuilder.PathTemplates         = "$($global:GetOSDBuilder.Home)\Templates"
    $global:GetOSDBuilder.PathContent           = "$($global:GetOSDBuilder.Home)\Content"
    #===================================================================================================
    # OSDBuilder.PSModule*
    #===================================================================================================
    $global:GetOSDBuilder.PSModuleOSD          = Get-Module -Name OSD | Select-Object *
    $global:GetOSDBuilder.PSModuleOSDSUS       = Get-Module -Name OSDSUS | Select-Object *
    $global:GetOSDBuilder.PSModuleOSDBuilder   = Get-Module -Name OSDBuilder | Select-Object *
    #===================================================================================================
    # OSDBuilder.Public*
    #===================================================================================================
    $global:GetOSDBuilder.PublicJson               = $null
    $global:GetOSDBuilder.PublicJsonURL            = "https://raw.githubusercontent.com/OSDeploy/OSDBuilder.Public/master/OSDBuilder.json"
    #===================================================================================================
    # OSDBuilder.Version*
    #===================================================================================================
    $global:GetOSDBuilder.VersionOSD           = $global:GetOSDBuilder.PSModuleOSD.Version | Sort-Object | Select-Object -Last 1
    $global:GetOSDBuilder.VersionOSDPublic         = $global:GetOSDBuilder.VersionOSD

    $global:GetOSDBuilder.VersionOSDSUS        = $global:GetOSDBuilder.PSModuleOSDSUS.Version | Sort-Object | Select-Object -Last 1
    $global:GetOSDBuilder.VersionOSDSUSPublic      = $global:GetOSDBuilder.VersionOSDSUS
    
    $global:GetOSDBuilder.VersionOSDBuilder    = $global:GetOSDBuilder.PSModuleOSDBuilder.Version | Sort-Object | Select-Object -Last 1
    $global:GetOSDBuilder.VersionOSDBuilderPublic  = $global:GetOSDBuilder.VersionOSDBuilder

    if (!($HideDetails.IsPresent)) {
        $StatusCode = try {(Invoke-WebRequest -Uri $global:GetOSDBuilder.PublicJsonURL -UseBasicParsing -DisableKeepAlive).StatusCode}
        catch [Net.WebException]{[int]$_.Exception.Response.StatusCode}
        if ($StatusCode -ne "200") {
            #Check Failed
        } else {
            $global:GetOSDBuilder.PublicJson               = Invoke-RestMethod -Uri $global:GetOSDBuilder.PublicJsonURL
            $global:GetOSDBuilder.VersionOSDPublic         = $global:GetOSDBuilder.PublicJson.OSD
            $global:GetOSDBuilder.VersionOSDSUSPublic      = $global:GetOSDBuilder.PublicJson.OSDSUS
            $global:GetOSDBuilder.VersionOSDBuilderPublic  = $global:GetOSDBuilder.PublicJson.OSDBuilder
        }
    }
    #===================================================================================================
    # OSDBuilder.json
    #===================================================================================================
    $OSDBuilderJsonLocal = "$($global:GetOSDBuilder.Home)\OSDBuilder.json"
    if (Test-Path $OSDBuilderJsonLocal) {
        Try {
            $global:GetOSDBuilder.LocalSettings = (Get-Content $OSDBuilderJsonLocal | ConvertFrom-Json).PSObject.Properties | foreach {[ordered]@{Name = $_.Name; Value = $_.Value}} | ConvertTo-Json | ConvertFrom-Json
            $global:GetOSDBuilder.LocalSettings | foreach {$global:SetOSDBuilder.$($_.Name) = $($_.Value)}
        }
        Catch {
            Write-Warning "Unable to import $OSDBuilderJsonLocal"
        }
    }

    if ($global:SetOSDBuilder.AllowGlobalOptions -eq $true) {
        $OSDBuilderJsonGlobal = "$env:ProgramData\OSDeploy\OSDBuilder.json"
        if ((Test-Path $OSDBuilderJsonGlobal)) {
            Try {
                $global:GetOSDBuilder.GlobalSettings = (Get-Content $OSDBuilderJsonGlobal | ConvertFrom-Json).PSObject.Properties | foreach {[ordered]@{Name = $_.Name; Value = $_.Value}} | ConvertTo-Json | ConvertFrom-Json
                $global:GetOSDBuilder.GlobalSettings | foreach {$global:SetOSDBuilder.$($_.Name) = $($_.Value)}
            }
            Catch {
                Write-Warning "Unable to import $OSDBuilderJsonGlobal"
            }
        }
    }

<# if (Test-Path $env:ProgramData\OSDeploy\OSDBuilder.json) {
        Try {
            $OSDBuilderJson = Get-OSDFromJson -Path $env:ProgramData\OSDeploy\OSDBuilder.json
            if ($OSDBuilderJson.PathContent) {$global:GetOSDBuilder.PathContent = $OSDBuilderJson.PathContent}
            if ($OSDBuilderJson.PathContentPacks) {$global:SetOSDBuilder.PathContentPacks = $OSDBuilderJson.PathContentPacks}
            if ($OSDBuilderJson.PathFeatureUpdates) {$global:SetOSDBuilder.PathFeatureUpdates = $OSDBuilderJson.PathFeatureUpdates}
            if ($OSDBuilderJson.PathOSBuilds) {$global:SetOSDBuilder.PathOSBuilds = $OSDBuilderJson.PathOSBuilds}
            if ($OSDBuilderJson.PathOSImport) {$global:SetOSDBuilder.PathOSImport = $OSDBuilderJson.PathOSImport}
            if ($OSDBuilderJson.PathOSMedia) {$global:SetOSDBuilder.PathOSMedia = $OSDBuilderJson.PathOSMedia}
            if ($OSDBuilderJson.PathPEBuilds) {$global:SetOSDBuilder.PathPEBuilds = $OSDBuilderJson.PathPEBuilds}
            #Content
            if ($OSDBuilderJson.PathMount) {$global:SetOSDBuilder.PathMount = $OSDBuilderJson.PathMount}
            if ($OSDBuilderJson.PathOSDUpdate) {$global:SetOSDBuilder.PathOSDUpdate = $OSDBuilderJson.PathOSDUpdate}
        }
        Catch {
            Write-Warning "Unable to import $env:ProgramData\OSDeploy\OSDBuilder.json"
        }
    } #>

    #===================================================================================================
    # Backward Compatibility
    #===================================================================================================
    #$global:OSDBuilderPath = $global:GetOSDBuilder.Home
    #$global:OSDBuilderOSImport = $global:SetOSDBuilder.PathOSImport
    #$global:OSDBuilderOSMedia = $global:SetOSDBuilder.PathOSMedia
    #$global:OSDBuilderOSBuilds = $global:SetOSDBuilder.PathOSBuilds
    #$global:OSDBuilderPEBuilds = $global:SetOSDBuilder.PathPEBuilds
    #$global:OSDBuilderTasks = $global:GetOSDBuilder.PathTasks
    #$global:OSDBuilderTemplates = $global:GetOSDBuilder.PathTemplates
    #$global:OSDBuilderContent = $global:GetOSDBuilder.PathContent

    $global:GetOSDBuilderHome               = $global:GetOSDBuilder.Home
    $global:GetOSDBuilderPathContent        = $global:GetOSDBuilder.PathContent
    $global:GetOSDBuilderPathContentPacks   = $global:SetOSDBuilder.PathContentPacks
    $global:GetOSDBuilderPathFeatureUpdates = $global:SetOSDBuilder.PathFeatureUpdates
    $global:GetOSDBuilderPathMount          = $global:SetOSDBuilder.PathMount
    $global:GetOSDBuilderPathOSBuilds       = $global:SetOSDBuilder.PathOSBuilds
    $global:GetOSDBuilderPathOSDUpdate      = $global:SetOSDBuilder.PathOSDUpdate
    $global:GetOSDBuilderPathOSImport       = $global:SetOSDBuilder.PathOSImport
    $global:GetOSDBuilderPathOSMedia        = $global:SetOSDBuilder.PathOSMedia
    $global:GetOSDBuilderPathPEBuilds       = $global:SetOSDBuilder.PathPEBuilds
    $global:GetOSDBuilderPathTasks          = $global:GetOSDBuilder.PathTasks
    $global:GetOSDBuilderPathTemplates      = $global:GetOSDBuilder.PathTemplates

    #$global:GetModuleOSD = $global:GetOSDBuilder.PSModuleOSD
    #$global:GetModuleOSDSUS = $global:GetOSDBuilder.PSModuleOSDSUS
    #$global:GetModuleOSDBuilder = $global:GetOSDBuilder.PSModuleOSDBuilder

    #$global:GetModuleOSDVersion = $global:GetOSDBuilder.VersionOSD
    #$global:GetModuleOSDSUSVersion = $global:GetOSDBuilder.VersionOSDSUS
    #$global:GetModuleOSDBuilderVersion = $global:GetOSDBuilder.VersionOSDBuilder
    $global:GetOSDBuilderVersionOSDBuilder  = $global:GetOSDBuilder.VersionOSDBuilder

    #$global:OSDBuilderPublic = $global:GetOSDBuilder.PublicJson
    #$global:OSDBuilderPublicURL = $global:GetOSDBuilder.PublicJsonURL

    #$global:OSDBuilderPublicOSD = $global:GetOSDBuilder.VersionOSDPublic
    #$global:OSDBuilderPublicOSDSUS = $global:GetOSDBuilder.VersionOSDSUSPublic
    #$global:OSDBuilderPublicOSDBuilder = $global:GetOSDBuilder.VersionOSDBuilderPublic
    #===================================================================================================
    # Display Version Information
    #===================================================================================================
    if (!($HideDetails.IsPresent)) {
        if ($null -eq $global:GetOSDBuilder.PublicJson) {
            Write-Verbose "OSDBuilder $($global:GetOSDBuilder.VersionOSDBuilder) | OSDSUS $($global:GetOSDBuilder.VersionOSDSUS) | OFFLINE" -Verbose
        } else {
            if ($global:GetOSDBuilder.VersionOSDBuilder -ge $global:GetOSDBuilder.VersionOSDBuilderPublic) {
                Write-Host "OSDBuilder $($global:GetOSDBuilder.VersionOSDBuilder) " -ForegroundColor Green -NoNewline
            } else {
                Write-Host "OSDBuilder $($global:GetOSDBuilder.VersionOSDBuilder) " -ForegroundColor Yellow -NoNewline
            }
            Write-Host "| " -ForegroundColor White -NoNewline
        
            if ($global:GetOSDBuilder.VersionOSDSUS -ge $global:GetOSDBuilder.VersionOSDSUSPublic) {
                Write-Host "OSDSUS $($global:GetOSDBuilder.VersionOSDSUS) " -ForegroundColor Green -NoNewline
            } else {
                Write-Host "OSDSUS $($global:GetOSDBuilder.VersionOSDSUS) " -ForegroundColor Yellow -NoNewline
            }
            if (Get-IsContentPacksEnabled) {
                Write-Host "| " -ForegroundColor White -NoNewline
                Write-Host "#MMSJazz Ready" -ForegroundColor Magenta
            } else {
                Write-Host
            }
        }
    }
    #===================================================================================================
    # Display OSDBulder Home Path
    #===================================================================================================
    if (!($HideDetails.IsPresent)) {Write-Host "Home $($global:GetOSDBuilder.Home)"}
    #===================================================================================================
    # Verify Single Version of OSDBuilder
    #===================================================================================================
    if (($global:GetOSDBuilder.PSModuleOSDBuilder).Count -gt 1) {
        Write-Warning "Multiple OSDBuilder Modules are loaded"
        Write-Warning "Close all open PowerShell sessions before using OSDBuilder"
        Break
    }
    #===================================================================================================
    # CreatePaths
    #===================================================================================================
    if ($CreatePaths.IsPresent) {
        New-ItemDirectoryGetOSDBuilderHome
        New-ItemDirectoryGetOSDBuilderPathContent
        New-OSDBuilderContentPack -Name '_Global'
    }
    #===================================================================================================
    # Remove Directories
    #===================================================================================================
    $OSDBuilderOldDirectories = @(
        "$GetOSDBuilderPathContent\UpdateStacks"
        "$GetOSDBuilderPathContent\UpdateWindows"
        "$GetOSDBuilderPathOSDUpdate\Windows 10 1903"
    )

    foreach ($OSDBuilderDir in $OSDBuilderOldDirectories) {
        if (Test-Path "$OSDBuilderDir") {
            Write-Warning "'$OSDBuilderDir' is no longer required and should be removed"
        }
    }
    #===================================================================================================
    # DownloadOneDrive
    #===================================================================================================
    if ($Quick -eq 'Download' -or $Download -eq 'OSMediaUpdates') {
        $HideDetails = $true
        Get-OSMedia | Update-OSMedia -Download
        Return
    }
    if ($Quick -eq 'Cleanup') {
        $HideDetails = $true
        Get-DownOSDBuilder -Superseded Remove
        Return
    }
    if ($Download -eq 'FeatureUpdates') {
        $HideDetails = $true
        Get-DownOSDBuilder -FeatureUpdates
        Return
    }
    if ($Download -eq 'OneDrive' -or $Quick -eq 'OneDrive') {
        $HideDetails = $true
        Get-DownOSDBuilder -ContentDownload "OneDriveSetup Production"
        Return
    }
    if ($Download -eq 'OneDriveEnterprise') {
        $HideDetails = $true
        Get-DownOSDBuilder -ContentDownload "OneDriveSetup Enterprise"
        Return
    }
    #===================================================================================================
    # Show-OSDBuilderHome
    #===================================================================================================
    if ($HideDetails -eq $false) {
        #===================================================================================================
        # Display Home Content
        #===================================================================================================
        if (!($HideDetails.IsPresent)) {
            if ($global:GetOSDBuilder.VersionOSDBuilder -gt $global:GetOSDBuilder.VersionOSDBuilderPublic) {
                Write-Host
                Write-Host "OSDBuilder Release Preview" -ForegroundColor Green
                Write-Host "The current Public version is $($global:GetOSDBuilder.VersionOSDBuilderPublic)" -ForegroundColor DarkGray
            } elseif ($global:GetOSDBuilder.VersionOSDBuilder -eq $global:GetOSDBuilder.VersionOSDBuilderPublic) {
                #Write-Host "OSDBuilder is up to date" -ForegroundColor Green
                #""
            } else {
                Write-Host
                Write-Warning "OSDBuilder can be updated to $($global:GetOSDBuilder.VersionOSDBuilderPublic)"
                Write-Host "OSDBuilder -Update" -ForegroundColor Cyan
            }

            if ($global:GetOSDBuilder.VersionOSDSUS -gt $global:GetOSDBuilder.VersionOSDSUSPublic) {
                Write-Host
                Write-Host "OSDSUS Release Preview" -ForegroundColor Green
                Write-Host "The current Public version is $($global:GetOSDBuilder.VersionOSDSUSPublic)" -ForegroundColor DarkGray
            } elseif ($global:GetOSDBuilder.VersionOSDSUS -eq $global:GetOSDBuilder.VersionOSDSUSPublic) {
                #Write-Host "OSDSUS is up to date" -ForegroundColor Green
            } else {
                Write-Host
                Write-Warning "OSDSUS can be updated to $($global:GetOSDBuilder.VersionOSDSUSPublic)"
                Write-Host "Update-OSDSUS" -ForegroundColor Cyan
            }

            Write-Host ""
            Write-Host "Latest Updates:" -ForegroundColor Gray
            foreach ($line in $global:GetOSDBuilder.PublicJson.LatestUpdates) {Write-Host $line -ForegroundColor DarkGray}
            Write-Host ""
            Write-Host "Helpful Links:" -ForegroundColor Gray
            foreach ($line in $global:GetOSDBuilder.PublicJson.HelpfulLinks) {Write-Host $line -ForegroundColor DarkGray}
            Write-Host ""
            Write-Host "New Links:" -ForegroundColor Gray
            foreach ($line in $global:GetOSDBuilder.PublicJson.NewLinks) {Write-Host $line -ForegroundColor DarkGray}

        }
        #Show-OSDBuilderHomeMap
        Show-OSDBuilderHomeTips
    }
    if ($UpdateModule.IsPresent) {
        Update-OSDSUS
        Update-ModuleOSDBuilder
    }
}